@algolia/client-abtesting 5.6.1 → 5.8.0

package/dist/fetch.d.ts

@@ -49,7 +49,7 @@ type ABTestConfiguration = {
 /**
  * A/B test status.  - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed.
  */
-type Status = 'active' | 'expired' | 'failed' | 'stopped';
+type Status = 'active' | 'stopped' | 'expired' | 'failed';
 
 type Currency = {
     /**
@@ -138,7 +138,9 @@ type Variant = {
     /**
      * A/B test currencies.
      */
-    currencies?: Record<string, Currency>;
+    currencies?: {
+        [key: string]: Currency;
+    };
     /**
      * Description for this variant.
      */
@@ -195,7 +197,9 @@ type ABTest = {
     conversionSignificance?: number | null;
     addToCartSignificance?: number | null;
     purchaseSignificance?: number | null;
-    revenueSignificance?: Record<string, number> | null;
+    revenueSignificance?: {
+        [key: string]: number;
+    } | null;
     /**
      * Date and time when the A/B test was last updated, in RFC 3339 format.
      */
@@ -216,7 +220,7 @@ type ABTest = {
     /**
      * A/B test variants.  The first variant is your _control_ index, typically your production index. The second variant is an index with changed settings that you want to test against the control.
      */
-    variants: Variant[];
+    variants: Array<Variant>;
     configuration?: ABTestConfiguration;
 };
 
@@ -269,7 +273,48 @@ type AddABTestsRequest = {
     /**
      * A/B test variants.
      */
-    variants: AddABTestsVariant[];
+    variants: Array<AddABTestsVariant>;
+    /**
+     * End date and time of the A/B test, in RFC 3339 format.
+     */
+    endAt: string;
+};
+
+type ListABTestsResponse = {
+    /**
+     * A/B tests.
+     */
+    abtests: Array<ABTest> | null;
+    /**
+     * Number of A/B tests.
+     */
+    count: number;
+    /**
+     * Number of retrievable A/B tests.
+     */
+    total: number;
+};
+
+type ScheduleABTestResponse = {
+    /**
+     * Unique scheduled A/B test identifier.
+     */
+    abTestScheduleID: number;
+};
+
+type ScheduleABTestsRequest = {
+    /**
+     * A/B test name.
+     */
+    name: string;
+    /**
+     * A/B test variants.
+     */
+    variants: Array<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.
      */
@@ -287,7 +332,9 @@ type CustomDeleteProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customGet` method.
@@ -300,7 +347,9 @@ type CustomGetProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customPost` method.
@@ -313,7 +362,9 @@ type CustomPostProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -330,7 +381,9 @@ type CustomPutProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -385,48 +438,7 @@ type StopABTestProps = {
     id: number;
 };
 
-type ListABTestsResponse = {
-    /**
-     * A/B tests.
-     */
-    abtests: ABTest[] | null;
-    /**
-     * Number of A/B tests.
-     */
-    count: number;
-    /**
-     * Number of retrievable A/B tests.
-     */
-    total: number;
-};
-
-type ScheduleABTestResponse = {
-    /**
-     * Unique scheduled A/B test identifier.
-     */
-    abTestScheduleID: number;
-};
-
-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;
-};
-
-declare const apiClientVersion = "5.6.1";
+declare const apiClientVersion = "5.8.0";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
 declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -465,15 +477,13 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Creates a new A/B test.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param addABTestsRequest - The addABTestsRequest object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -482,7 +492,6 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -491,7 +500,6 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -501,7 +509,6 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -513,8 +520,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Deletes an A/B test by its ID.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param deleteABTest - The deleteABTest object.
      * @param deleteABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -524,8 +530,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Retrieves the details for an A/B test by its ID.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - analytics
      * @param getABTest - The getABTest object.
      * @param getABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -535,8 +540,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Lists all A/B tests you configured for this application.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - analytics
      * @param listABTests - The listABTests object.
      * @param listABTests.offset - Position of the first item to return.
      * @param listABTests.limit - Number of items to return.
@@ -549,8 +553,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Schedule an A/B test to be started at a later time.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param scheduleABTestsRequest - The scheduleABTestsRequest object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -559,8 +562,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param stopABTest - The stopABTest object.
      * @param stopABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

package/dist/node.d.cts

@@ -49,7 +49,7 @@ type ABTestConfiguration = {
 /**
  * A/B test status.  - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed.
  */
-type Status = 'active' | 'expired' | 'failed' | 'stopped';
+type Status = 'active' | 'stopped' | 'expired' | 'failed';
 
 type Currency = {
     /**
@@ -138,7 +138,9 @@ type Variant = {
     /**
      * A/B test currencies.
      */
-    currencies?: Record<string, Currency>;
+    currencies?: {
+        [key: string]: Currency;
+    };
     /**
      * Description for this variant.
      */
@@ -195,7 +197,9 @@ type ABTest = {
     conversionSignificance?: number | null;
     addToCartSignificance?: number | null;
     purchaseSignificance?: number | null;
-    revenueSignificance?: Record<string, number> | null;
+    revenueSignificance?: {
+        [key: string]: number;
+    } | null;
     /**
      * Date and time when the A/B test was last updated, in RFC 3339 format.
      */
@@ -216,7 +220,7 @@ type ABTest = {
     /**
      * A/B test variants.  The first variant is your _control_ index, typically your production index. The second variant is an index with changed settings that you want to test against the control.
      */
-    variants: Variant[];
+    variants: Array<Variant>;
     configuration?: ABTestConfiguration;
 };
 
@@ -269,7 +273,48 @@ type AddABTestsRequest = {
     /**
      * A/B test variants.
      */
-    variants: AddABTestsVariant[];
+    variants: Array<AddABTestsVariant>;
+    /**
+     * End date and time of the A/B test, in RFC 3339 format.
+     */
+    endAt: string;
+};
+
+type ListABTestsResponse = {
+    /**
+     * A/B tests.
+     */
+    abtests: Array<ABTest> | null;
+    /**
+     * Number of A/B tests.
+     */
+    count: number;
+    /**
+     * Number of retrievable A/B tests.
+     */
+    total: number;
+};
+
+type ScheduleABTestResponse = {
+    /**
+     * Unique scheduled A/B test identifier.
+     */
+    abTestScheduleID: number;
+};
+
+type ScheduleABTestsRequest = {
+    /**
+     * A/B test name.
+     */
+    name: string;
+    /**
+     * A/B test variants.
+     */
+    variants: Array<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.
      */
@@ -287,7 +332,9 @@ type CustomDeleteProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customGet` method.
@@ -300,7 +347,9 @@ type CustomGetProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customPost` method.
@@ -313,7 +362,9 @@ type CustomPostProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -330,7 +381,9 @@ type CustomPutProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -385,48 +438,7 @@ type StopABTestProps = {
     id: number;
 };
 
-type ListABTestsResponse = {
-    /**
-     * A/B tests.
-     */
-    abtests: ABTest[] | null;
-    /**
-     * Number of A/B tests.
-     */
-    count: number;
-    /**
-     * Number of retrievable A/B tests.
-     */
-    total: number;
-};
-
-type ScheduleABTestResponse = {
-    /**
-     * Unique scheduled A/B test identifier.
-     */
-    abTestScheduleID: number;
-};
-
-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;
-};
-
-declare const apiClientVersion = "5.6.1";
+declare const apiClientVersion = "5.8.0";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
 declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -465,15 +477,13 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Creates a new A/B test.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param addABTestsRequest - The addABTestsRequest object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -482,7 +492,6 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -491,7 +500,6 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -501,7 +509,6 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -513,8 +520,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Deletes an A/B test by its ID.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param deleteABTest - The deleteABTest object.
      * @param deleteABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -524,8 +530,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Retrieves the details for an A/B test by its ID.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - analytics
      * @param getABTest - The getABTest object.
      * @param getABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -535,8 +540,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Lists all A/B tests you configured for this application.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - analytics
      * @param listABTests - The listABTests object.
      * @param listABTests.offset - Position of the first item to return.
      * @param listABTests.limit - Number of items to return.
@@ -549,8 +553,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Schedule an A/B test to be started at a later time.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param scheduleABTestsRequest - The scheduleABTestsRequest object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -559,8 +562,7 @@ declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param stopABTest - The stopABTest object.
      * @param stopABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.