@algolia/client-analytics 5.27.0 → 5.29.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/dist/worker.d.ts CHANGED
@@ -76,11 +76,11 @@ type ClickPosition = {
76
76
  /**
77
77
  * Range of positions in the search results, using the pattern `[start,end]`. For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
78
78
  */
79
- position?: Array<number>;
79
+ position?: Array<number> | undefined;
80
80
  /**
81
81
  * Number of times this search has been clicked at that position.
82
82
  */
83
- clickCount?: number;
83
+ clickCount?: number | undefined;
84
84
  };
85
85
 
86
86
  type GetClickPositionsResponse = {
@@ -287,11 +287,11 @@ type CurrencyCode = {
287
287
  /**
288
288
  * Currency code.
289
289
  */
290
- currency?: string;
290
+ currency?: string | undefined;
291
291
  /**
292
292
  * Revenue associated with this search in this currency.
293
293
  */
294
- revenue?: number;
294
+ revenue?: number | undefined;
295
295
  };
296
296
 
297
297
  type DailyRevenue = {
@@ -785,7 +785,7 @@ type OrderBy = 'searchCount' | 'clickThroughRate' | 'conversionRate' | 'averageC
785
785
  */
786
786
  type CustomDeleteProps = {
787
787
  /**
788
- * Path of the endpoint, anything after \"/1\" must be specified.
788
+ * Path of the endpoint, for example `1/newFeature`.
789
789
  */
790
790
  path: string;
791
791
  /**
@@ -793,14 +793,14 @@ type CustomDeleteProps = {
793
793
  */
794
794
  parameters?: {
795
795
  [key: string]: any;
796
- };
796
+ } | undefined;
797
797
  };
798
798
  /**
799
799
  * Properties for the `customGet` method.
800
800
  */
801
801
  type CustomGetProps = {
802
802
  /**
803
- * Path of the endpoint, anything after \"/1\" must be specified.
803
+ * Path of the endpoint, for example `1/newFeature`.
804
804
  */
805
805
  path: string;
806
806
  /**
@@ -808,14 +808,14 @@ type CustomGetProps = {
808
808
  */
809
809
  parameters?: {
810
810
  [key: string]: any;
811
- };
811
+ } | undefined;
812
812
  };
813
813
  /**
814
814
  * Properties for the `customPost` method.
815
815
  */
816
816
  type CustomPostProps = {
817
817
  /**
818
- * Path of the endpoint, anything after \"/1\" must be specified.
818
+ * Path of the endpoint, for example `1/newFeature`.
819
819
  */
820
820
  path: string;
821
821
  /**
@@ -823,18 +823,18 @@ type CustomPostProps = {
823
823
  */
824
824
  parameters?: {
825
825
  [key: string]: any;
826
- };
826
+ } | undefined;
827
827
  /**
828
828
  * Parameters to send with the custom request.
829
829
  */
830
- body?: Record<string, unknown>;
830
+ body?: Record<string, unknown> | undefined;
831
831
  };
832
832
  /**
833
833
  * Properties for the `customPut` method.
834
834
  */
835
835
  type CustomPutProps = {
836
836
  /**
837
- * Path of the endpoint, anything after \"/1\" must be specified.
837
+ * Path of the endpoint, for example `1/newFeature`.
838
838
  */
839
839
  path: string;
840
840
  /**
@@ -842,11 +842,11 @@ type CustomPutProps = {
842
842
  */
843
843
  parameters?: {
844
844
  [key: string]: any;
845
- };
845
+ } | undefined;
846
846
  /**
847
847
  * Parameters to send with the custom request.
848
848
  */
849
- body?: Record<string, unknown>;
849
+ body?: Record<string, unknown> | undefined;
850
850
  };
851
851
  /**
852
852
  * Properties for the `getAddToCartRate` method.
@@ -859,15 +859,15 @@ type GetAddToCartRateProps = {
859
859
  /**
860
860
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
861
861
  */
862
- startDate?: string;
862
+ startDate?: string | undefined;
863
863
  /**
864
864
  * End date of the period to analyze, in `YYYY-MM-DD` format.
865
865
  */
866
- endDate?: string;
866
+ endDate?: string | undefined;
867
867
  /**
868
868
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
869
869
  */
