algoliasearch 5.0.0-alpha.53 → 5.0.0-alpha.55

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 (463) hide show
  1. package/builds/browser.ts +1 -1
  2. package/builds/models.ts +1 -1
  3. package/builds/node.ts +1 -1
  4. package/dist/algoliasearch/builds/models.d.ts +31 -31
  5. package/dist/algoliasearch/jest.config.d.ts +3 -3
  6. package/dist/algoliasearch.cjs.js +3487 -3485
  7. package/dist/algoliasearch.esm.browser.js +3620 -3618
  8. package/dist/algoliasearch.esm.node.js +3487 -3485
  9. package/dist/algoliasearch.umd.js +2 -2
  10. package/dist/builds/browser.d.ts +87 -87
  11. package/dist/builds/node.d.ts +87 -87
  12. package/dist/client-abtesting/model/aBTest.d.ts +39 -39
  13. package/dist/client-abtesting/model/aBTestResponse.d.ts +14 -14
  14. package/dist/client-abtesting/model/abTestsVariant.d.ts +14 -14
  15. package/dist/client-abtesting/model/abTestsVariantSearchParams.d.ts +3 -3
  16. package/dist/client-abtesting/model/addABTestsRequest.d.ts +15 -15
  17. package/dist/client-abtesting/model/addABTestsVariant.d.ts +3 -3
  18. package/dist/client-abtesting/model/clientMethodProps.d.ts +100 -100
  19. package/dist/client-abtesting/model/customSearchParams.d.ts +3 -3
  20. package/dist/client-abtesting/model/errorBase.d.ts +6 -6
  21. package/dist/client-abtesting/model/index.d.ts +11 -11
  22. package/dist/client-abtesting/model/listABTestsResponse.d.ts +15 -15
  23. package/dist/client-abtesting/model/variant.d.ts +50 -50
  24. package/dist/client-abtesting/src/abtestingClient.d.ts +124 -124
  25. package/dist/client-analytics/model/averageClickEvent.d.ts +14 -14
  26. package/dist/client-analytics/model/clickPosition.d.ts +10 -10
  27. package/dist/client-analytics/model/clickThroughRateEvent.d.ts +18 -18
  28. package/dist/client-analytics/model/clientMethodProps.d.ts +507 -507
  29. package/dist/client-analytics/model/conversionRateEvent.d.ts +18 -18
  30. package/dist/client-analytics/model/direction.d.ts +1 -1
  31. package/dist/client-analytics/model/errorBase.d.ts +6 -6
  32. package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts +15 -15
  33. package/dist/client-analytics/model/getClickPositionsResponse.d.ts +7 -7
  34. package/dist/client-analytics/model/getClickThroughRateResponse.d.ts +19 -19
  35. package/dist/client-analytics/model/getConversationRateResponse.d.ts +19 -19
  36. package/dist/client-analytics/model/getNoClickRateResponse.d.ts +19 -19
  37. package/dist/client-analytics/model/getNoResultsRateResponse.d.ts +19 -19
  38. package/dist/client-analytics/model/getSearchesCountResponse.d.ts +11 -11
  39. package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts +7 -7
  40. package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts +7 -7
  41. package/dist/client-analytics/model/getStatusResponse.d.ts +6 -6
  42. package/dist/client-analytics/model/getTopCountriesResponse.d.ts +7 -7
  43. package/dist/client-analytics/model/getTopFilterAttribute.d.ts +10 -10
  44. package/dist/client-analytics/model/getTopFilterAttributesResponse.d.ts +7 -7
  45. package/dist/client-analytics/model/getTopFilterForAttribute.d.ts +18 -18
  46. package/dist/client-analytics/model/getTopFilterForAttributeResponse.d.ts +7 -7
  47. package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts +7 -7
  48. package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts +14 -14
  49. package/dist/client-analytics/model/getTopFiltersNoResultsValues.d.ts +11 -11
  50. package/dist/client-analytics/model/getTopHitsResponse.d.ts +3 -3
  51. package/dist/client-analytics/model/getTopSearchesResponse.d.ts +3 -3
  52. package/dist/client-analytics/model/getUsersCountResponse.d.ts +11 -11
  53. package/dist/client-analytics/model/index.d.ts +44 -44
  54. package/dist/client-analytics/model/noClickRateEvent.d.ts +18 -18
  55. package/dist/client-analytics/model/noResultsRateEvent.d.ts +18 -18
  56. package/dist/client-analytics/model/orderBy.d.ts +1 -1
  57. package/dist/client-analytics/model/searchEvent.d.ts +10 -10
  58. package/dist/client-analytics/model/searchNoClickEvent.d.ts +14 -14
  59. package/dist/client-analytics/model/searchNoResultEvent.d.ts +14 -14
  60. package/dist/client-analytics/model/topCountry.d.ts +10 -10
  61. package/dist/client-analytics/model/topHit.d.ts +10 -10
  62. package/dist/client-analytics/model/topHitWithAnalytics.d.ts +30 -30
  63. package/dist/client-analytics/model/topHitsResponse.d.ts +7 -7
  64. package/dist/client-analytics/model/topHitsResponseWithAnalytics.d.ts +7 -7
  65. package/dist/client-analytics/model/topSearch.d.ts +14 -14
  66. package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +38 -38
  67. package/dist/client-analytics/model/topSearchesResponse.d.ts +7 -7
  68. package/dist/client-analytics/model/topSearchesResponseWithAnalytics.d.ts +7 -7
  69. package/dist/client-analytics/model/userWithDate.d.ts +10 -10
  70. package/dist/client-analytics/src/analyticsClient.d.ts +318 -318
  71. package/dist/client-personalization/model/clientMethodProps.d.ts +78 -78
  72. package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +10 -10
  73. package/dist/client-personalization/model/errorBase.d.ts +6 -6
  74. package/dist/client-personalization/model/eventScoring.d.ts +14 -14
  75. package/dist/client-personalization/model/facetScoring.d.ts +10 -10
  76. package/dist/client-personalization/model/getUserTokenResponse.d.ts +14 -14
  77. package/dist/client-personalization/model/index.d.ts +8 -8
  78. package/dist/client-personalization/model/personalizationStrategyParams.d.ts +16 -16
  79. package/dist/client-personalization/model/setPersonalizationStrategyResponse.d.ts +6 -6
  80. package/dist/client-personalization/src/personalizationClient.d.ts +112 -112
  81. package/dist/client-search/model/acl.d.ts +4 -4
  82. package/dist/client-search/model/action.d.ts +4 -4
  83. package/dist/client-search/model/addApiKeyResponse.d.ts +10 -10
  84. package/dist/client-search/model/advancedSyntaxFeatures.d.ts +1 -1
  85. package/dist/client-search/model/alternativesAsExact.d.ts +1 -1
  86. package/dist/client-search/model/anchoring.d.ts +4 -4
  87. package/dist/client-search/model/apiKey.d.ts +38 -38
  88. package/dist/client-search/model/aroundRadius.d.ts +5 -5
  89. package/dist/client-search/model/aroundRadiusAll.d.ts +1 -1
  90. package/dist/client-search/model/assignUserIdParams.d.ts +9 -9
  91. package/dist/client-search/model/attributeToUpdate.d.ts +2 -2
  92. package/dist/client-search/model/automaticFacetFilter.d.ts +17 -17
  93. package/dist/client-search/model/automaticFacetFilters.d.ts +5 -5
  94. package/dist/client-search/model/baseGetApiKeyResponse.d.ts +10 -10
  95. package/dist/client-search/model/baseIndexSettings.d.ts +62 -62
  96. package/dist/client-search/model/baseSearchParams.d.ts +3 -3
  97. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +122 -122
  98. package/dist/client-search/model/baseSearchResponse.d.ts +101 -101
  99. package/dist/client-search/model/batchAssignUserIdsParams.d.ts +13 -13
  100. package/dist/client-search/model/batchDictionaryEntriesParams.d.ts +14 -14
  101. package/dist/client-search/model/batchDictionaryEntriesRequest.d.ts +6 -6
  102. package/dist/client-search/model/batchParams.d.ts +7 -7
  103. package/dist/client-search/model/batchRequest.d.ts +8 -8
  104. package/dist/client-search/model/batchResponse.d.ts +10 -10
  105. package/dist/client-search/model/batchWriteParams.d.ts +7 -7
  106. package/dist/client-search/model/browseParams.d.ts +3 -3
  107. package/dist/client-search/model/browseParamsObject.d.ts +3 -3
  108. package/dist/client-search/model/browseResponse.d.ts +4 -4
  109. package/dist/client-search/model/builtInOperation.d.ts +11 -11
  110. package/dist/client-search/model/builtInOperationType.d.ts +4 -4
  111. package/dist/client-search/model/clientMethodProps.d.ts +715 -715
  112. package/dist/client-search/model/condition.d.ts +16 -16
  113. package/dist/client-search/model/consequence.d.ts +25 -25
  114. package/dist/client-search/model/consequenceHide.d.ts +9 -9
  115. package/dist/client-search/model/consequenceParams.d.ts +4 -4
  116. package/dist/client-search/model/consequenceQuery.d.ts +5 -5
  117. package/dist/client-search/model/consequenceQueryObject.d.ts +11 -11
  118. package/dist/client-search/model/createdAtResponse.d.ts +9 -9
  119. package/dist/client-search/model/cursor.d.ts +6 -6
  120. package/dist/client-search/model/deleteApiKeyResponse.d.ts +6 -6
  121. package/dist/client-search/model/deleteByParams.d.ts +26 -26
  122. package/dist/client-search/model/deleteSourceResponse.d.ts +6 -6
  123. package/dist/client-search/model/deletedAtResponse.d.ts +13 -13
  124. package/dist/client-search/model/dictionaryAction.d.ts +4 -4
  125. package/dist/client-search/model/dictionaryEntry.d.ts +27 -27
  126. package/dist/client-search/model/dictionaryEntryState.d.ts +4 -4
  127. package/dist/client-search/model/dictionaryLanguage.d.ts +9 -9
  128. package/dist/client-search/model/dictionarySettingsParams.d.ts +7 -7
  129. package/dist/client-search/model/dictionaryType.d.ts +1 -1
  130. package/dist/client-search/model/distinct.d.ts +4 -4
  131. package/dist/client-search/model/edit.d.ts +12 -12
  132. package/dist/client-search/model/editType.d.ts +4 -4
  133. package/dist/client-search/model/errorBase.d.ts +6 -6
  134. package/dist/client-search/model/exactOnSingleWordQuery.d.ts +4 -4
  135. package/dist/client-search/model/facetFilters.d.ts +5 -5
  136. package/dist/client-search/model/facetHits.d.ts +14 -14
  137. package/dist/client-search/model/facetOrdering.d.ts +12 -12
  138. package/dist/client-search/model/facets.d.ts +9 -9
  139. package/dist/client-search/model/facetsStats.d.ts +18 -18
  140. package/dist/client-search/model/fetchedIndex.d.ts +46 -46
  141. package/dist/client-search/model/getApiKeyResponse.d.ts +3 -3
  142. package/dist/client-search/model/getDictionarySettingsResponse.d.ts +4 -4
  143. package/dist/client-search/model/getLogsResponse.d.ts +4 -4
  144. package/dist/client-search/model/getObjectsParams.d.ts +7 -7
  145. package/dist/client-search/model/getObjectsRequest.d.ts +17 -17
  146. package/dist/client-search/model/getObjectsResponse.d.ts +6 -6
  147. package/dist/client-search/model/getTaskResponse.d.ts +4 -4
  148. package/dist/client-search/model/getTopUserIdsResponse.d.ts +10 -10
  149. package/dist/client-search/model/hasPendingMappingsResponse.d.ts +10 -10
  150. package/dist/client-search/model/highlightResult.d.ts +2 -2
  151. package/dist/client-search/model/highlightResultOption.d.ts +19 -19
  152. package/dist/client-search/model/hit.d.ts +22 -22
  153. package/dist/client-search/model/ignorePlurals.d.ts +4 -4
  154. package/dist/client-search/model/index.d.ts +154 -154
  155. package/dist/client-search/model/indexSettings.d.ts +6 -6
  156. package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +156 -156
  157. package/dist/client-search/model/languages.d.ts +9 -9
  158. package/dist/client-search/model/listApiKeysResponse.d.ts +7 -7
  159. package/dist/client-search/model/listClustersResponse.d.ts +9 -9
  160. package/dist/client-search/model/listIndicesResponse.d.ts +11 -11
  161. package/dist/client-search/model/listUserIdsResponse.d.ts +10 -10
  162. package/dist/client-search/model/log.d.ts +63 -63
  163. package/dist/client-search/model/logQuery.d.ts +14 -14
  164. package/dist/client-search/model/logType.d.ts +1 -1
  165. package/dist/client-search/model/matchLevel.d.ts +4 -4
  166. package/dist/client-search/model/matchedGeoLocation.d.ts +14 -14
  167. package/dist/client-search/model/mixedSearchFilters.d.ts +1 -1
  168. package/dist/client-search/model/multipleBatchRequest.d.ts +12 -12
  169. package/dist/client-search/model/multipleBatchResponse.d.ts +10 -10
  170. package/dist/client-search/model/numericFilters.d.ts +5 -5
  171. package/dist/client-search/model/operationIndexParams.d.ts +13 -13
  172. package/dist/client-search/model/operationType.d.ts +4 -4
  173. package/dist/client-search/model/optionalFilters.d.ts +5 -5
  174. package/dist/client-search/model/params.d.ts +12 -12
  175. package/dist/client-search/model/personalization.d.ts +14 -14
  176. package/dist/client-search/model/promote.d.ts +3 -3
  177. package/dist/client-search/model/promoteObjectID.d.ts +13 -13
  178. package/dist/client-search/model/promoteObjectIDs.d.ts +13 -13
  179. package/dist/client-search/model/queryType.d.ts +4 -4
  180. package/dist/client-search/model/rankingInfo.d.ts +50 -50
  181. package/dist/client-search/model/reRankingApplyFilter.d.ts +5 -5
  182. package/dist/client-search/model/removeStopWords.d.ts +4 -4
  183. package/dist/client-search/model/removeUserIdResponse.d.ts +6 -6
  184. package/dist/client-search/model/removeWordsIfNoResults.d.ts +4 -4
  185. package/dist/client-search/model/renderingContent.d.ts +7 -7
  186. package/dist/client-search/model/replaceSourceResponse.d.ts +6 -6
  187. package/dist/client-search/model/rule.d.ts +29 -29
  188. package/dist/client-search/model/saveObjectResponse.d.ts +11 -11
  189. package/dist/client-search/model/saveSynonymResponse.d.ts +14 -14
  190. package/dist/client-search/model/scopeType.d.ts +1 -1
  191. package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +21 -21
  192. package/dist/client-search/model/searchForFacetValuesRequest.d.ts +14 -14
  193. package/dist/client-search/model/searchForFacetValuesResponse.d.ts +4 -4
  194. package/dist/client-search/model/searchForFacets.d.ts +3 -3
  195. package/dist/client-search/model/searchForFacetsOptions.d.ts +20 -20
  196. package/dist/client-search/model/searchForHits.d.ts +3 -3
  197. package/dist/client-search/model/searchForHitsOptions.d.ts +12 -12
  198. package/dist/client-search/model/searchHits.d.ts +4 -4
  199. package/dist/client-search/model/searchMethodParams.d.ts +6 -6
  200. package/dist/client-search/model/searchParams.d.ts +3 -3
  201. package/dist/client-search/model/searchParamsObject.d.ts +3 -3
  202. package/dist/client-search/model/searchParamsQuery.d.ts +6 -6
  203. package/dist/client-search/model/searchParamsString.d.ts +6 -6
  204. package/dist/client-search/model/searchQuery.d.ts +3 -3
  205. package/dist/client-search/model/searchResponse.d.ts +3 -3
  206. package/dist/client-search/model/searchResponses.d.ts +4 -4
  207. package/dist/client-search/model/searchRulesParams.d.ts +31 -31
  208. package/dist/client-search/model/searchRulesResponse.d.ts +19 -19
  209. package/dist/client-search/model/searchStrategy.d.ts +1 -1
  210. package/dist/client-search/model/searchSynonymsParams.d.ts +6 -6
  211. package/dist/client-search/model/searchSynonymsResponse.d.ts +11 -11
  212. package/dist/client-search/model/searchTypeDefault.d.ts +4 -4
  213. package/dist/client-search/model/searchTypeFacet.d.ts +4 -4
  214. package/dist/client-search/model/searchUserIdsParams.d.ts +21 -21
  215. package/dist/client-search/model/searchUserIdsResponse.d.ts +26 -26
  216. package/dist/client-search/model/snippetResult.d.ts +2 -2
  217. package/dist/client-search/model/snippetResultOption.d.ts +11 -11
  218. package/dist/client-search/model/sortRemainingBy.d.ts +4 -4
  219. package/dist/client-search/model/source.d.ts +13 -13
  220. package/dist/client-search/model/standardEntries.d.ts +17 -17
  221. package/dist/client-search/model/synonymHit.d.ts +35 -35
  222. package/dist/client-search/model/synonymType.d.ts +4 -4
  223. package/dist/client-search/model/tagFilters.d.ts +5 -5
  224. package/dist/client-search/model/taskStatus.d.ts +1 -1
  225. package/dist/client-search/model/timeRange.d.ts +10 -10
  226. package/dist/client-search/model/typoTolerance.d.ts +5 -5
  227. package/dist/client-search/model/typoToleranceEnum.d.ts +1 -1
  228. package/dist/client-search/model/updateApiKeyResponse.d.ts +10 -10
  229. package/dist/client-search/model/updatedAtResponse.d.ts +13 -13
  230. package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +17 -17
  231. package/dist/client-search/model/updatedRuleResponse.d.ts +14 -14
  232. package/dist/client-search/model/userHighlightResult.d.ts +11 -11
  233. package/dist/client-search/model/userHit.d.ts +24 -24
  234. package/dist/client-search/model/userId.d.ts +21 -21
  235. package/dist/client-search/model/value.d.ts +8 -8
  236. package/dist/client-search/src/searchClient.d.ts +723 -723
  237. package/dist/lite/builds/browser.d.ts +5 -5
  238. package/dist/lite/builds/node.d.ts +5 -5
  239. package/dist/lite/lite.cjs.js +183 -183
  240. package/dist/lite/lite.esm.browser.js +307 -307
  241. package/dist/lite/lite.esm.node.js +183 -183
  242. package/dist/lite/lite.umd.js +2 -2
  243. package/dist/lite/model/acl.d.ts +4 -4
  244. package/dist/lite/model/action.d.ts +4 -4
  245. package/dist/lite/model/addApiKeyResponse.d.ts +10 -10
  246. package/dist/lite/model/advancedSyntaxFeatures.d.ts +1 -1
  247. package/dist/lite/model/alternativesAsExact.d.ts +1 -1
  248. package/dist/lite/model/anchoring.d.ts +4 -4
  249. package/dist/lite/model/apiKey.d.ts +38 -38
  250. package/dist/lite/model/aroundRadius.d.ts +5 -5
  251. package/dist/lite/model/aroundRadiusAll.d.ts +1 -1
  252. package/dist/lite/model/attributeToUpdate.d.ts +2 -2
  253. package/dist/lite/model/automaticFacetFilter.d.ts +17 -17
  254. package/dist/lite/model/automaticFacetFilters.d.ts +5 -5
  255. package/dist/lite/model/baseGetApiKeyResponse.d.ts +10 -10
  256. package/dist/lite/model/baseIndexSettings.d.ts +62 -62
  257. package/dist/lite/model/baseSearchParams.d.ts +3 -3
  258. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +122 -122
  259. package/dist/lite/model/baseSearchResponse.d.ts +101 -101
  260. package/dist/lite/model/browseParams.d.ts +3 -3
  261. package/dist/lite/model/browseParamsObject.d.ts +3 -3
  262. package/dist/lite/model/browseResponse.d.ts +4 -4
  263. package/dist/lite/model/builtInOperation.d.ts +11 -11
  264. package/dist/lite/model/builtInOperationType.d.ts +4 -4
  265. package/dist/lite/model/clientMethodProps.d.ts +48 -48
  266. package/dist/lite/model/condition.d.ts +16 -16
  267. package/dist/lite/model/consequence.d.ts +25 -25
  268. package/dist/lite/model/consequenceHide.d.ts +9 -9
  269. package/dist/lite/model/consequenceParams.d.ts +4 -4
  270. package/dist/lite/model/consequenceQuery.d.ts +5 -5
  271. package/dist/lite/model/consequenceQueryObject.d.ts +11 -11
  272. package/dist/lite/model/cursor.d.ts +6 -6
  273. package/dist/lite/model/deleteByParams.d.ts +26 -26
  274. package/dist/lite/model/dictionaryAction.d.ts +4 -4
  275. package/dist/lite/model/dictionaryEntry.d.ts +27 -27
  276. package/dist/lite/model/dictionaryEntryState.d.ts +4 -4
  277. package/dist/lite/model/dictionaryLanguage.d.ts +9 -9
  278. package/dist/lite/model/dictionaryType.d.ts +1 -1
  279. package/dist/lite/model/distinct.d.ts +4 -4
  280. package/dist/lite/model/edit.d.ts +12 -12
  281. package/dist/lite/model/editType.d.ts +4 -4
  282. package/dist/lite/model/errorBase.d.ts +6 -6
  283. package/dist/lite/model/exactOnSingleWordQuery.d.ts +4 -4
  284. package/dist/lite/model/facetFilters.d.ts +5 -5
  285. package/dist/lite/model/facetOrdering.d.ts +12 -12
  286. package/dist/lite/model/facets.d.ts +9 -9
  287. package/dist/lite/model/facetsStats.d.ts +18 -18
  288. package/dist/lite/model/fetchedIndex.d.ts +46 -46
  289. package/dist/lite/model/getApiKeyResponse.d.ts +3 -3
  290. package/dist/lite/model/highlightResult.d.ts +2 -2
  291. package/dist/lite/model/highlightResultOption.d.ts +19 -19
  292. package/dist/lite/model/hit.d.ts +22 -22
  293. package/dist/lite/model/ignorePlurals.d.ts +4 -4
  294. package/dist/lite/model/index.d.ts +107 -107
  295. package/dist/lite/model/indexSettings.d.ts +6 -6
  296. package/dist/lite/model/indexSettingsAsSearchParams.d.ts +156 -156
  297. package/dist/lite/model/languages.d.ts +9 -9
  298. package/dist/lite/model/listIndicesResponse.d.ts +11 -11
  299. package/dist/lite/model/logType.d.ts +1 -1
  300. package/dist/lite/model/matchLevel.d.ts +4 -4
  301. package/dist/lite/model/matchedGeoLocation.d.ts +14 -14
  302. package/dist/lite/model/mixedSearchFilters.d.ts +1 -1
  303. package/dist/lite/model/numericFilters.d.ts +5 -5
  304. package/dist/lite/model/operationType.d.ts +4 -4
  305. package/dist/lite/model/optionalFilters.d.ts +5 -5
  306. package/dist/lite/model/params.d.ts +12 -12
  307. package/dist/lite/model/personalization.d.ts +14 -14
  308. package/dist/lite/model/promote.d.ts +3 -3
  309. package/dist/lite/model/promoteObjectID.d.ts +13 -13
  310. package/dist/lite/model/promoteObjectIDs.d.ts +13 -13
  311. package/dist/lite/model/queryType.d.ts +4 -4
  312. package/dist/lite/model/rankingInfo.d.ts +50 -50
  313. package/dist/lite/model/reRankingApplyFilter.d.ts +5 -5
  314. package/dist/lite/model/removeStopWords.d.ts +4 -4
  315. package/dist/lite/model/removeWordsIfNoResults.d.ts +4 -4
  316. package/dist/lite/model/renderingContent.d.ts +7 -7
  317. package/dist/lite/model/rule.d.ts +29 -29
  318. package/dist/lite/model/scopeType.d.ts +1 -1
  319. package/dist/lite/model/searchForFacets.d.ts +3 -3
  320. package/dist/lite/model/searchForFacetsOptions.d.ts +20 -20
  321. package/dist/lite/model/searchForHits.d.ts +3 -3
  322. package/dist/lite/model/searchForHitsOptions.d.ts +12 -12
  323. package/dist/lite/model/searchHits.d.ts +4 -4
  324. package/dist/lite/model/searchMethodParams.d.ts +6 -6
  325. package/dist/lite/model/searchParams.d.ts +3 -3
  326. package/dist/lite/model/searchParamsObject.d.ts +3 -3
  327. package/dist/lite/model/searchParamsQuery.d.ts +6 -6
  328. package/dist/lite/model/searchParamsString.d.ts +6 -6
  329. package/dist/lite/model/searchQuery.d.ts +3 -3
  330. package/dist/lite/model/searchResponse.d.ts +3 -3
  331. package/dist/lite/model/searchResponses.d.ts +4 -4
  332. package/dist/lite/model/searchStrategy.d.ts +1 -1
  333. package/dist/lite/model/searchSynonymsResponse.d.ts +11 -11
  334. package/dist/lite/model/searchTypeDefault.d.ts +4 -4
  335. package/dist/lite/model/searchTypeFacet.d.ts +4 -4
  336. package/dist/lite/model/snippetResult.d.ts +2 -2
  337. package/dist/lite/model/snippetResultOption.d.ts +11 -11
  338. package/dist/lite/model/sortRemainingBy.d.ts +4 -4
  339. package/dist/lite/model/source.d.ts +13 -13
  340. package/dist/lite/model/standardEntries.d.ts +17 -17
  341. package/dist/lite/model/synonymHit.d.ts +35 -35
  342. package/dist/lite/model/synonymType.d.ts +4 -4
  343. package/dist/lite/model/tagFilters.d.ts +5 -5
  344. package/dist/lite/model/taskStatus.d.ts +1 -1
  345. package/dist/lite/model/timeRange.d.ts +10 -10
  346. package/dist/lite/model/typoTolerance.d.ts +5 -5
  347. package/dist/lite/model/typoToleranceEnum.d.ts +1 -1
  348. package/dist/lite/model/updatedRuleResponse.d.ts +14 -14
  349. package/dist/lite/model/userId.d.ts +21 -21
  350. package/dist/lite/model/value.d.ts +8 -8
  351. package/dist/lite/src/liteClient.d.ts +50 -50
  352. package/lite/builds/browser.ts +1 -1
  353. package/lite/builds/node.ts +1 -1
  354. package/lite/model/acl.ts +1 -1
  355. package/lite/model/action.ts +1 -1
  356. package/lite/model/addApiKeyResponse.ts +1 -1
  357. package/lite/model/advancedSyntaxFeatures.ts +1 -1
  358. package/lite/model/alternativesAsExact.ts +1 -1
  359. package/lite/model/anchoring.ts +1 -1
  360. package/lite/model/apiKey.ts +1 -1
  361. package/lite/model/aroundRadius.ts +1 -1
  362. package/lite/model/aroundRadiusAll.ts +1 -1
  363. package/lite/model/attributeToUpdate.ts +1 -1
  364. package/lite/model/automaticFacetFilter.ts +1 -1
  365. package/lite/model/automaticFacetFilters.ts +1 -1
  366. package/lite/model/baseGetApiKeyResponse.ts +1 -1
  367. package/lite/model/baseIndexSettings.ts +1 -1
  368. package/lite/model/baseSearchParams.ts +1 -1
  369. package/lite/model/baseSearchParamsWithoutQuery.ts +1 -1
  370. package/lite/model/baseSearchResponse.ts +1 -1
  371. package/lite/model/browseParams.ts +1 -1
  372. package/lite/model/browseParamsObject.ts +1 -1
  373. package/lite/model/browseResponse.ts +1 -1
  374. package/lite/model/builtInOperation.ts +1 -1
  375. package/lite/model/builtInOperationType.ts +1 -1
  376. package/lite/model/clientMethodProps.ts +1 -1
  377. package/lite/model/condition.ts +1 -1
  378. package/lite/model/consequence.ts +1 -1
  379. package/lite/model/consequenceHide.ts +1 -1
  380. package/lite/model/consequenceParams.ts +1 -1
  381. package/lite/model/consequenceQuery.ts +1 -1
  382. package/lite/model/consequenceQueryObject.ts +1 -1
  383. package/lite/model/cursor.ts +1 -1
  384. package/lite/model/deleteByParams.ts +1 -1
  385. package/lite/model/dictionaryAction.ts +1 -1
  386. package/lite/model/dictionaryEntry.ts +1 -1
  387. package/lite/model/dictionaryEntryState.ts +1 -1
  388. package/lite/model/dictionaryLanguage.ts +1 -1
  389. package/lite/model/dictionaryType.ts +1 -1
  390. package/lite/model/distinct.ts +1 -1
  391. package/lite/model/edit.ts +1 -1
  392. package/lite/model/editType.ts +1 -1
  393. package/lite/model/errorBase.ts +1 -1
  394. package/lite/model/exactOnSingleWordQuery.ts +1 -1
  395. package/lite/model/facetFilters.ts +1 -1
  396. package/lite/model/facetOrdering.ts +1 -1
  397. package/lite/model/facets.ts +1 -1
  398. package/lite/model/facetsStats.ts +1 -1
  399. package/lite/model/fetchedIndex.ts +1 -1
  400. package/lite/model/getApiKeyResponse.ts +1 -1
  401. package/lite/model/highlightResult.ts +1 -1
  402. package/lite/model/highlightResultOption.ts +1 -1
  403. package/lite/model/hit.ts +1 -1
  404. package/lite/model/ignorePlurals.ts +1 -1
  405. package/lite/model/index.ts +1 -1
  406. package/lite/model/indexSettings.ts +1 -1
  407. package/lite/model/indexSettingsAsSearchParams.ts +1 -1
  408. package/lite/model/languages.ts +1 -1
  409. package/lite/model/listIndicesResponse.ts +1 -1
  410. package/lite/model/logType.ts +1 -1
  411. package/lite/model/matchLevel.ts +1 -1
  412. package/lite/model/matchedGeoLocation.ts +1 -1
  413. package/lite/model/mixedSearchFilters.ts +1 -1
  414. package/lite/model/numericFilters.ts +1 -1
  415. package/lite/model/operationType.ts +1 -1
  416. package/lite/model/optionalFilters.ts +1 -1
  417. package/lite/model/params.ts +1 -1
  418. package/lite/model/personalization.ts +1 -1
  419. package/lite/model/promote.ts +1 -1
  420. package/lite/model/promoteObjectID.ts +1 -1
  421. package/lite/model/promoteObjectIDs.ts +1 -1
  422. package/lite/model/queryType.ts +1 -1
  423. package/lite/model/rankingInfo.ts +1 -1
  424. package/lite/model/reRankingApplyFilter.ts +1 -1
  425. package/lite/model/removeStopWords.ts +1 -1
  426. package/lite/model/removeWordsIfNoResults.ts +1 -1
  427. package/lite/model/renderingContent.ts +1 -1
  428. package/lite/model/rule.ts +1 -1
  429. package/lite/model/scopeType.ts +1 -1
  430. package/lite/model/searchForFacets.ts +1 -1
  431. package/lite/model/searchForFacetsOptions.ts +1 -1
  432. package/lite/model/searchForHits.ts +1 -1
  433. package/lite/model/searchForHitsOptions.ts +1 -1
  434. package/lite/model/searchHits.ts +1 -1
  435. package/lite/model/searchMethodParams.ts +1 -1
  436. package/lite/model/searchParams.ts +1 -1
  437. package/lite/model/searchParamsObject.ts +1 -1
  438. package/lite/model/searchParamsQuery.ts +1 -1
  439. package/lite/model/searchParamsString.ts +1 -1
  440. package/lite/model/searchQuery.ts +1 -1
  441. package/lite/model/searchResponse.ts +1 -1
  442. package/lite/model/searchResponses.ts +1 -1
  443. package/lite/model/searchStrategy.ts +1 -1
  444. package/lite/model/searchSynonymsResponse.ts +1 -1
  445. package/lite/model/searchTypeDefault.ts +1 -1
  446. package/lite/model/searchTypeFacet.ts +1 -1
  447. package/lite/model/snippetResult.ts +1 -1
  448. package/lite/model/snippetResultOption.ts +1 -1
  449. package/lite/model/sortRemainingBy.ts +1 -1
  450. package/lite/model/source.ts +1 -1
  451. package/lite/model/standardEntries.ts +1 -1
  452. package/lite/model/synonymHit.ts +1 -1
  453. package/lite/model/synonymType.ts +1 -1
  454. package/lite/model/tagFilters.ts +1 -1
  455. package/lite/model/taskStatus.ts +1 -1
  456. package/lite/model/timeRange.ts +1 -1
  457. package/lite/model/typoTolerance.ts +1 -1
  458. package/lite/model/typoToleranceEnum.ts +1 -1
  459. package/lite/model/updatedRuleResponse.ts +1 -1
  460. package/lite/model/userId.ts +1 -1
  461. package/lite/model/value.ts +1 -1
  462. package/lite/src/liteClient.ts +2 -2
  463. package/package.json +12 -12
