feat(specs): add /schedule endpoint (generated)

algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Fernando Beck <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: 3 people

packages/client-abtesting/model/index.ts

@@ -18,6 +18,8 @@ export * from './listABTestsResponse';
 export * from './minimumDetectableEffect';
 export * from './outliers';
 export * from './outliersFilter';
+export * from './scheduleABTestResponse';
+export * from './scheduleABTestsRequest';
 export * from './status';
 export * from './variant';
 export * from './clientMethodProps';

packages/client-abtesting/model/scheduleABTestResponse.ts

@@ -0,0 +1,8 @@
+// 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.
+
+export type ScheduleABTestResponse = {
+  /**
+   * Unique scheduled A/B test identifier.
+   */
+  abTestScheduleID: number;
+};

packages/client-abtesting/model/scheduleABTestsRequest.ts

@@ -0,0 +1,25 @@
+// 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 { AddABTestsVariant } from './addABTestsVariant';
+
+export type ScheduleABTestsRequest = {
+  /**
+   * A/B test name.
+   */
+  name: string;
+
+  /**
+   * A/B test variants.
+   */
+  variants: AddABTestsVariant[];
+
+  /**
+   * Date and time when the A/B test is scheduled to start, in RFC 3339 format.
+   */
+  scheduledAt: string;
+
+  /**
+   * End date and time of the A/B test, in RFC 3339 format.
+   */
+  endAt: string;
+};

packages/client-abtesting/src/abtestingClient.ts

@@ -28,6 +28,8 @@ import type {
   StopABTestProps,
 } from '../model/clientMethodProps';
 import type { ListABTestsResponse } from '../model/listABTestsResponse';
+import type { ScheduleABTestResponse } from '../model/scheduleABTestResponse';
+import type { ScheduleABTestsRequest } from '../model/scheduleABTestsRequest';
 
 export const apiClientVersion = '5.0.2';
 
@@ -407,6 +409,61 @@ export function createAbtestingClient({
       return transporter.request(request, requestOptions);
     },
 
+    /**
+     * Schedule an A/B test to be started at a later time.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param scheduleABTestsRequest - The scheduleABTestsRequest object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    scheduleABTest(
+      scheduleABTestsRequest: ScheduleABTestsRequest,
+      requestOptions?: RequestOptions
+    ): Promise<ScheduleABTestResponse> {
+      if (!scheduleABTestsRequest) {
+        throw new Error(
+          'Parameter `scheduleABTestsRequest` is required when calling `scheduleABTest`.'
+        );
+      }
+
+      if (!scheduleABTestsRequest.name) {
+        throw new Error(
+          'Parameter `scheduleABTestsRequest.name` is required when calling `scheduleABTest`.'
+        );
+      }
+      if (!scheduleABTestsRequest.variants) {
+        throw new Error(
+          'Parameter `scheduleABTestsRequest.variants` is required when calling `scheduleABTest`.'
+        );
+      }
+      if (!scheduleABTestsRequest.scheduledAt) {
+        throw new Error(
+          'Parameter `scheduleABTestsRequest.scheduledAt` is required when calling `scheduleABTest`.'
+        );
+      }
+      if (!scheduleABTestsRequest.endAt) {
+        throw new Error(
+          'Parameter `scheduleABTestsRequest.endAt` is required when calling `scheduleABTest`.'
+        );
+      }
+
+      const requestPath = '/2/abtests/schedule';
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: scheduleABTestsRequest,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
     /**
      * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
      *