870
- tags?: string;
870
+ tags?: string | undefined;
871
871
  };
872
872
  /**
873
873
  * Properties for the `getAverageClickPosition` method.
@@ -880,15 +880,15 @@ type GetAverageClickPositionProps = {
880
880
  /**
881
881
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
882
882
  */
883
- startDate?: string;
883
+ startDate?: string | undefined;
884
884
  /**
885
885
  * End date of the period to analyze, in `YYYY-MM-DD` format.
886
886
  */
887
- endDate?: string;
887
+ endDate?: string | undefined;
888
888
  /**
889
889
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
890
890
  */
891
- tags?: string;
891
+ tags?: string | undefined;
892
892
  };
893
893
  /**
894
894
  * Properties for the `getClickPositions` method.
@@ -901,15 +901,15 @@ type GetClickPositionsProps = {
901
901
  /**
902
902
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
903
903
  */
904
- startDate?: string;
904
+ startDate?: string | undefined;
905
905
  /**
906
906
  * End date of the period to analyze, in `YYYY-MM-DD` format.
907
907
  */
908
- endDate?: string;
908
+ endDate?: string | undefined;
909
909
  /**
910
910
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
911
911
  */
912
- tags?: string;
912
+ tags?: string | undefined;
913
913
  };
914
914
  /**
915
915
  * Properties for the `getClickThroughRate` method.
@@ -922,15 +922,15 @@ type GetClickThroughRateProps = {
922
922
  /**
923
923
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
924
924
  */
925
- startDate?: string;
925
+ startDate?: string | undefined;
926
926
  /**
927
927
  * End date of the period to analyze, in `YYYY-MM-DD` format.
928
928
  */
929
- endDate?: string;
929
+ endDate?: string | undefined;
930
930
  /**
931
931
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
932
932
  */
933
- tags?: string;
933
+ tags?: string | undefined;
934
934
  };
935
935
  /**
936
936
  * Properties for the `getConversionRate` method.
@@ -943,15 +943,15 @@ type GetConversionRateProps = {
943
943
  /**
944
944
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
945
945
  */
946
- startDate?: string;
946
+ startDate?: string | undefined;
947
947
  /**
948
948
  * End date of the period to analyze, in `YYYY-MM-DD` format.
949
949
  */
950
- endDate?: string;
950
+ endDate?: string | undefined;
951
951
  /**
952
952
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
953
953
  */
954
- tags?: string;
954
+ tags?: string | undefined;
955
955
  };
956
956
  /**
957
957
  * Properties for the `getNoClickRate` method.
@@ -964,15 +964,15 @@ type GetNoClickRateProps = {
964
964
  /**
965
965
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
966
966
  */
967
- startDate?: string;
967
+ startDate?: string | undefined;
968
968
  /**
969
969
  * End date of the period to analyze, in `YYYY-MM-DD` format.
970
970
  */
971
- endDate?: string;
971
+ endDate?: string | undefined;
972
972
  /**
973
973
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
974
974
  */
975
- tags?: string;
975
+ tags?: string | undefined;
976
976
  };
977
977
  /**
978
978
  * Properties for the `getNoResultsRate` method.
@@ -985,15 +985,15 @@ type GetNoResultsRateProps = {
985
985
  /**
986
986
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
987
987
  */
988
- startDate?: string;
988
+ startDate?: string | undefined;
989
989
  /**
990
990
  * End date of the period to analyze, in `YYYY-MM-DD` format.
991
991
  */
992
- endDate?: string;
992
+ endDate?: string | undefined;
993
993
  /**
994
994
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
995
995
  */
996
- tags?: string;
996
+ tags?: string | undefined;
997
997
  };
998
998
  /**
999
999
  * Properties for the `getPurchaseRate` method.
@@ -1006,15 +1006,15 @@ type GetPurchaseRateProps = {
1006
1006
  /**
1007
1007
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1008
1008
  */
1009
- startDate?: string;
1009
+ startDate?: string | undefined;
1010
1010
  /**
1011
1011
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1012
1012
  */
1013
- endDate?: string;
1013
+ endDate?: string | undefined;
1014
1014
  /**
1015
1015
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1016
1016
  */