@@ -1,6 +1,6 @@
1
- import type { ClientOptions } from '@algolia/client-common';
2
- import type { LiteClient } from '../src/liteClient';
3
- export { apiClientVersion, LiteClient } from '../src/liteClient';
4
- export * from '../model';
5
- export declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
1
+ import type { ClientOptions } from '@algolia/client-common';
2
+ import type { LiteClient } from '../src/liteClient';
3
+ export { apiClientVersion, LiteClient } from '../src/liteClient';
4
+ export * from '../model';
5
+ export declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
6
6
  //# sourceMappingURL=browser.d.ts.map
@@ -1,6 +1,6 @@
1
- import type { ClientOptions } from '@algolia/client-common';
2
- import type { LiteClient } from '../src/liteClient';
3
- export { apiClientVersion, LiteClient } from '../src/liteClient';
4
- export * from '../model';
5
- export declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
1
+ import type { ClientOptions } from '@algolia/client-common';
2
+ import type { LiteClient } from '../src/liteClient';
3
+ export { apiClientVersion, LiteClient } from '../src/liteClient';
4
+ export * from '../model';
5
+ export declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
6
6
  //# sourceMappingURL=node.d.ts.map
@@ -5,191 +5,191 @@ Object.defineProperty(exports, '__esModule', { value: true });
5
5
  var clientCommon = require('@algolia/client-common');
