@algolia/client-abtesting 5.0.0-alpha.1

package/dist/model/variant.d.ts

@@ -0,0 +1,51 @@
+export declare type Variant = {
+    /**
+     * Average click position for the variant.
+     */
+    averageClickPosition: number;
+    /**
+     * Distinct click count for the variant.
+     */
+    clickCount: number;
+    /**
+     * Click through rate for the variant.
+     */
+    clickThroughRate: number;
+    /**
+     * Distinct conversion count for the variant.
+     */
+    conversionCount: number;
+    /**
+     * Conversion rate for the variant.
+     */
+    conversionRate: number;
+    /**
+     * The A/B test description.
+     */
+    description: string;
+    /**
+     * The index performing the A/B test.
+     */
+    index: string;
+    /**
+     * The number of occurrences.
+     */
+    noResultCount: number;
+    /**
+     * The number of search during the A/B test.
+     */
+    searchCount: number;
+    /**
+     * The number of tracked search click.
+     */
+    trackedSearchCount: number;
+    /**
+     * The traffic percentage for the A/B test.
+     */
+    trafficPercentage: number;
+    /**
+     * The number of user during the A/B test.
+     */
+    userCount: number;
+};
+//# sourceMappingURL=variant.d.ts.map

package/dist/model/variant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../../../packages/client-abtesting/model/variant.ts"],"names":[],"mappings":"AAEA,oBAAY,OAAO,GAAG;IACpB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/src/abtestingClient.d.ts

@@ -0,0 +1,114 @@
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { ABTest } from '../model/aBTest';
+import type { ABTestResponse } from '../model/aBTestResponse';
+import type { AddABTestsRequest } from '../model/addABTestsRequest';
+import type { DelProps, DeleteABTestProps, GetProps, GetABTestProps, ListABTestsProps, PostProps, PutProps, StopABTestProps } from '../model/clientMethodProps';
+import type { ListABTestsResponse } from '../model/listABTestsResponse';
+export declare const apiClientVersion = "5.0.0-alpha.1";
+export declare const REGIONS: readonly ["de", "us"];
+export declare type Region = typeof REGIONS[number];
+export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+    region?: Region;
+}): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
+     *
+     * @summary Create a test.
+     * @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.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param del - The del object.
+     * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+     * @param del.parameters - Query parameters to be applied to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Delete a test.
+     *
+     * @summary Delete a test.
+     * @param deleteABTest - The deleteABTest object.
+     * @param deleteABTest.id - The A/B test ID.
+     * @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>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param get - The get object.
+     * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+     * @param get.parameters - Query parameters to be applied to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Returns metadata and metrics for an A/B test.
+     *
+     * @summary Get a test.
+     * @param getABTest - The getABTest object.
+     * @param getABTest.id - The A/B test ID.
+     * @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>;
+    /**
+     * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
+     *
+     * @summary List all tests.
+     * @param listABTests - The listABTests object.
+     * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param listABTests.limit - Number of records to return. Limit is the size of the page.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    listABTests({ offset, limit }: ListABTestsProps, requestOptions?: RequestOptions): Promise<ListABTestsResponse>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param post - The post object.
+     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+     * @param post.parameters - Query parameters to be applied to the current query.
+     * @param post.body - The parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param put - The put object.
+     * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+     * @param put.parameters - Query parameters to be applied to the current query.
+     * @param put.body - The parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
+     *
+     * @summary Stop a test.
+     * @param stopABTest - The stopABTest object.
+     * @param stopABTest.id - The A/B test ID.
+     * @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>;
+};
+export declare type AbtestingClient = ReturnType<typeof createAbtestingClient>;
+//# sourceMappingURL=abtestingClient.d.ts.map

package/dist/src/abtestingClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abtestingClient.d.ts","sourceRoot":"","sources":["../../../../packages/client-abtesting/src/abtestingClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,oBAAY,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AAW5C,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;IAuBxC;;OAEG;;IAIH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAGxD;;;;;;OAMG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAsC1B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;sBAEO,cAAc,mBACL,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAsBlB;;;;;;;;OAQG;mCAEkB,gBAAgB,mBAClB,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;OAOG;uBAEO,eAAe,mBACN,cAAc,GAC9B,QAAQ,cAAc,CAAC;EAwB7B;AAED,oBAAY,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/index.d.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-unresolved
+export * from './dist/builds/node';

package/index.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-commonjs,import/extensions
+module.exports = require('./dist/client-abtesting.cjs.js');

package/model/aBTest.ts

@@ -0,0 +1,42 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Variant } from './variant';
+
+export type ABTest = {
+  /**
+   * The A/B test ID.
+   */
+  abTestID: number;
+  /**
+   * A/B test significance based on click data. Should be > 0.95 to be considered significant (no matter which variant is winning).
+   */
+  clickSignificance: number;
+  /**
+   * A/B test significance based on conversion data. Should be > 0.95 to be considered significant (no matter which variant is winning).
+   */
+  conversionSignificance: number;
+  /**
+   * End date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+   */
+  endAt: string;
+  /**
+   * Update date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+   */
+  updatedAt: string;
+  /**
+   * Creation date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+   */
+  createdAt: string;
+  /**
+   * A/B test name.
+   */
+  name: string;
+  /**
+   * Status of the A/B test.
+   */
+  status: string;
+  /**
+   * List of A/B test variant.
+   */
+  variants: Variant[];
+};