1017
- tags?: string;
1017
+ tags?: string | undefined;
1018
1018
  };
1019
1019
  /**
1020
1020
  * Properties for the `getRevenue` method.
@@ -1027,15 +1027,15 @@ type GetRevenueProps = {
1027
1027
  /**
1028
1028
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1029
1029
  */
1030
- startDate?: string;
1030
+ startDate?: string | undefined;
1031
1031
  /**
1032
1032
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1033
1033
  */
1034
- endDate?: string;
1034
+ endDate?: string | undefined;
1035
1035
  /**
1036
1036
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1037
1037
  */
1038
- tags?: string;
1038
+ tags?: string | undefined;
1039
1039
  };
1040
1040
  /**
1041
1041
  * Properties for the `getSearchesCount` method.
@@ -1048,15 +1048,15 @@ type GetSearchesCountProps = {
1048
1048
  /**
1049
1049
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1050
1050
  */
1051
- startDate?: string;
1051
+ startDate?: string | undefined;
1052
1052
  /**
1053
1053
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1054
1054
  */
1055
- endDate?: string;
1055
+ endDate?: string | undefined;
1056
1056
  /**
1057
1057
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1058
1058
  */
1059
- tags?: string;
1059
+ tags?: string | undefined;
1060
1060
  };
1061
1061
  /**
1062
1062
  * Properties for the `getSearchesNoClicks` method.
@@ -1069,23 +1069,23 @@ type GetSearchesNoClicksProps = {
1069
1069
  /**
1070
1070
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1071
1071
  */
1072
- startDate?: string;
1072
+ startDate?: string | undefined;
1073
1073
  /**
1074
1074
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1075
1075
  */
1076
- endDate?: string;
1076
+ endDate?: string | undefined;
1077
1077
  /**
1078
1078
  * Number of items to return.
1079
1079
  */
1080
- limit?: number;
1080
+ limit?: number | undefined;
1081
1081
  /**
1082
1082
  * Position of the first item to return.
1083
1083
  */
1084
- offset?: number;
1084
+ offset?: number | undefined;
1085
1085
  /**
1086
1086
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1087
1087
  */
1088
- tags?: string;
1088
+ tags?: string | undefined;
1089
1089
  };
1090
1090
  /**
1091
1091
  * Properties for the `getSearchesNoResults` method.
@@ -1098,23 +1098,23 @@ type GetSearchesNoResultsProps = {
1098
1098
  /**
1099
1099
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1100
1100
  */
1101
- startDate?: string;
1101
+ startDate?: string | undefined;
1102
1102
  /**
1103
1103
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1104
1104
  */
1105
- endDate?: string;
1105
+ endDate?: string | undefined;
1106
1106
  /**
1107
1107
  * Number of items to return.
1108
1108
  */
1109
- limit?: number;
1109
+ limit?: number | undefined;
1110
1110
  /**
1111
1111
  * Position of the first item to return.
1112
1112
  */
1113
- offset?: number;
1113
+ offset?: number | undefined;
1114
1114
  /**
1115
1115
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1116
1116
  */
1117
- tags?: string;
1117
+ tags?: string | undefined;
1118
1118
  };
1119
1119
  /**
1120
1120
  * Properties for the `getStatus` method.
@@ -1136,23 +1136,23 @@ type GetTopCountriesProps = {
1136
1136
  /**
1137
1137
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1138
1138
  */
1139
- startDate?: string;
1139
+ startDate?: string | undefined;
1140
1140
  /**
1141
1141
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1142
1142
  */
1143
- endDate?: string;
1143
+ endDate?: string | undefined;
1144
1144
  /**
1145
1145
  * Number of items to return.
1146
1146
  */
1147
- limit?: number;
1147
+ limit?: number | undefined;
1148
1148
  /**
1149
1149
  * Position of the first item to return.
1150
1150
  */
1151
- offset?: number;
1151
+ offset?: number | undefined;
1152
1152
  /**
1153
1153
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1154
1154
  */
1155
- tags?: string;
1155
+ tags?: string | undefined;
1156
1156
  };