6
6
  var requesterNodeHttp = require('@algolia/requester-node-http');
7
7
 
8
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
9
- const apiClientVersion = '5.0.0-alpha.53';
10
- function getDefaultHosts(appId) {
11
- return [
12
- {
13
- url: `${appId}-dsn.algolia.net`,
14
- accept: 'read',
15
- protocol: 'https',
16
- },
17
- {
18
- url: `${appId}.algolia.net`,
19
- accept: 'write',
20
- protocol: 'https',
21
- },
22
- ].concat(clientCommon.shuffle([
23
- {
24
- url: `${appId}-1.algolianet.com`,
25
- accept: 'readWrite',
26
- protocol: 'https',
27
- },
28
- {
29
- url: `${appId}-2.algolianet.com`,
30
- accept: 'readWrite',
31
- protocol: 'https',
32
- },
33
- {
34
- url: `${appId}-3.algolianet.com`,
35
- accept: 'readWrite',
36
- protocol: 'https',
37
- },
38
- ]));
39
- }
40
- // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
41
- function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
42
- const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
43
- const transporter = clientCommon.createTransporter({
44
- hosts: getDefaultHosts(appIdOption),
45
- ...options,
46
- algoliaAgent: clientCommon.getAlgoliaAgent({
47
- algoliaAgents,
48
- client: 'Lite',
49
- version: apiClientVersion,
50
- }),
51
- baseHeaders: {
52
- 'content-type': 'text/plain',
53
- ...auth.headers(),
54
- ...options.baseHeaders,
55
- },
56
- baseQueryParameters: {
57
- ...auth.queryParameters(),
58
- ...options.baseQueryParameters,
59
- },
60
- });
61
- return {
62
- transporter,
63
- /**
64
- * The `appId` currently in use.
65
- */
66
- appId: appIdOption,
67
- /**
68
- * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
69
- */
70
- clearCache() {
71
- return Promise.all([
72
- transporter.requestsCache.clear(),
73
- transporter.responsesCache.clear(),
74
- ]).then(() => undefined);
75
- },
76
- /**
77
- * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
78
- */
79
- get _ua() {
80
- return transporter.algoliaAgent.value;
81
- },
82
- /**
83
- * Adds a `segment` to the `x-algolia-agent` sent with every requests.
84
- *
85
- * @param segment - The algolia agent (user-agent) segment to add.
86
- * @param version - The version of the agent.
87
- */
88
- addAlgoliaAgent(segment, version) {
89
- transporter.algoliaAgent.add({ segment, version });
90
- },
91
- /**
92
- * This method allow you to send requests to the Algolia REST API.
93
- *
94
- * @summary Send requests to the Algolia REST API.
95
- * @param post - The post object.
96
- * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
97
- * @param post.parameters - Query parameters to be applied to the current query.
98
- * @param post.body - The parameters to send with the custom request.
99
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
100
- */
101
- post({ path, parameters, body }, requestOptions) {
102
- if (!path) {
103
- throw new Error('Parameter `path` is required when calling `post`.');
104
- }
105
- const requestPath = '/1{path}'.replace('{path}', path);
106
- const headers = {};
107
- const queryParameters = parameters ? parameters : {};
108
- const request = {
109
- method: 'POST',
110
- path: requestPath,
111
- queryParameters,
112
- headers,
113
- data: body ? body : {},
114
- };
115
- return transporter.request(request, requestOptions);
116
- },
117
- /**
118
- * Perform a search operation targeting one or many indices.
119
- *
120
- * @summary Search multiple indices.
121
- * @param searchMethodParams - The `search` requests and strategy.
122
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
123
- */
124
- search(searchMethodParams, requestOptions) {
125
- if (searchMethodParams && Array.isArray(searchMethodParams)) {
126
- const newSignatureRequest = {
127
- requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
128
- if (legacyRequest.type === 'facet') {
129
- return {
130
- ...legacyRequest,
131
- ...params,
132
- type: 'facet',
133
- };
134
- }
135
- return {
136
- ...legacyRequest,
137
- ...params,
138
- facet: undefined,
139
- maxFacetHits: undefined,
140
- facetQuery: undefined,
141
- };
142
- }),
143
- };
144
- // eslint-disable-next-line no-param-reassign
145
- searchMethodParams = newSignatureRequest;
146
- }
147
- if (!searchMethodParams) {
148
- throw new Error('Parameter `searchMethodParams` is required when calling `search`.');
149
- }
150
- if (!searchMethodParams.requests) {
151
- throw new Error('Parameter `searchMethodParams.requests` is required when calling `search`.');
152
- }
153
- const requestPath = '/1/indexes/*/queries';
154
- const headers = {};
155
- const queryParameters = {};
156
- const request = {
157
- method: 'POST',
158
- path: requestPath,
159
- queryParameters,
160
- headers,
161
- data: searchMethodParams,
162
- useReadTransporter: true,
163
- cacheable: true,
164
- };
165
- return transporter.request(request, requestOptions);
166
- },
167
- };
8
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
9
+ const apiClientVersion = '5.0.0-alpha.55';
10
+ function getDefaultHosts(appId) {
11
+ return [
12
+ {
13
+ url: `${appId}-dsn.algolia.net`,
14
+ accept: 'read',
15
+ protocol: 'https',
16
+ },
17
+ {
18
+ url: `${appId}.algolia.net`,
19
+ accept: 'write',
20
+ protocol: 'https',
21
+ },
22
+ ].concat(clientCommon.shuffle([
23
+ {
24
+ url: `${appId}-1.algolianet.com`,
25
+ accept: 'readWrite',
26
+ protocol: 'https',
27
+ },
28
+ {
29
+ url: `${appId}-2.algolianet.com`,
30
+ accept: 'readWrite',
31
+ protocol: 'https',
32
+ },
33
+ {
34
+ url: `${appId}-3.algolianet.com`,
35
+ accept: 'readWrite',
36
+ protocol: 'https',
37
+ },
38
+ ]));
39
+ }
40
+ // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
41
+ function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
42
+ const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
43
+ const transporter = clientCommon.createTransporter({
44
+ hosts: getDefaultHosts(appIdOption),
45
+ ...options,
46
+ algoliaAgent: clientCommon.getAlgoliaAgent({
47
+ algoliaAgents,
48
+ client: 'Lite',
49
+ version: apiClientVersion,
50
+ }),
51
+ baseHeaders: {
52
+ 'content-type': 'text/plain',
53
+ ...auth.headers(),
54
+ ...options.baseHeaders,
55
+ },
56
+ baseQueryParameters: {
57
+ ...auth.queryParameters(),
58
+ ...options.baseQueryParameters,
59
+ },
60
+ });
61
+ return {
62
+ transporter,
63
+ /**
64
+ * The `appId` currently in use.
65
+ */
66
+ appId: appIdOption,
67
+ /**
68
+ * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
69
+ */
70
+ clearCache() {
71
+ return Promise.all([
72
+ transporter.requestsCache.clear(),
73
+ transporter.responsesCache.clear(),
74
+ ]).then(() => undefined);
75
+ },
76
+ /**
77
+ * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
78
+ */
79
+ get _ua() {
80
+ return transporter.algoliaAgent.value;
81
+ },
82
+ /**
83
+ * Adds a `segment` to the `x-algolia-agent` sent with every requests.
84
+ *
85
+ * @param segment - The algolia agent (user-agent) segment to add.
86
+ * @param version - The version of the agent.
87
+ */
88
+ addAlgoliaAgent(segment, version) {
89
+ transporter.algoliaAgent.add({ segment, version });
90
+ },
91
+ /**
92
+ * This method allow you to send requests to the Algolia REST API.
93
+ *
94
+ * @summary Send requests to the Algolia REST API.
95
+ * @param post - The post object.
96
+ * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
97
+ * @param post.parameters - Query parameters to be applied to the current query.
98
+ * @param post.body - The parameters to send with the custom request.
99
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
100
+ */
101
+ post({ path, parameters, body }, requestOptions) {
102
+ if (!path) {
103
+ throw new Error('Parameter `path` is required when calling `post`.');
104
+ }
105
+ const requestPath = '/1{path}'.replace('{path}', path);
106
+ const headers = {};
107
+ const queryParameters = parameters ? parameters : {};
108
+ const request = {
109
+ method: 'POST',
110
+ path: requestPath,
111
+ queryParameters,
112
+ headers,
113
+ data: body ? body : {},
114
+ };
115
+ return transporter.request(request, requestOptions);
116
+ },
117
+ /**
118
+ * Perform a search operation targeting one or many indices.
119
+ *
120
+ * @summary Search multiple indices.
121
+ * @param searchMethodParams - The `search` requests and strategy.
122
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
123
+ */
124
+ search(searchMethodParams, requestOptions) {
125
+ if (searchMethodParams && Array.isArray(searchMethodParams)) {
126
+ const newSignatureRequest = {
127
+ requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
128
+ if (legacyRequest.type === 'facet') {
129
+ return {
130
+ ...legacyRequest,
131
+ ...params,
132
+ type: 'facet',
133
+ };
134
+ }
135
+ return {
136
+ ...legacyRequest,
137
+ ...params,
138
+ facet: undefined,
139
+ maxFacetHits: undefined,
140
+ facetQuery: undefined,
141
+ };
142
+ }),
143
+ };
144
+ // eslint-disable-next-line no-param-reassign
145
+ searchMethodParams = newSignatureRequest;
146
+ }
147
+ if (!searchMethodParams) {
148
+ throw new Error('Parameter `searchMethodParams` is required when calling `search`.');
149
+ }
150
+ if (!searchMethodParams.requests) {
151
+ throw new Error('Parameter `searchMethodParams.requests` is required when calling `search`.');
152
+ }
153
+ const requestPath = '/1/indexes/*/queries';
154
+ const headers = {};
155
+ const queryParameters = {};
156
+ const request = {
157
+ method: 'POST',
158
+ path: requestPath,
159
+ queryParameters,
160
+ headers,
161
+ data: searchMethodParams,
162
+ useReadTransporter: true,
163
+ cacheable: true,
164
+ };
165
+ return transporter.request(request, requestOptions);
166
+ },
167
+ };
168
168
  }