package/model/aBTestResponse.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type ABTestResponse = {
+  /**
+   * The index performing the A/B test.
+   */
+  index: string;
+  /**
+   * The A/B test ID.
+   */
+  abTestID: number;
+  /**
+   * TaskID of the task to wait for.
+   */
+  taskID: number;
+};

package/model/abTestsVariant.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type AbTestsVariant = {
+  /**
+   * The index performing the A/B test.
+   */
+  index: string;
+  /**
+   * The traffic percentage for the A/B test.
+   */
+  trafficPercentage: number;
+  /**
+   * The A/B test description.
+   */
+  description?: string;
+};

package/model/abTestsVariantSearchParams.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AbTestsVariant } from './abTestsVariant';
+import type { CustomSearchParams } from './customSearchParams';
+
+export type AbTestsVariantSearchParams = AbTestsVariant & CustomSearchParams;

package/model/addABTestsRequest.ts

@@ -0,0 +1,18 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AddABTestsVariant } from './addABTestsVariant';
+
+export type AddABTestsRequest = {
+  /**
+   * A/B test name.
+   */
+  name: string;
+  /**
+   * List of 2 variants for the A/B test.
+   */
+  variant: AddABTestsVariant[];
+  /**
+   * End date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+   */
+  endAt: string;
+};

package/model/addABTestsVariant.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AbTestsVariant } from './abTestsVariant';
+import type { AbTestsVariantSearchParams } from './abTestsVariantSearchParams';
+
+export type AddABTestsVariant = AbTestsVariant | AbTestsVariantSearchParams;

package/model/clientMethodProps.ts

@@ -0,0 +1,109 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Properties for the `del` method.
+ */
+export type DelProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `deleteABTest` method.
+ */
+export type DeleteABTestProps = {
+  /**
+   * The A/B test ID.
+   */
+  id: number;
+};
+
+/**
+ * Properties for the `get` method.
+ */
+export type GetProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `getABTest` method.
+ */
+export type GetABTestProps = {
+  /**
+   * The A/B test ID.
+   */
+  id: number;
+};
+
+/**
+ * Properties for the `listABTests` method.
+ */
+export type ListABTestsProps = {
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+};
+
+/**
+ * Properties for the `post` method.
+ */
+export type PostProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `put` method.
+ */
+export type PutProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `stopABTest` method.
+ */
+export type StopABTestProps = {
+  /**
+   * The A/B test ID.
+   */
+  id: number;
+};

package/model/customSearchParams.ts

@@ -0,0 +1,5 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type CustomSearchParams = {
+  customSearchParameters: Record<string, any>;
+};

package/model/errorBase.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+  message?: string;
+};

package/model/index.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export * from './aBTest';
+export * from './aBTestResponse';
+export * from './abTestsVariant';
+export * from './abTestsVariantSearchParams';
+export * from './addABTestsRequest';
+export * from './addABTestsVariant';
+export * from './customSearchParams';
+export * from './errorBase';
+export * from './listABTestsResponse';
+export * from './variant';
+export * from './clientMethodProps';

package/model/listABTestsResponse.ts

@@ -0,0 +1,18 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ABTest } from './aBTest';
+
+export type ListABTestsResponse = {
+  /**
+   * List of A/B tests.
+   */
+  abtests: ABTest[];
+  /**
+   * Number of A/B tests found for the app.
+   */
+  count: number;
+  /**
+   * Number of A/B tests retrievable.
+   */
+  total: number;
+};

package/model/variant.ts

@@ -0,0 +1,52 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type Variant = {
+  /**
+   * Average click position for the variant.
+   */
+  averageClickPosition: number;
+  /**
+   * Distinct click count for the variant.
+   */
+  clickCount: number;
+  /**
+   * Click through rate for the variant.
+   */
+  clickThroughRate: number;
+  /**
+   * Distinct conversion count for the variant.
+   */
+  conversionCount: number;
+  /**
+   * Conversion rate for the variant.
+   */
+  conversionRate: number;
+  /**
+   * The A/B test description.
+   */
+  description: string;
+  /**
+   * The index performing the A/B test.
+   */
+  index: string;
+  /**
+   * The number of occurrences.
+   */
+  noResultCount: number;
+  /**
+   * The number of search during the A/B test.
+   */
+  searchCount: number;
+  /**
+   * The number of tracked search click.
+   */
+  trackedSearchCount: number;
+  /**
+   * The traffic percentage for the A/B test.
+   */
+  trafficPercentage: number;
+  /**
+   * The number of user during the A/B test.
+   */
+  userCount: number;
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@algolia/client-abtesting",
+  "version": "5.0.0-alpha.1",
+  "description": "JavaScript client for client-abtesting",
+  "repository": "algolia/algoliasearch-client-javascript",
+  "license": "MIT",
+  "author": "Algolia",
+  "main": "index.js",
+  "jsdelivr": "dist/client-abtesting.umd.js",
+  "unpkg": "dist/client-abtesting.umd.js",
+  "module": "dist/client-abtesting.esm.node.js",
+  "browser": "dist/client-abtesting.umd.js",
+  "types": "index.d.ts",
+  "files": [
+    "dist",
+    "model",
+    "index.js",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "clean": "rm -rf ./dist"
+  },
+  "dependencies": {
+    "@algolia/client-common": "5.0.0-alpha.1",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.1",
+    "@algolia/requester-node-http": "5.0.0-alpha.1"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.45",
+    "typescript": "4.7.4"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
+  }
+}