1157
1157
  /**
1158
1158
  * Properties for the `getTopFilterAttributes` method.
@@ -1165,27 +1165,27 @@ type GetTopFilterAttributesProps = {
1165
1165
  /**
1166
1166
  * Search query.
1167
1167
  */
1168
- search?: string;
1168
+ search?: string | undefined;
1169
1169
  /**
1170
1170
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1171
1171
  */
1172
- startDate?: string;
1172
+ startDate?: string | undefined;
1173
1173
  /**
1174
1174
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1175
1175
  */
1176
- endDate?: string;
1176
+ endDate?: string | undefined;
1177
1177
  /**
1178
1178
  * Number of items to return.
1179
1179
  */
1180
- limit?: number;
1180
+ limit?: number | undefined;
1181
1181
  /**
1182
1182
  * Position of the first item to return.
1183
1183
  */
1184
- offset?: number;
1184
+ offset?: number | undefined;
1185
1185
  /**
1186
1186
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1187
1187
  */
1188
- tags?: string;
1188
+ tags?: string | undefined;
1189
1189
  };
1190
1190
  /**
1191
1191
  * Properties for the `getTopFilterForAttribute` method.
@@ -1202,27 +1202,27 @@ type GetTopFilterForAttributeProps = {
1202
1202
  /**
1203
1203
  * Search query.
1204
1204
  */
1205
- search?: string;
1205
+ search?: string | undefined;
1206
1206
  /**
1207
1207
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1208
1208
  */
1209
- startDate?: string;
1209
+ startDate?: string | undefined;
1210
1210
  /**
1211
1211
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1212
1212
  */
1213
- endDate?: string;
1213
+ endDate?: string | undefined;
1214
1214
  /**
1215
1215
  * Number of items to return.
1216
1216
  */
1217
- limit?: number;
1217
+ limit?: number | undefined;
1218
1218
  /**
1219
1219
  * Position of the first item to return.
1220
1220
  */
1221
- offset?: number;
1221
+ offset?: number | undefined;
1222
1222
  /**
1223
1223
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1224
1224
  */
1225
- tags?: string;
1225
+ tags?: string | undefined;
1226
1226
  };
1227
1227
  /**
1228
1228
  * Properties for the `getTopFiltersNoResults` method.
@@ -1235,27 +1235,27 @@ type GetTopFiltersNoResultsProps = {
1235
1235
  /**
1236
1236
  * Search query.
1237
1237
  */
1238
- search?: string;
1238
+ search?: string | undefined;
1239
1239
  /**
1240
1240
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1241
1241
  */
1242
- startDate?: string;
1242
+ startDate?: string | undefined;
1243
1243
  /**
1244
1244
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1245
1245
  */
1246
- endDate?: string;
1246
+ endDate?: string | undefined;
1247
1247
  /**
1248
1248
  * Number of items to return.
1249
1249
  */
1250
- limit?: number;
1250
+ limit?: number | undefined;
1251
1251
  /**
1252
1252
  * Position of the first item to return.
1253
1253
  */
1254
- offset?: number;
1254
+ offset?: number | undefined;
1255
1255
  /**
1256
1256
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1257
1257
  */
1258
- tags?: string;
1258
+ tags?: string | undefined;
1259
1259
  };
1260
1260
  /**
1261
1261
  * Properties for the `getTopHits` method.
@@ -1268,35 +1268,35 @@ type GetTopHitsProps = {
1268
1268
  /**
1269
1269
  * Search query.
1270
1270
  */
1271
- search?: string;
1271
+ search?: string | undefined;
1272
1272
  /**
1273
1273
  * Whether to include metrics related to click and conversion events in the response.
1274
1274
  */
1275
- clickAnalytics?: boolean;
1275
+ clickAnalytics?: boolean | undefined;
1276
1276
  /**
1277
1277
  * Whether to include metrics related to revenue events in the response.
1278
1278
  */
1279
- revenueAnalytics?: boolean;
1279
+ revenueAnalytics?: boolean | undefined;
1280
1280
  /**
1281
1281
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1282
1282
  */
1283
- startDate?: string;
1283
+ startDate?: string | undefined;
1284
1284
  /**
1285
1285
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1286
1286
  */
