algoliasearch 5.0.0-alpha.110 → 5.0.0-alpha.112

package/dist/client-abtesting/model/variant.d.ts

@@ -6,11 +6,11 @@ export type Variant = {
      */
     addToCartCount: number;
     /**
-     * Variant\'s [add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate).
+     * [Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for this variant.
      */
     addToCartRate: number | null;
     /**
-     * Variant\'s [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
+     * [Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for this variant.
      */
     averageClickPosition: number | null;
     /**
@@ -18,7 +18,7 @@ export type Variant = {
      */
     clickCount: number;
     /**
-     * Variant\'s [click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     * [Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for this variant.
      */
     clickThroughRate: number | null;
     /**
@@ -26,7 +26,7 @@ export type Variant = {
      */
     conversionCount: number;
     /**
-     * Variant\'s [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+     * [Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.
      */
     conversionRate: number | null;
     /**
@@ -34,20 +34,20 @@ export type Variant = {
      */
     currencies?: Record<string, Currency>;
     /**
-     * A/B test description.
+     * Description for this variant.
      */
     description: string;
     /**
-     * The estimated number of searches that will need to be run to achieve the desired confidence level and statistical power. A `minimumDetectableEffect` must be set in the `configuration` object for this to be used.
+     * Estimated number of searches required to achieve the desired statistical significance.  The A/B test configuration must include a `mininmumDetectableEffect` setting for this number to be included in the response.
      */
     estimatedSampleSize?: number;
     filterEffects?: FilterEffects;
     /**
-     * A/B test index.
+     * Index name of the A/B test variant (case-sensitive).
      */
     index: string;
     /**
-     * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
+     * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this variant.
      */
     noResultCount: number | null;
     /**
@@ -55,11 +55,11 @@ export type Variant = {
      */
     purchaseCount: number;
     /**
-     * Variant\'s [purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate).
+     * [Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this variant.
      */
     purchaseRate: number | null;
     /**
-     * Number of searches carried out during the A/B test.
+     * Number of searches for this variant.
      */
     searchCount: number | null;
     /**
@@ -67,15 +67,15 @@ export type Variant = {
      */
     trackedSearchCount?: number;
     /**
-     * A/B test traffic percentage.
+     * Percentage of search requests each variant receives.
      */
     trafficPercentage: number;
     /**
-     * Number of users during the A/B test.
+     * Number of users that made searches to this variant.
      */
     userCount: number | null;
     /**
-     * Number of users that performed a tracked search during the A/B test.
+     * Number of users that made tracked searches to this variant.
      */
     trackedUserCount: number | null;
 };

package/dist/client-abtesting/src/abtestingClient.d.ts

@@ -4,7 +4,7 @@ import type { ABTestResponse } from '../model/aBTestResponse';
 import type { AddABTestsRequest } from '../model/addABTestsRequest';
 import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteABTestProps, GetABTestProps, ListABTestsProps, StopABTestProps } from '../model/clientMethodProps';
 import type { ListABTestsResponse } from '../model/listABTestsResponse';
-export declare const apiClientVersion = "5.0.0-alpha.110";
+export declare const apiClientVersion = "5.0.0-alpha.112";
 export declare const REGIONS: readonly ["de", "us"];
 export type Region = (typeof REGIONS)[number];
 export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -31,7 +31,7 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      */
     addAlgoliaAgent(segment: string, version?: string): void;
     /**
-     * Creates an A/B test.
+     * Creates a new A/B test.
      *
      * Required API Key ACLs:
      * - editSettings.
@@ -79,29 +79,29 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      */
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     * Deletes an A/B test by its ID.
      *
      * Required API Key ACLs:
      * - editSettings.
      *
      * @param deleteABTest - The deleteABTest object.
-     * @param deleteABTest.id - Unique A/B test ID.
+     * @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.
      */
     deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
     /**
-     * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     * Retrieves the details for an A/B test by its ID.
      *
      * Required API Key ACLs:
      * - analytics.
      *
      * @param getABTest - The getABTest object.
-     * @param getABTest.id - Unique A/B test ID.
+     * @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.
      */
     getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
     /**
-     * List all A/B tests.
+     * Lists all A/B tests you configured for this application.
      *
      * Required API Key ACLs:
      * - analytics.
@@ -109,19 +109,19 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      * @param listABTests - The listABTests object.
      * @param listABTests.offset - Position of the first item to return.
      * @param listABTests.limit - Number of items to return.
-     * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
-     * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
+     * @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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
     /**
-     * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
      *
      * Required API Key ACLs:
      * - editSettings.
      *
      * @param stopABTest - The stopABTest object.
-     * @param stopABTest.id - Unique A/B test ID.
+     * @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.
      */
     stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;

package/dist/client-analytics/model/clientMethodProps.d.ts

@@ -69,11 +69,11 @@ export type GetAddToCartRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -90,11 +90,11 @@ export type GetAverageClickPositionProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -111,11 +111,11 @@ export type GetClickPositionsProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -132,11 +132,11 @@ export type GetClickThroughRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -153,11 +153,11 @@ export type GetConversionRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -174,11 +174,11 @@ export type GetNoClickRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -195,11 +195,11 @@ export type GetNoResultsRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -216,11 +216,11 @@ export type GetPurchaseRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -237,11 +237,11 @@ export type GetRevenueProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -258,11 +258,11 @@ export type GetSearchesCountProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -279,11 +279,11 @@ export type GetSearchesNoClicksProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -308,11 +308,11 @@ export type GetSearchesNoResultsProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -346,11 +346,11 @@ export type GetTopCountriesProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -379,11 +379,11 @@ export type GetTopFilterAttributesProps = {
      */
     search?: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -416,11 +416,11 @@ export type GetTopFilterForAttributeProps = {
      */
     search?: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -449,11 +449,11 @@ export type GetTopFiltersNoResultsProps = {
      */
     search?: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -490,11 +490,11 @@ export type GetTopHitsProps = {
      */
     revenueAnalytics?: boolean;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -527,11 +527,11 @@ export type GetTopSearchesProps = {
      */
     revenueAnalytics?: boolean;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -564,11 +564,11 @@ export type GetUsersCountProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**

package/dist/client-analytics/model/getStatusResponse.d.ts

@@ -1,6 +1,6 @@
 export type GetStatusResponse = {
     /**
-     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. If null, no update was performed yet.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
     updatedAt: string | null;
 };