@algolia/client-abtesting 5.2.5 → 5.3.0

package/dist/node.d.cts

@@ -1,5 +1,5 @@
 import * as _algolia_client_common from '@algolia/client-common';
-import { ClientOptions } from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
 /**
  * Configuration for handling empty searches.
@@ -276,54 +276,6 @@ type AddABTestsRequest = {
     endAt: string;
 };
 
-/**
- * Error.
- */
-type ErrorBase = Record<string, any> & {
-    message?: string;
-};
-
-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;
-};
-
 /**
  * Properties for the `customDelete` method.
  */
@@ -433,30 +385,198 @@ type StopABTestProps = {
     id: number;
 };
 
-declare const apiClientVersion = "5.2.5";
+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.3.0";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
-
-/**
- * The client type.
- */
-type AbtestingClient = ReturnType<typeof abtestingClient>;
-declare function abtestingClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): {
+declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+    region?: Region;
+}): {
     transporter: _algolia_client_common.Transporter;
+    /**
+     * The `appId` currently in use.
+     */
     appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
     clearCache(): Promise<void>;
-    _ua: string;
+    /**
+     * 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;
-    addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: _algolia_client_common.RequestOptions): Promise<ABTestResponse>;
-    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    deleteABTest({ id }: DeleteABTestProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ABTestResponse>;
-    getABTest({ id }: GetABTestProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ABTest>;
-    listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<ListABTestsResponse>;
-    scheduleABTest(scheduleABTestsRequest: ScheduleABTestsRequest, requestOptions?: _algolia_client_common.RequestOptions): Promise<ScheduleABTestResponse>;
-    stopABTest({ id }: StopABTestProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ABTestResponse>;
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }: {
+        apiKey: string;
+    }): void;
+    /**
+     * Creates a new A/B test.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    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.
+     * @param customPost.body - 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.
+     */
+    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.
+     * @param customPut.body - 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.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * 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 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>;
+    /**
+     * 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 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>;
+    /**
+     * Lists all A/B tests you configured for this application.
+     *
+     * Required API Key ACLs:
+     * - analytics.
+     *
+     * @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 - 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>;
+    /**
+     * 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>;
+    /**
+     * 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 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>;
 };
 
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+type AbtestingClient = ReturnType<typeof createAbtestingClient>;
+
+declare function abtestingClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): AbtestingClient;
+
 export { type ABTest, type ABTestConfiguration, type ABTestResponse, type AbTestsVariant, type AbTestsVariantSearchParams, type AbtestingClient, type AddABTestsRequest, type AddABTestsVariant, type Currency, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type CustomSearchParams, type DeleteABTestProps, type Effect, type EmptySearch, type EmptySearchFilter, type ErrorBase, type FilterEffects, type GetABTestProps, type ListABTestsProps, type ListABTestsResponse, type MinimumDetectableEffect, type Outliers, type OutliersFilter, type Region, type ScheduleABTestResponse, type ScheduleABTestsRequest, type Status, type StopABTestProps, type Variant, abtestingClient, apiClientVersion };

package/dist/node.d.ts

@@ -1,5 +1,5 @@
 import * as _algolia_client_common from '@algolia/client-common';
-import { ClientOptions } from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
 /**
  * Configuration for handling empty searches.
@@ -276,54 +276,6 @@ type AddABTestsRequest = {
     endAt: string;
 };
 
-/**
- * Error.
- */
-type ErrorBase = Record<string, any> & {
-    message?: string;
-};
-
-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;
-};
-
 /**
  * Properties for the `customDelete` method.
  */
@@ -433,30 +385,198 @@ type StopABTestProps = {
     id: number;
 };
 
-declare const apiClientVersion = "5.2.5";
+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.3.0";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
-
-/**
- * The client type.
- */
-type AbtestingClient = ReturnType<typeof abtestingClient>;
-declare function abtestingClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): {
+declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+    region?: Region;
+}): {
     transporter: _algolia_client_common.Transporter;
+    /**
+     * The `appId` currently in use.
+     */
     appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
     clearCache(): Promise<void>;
-    _ua: string;
+    /**
+     * 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;
-    addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: _algolia_client_common.RequestOptions): Promise<ABTestResponse>;
-    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    deleteABTest({ id }: DeleteABTestProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ABTestResponse>;
-    getABTest({ id }: GetABTestProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ABTest>;
-    listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<ListABTestsResponse>;
-    scheduleABTest(scheduleABTestsRequest: ScheduleABTestsRequest, requestOptions?: _algolia_client_common.RequestOptions): Promise<ScheduleABTestResponse>;
-    stopABTest({ id }: StopABTestProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ABTestResponse>;
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }: {
+        apiKey: string;
+    }): void;
+    /**
+     * Creates a new A/B test.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    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.
+     * @param customPost.body - 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.
+     */
+    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.
+     * @param customPut.body - 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.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * 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 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>;
+    /**
+     * 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 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>;
+    /**
+     * Lists all A/B tests you configured for this application.
+     *
+     * Required API Key ACLs:
+     * - analytics.
+     *
+     * @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 - 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>;
+    /**
+     * 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>;
+    /**
+     * 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 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>;
 };
 
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+type AbtestingClient = ReturnType<typeof createAbtestingClient>;
+
+declare function abtestingClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): AbtestingClient;
+
 export { type ABTest, type ABTestConfiguration, type ABTestResponse, type AbTestsVariant, type AbTestsVariantSearchParams, type AbtestingClient, type AddABTestsRequest, type AddABTestsVariant, type Currency, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type CustomSearchParams, type DeleteABTestProps, type Effect, type EmptySearch, type EmptySearchFilter, type ErrorBase, type FilterEffects, type GetABTestProps, type ListABTestsProps, type ListABTestsResponse, type MinimumDetectableEffect, type Outliers, type OutliersFilter, type Region, type ScheduleABTestResponse, type ScheduleABTestsRequest, type Status, type StopABTestProps, type Variant, abtestingClient, apiClientVersion };