169
169
 
170
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
171
- function liteClient(appId, apiKey, options) {
172
- if (!appId || typeof appId !== 'string') {
173
- throw new Error('`appId` is missing.');
174
- }
175
- if (!apiKey || typeof apiKey !== 'string') {
176
- throw new Error('`apiKey` is missing.');
177
- }
178
- return createLiteClient({
179
- appId,
180
- apiKey,
181
- timeouts: {
182
- connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
183
- read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
184
- write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
185
- },
186
- requester: requesterNodeHttp.createHttpRequester(),
187
- algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
188
- responsesCache: clientCommon.createNullCache(),
189
- requestsCache: clientCommon.createNullCache(),
190
- hostsCache: clientCommon.createMemoryCache(),
191
- ...options,
192
- });
170
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
171
+ function liteClient(appId, apiKey, options) {
172
+ if (!appId || typeof appId !== 'string') {
173
+ throw new Error('`appId` is missing.');
174
+ }
175
+ if (!apiKey || typeof apiKey !== 'string') {
176
+ throw new Error('`apiKey` is missing.');
177
+ }
178
+ return createLiteClient({
179
+ appId,
180
+ apiKey,
181
+ timeouts: {
182
+ connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
183
+ read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
184
+ write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
185
+ },
186
+ requester: requesterNodeHttp.createHttpRequester(),
187
+ algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
188
+ responsesCache: clientCommon.createNullCache(),
189
+ requestsCache: clientCommon.createNullCache(),
190
+ hostsCache: clientCommon.createMemoryCache(),
191
+ ...options,
192
+ });
193
193
  }
194
194
 
195
195
  exports.apiClientVersion = apiClientVersion;