1287
- endDate?: string;
1287
+ endDate?: string | undefined;
1288
1288
  /**
1289
1289
  * Number of items to return.
1290
1290
  */
1291
- limit?: number;
1291
+ limit?: number | undefined;
1292
1292
  /**
1293
1293
  * Position of the first item to return.
1294
1294
  */
1295
- offset?: number;
1295
+ offset?: number | undefined;
1296
1296
  /**
1297
1297
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1298
1298
  */
1299
- tags?: string;
1299
+ tags?: string | undefined;
1300
1300
  };
1301
1301
  /**
1302
1302
  * Properties for the `getTopSearches` method.
@@ -1309,39 +1309,39 @@ type GetTopSearchesProps = {
1309
1309
  /**
1310
1310
  * Whether to include metrics related to click and conversion events in the response.
1311
1311
  */
1312
- clickAnalytics?: boolean;
1312
+ clickAnalytics?: boolean | undefined;
1313
1313
  /**
1314
1314
  * Whether to include metrics related to revenue events in the response.
1315
1315
  */
1316
- revenueAnalytics?: boolean;
1316
+ revenueAnalytics?: boolean | undefined;
1317
1317
  /**
1318
1318
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1319
1319
  */
1320
- startDate?: string;
1320
+ startDate?: string | undefined;
1321
1321
  /**
1322
1322
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1323
1323
  */
1324
- endDate?: string;
1324
+ endDate?: string | undefined;
1325
1325
  /**
1326
1326
  * Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
1327
1327
  */
1328
- orderBy?: OrderBy;
1328
+ orderBy?: OrderBy | undefined;
1329
1329
  /**
1330
1330
  * Sorting direction of the results: ascending or descending.
1331
1331
  */
1332
- direction?: Direction;
1332
+ direction?: Direction | undefined;
1333
1333
  /**
1334
1334
  * Number of items to return.
1335
1335
  */
1336
- limit?: number;
1336
+ limit?: number | undefined;
1337
1337
  /**
1338
1338
  * Position of the first item to return.
1339
1339
  */
1340
- offset?: number;
1340
+ offset?: number | undefined;
1341
1341
  /**
1342
1342
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1343
1343
  */
1344
- tags?: string;
1344
+ tags?: string | undefined;
1345
1345
  };
1346
1346
  /**
1347
1347
  * Properties for the `getUsersCount` method.
@@ -1354,22 +1354,22 @@ type GetUsersCountProps = {
1354
1354
  /**
1355
1355
  * Start date of the period to analyze, in `YYYY-MM-DD` format.
1356
1356
  */
1357
- startDate?: string;
1357
+ startDate?: string | undefined;
1358
1358
  /**
1359
1359
  * End date of the period to analyze, in `YYYY-MM-DD` format.
1360
1360
  */
1361
- endDate?: string;
1361
+ endDate?: string | undefined;
1362
1362
  /**
1363
1363
  * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1364
1364
  */
1365
- tags?: string;
1365
+ tags?: string | undefined;
1366
1366
  };
1367
1367
 
1368
- declare const apiClientVersion = "5.27.0";
1368
+ declare const apiClientVersion = "5.29.0";
1369
1369
  declare const REGIONS: readonly ["de", "us"];
1370
1370
  type Region = (typeof REGIONS)[number];
1371
1371
  type RegionOptions = {
1372
- region?: Region;
1372
+ region?: Region | undefined;
1373
1373
  };
1374
1374
  declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
1375
1375
  transporter: _algolia_client_common.Transporter;
@@ -1395,7 +1395,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1395
1395
  * @param segment - The algolia agent (user-agent) segment to add.
1396
1396
  * @param version - The version of the agent.
1397
1397
  */
1398
- addAlgoliaAgent(segment: string, version?: string): void;
1398
+ addAlgoliaAgent(segment: string, version?: string | undefined): void;
1399
1399
  /**
1400
1400
  * Helper method to switch the API key used to authenticate the requests.
1401
1401
  *
@@ -1408,7 +1408,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1408
1408
  /**
1409
1409
  * This method lets you send requests to the Algolia REST API.
1410
1410
  * @param customDelete - The customDelete object.
1411
- * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
1411
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
1412
1412
  * @param customDelete.parameters - Query parameters to apply to the current query.
1413
1413
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1414
1414
  */
