@algolia/client-abtesting 5.2.2 → 5.2.4-beta.2

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.
Files changed (78) hide show
  1. package/README.md +2 -2
  2. package/dist/browser.d.ts +462 -0
  3. package/dist/builds/browser.js +391 -0
  4. package/dist/builds/browser.js.map +1 -0
  5. package/dist/builds/browser.min.js +2 -0
  6. package/dist/builds/browser.min.js.map +1 -0
  7. package/dist/builds/browser.umd.js +12 -0
  8. package/dist/builds/node.cjs +409 -0
  9. package/dist/builds/node.cjs.map +1 -0
  10. package/dist/builds/node.js +389 -0
  11. package/dist/builds/node.js.map +1 -0
  12. package/dist/node.d.cts +462 -0
  13. package/dist/node.d.ts +462 -0
  14. package/dist/src/abtestingClient.cjs +376 -0
  15. package/dist/src/abtestingClient.cjs.map +1 -0
  16. package/dist/src/abtestingClient.js +349 -0
  17. package/dist/src/abtestingClient.js.map +1 -0
  18. package/index.d.ts +1 -1
  19. package/index.js +1 -1
  20. package/package.json +27 -27
  21. package/dist/builds/browser.d.ts +0 -26
  22. package/dist/builds/browser.d.ts.map +0 -1
  23. package/dist/builds/node.d.ts +0 -26
  24. package/dist/builds/node.d.ts.map +0 -1
  25. package/dist/client-abtesting.cjs +0 -376
  26. package/dist/client-abtesting.esm.browser.js +0 -1050
  27. package/dist/client-abtesting.esm.node.js +0 -373
  28. package/dist/client-abtesting.umd.js +0 -2
  29. package/dist/model/aBTest.d.ts +0 -37
  30. package/dist/model/aBTest.d.ts.map +0 -1
  31. package/dist/model/aBTestConfiguration.d.ts +0 -12
  32. package/dist/model/aBTestConfiguration.d.ts.map +0 -1
  33. package/dist/model/aBTestResponse.d.ts +0 -15
  34. package/dist/model/aBTestResponse.d.ts.map +0 -1
  35. package/dist/model/abTestsVariant.d.ts +0 -15
  36. package/dist/model/abTestsVariant.d.ts.map +0 -1
  37. package/dist/model/abTestsVariantSearchParams.d.ts +0 -4
  38. package/dist/model/abTestsVariantSearchParams.d.ts.map +0 -1
  39. package/dist/model/addABTestsRequest.d.ts +0 -16
  40. package/dist/model/addABTestsRequest.d.ts.map +0 -1
  41. package/dist/model/addABTestsVariant.d.ts +0 -4
  42. package/dist/model/addABTestsVariant.d.ts.map +0 -1
  43. package/dist/model/clientMethodProps.d.ts +0 -109
  44. package/dist/model/clientMethodProps.d.ts.map +0 -1
  45. package/dist/model/currency.d.ts +0 -19
  46. package/dist/model/currency.d.ts.map +0 -1
  47. package/dist/model/customSearchParams.d.ts +0 -7
  48. package/dist/model/customSearchParams.d.ts.map +0 -1
  49. package/dist/model/effect.d.ts +0 -5
  50. package/dist/model/effect.d.ts.map +0 -1
  51. package/dist/model/emptySearch.d.ts +0 -10
  52. package/dist/model/emptySearch.d.ts.map +0 -1
  53. package/dist/model/emptySearchFilter.d.ts +0 -14
  54. package/dist/model/emptySearchFilter.d.ts.map +0 -1
  55. package/dist/model/errorBase.d.ts +0 -7
  56. package/dist/model/errorBase.d.ts.map +0 -1
  57. package/dist/model/filterEffects.d.ts +0 -10
  58. package/dist/model/filterEffects.d.ts.map +0 -1
  59. package/dist/model/index.d.ts +0 -24
  60. package/dist/model/index.d.ts.map +0 -1
  61. package/dist/model/listABTestsResponse.d.ts +0 -16
  62. package/dist/model/listABTestsResponse.d.ts.map +0 -1
  63. package/dist/model/minimumDetectableEffect.d.ts +0 -12
  64. package/dist/model/minimumDetectableEffect.d.ts.map +0 -1
  65. package/dist/model/outliers.d.ts +0 -10
  66. package/dist/model/outliers.d.ts.map +0 -1
  67. package/dist/model/outliersFilter.d.ts +0 -14
  68. package/dist/model/outliersFilter.d.ts.map +0 -1
  69. package/dist/model/scheduleABTestResponse.d.ts +0 -7
  70. package/dist/model/scheduleABTestResponse.d.ts.map +0 -1
  71. package/dist/model/scheduleABTestsRequest.d.ts +0 -20
  72. package/dist/model/scheduleABTestsRequest.d.ts.map +0 -1
  73. package/dist/model/status.d.ts +0 -5
  74. package/dist/model/status.d.ts.map +0 -1
  75. package/dist/model/variant.d.ts +0 -82
  76. package/dist/model/variant.d.ts.map +0 -1
  77. package/dist/src/abtestingClient.d.ts +0 -141
  78. package/dist/src/abtestingClient.d.ts.map +0 -1
