@algolia/abtesting 1.21.2 → 1.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/browser.d.ts +161 -4
- package/dist/builds/browser.js +312 -1
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +5 -5
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +7 -7
- package/dist/builds/fetch.js +312 -1
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +312 -1
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +312 -1
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +312 -1
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +161 -4
- package/dist/node.d.cts +161 -4
- package/dist/node.d.ts +161 -4
- package/dist/src/abtestingV3Client.cjs +312 -1
- package/dist/src/abtestingV3Client.cjs.map +1 -1
- package/dist/src/abtestingV3Client.js +312 -1
- package/dist/src/abtestingV3Client.js.map +1 -1
- package/dist/worker.d.ts +161 -4
- package/package.json +10 -10
package/dist/node.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _algolia_client_common from '@algolia/client-common';
|
|
2
|
-
import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
|
|
2
|
+
import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Multiple-testing correction method applied when evaluating metric significance.
|
|
@@ -56,6 +56,20 @@ type ABTestConfiguration = {
|
|
|
56
56
|
errorCorrection?: ErrorCorrectionType | undefined;
|
|
57
57
|
};
|
|
58
58
|
|
|
59
|
+
/**
|
|
60
|
+
* Outcome of the A/B test once a winner has been declared. Only present when a winning variant has been declared, so its presence indicates the test has been decided.
|
|
61
|
+
*/
|
|
62
|
+
type Decision = {
|
|
63
|
+
/**
|
|
64
|
+
* Identifier of the declared winning variant. The control variant is 1.
|
|
65
|
+
*/
|
|
66
|
+
winnerVariantId: number;
|
|
67
|
+
/**
|
|
68
|
+
* Date and time when the winning variant was declared, in RFC 3339 format.
|
|
69
|
+
*/
|
|
70
|
+
declaredAt: string;
|
|
71
|
+
};
|
|
72
|
+
|
|
59
73
|
/**
|
|
60
74
|
* 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.
|
|
61
75
|
*/
|
|
@@ -215,6 +229,7 @@ type ABTest = {
|
|
|
215
229
|
* Unique migrated A/B test identifier.
|
|
216
230
|
*/
|
|
217
231
|
migratedAbTestID?: number | undefined;
|
|
232
|
+
decision?: Decision | undefined;
|
|
218
233
|
};
|
|
219
234
|
|
|
220
235
|
type ABTestResponse = {
|
|
@@ -512,14 +527,14 @@ type StopABTestProps = {
|
|
|
512
527
|
id: number;
|
|
513
528
|
};
|
|
514
529
|
|
|
515
|
-
declare const apiClientVersion = "1.
|
|
530
|
+
declare const apiClientVersion = "1.23.0";
|
|
516
531
|
declare const REGIONS: readonly ["de", "us"];
|
|
517
532
|
type Region = (typeof REGIONS)[number];
|
|
518
533
|
type RegionOptions = {
|
|
519
534
|
region?: Region | undefined;
|
|
520
535
|
};
|
|
521
536
|
declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
|
|
522
|
-
transporter: _algolia_client_common.
|
|
537
|
+
transporter: _algolia_client_common.TransporterWithHttpInfo;
|
|
523
538
|
/**
|
|
524
539
|
* The `appId` currently in use.
|
|
525
540
|
*/
|
|
@@ -561,6 +576,18 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
561
576
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
562
577
|
*/
|
|
563
578
|
addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
|
|
579
|
+
/**
|
|
580
|
+
* Creates a new A/B test.
|
|
581
|
+
*
|
|
582
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
583
|
+
*
|
|
584
|
+
* Required API Key ACLs:
|
|
585
|
+
* - editSettings
|
|
586
|
+
* @param addABTestsRequest - The addABTestsRequest object.
|
|
587
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
588
|
+
* @see addABTests for the plain version.
|
|
589
|
+
*/
|
|
590
|
+
addABTestsWithHTTPInfo(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestResponse>>;
|
|
564
591
|
/**
|
|
565
592
|
* This method lets you send requests to the Algolia REST API.
|
|
566
593
|
* @param customDelete - The customDelete object.
|
|
@@ -569,6 +596,17 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
569
596
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
570
597
|
*/
|
|
571
598
|
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
599
|
+
/**
|
|
600
|
+
* This method lets you send requests to the Algolia REST API.
|
|
601
|
+
*
|
|
602
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
603
|
+
* @param customDelete - The customDelete object.
|
|
604
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
605
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
606
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
607
|
+
* @see customDelete for the plain version.
|
|
608
|
+
*/
|
|
609
|
+
customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
572
610
|
/**
|
|
573
611
|
* This method lets you send requests to the Algolia REST API.
|
|
574
612
|
* @param customGet - The customGet object.
|
|
@@ -577,6 +615,17 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
577
615
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
578
616
|
*/
|
|
579
617
|
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
618
|
+
/**
|
|
619
|
+
* This method lets you send requests to the Algolia REST API.
|
|
620
|
+
*
|
|
621
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
622
|
+
* @param customGet - The customGet object.
|
|
623
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
624
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
625
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
626
|
+
* @see customGet for the plain version.
|
|
627
|
+
*/
|
|
628
|
+
customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
580
629
|
/**
|
|
581
630
|
* This method lets you send requests to the Algolia REST API.
|
|
582
631
|
* @param customPost - The customPost object.
|
|
@@ -586,6 +635,18 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
586
635
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
587
636
|
*/
|
|
588
637
|
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
638
|
+
/**
|
|
639
|
+
* This method lets you send requests to the Algolia REST API.
|
|
640
|
+
*
|
|
641
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
642
|
+
* @param customPost - The customPost object.
|
|
643
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
644
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
645
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
646
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
647
|
+
* @see customPost for the plain version.
|
|
648
|
+
*/
|
|
649
|
+
customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
589
650
|
/**
|
|
590
651
|
* This method lets you send requests to the Algolia REST API.
|
|
591
652
|
* @param customPut - The customPut object.
|
|
@@ -595,6 +656,18 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
595
656
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
596
657
|
*/
|
|
597
658
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
659
|
+
/**
|
|
660
|
+
* This method lets you send requests to the Algolia REST API.
|
|
661
|
+
*
|
|
662
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
663
|
+
* @param customPut - The customPut object.
|
|
664
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
665
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
666
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
667
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
668
|
+
* @see customPut for the plain version.
|
|
669
|
+
*/
|
|
670
|
+
customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
598
671
|
/**
|
|
599
672
|
* Deletes an A/B test by its ID.
|
|
600
673
|
*
|
|
@@ -605,6 +678,19 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
605
678
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
606
679
|
*/
|
|
607
680
|
deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
|
|
681
|
+
/**
|
|
682
|
+
* Deletes an A/B test by its ID.
|
|
683
|
+
*
|
|
684
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
685
|
+
*
|
|
686
|
+
* Required API Key ACLs:
|
|
687
|
+
* - editSettings
|
|
688
|
+
* @param deleteABTest - The deleteABTest object.
|
|
689
|
+
* @param deleteABTest.id - Unique A/B test identifier.
|
|
690
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
691
|
+
* @see deleteABTest for the plain version.
|
|
692
|
+
*/
|
|
693
|
+
deleteABTestWithHTTPInfo({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestResponse>>;
|
|
608
694
|
/**
|
|
609
695
|
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
|
|
610
696
|
*
|
|
@@ -614,6 +700,18 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
614
700
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
615
701
|
*/
|
|
616
702
|
estimateABTest(estimateABTestRequest: EstimateABTestRequest, requestOptions?: RequestOptions): Promise<EstimateABTestResponse>;
|
|
703
|
+
/**
|
|
704
|
+
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
|
|
705
|
+
*
|
|
706
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
707
|
+
*
|
|
708
|
+
* Required API Key ACLs:
|
|
709
|
+
* - analytics
|
|
710
|
+
* @param estimateABTestRequest - The estimateABTestRequest object.
|
|
711
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
712
|
+
* @see estimateABTest for the plain version.
|
|
713
|
+
*/
|
|
714
|
+
estimateABTestWithHTTPInfo(estimateABTestRequest: EstimateABTestRequest, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<EstimateABTestResponse>>;
|
|
617
715
|
/**
|
|
618
716
|
* Retrieves the details for an A/B test by its ID.
|
|
619
717
|
*
|
|
@@ -624,6 +722,19 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
624
722
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
625
723
|
*/
|
|
626
724
|
getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
|
|
725
|
+
/**
|
|
726
|
+
* Retrieves the details for an A/B test by its ID.
|
|
727
|
+
*
|
|
728
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
729
|
+
*
|
|
730
|
+
* Required API Key ACLs:
|
|
731
|
+
* - analytics
|
|
732
|
+
* @param getABTest - The getABTest object.
|
|
733
|
+
* @param getABTest.id - Unique A/B test identifier.
|
|
734
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
735
|
+
* @see getABTest for the plain version.
|
|
736
|
+
*/
|
|
737
|
+
getABTestWithHTTPInfo({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTest>>;
|
|
627
738
|
/**
|
|
628
739
|
* Retrieves timeseries for an A/B test by its ID.
|
|
629
740
|
*
|
|
@@ -637,6 +748,22 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
637
748
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
638
749
|
*/
|
|
639
750
|
getTimeseries({ id, startDate, endDate, metric }: GetTimeseriesProps, requestOptions?: RequestOptions): Promise<Timeseries>;
|
|
751
|
+
/**
|
|
752
|
+
* Retrieves timeseries for an A/B test by its ID.
|
|
753
|
+
*
|
|
754
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
755
|
+
*
|
|
756
|
+
* Required API Key ACLs:
|
|
757
|
+
* - analytics
|
|
758
|
+
* @param getTimeseries - The getTimeseries object.
|
|
759
|
+
* @param getTimeseries.id - Unique A/B test identifier.
|
|
760
|
+
* @param getTimeseries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
761
|
+
* @param getTimeseries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
762
|
+
* @param getTimeseries.metric - List of metrics to retrieve. If not specified, all metrics are returned.
|
|
763
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
764
|
+
* @see getTimeseries for the plain version.
|
|
765
|
+
*/
|
|
766
|
+
getTimeseriesWithHTTPInfo({ id, startDate, endDate, metric }: GetTimeseriesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Timeseries>>;
|
|
640
767
|
/**
|
|
641
768
|
* Lists all A/B tests you configured for this application.
|
|
642
769
|
*
|
|
@@ -651,6 +778,23 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
651
778
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
652
779
|
*/
|
|
653
780
|
listABTests({ offset, limit, indexPrefix, indexSuffix, direction }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
|
|
781
|
+
/**
|
|
782
|
+
* Lists all A/B tests you configured for this application.
|
|
783
|
+
*
|
|
784
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
785
|
+
*
|
|
786
|
+
* Required API Key ACLs:
|
|
787
|
+
* - analytics
|
|
788
|
+
* @param listABTests - The listABTests object.
|
|
789
|
+
* @param listABTests.offset - Position of the first item to return.
|
|
790
|
+
* @param listABTests.limit - Number of items to return.
|
|
791
|
+
* @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
|
|
792
|
+
* @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
|
|
793
|
+
* @param listABTests.direction - Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
|
|
794
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
795
|
+
* @see listABTests for the plain version.
|
|
796
|
+
*/
|
|
797
|
+
listABTestsWithHTTPInfo({ offset, limit, indexPrefix, indexSuffix, direction }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListABTestsResponse>>;
|
|
654
798
|
/**
|
|
655
799
|
* Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
|
|
656
800
|
*
|
|
@@ -661,6 +805,19 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
661
805
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
662
806
|
*/
|
|
663
807
|
stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
|
|
808
|
+
/**
|
|
809
|
+
* Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
|
|
810
|
+
*
|
|
811
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
812
|
+
*
|
|
813
|
+
* Required API Key ACLs:
|
|
814
|
+
* - editSettings
|
|
815
|
+
* @param stopABTest - The stopABTest object.
|
|
816
|
+
* @param stopABTest.id - Unique A/B test identifier.
|
|
817
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
818
|
+
* @see stopABTest for the plain version.
|
|
819
|
+
*/
|
|
820
|
+
stopABTestWithHTTPInfo({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestResponse>>;
|
|
664
821
|
};
|
|
665
822
|
|
|
666
823
|
/**
|
|
@@ -674,4 +831,4 @@ type AbtestingV3Client = ReturnType<typeof createAbtestingV3Client>;
|
|
|
674
831
|
|
|
675
832
|
declare function abtestingV3Client(appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined): AbtestingV3Client;
|
|
676
833
|
|
|
677
|
-
export { type ABTest, type ABTestConfiguration, type ABTestResponse, type AbTestsVariant, type AbTestsVariantSearchParams, type AbtestingV3Client, type AddABTestsRequest, type AddABTestsVariant, type CreateMetric, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type CustomSearchParams, type DeleteABTestProps, type Direction, type EffectMetric, type EmptySearchFilter, type ErrorBase, type ErrorCorrectionType, type EstimateABTestRequest, type EstimateABTestResponse, type EstimateConfiguration, type FilterEffects, type GetABTestProps, type GetTimeseriesProps, type ListABTestsProps, type ListABTestsResponse, type MetricDate, type MetricMetadata, type MetricName, type MetricResult, type MetricsFilter, type MinimumDetectableEffect, type OutliersFilter, type Region, type RegionOptions, type Status, type StopABTestProps, type Timeseries, type TimeseriesVariant, type Variant, type VariantMetadata, abtestingV3Client, apiClientVersion };
|
|
834
|
+
export { type ABTest, type ABTestConfiguration, type ABTestResponse, type AbTestsVariant, type AbTestsVariantSearchParams, type AbtestingV3Client, type AddABTestsRequest, type AddABTestsVariant, type CreateMetric, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type CustomSearchParams, type Decision, type DeleteABTestProps, type Direction, type EffectMetric, type EmptySearchFilter, type ErrorBase, type ErrorCorrectionType, type EstimateABTestRequest, type EstimateABTestResponse, type EstimateConfiguration, type FilterEffects, type GetABTestProps, type GetTimeseriesProps, type ListABTestsProps, type ListABTestsResponse, type MetricDate, type MetricMetadata, type MetricName, type MetricResult, type MetricsFilter, type MinimumDetectableEffect, type OutliersFilter, type Region, type RegionOptions, type Status, type StopABTestProps, type Timeseries, type TimeseriesVariant, type Variant, type VariantMetadata, abtestingV3Client, apiClientVersion };
|
package/dist/node.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _algolia_client_common from '@algolia/client-common';
|
|
2
|
-
import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
|
|
2
|
+
import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Multiple-testing correction method applied when evaluating metric significance.
|
|
@@ -56,6 +56,20 @@ type ABTestConfiguration = {
|
|
|
56
56
|
errorCorrection?: ErrorCorrectionType | undefined;
|
|
57
57
|
};
|
|
58
58
|
|
|
59
|
+
/**
|
|
60
|
+
* Outcome of the A/B test once a winner has been declared. Only present when a winning variant has been declared, so its presence indicates the test has been decided.
|
|
61
|
+
*/
|
|
62
|
+
type Decision = {
|
|
63
|
+
/**
|
|
64
|
+
* Identifier of the declared winning variant. The control variant is 1.
|
|
65
|
+
*/
|
|
66
|
+
winnerVariantId: number;
|
|
67
|
+
/**
|
|
68
|
+
* Date and time when the winning variant was declared, in RFC 3339 format.
|
|
69
|
+
*/
|
|
70
|
+
declaredAt: string;
|
|
71
|
+
};
|
|
72
|
+
|
|
59
73
|
/**
|
|
60
74
|
* 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.
|
|
61
75
|
*/
|
|
@@ -215,6 +229,7 @@ type ABTest = {
|
|
|
215
229
|
* Unique migrated A/B test identifier.
|
|
216
230
|
*/
|
|
217
231
|
migratedAbTestID?: number | undefined;
|
|
232
|
+
decision?: Decision | undefined;
|
|
218
233
|
};
|
|
219
234
|
|
|
220
235
|
type ABTestResponse = {
|
|
@@ -512,14 +527,14 @@ type StopABTestProps = {
|
|
|
512
527
|
id: number;
|
|
513
528
|
};
|
|
514
529
|
|
|
515
|
-
declare const apiClientVersion = "1.
|
|
530
|
+
declare const apiClientVersion = "1.23.0";
|
|
516
531
|
declare const REGIONS: readonly ["de", "us"];
|
|
517
532
|
type Region = (typeof REGIONS)[number];
|
|
518
533
|
type RegionOptions = {
|
|
519
534
|
region?: Region | undefined;
|
|
520
535
|
};
|
|
521
536
|
declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
|
|
522
|
-
transporter: _algolia_client_common.
|
|
537
|
+
transporter: _algolia_client_common.TransporterWithHttpInfo;
|
|
523
538
|
/**
|
|
524
539
|
* The `appId` currently in use.
|
|
525
540
|
*/
|
|
@@ -561,6 +576,18 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
561
576
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
562
577
|
*/
|
|
563
578
|
addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
|
|
579
|
+
/**
|
|
580
|
+
* Creates a new A/B test.
|
|
581
|
+
*
|
|
582
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
583
|
+
*
|
|
584
|
+
* Required API Key ACLs:
|
|
585
|
+
* - editSettings
|
|
586
|
+
* @param addABTestsRequest - The addABTestsRequest object.
|
|
587
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
588
|
+
* @see addABTests for the plain version.
|
|
589
|
+
*/
|
|
590
|
+
addABTestsWithHTTPInfo(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestResponse>>;
|
|
564
591
|
/**
|
|
565
592
|
* This method lets you send requests to the Algolia REST API.
|
|
566
593
|
* @param customDelete - The customDelete object.
|
|
@@ -569,6 +596,17 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
569
596
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
570
597
|
*/
|
|
571
598
|
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
599
|
+
/**
|
|
600
|
+
* This method lets you send requests to the Algolia REST API.
|
|
601
|
+
*
|
|
602
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
603
|
+
* @param customDelete - The customDelete object.
|
|
604
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
605
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
606
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
607
|
+
* @see customDelete for the plain version.
|
|
608
|
+
*/
|
|
609
|
+
customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
572
610
|
/**
|
|
573
611
|
* This method lets you send requests to the Algolia REST API.
|
|
574
612
|
* @param customGet - The customGet object.
|
|
@@ -577,6 +615,17 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
577
615
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
578
616
|
*/
|
|
579
617
|
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
618
|
+
/**
|
|
619
|
+
* This method lets you send requests to the Algolia REST API.
|
|
620
|
+
*
|
|
621
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
622
|
+
* @param customGet - The customGet object.
|
|
623
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
624
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
625
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
626
|
+
* @see customGet for the plain version.
|
|
627
|
+
*/
|
|
628
|
+
customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
580
629
|
/**
|
|
581
630
|
* This method lets you send requests to the Algolia REST API.
|
|
582
631
|
* @param customPost - The customPost object.
|
|
@@ -586,6 +635,18 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
586
635
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
587
636
|
*/
|
|
588
637
|
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
638
|
+
/**
|
|
639
|
+
* This method lets you send requests to the Algolia REST API.
|
|
640
|
+
*
|
|
641
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
642
|
+
* @param customPost - The customPost object.
|
|
643
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
644
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
645
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
646
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
647
|
+
* @see customPost for the plain version.
|
|
648
|
+
*/
|
|
649
|
+
customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
589
650
|
/**
|
|
590
651
|
* This method lets you send requests to the Algolia REST API.
|
|
591
652
|
* @param customPut - The customPut object.
|
|
@@ -595,6 +656,18 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
595
656
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
596
657
|
*/
|
|
597
658
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
659
|
+
/**
|
|
660
|
+
* This method lets you send requests to the Algolia REST API.
|
|
661
|
+
*
|
|
662
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
663
|
+
* @param customPut - The customPut object.
|
|
664
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
665
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
666
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
667
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
668
|
+
* @see customPut for the plain version.
|
|
669
|
+
*/
|
|
670
|
+
customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
598
671
|
/**
|
|
599
672
|
* Deletes an A/B test by its ID.
|
|
600
673
|
*
|
|
@@ -605,6 +678,19 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
605
678
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
606
679
|
*/
|
|
607
680
|
deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
|
|
681
|
+
/**
|
|
682
|
+
* Deletes an A/B test by its ID.
|
|
683
|
+
*
|
|
684
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
685
|
+
*
|
|
686
|
+
* Required API Key ACLs:
|
|
687
|
+
* - editSettings
|
|
688
|
+
* @param deleteABTest - The deleteABTest object.
|
|
689
|
+
* @param deleteABTest.id - Unique A/B test identifier.
|
|
690
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
691
|
+
* @see deleteABTest for the plain version.
|
|
692
|
+
*/
|
|
693
|
+
deleteABTestWithHTTPInfo({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestResponse>>;
|
|
608
694
|
/**
|
|
609
695
|
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
|
|
610
696
|
*
|
|
@@ -614,6 +700,18 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
614
700
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
615
701
|
*/
|
|
616
702
|
estimateABTest(estimateABTestRequest: EstimateABTestRequest, requestOptions?: RequestOptions): Promise<EstimateABTestResponse>;
|
|
703
|
+
/**
|
|
704
|
+
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
|
|
705
|
+
*
|
|
706
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
707
|
+
*
|
|
708
|
+
* Required API Key ACLs:
|
|
709
|
+
* - analytics
|
|
710
|
+
* @param estimateABTestRequest - The estimateABTestRequest object.
|
|
711
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
712
|
+
* @see estimateABTest for the plain version.
|
|
713
|
+
*/
|
|
714
|
+
estimateABTestWithHTTPInfo(estimateABTestRequest: EstimateABTestRequest, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<EstimateABTestResponse>>;
|
|
617
715
|
/**
|
|
618
716
|
* Retrieves the details for an A/B test by its ID.
|
|
619
717
|
*
|
|
@@ -624,6 +722,19 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
624
722
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
625
723
|
*/
|
|
626
724
|
getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
|
|
725
|
+
/**
|
|
726
|
+
* Retrieves the details for an A/B test by its ID.
|
|
727
|
+
*
|
|
728
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
729
|
+
*
|
|
730
|
+
* Required API Key ACLs:
|
|
731
|
+
* - analytics
|
|
732
|
+
* @param getABTest - The getABTest object.
|
|
733
|
+
* @param getABTest.id - Unique A/B test identifier.
|
|
734
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
735
|
+
* @see getABTest for the plain version.
|
|
736
|
+
*/
|
|
737
|
+
getABTestWithHTTPInfo({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTest>>;
|
|
627
738
|
/**
|
|
628
739
|
* Retrieves timeseries for an A/B test by its ID.
|
|
629
740
|
*
|
|
@@ -637,6 +748,22 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
637
748
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
638
749
|
*/
|
|
639
750
|
getTimeseries({ id, startDate, endDate, metric }: GetTimeseriesProps, requestOptions?: RequestOptions): Promise<Timeseries>;
|
|
751
|
+
/**
|
|
752
|
+
* Retrieves timeseries for an A/B test by its ID.
|
|
753
|
+
*
|
|
754
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
755
|
+
*
|
|
756
|
+
* Required API Key ACLs:
|
|
757
|
+
* - analytics
|
|
758
|
+
* @param getTimeseries - The getTimeseries object.
|
|
759
|
+
* @param getTimeseries.id - Unique A/B test identifier.
|
|
760
|
+
* @param getTimeseries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
761
|
+
* @param getTimeseries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
762
|
+
* @param getTimeseries.metric - List of metrics to retrieve. If not specified, all metrics are returned.
|
|
763
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
764
|
+
* @see getTimeseries for the plain version.
|
|
765
|
+
*/
|
|
766
|
+
getTimeseriesWithHTTPInfo({ id, startDate, endDate, metric }: GetTimeseriesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Timeseries>>;
|
|
640
767
|
/**
|
|
641
768
|
* Lists all A/B tests you configured for this application.
|
|
642
769
|
*
|
|
@@ -651,6 +778,23 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
651
778
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
652
779
|
*/
|
|
653
780
|
listABTests({ offset, limit, indexPrefix, indexSuffix, direction }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
|
|
781
|
+
/**
|
|
782
|
+
* Lists all A/B tests you configured for this application.
|
|
783
|
+
*
|
|
784
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
785
|
+
*
|
|
786
|
+
* Required API Key ACLs:
|
|
787
|
+
* - analytics
|
|
788
|
+
* @param listABTests - The listABTests object.
|
|
789
|
+
* @param listABTests.offset - Position of the first item to return.
|
|
790
|
+
* @param listABTests.limit - Number of items to return.
|
|
791
|
+
* @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
|
|
792
|
+
* @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
|
|
793
|
+
* @param listABTests.direction - Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
|
|
794
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
795
|
+
* @see listABTests for the plain version.
|
|
796
|
+
*/
|
|
797
|
+
listABTestsWithHTTPInfo({ offset, limit, indexPrefix, indexSuffix, direction }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListABTestsResponse>>;
|
|
654
798
|
/**
|
|
655
799
|
* Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
|
|
656
800
|
*
|
|
@@ -661,6 +805,19 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
|
|
|
661
805
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
662
806
|
*/
|
|
663
807
|
stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
|
|
808
|
+
/**
|
|
809
|
+
* Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
|
|
810
|
+
*
|
|
811
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
812
|
+
*
|
|
813
|
+
* Required API Key ACLs:
|
|
814
|
+
* - editSettings
|
|
815
|
+
* @param stopABTest - The stopABTest object.
|
|
816
|
+
* @param stopABTest.id - Unique A/B test identifier.
|
|
817
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
818
|
+
* @see stopABTest for the plain version.
|
|
819
|
+
*/
|
|
820
|
+
stopABTestWithHTTPInfo({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestResponse>>;
|
|
664
821
|
};
|
|
665
822
|
|
|
666
823
|
/**
|
|
@@ -674,4 +831,4 @@ type AbtestingV3Client = ReturnType<typeof createAbtestingV3Client>;
|
|
|
674
831
|
|
|
675
832
|
declare function abtestingV3Client(appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined): AbtestingV3Client;
|
|
676
833
|
|
|
677
|
-
export { type ABTest, type ABTestConfiguration, type ABTestResponse, type AbTestsVariant, type AbTestsVariantSearchParams, type AbtestingV3Client, type AddABTestsRequest, type AddABTestsVariant, type CreateMetric, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type CustomSearchParams, type DeleteABTestProps, type Direction, type EffectMetric, type EmptySearchFilter, type ErrorBase, type ErrorCorrectionType, type EstimateABTestRequest, type EstimateABTestResponse, type EstimateConfiguration, type FilterEffects, type GetABTestProps, type GetTimeseriesProps, type ListABTestsProps, type ListABTestsResponse, type MetricDate, type MetricMetadata, type MetricName, type MetricResult, type MetricsFilter, type MinimumDetectableEffect, type OutliersFilter, type Region, type RegionOptions, type Status, type StopABTestProps, type Timeseries, type TimeseriesVariant, type Variant, type VariantMetadata, abtestingV3Client, apiClientVersion };
|
|
834
|
+
export { type ABTest, type ABTestConfiguration, type ABTestResponse, type AbTestsVariant, type AbTestsVariantSearchParams, type AbtestingV3Client, type AddABTestsRequest, type AddABTestsVariant, type CreateMetric, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type CustomSearchParams, type Decision, type DeleteABTestProps, type Direction, type EffectMetric, type EmptySearchFilter, type ErrorBase, type ErrorCorrectionType, type EstimateABTestRequest, type EstimateABTestResponse, type EstimateConfiguration, type FilterEffects, type GetABTestProps, type GetTimeseriesProps, type ListABTestsProps, type ListABTestsResponse, type MetricDate, type MetricMetadata, type MetricName, type MetricResult, type MetricsFilter, type MinimumDetectableEffect, type OutliersFilter, type Region, type RegionOptions, type Status, type StopABTestProps, type Timeseries, type TimeseriesVariant, type Variant, type VariantMetadata, abtestingV3Client, apiClientVersion };
|