@@ -1416,7 +1416,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1416
1416
  /**
1417
1417
  * This method lets you send requests to the Algolia REST API.
1418
1418
  * @param customGet - The customGet object.
1419
- * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
1419
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
1420
1420
  * @param customGet.parameters - Query parameters to apply to the current query.
1421
1421
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1422
1422
  */
@@ -1424,7 +1424,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1424
1424
  /**
1425
1425
  * This method lets you send requests to the Algolia REST API.
1426
1426
  * @param customPost - The customPost object.
1427
- * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
1427
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
1428
1428
  * @param customPost.parameters - Query parameters to apply to the current query.
1429
1429
  * @param customPost.body - Parameters to send with the custom request.
1430
1430
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1433,7 +1433,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1433
1433
  /**
1434
1434
  * This method lets you send requests to the Algolia REST API.
1435
1435
  * @param customPut - The customPut object.
1436
- * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
1436
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
1437
1437
  * @param customPut.parameters - Query parameters to apply to the current query.
1438
1438
  * @param customPut.body - Parameters to send with the custom request.
1439
1439
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1729,11 +1729,11 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1729
1729
  * Error.
1730
1730
  */
1731
1731
  type ErrorBase = Record<string, any> & {
1732
- message?: string;
1732
+ message?: string | undefined;
1733
1733
  };
1734
1734
 
1735
1735
  type AnalyticsClient = ReturnType<typeof createAnalyticsClient>;
1736
1736
 
1737
- declare function analyticsClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): AnalyticsClient;
1737
+ declare function analyticsClient(appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined): AnalyticsClient;
1738
1738
 
1739
1739
  export { type AnalyticsClient, type ClickPosition, type CurrencyCode, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DailyAddToCartRates, type DailyAverageClicks, type DailyClickThroughRates, type DailyConversionRates, type DailyNoClickRates, type DailyNoResultsRates, type DailyPurchaseRates, type DailyRevenue, type DailySearches, type DailySearchesNoClicks, type DailySearchesNoResults, type DailyUsers, type Direction, type ErrorBase, type GetAddToCartRateProps, type GetAddToCartRateResponse, type GetAverageClickPositionProps, type GetAverageClickPositionResponse, type GetClickPositionsProps, type GetClickPositionsResponse, type GetClickThroughRateProps, type GetClickThroughRateResponse, type GetConversionRateProps, type GetConversionRateResponse, type GetNoClickRateProps, type GetNoClickRateResponse, type GetNoResultsRateProps, type GetNoResultsRateResponse, type GetPurchaseRateProps, type GetPurchaseRateResponse, type GetRevenue, type GetRevenueProps, type GetSearchesCountProps, type GetSearchesCountResponse, type GetSearchesNoClicksProps, type GetSearchesNoClicksResponse, type GetSearchesNoResultsProps, type GetSearchesNoResultsResponse, type GetStatusProps, type GetStatusResponse, type GetTopCountriesProps, type GetTopCountriesResponse, type GetTopFilterAttribute, type GetTopFilterAttributesProps, type GetTopFilterAttributesResponse, type GetTopFilterForAttribute, type GetTopFilterForAttributeProps, type GetTopFilterForAttributeResponse, type GetTopFiltersNoResultsProps, type GetTopFiltersNoResultsResponse, type GetTopFiltersNoResultsValue, type GetTopFiltersNoResultsValues, type GetTopHitsProps, type GetTopHitsResponse, type GetTopSearchesProps, type GetTopSearchesResponse, type GetUsersCountProps, type GetUsersCountResponse, type Operator, type OrderBy, type Region, type RegionOptions, type TopCountry, type TopHit, type TopHitWithAnalytics, type TopHitWithRevenueAnalytics, type TopHitsResponse, type TopHitsResponseWithAnalytics, type TopHitsResponseWithRevenueAnalytics, type TopSearch, type TopSearchWithAnalytics, type TopSearchWithRevenueAnalytics, type TopSearchesResponse, type TopSearchesResponseWithAnalytics, type TopSearchesResponseWithRevenueAnalytics, analyticsClient, apiClientVersion };