@@ -1,19 +0,0 @@
1
- export type Currency = {
2
- /**
3
- * Currency code.
4
- */
5
- currency?: string;
6
- /**
7
- * Revenue for this currency.
8
- */
9
- revenue?: number;
10
- /**
11
- * Mean for this currency.
12
- */
13
- mean?: number;
14
- /**
15
- * Standard deviation for this currency.
16
- */
17
- standardDeviation?: number;
18
- };
19
- //# sourceMappingURL=currency.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../model/currency.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}
@@ -1,7 +0,0 @@
1
- /**
2
- * Search parameters to add to the test variant. Only use this parameter if the two variants use the same index.
3
- */
4
- export type CustomSearchParams = {
5
- customSearchParameters: Record<string, unknown>;
6
- };
7
- //# sourceMappingURL=customSearchParams.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"customSearchParams.d.ts","sourceRoot":"","sources":["../../model/customSearchParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjD,CAAC"}
@@ -1,5 +0,0 @@
1
- /**
2
- * Metric for which you want to detect the smallest relative difference.
3
- */
4
- export type Effect = 'addToCartRate' | 'clickThroughRate' | 'conversionRate' | 'purchaseRate';
5
- //# sourceMappingURL=effect.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"effect.d.ts","sourceRoot":"","sources":["../../model/effect.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,eAAe,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,cAAc,CAAC"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Configuration for handling empty searches.
3
- */
4
- export type EmptySearch = {
5
- /**
6
- * Whether to exclude empty searches when calculating A/B test results.
7
- */
8
- exclude?: boolean;
9
- };
10
- //# sourceMappingURL=emptySearch.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"emptySearch.d.ts","sourceRoot":"","sources":["../../model/emptySearch.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
@@ -1,14 +0,0 @@
1
- /**
2
- * Empty searches removed from the A/B test as a result of configuration settings.
3
- */
4
- export type EmptySearchFilter = {
5
- /**
6
- * Number of users removed from the A/B test.
7
- */
8
- usersCount?: number;
9
- /**
10
- * Number of tracked searches removed from the A/B test.
11
- */
12
- trackedSearchesCount?: number;
13
- };
14
- //# sourceMappingURL=emptySearchFilter.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"emptySearchFilter.d.ts","sourceRoot":"","sources":["../../model/emptySearchFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC"}
@@ -1,7 +0,0 @@
1
- /**
2
- * Error.
3
- */
4
- export type ErrorBase = Record<string, any> & {
5
- message?: string;
6
- };
7
- //# sourceMappingURL=errorBase.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,10 +0,0 @@
1
- import type { EmptySearchFilter } from './emptySearchFilter';
2
- import type { OutliersFilter } from './outliersFilter';
3
- /**
4
- * A/B test filter effects resulting from configuration settings.
5
- */
6
- export type FilterEffects = {
7
- outliers?: OutliersFilter;
8
- emptySearch?: EmptySearchFilter;
9
- };
10
- //# sourceMappingURL=filterEffects.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"filterEffects.d.ts","sourceRoot":"","sources":["../../model/filterEffects.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,cAAc,CAAC;IAE1B,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC,CAAC"}
@@ -1,24 +0,0 @@
1
- export * from './aBTest';
2
- export * from './aBTestConfiguration';
3
- export * from './aBTestResponse';
4
- export * from './abTestsVariant';
5
- export * from './abTestsVariantSearchParams';
6
- export * from './addABTestsRequest';
7
- export * from './addABTestsVariant';
8
- export * from './currency';
9
- export * from './customSearchParams';
10
- export * from './effect';
11
- export * from './emptySearch';
12
- export * from './emptySearchFilter';
13
- export * from './errorBase';
14
- export * from './filterEffects';
15
- export * from './listABTestsResponse';
16
- export * from './minimumDetectableEffect';
17
- export * from './outliers';
18
- export * from './outliersFilter';
19
- export * from './scheduleABTestResponse';
20
- export * from './scheduleABTestsRequest';
21
- export * from './status';
22
- export * from './variant';
23
- export * from './clientMethodProps';
24
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC"}
@@ -1,16 +0,0 @@
1
- import type { ABTest } from './aBTest';
2
- export type ListABTestsResponse = {
3
- /**
4
- * A/B tests.
5
- */
6
- abtests: ABTest[] | null;
7
- /**
8
- * Number of A/B tests.
9
- */
10
- count: number;
11
- /**
12
- * Number of retrievable A/B tests.
13
- */
14
- total: number;
15
- };
16
- //# sourceMappingURL=listABTestsResponse.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"listABTestsResponse.d.ts","sourceRoot":"","sources":["../../model/listABTestsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
@@ -1,12 +0,0 @@
1
- import type { Effect } from './effect';
2
- /**
3
- * Configuration for the smallest difference between test variants you want to detect.
4
- */
5
- export type MinimumDetectableEffect = {
6
- /**
7
- * Smallest difference in an observable metric between variants. For example, to detect a 10% difference between variants, set this value to 0.1.
8
- */
9
- size?: number;
10
- effect?: Effect;
11
- };
12
- //# sourceMappingURL=minimumDetectableEffect.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"minimumDetectableEffect.d.ts","sourceRoot":"","sources":["../../model/minimumDetectableEffect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Configuration for handling outliers.
3
- */
4
- export type Outliers = {
5
- /**
6
- * Whether to exclude outliers when calculating A/B test results.
7
- */
8
- exclude?: boolean;
9
- };
10
- //# sourceMappingURL=outliers.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"outliers.d.ts","sourceRoot":"","sources":["../../model/outliers.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
@@ -1,14 +0,0 @@
1
- /**
2
- * Outliers removed from the A/B test as a result of configuration settings.
3
- */
4
- export type OutliersFilter = {
5
- /**
6
- * Number of users removed from the A/B test.
7
- */
8
- usersCount?: number;
9
- /**
10
- * Number of tracked searches removed from the A/B test.
11
- */
12
- trackedSearchesCount?: number;
13
- };
14
- //# sourceMappingURL=outliersFilter.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"outliersFilter.d.ts","sourceRoot":"","sources":["../../model/outliersFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC"}
@@ -1,7 +0,0 @@
1
- export type ScheduleABTestResponse = {
2
- /**
3
- * Unique scheduled A/B test identifier.
4
- */
5
- abTestScheduleID: number;
6
- };
7
- //# sourceMappingURL=scheduleABTestResponse.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"scheduleABTestResponse.d.ts","sourceRoot":"","sources":["../../model/scheduleABTestResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC"}
@@ -1,20 +0,0 @@
1
- import type { AddABTestsVariant } from './addABTestsVariant';
2
- export type ScheduleABTestsRequest = {
3
- /**
4
- * A/B test name.
5
- */
6
- name: string;
7
- /**
8
- * A/B test variants.
9
- */
10
- variants: AddABTestsVariant[];
11
- /**
12
- * Date and time when the A/B test is scheduled to start, in RFC 3339 format.
13
- */
14
- scheduledAt: string;
15
- /**
16
- * End date and time of the A/B test, in RFC 3339 format.
17
- */
18
- endAt: string;
19
- };
20
- //# sourceMappingURL=scheduleABTestsRequest.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"scheduleABTestsRequest.d.ts","sourceRoot":"","sources":["../../model/scheduleABTestsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
@@ -1,5 +0,0 @@
1
- /**
2
- * 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.
3
- */
4
- export type Status = 'active' | 'expired' | 'failed' | 'stopped';
5
- //# sourceMappingURL=status.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../model/status.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC"}
@@ -1,82 +0,0 @@
1
- import type { Currency } from './currency';
2
- import type { FilterEffects } from './filterEffects';
3
- export type Variant = {
4
- /**
5
- * Number of add-to-cart events for this variant.
6
- */
7
- addToCartCount: number;
8
- /**
9
- * [Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for this variant.
10
- */
11
- addToCartRate?: number | null;
12
- /**
13
- * [Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for this variant.
14
- */
15
- averageClickPosition?: number | null;
16
- /**
17
- * Number of click events for this variant.
18
- */
19
- clickCount: number;
20
- /**
21
- * [Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for this variant.
22
- */
23
- clickThroughRate?: number | null;
24
- /**
25
- * Number of click events for this variant.
26
- */
27
- conversionCount: number;
28
- /**
29
- * [Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.
30
- */
31
- conversionRate?: number | null;
32
- /**
33
- * A/B test currencies.
34
- */
35
- currencies?: Record<string, Currency>;
36
- /**
37
- * Description for this variant.
38
- */
39
- description: string;
40
- /**
41
- * 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.
42
- */
43
- estimatedSampleSize?: number;
44
- filterEffects?: FilterEffects;
45
- /**
46
- * Index name of the A/B test variant (case-sensitive).
47
- */
48
- index: string;
49
- /**
50
- * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this variant.
51
- */
52
- noResultCount: number | null;
53
- /**
54
- * Number of purchase events for this variant.
55
- */
56
- purchaseCount: number;
57
- /**
58
- * [Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this variant.
59
- */
60
- purchaseRate?: number | null;
61
- /**
62
- * Number of searches for this variant.
63
- */
64
- searchCount: number | null;
65
- /**
66
- * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
67
- */
68
- trackedSearchCount?: number;
69
- /**
70
- * Percentage of search requests each variant receives.
71
- */
72
- trafficPercentage: number;
73
- /**
74
- * Number of users that made searches to this variant.
75
- */
76
- userCount: number | null;
77
- /**
78
- * Number of users that made tracked searches to this variant.
79
- */
80
- trackedUserCount: number | null;
81
- };
82
- //# sourceMappingURL=variant.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../model/variant.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC,CAAC"}
@@ -1,141 +0,0 @@
1
- import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
2
- import type { ABTest } from '../model/aBTest';
3
- import type { ABTestResponse } from '../model/aBTestResponse';
4
- import type { AddABTestsRequest } from '../model/addABTestsRequest';
5
- import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteABTestProps, GetABTestProps, ListABTestsProps, StopABTestProps } from '../model/clientMethodProps';
6
- import type { ListABTestsResponse } from '../model/listABTestsResponse';
7
- import type { ScheduleABTestResponse } from '../model/scheduleABTestResponse';
8
- import type { ScheduleABTestsRequest } from '../model/scheduleABTestsRequest';
9
- export declare const apiClientVersion = "5.2.2";
10
- export declare const REGIONS: readonly ["de", "us"];
11
- export type Region = (typeof REGIONS)[number];
12
- export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
13
- region?: Region;
14
- }): {
15
- transporter: import("@algolia/client-common").Transporter;
16
- /**
17
- * The `appId` currently in use.
18
- */
19
- appId: string;
20
- /**
21
- * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
22
- */
23
- clearCache(): Promise<void>;
24
- /**
25
- * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
26
- */
27
- readonly _ua: string;
28
- /**
29
- * Adds a `segment` to the `x-algolia-agent` sent with every requests.
30
- *
31
- * @param segment - The algolia agent (user-agent) segment to add.
32
- * @param version - The version of the agent.
33
- */
34
- addAlgoliaAgent(segment: string, version?: string): void;
35
- /**
36
- * Creates a new A/B test.
37
- *
38
- * Required API Key ACLs:
39
- * - editSettings.
40
- *
41
- * @param addABTestsRequest - The addABTestsRequest object.
42
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
43
- */
44
- addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
45
- /**
46
- * This method allow you to send requests to the Algolia REST API.
47
- *
48
- * @param customDelete - The customDelete object.
49
- * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
50
- * @param customDelete.parameters - Query parameters to apply to the current query.
51
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
52
- */
53
- customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
54
- /**
55
- * This method allow you to send requests to the Algolia REST API.
56
- *
57
- * @param customGet - The customGet object.
58
- * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
59
- * @param customGet.parameters - Query parameters to apply to the current query.
60
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
61
- */
62
- customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
63
- /**
64
- * This method allow you to send requests to the Algolia REST API.
65
- *
66
- * @param customPost - The customPost object.
67
- * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
68
- * @param customPost.parameters - Query parameters to apply to the current query.
69
- * @param customPost.body - Parameters to send with the custom request.
70
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
71
- */
72
- customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
73
- /**
74
- * This method allow you to send requests to the Algolia REST API.
75
- *
76
- * @param customPut - The customPut object.
77
- * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
78
- * @param customPut.parameters - Query parameters to apply to the current query.
79
- * @param customPut.body - Parameters to send with the custom request.
80
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
81
- */
82
- customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
83
- /**
84
- * Deletes an A/B test by its ID.
85
- *
86
- * Required API Key ACLs:
87
- * - editSettings.
88
- *
89
- * @param deleteABTest - The deleteABTest object.
90
- * @param deleteABTest.id - Unique A/B test identifier.
91
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
92
- */
93
- deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
94
- /**
95
- * Retrieves the details for an A/B test by its ID.
96
- *
97
- * Required API Key ACLs:
98
- * - analytics.
99
- *
100
- * @param getABTest - The getABTest object.
101
- * @param getABTest.id - Unique A/B test identifier.
102
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
103
- */
104
- getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
105
- /**
106
- * Lists all A/B tests you configured for this application.
107
- *
108
- * Required API Key ACLs:
109
- * - analytics.
110
- *
111
- * @param listABTests - The listABTests object.
112
- * @param listABTests.offset - Position of the first item to return.
113
- * @param listABTests.limit - Number of items to return.
114
- * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
115
- * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
116
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
117
- */
118
- listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
119
- /**
120
- * Schedule an A/B test to be started at a later time.
121
- *
122
- * Required API Key ACLs:
123
- * - editSettings.
124
- *
125
- * @param scheduleABTestsRequest - The scheduleABTestsRequest object.
126
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
127
- */
128
- scheduleABTest(scheduleABTestsRequest: ScheduleABTestsRequest, requestOptions?: RequestOptions): Promise<ScheduleABTestResponse>;
129
- /**
130
- * Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
131
- *
132
- * Required API Key ACLs:
133
- * - editSettings.
134
- *
135
- * @param stopABTest - The stopABTest object.
136
- * @param stopABTest.id - Unique A/B test identifier.
137
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
138
- */
139
- stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
140
- };
141
- //# sourceMappingURL=abtestingClient.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"abtestingClient.d.ts","sourceRoot":"","sources":["../../src/abtestingClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,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,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAE9E,eAAO,MAAM,gBAAgB,UAAU,CAAC;AAExC,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAS9C,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;;IAwBxC;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAI3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;kCAC2B,iBAAiB,mBAAmB,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IA8B1G;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAmBnC;;;;;;;OAOG;oCAC6B,cAAc,mBAAmB,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAmBlH;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoBnC;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoBnC;;;;;;;;;OASG;yBACkB,iBAAiB,mBAAmB,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAmBjG;;;;;;;;;OASG;sBACe,cAAc,mBAAmB,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBnF;;;;;;;;;;;;OAYG;8DAE4C,gBAAgB,mBAC7C,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,mBAAmB,CAAC;IA6B/B;;;;;;;;OAQG;2CAEuB,sBAAsB,mBAC7B,cAAc,GAC9B,OAAO,CAAC,sBAAsB,CAAC;IAiClC;;;;;;;;;OASG;uBACgB,eAAe,mBAAmB,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;EAmBhG"}