@algolia/client-search 5.9.1 → 5.10.0-beta.1

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 (202) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +9 -9
  3. package/dist/builds/browser.js +1 -1
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +1 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +1 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +1 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +9 -9
  15. package/dist/node.d.cts +9 -9
  16. package/dist/node.d.ts +9 -9
  17. package/dist/src/searchClient.cjs +1 -1
  18. package/dist/src/searchClient.cjs.map +1 -1
  19. package/dist/src/searchClient.js +1 -1
  20. package/dist/src/searchClient.js.map +1 -1
  21. package/package.json +6 -7
  22. package/model/acl.ts +0 -21
  23. package/model/action.ts +0 -13
  24. package/model/addApiKeyResponse.ts +0 -13
  25. package/model/advancedSyntaxFeatures.ts +0 -3
  26. package/model/alternativesAsExact.ts +0 -3
  27. package/model/anchoring.ts +0 -6
  28. package/model/apiKey.ts +0 -48
  29. package/model/apiKeyOperation.ts +0 -3
  30. package/model/aroundPrecision.ts +0 -8
  31. package/model/aroundRadius.ts +0 -8
  32. package/model/aroundRadiusAll.ts +0 -6
  33. package/model/assignUserIdParams.ts +0 -11
  34. package/model/attributeToUpdate.ts +0 -5
  35. package/model/automaticFacetFilter.ts +0 -21
  36. package/model/automaticFacetFilters.ts +0 -8
  37. package/model/banner.ts +0 -13
  38. package/model/bannerImage.ts +0 -12
  39. package/model/bannerImageUrl.ts +0 -8
  40. package/model/bannerLink.ts +0 -8
  41. package/model/baseGetApiKeyResponse.ts +0 -13
  42. package/model/baseIndexSettings.ts +0 -90
  43. package/model/baseSearchParams.ts +0 -6
  44. package/model/baseSearchParamsWithoutQuery.ts +0 -148
  45. package/model/baseSearchResponse.ts +0 -129
  46. package/model/batchAssignUserIdsParams.ts +0 -16
  47. package/model/batchDictionaryEntriesParams.ts +0 -18
  48. package/model/batchDictionaryEntriesRequest.ts +0 -10
  49. package/model/batchParams.ts +0 -10
  50. package/model/batchRequest.ts +0 -12
  51. package/model/batchResponse.ts +0 -13
  52. package/model/batchWriteParams.ts +0 -10
  53. package/model/booleanString.ts +0 -3
  54. package/model/browsePagination.ts +0 -23
  55. package/model/browseParams.ts +0 -7
  56. package/model/browseParamsObject.ts +0 -6
  57. package/model/browseResponse.ts +0 -8
  58. package/model/builtInOperation.ts +0 -13
  59. package/model/builtInOperationType.ts +0 -13
  60. package/model/builtInOperationValue.ts +0 -3
  61. package/model/clientMethodProps.ts +0 -870
  62. package/model/condition.ts +0 -27
  63. package/model/consequence.ts +0 -32
  64. package/model/consequenceHide.ts +0 -11
  65. package/model/consequenceParams.ts +0 -7
  66. package/model/consequenceQuery.ts +0 -8
  67. package/model/consequenceQueryObject.ts +0 -15
  68. package/model/createdAtResponse.ts +0 -11
  69. package/model/cursor.ts +0 -8
  70. package/model/deleteApiKeyResponse.ts +0 -8
  71. package/model/deleteByParams.ts +0 -36
  72. package/model/deleteSourceResponse.ts +0 -8
  73. package/model/deletedAtResponse.ts +0 -16
  74. package/model/dictionaryAction.ts +0 -6
  75. package/model/dictionaryEntry.ts +0 -36
  76. package/model/dictionaryEntryState.ts +0 -6
  77. package/model/dictionaryEntryType.ts +0 -6
  78. package/model/dictionaryLanguage.ts +0 -11
  79. package/model/dictionarySettingsParams.ts +0 -10
  80. package/model/dictionaryType.ts +0 -3
  81. package/model/distinct.ts +0 -6
  82. package/model/edit.ts +0 -17
  83. package/model/editType.ts +0 -6
  84. package/model/errorBase.ts +0 -8
  85. package/model/exactOnSingleWordQuery.ts +0 -6
  86. package/model/exhaustive.ts +0 -31
  87. package/model/facetFilters.ts +0 -6
  88. package/model/facetHits.ts +0 -18
  89. package/model/facetOrdering.ts +0 -16
  90. package/model/facetStats.ts +0 -23
  91. package/model/facets.ts +0 -11
  92. package/model/fetchedIndex.ts +0 -63
  93. package/model/getApiKeyResponse.ts +0 -6
  94. package/model/getDictionarySettingsResponse.ts +0 -7
  95. package/model/getLogsResponse.ts +0 -7
  96. package/model/getObjectsParams.ts +0 -10
  97. package/model/getObjectsRequest.ts +0 -21
  98. package/model/getObjectsResponse.ts +0 -8
  99. package/model/getTaskResponse.ts +0 -7
  100. package/model/getTopUserIdsResponse.ts +0 -13
  101. package/model/hasPendingMappingsResponse.ts +0 -13
  102. package/model/highlightResult.ts +0 -5
  103. package/model/highlightResultOption.ts +0 -25
  104. package/model/hit.ts +0 -29
  105. package/model/ignorePlurals.ts +0 -9
  106. package/model/index.ts +0 -182
  107. package/model/indexSettings.ts +0 -9
  108. package/model/indexSettingsAsSearchParams.ts +0 -205
  109. package/model/languages.ts +0 -14
  110. package/model/listApiKeysResponse.ts +0 -10
  111. package/model/listClustersResponse.ts +0 -11
  112. package/model/listIndicesResponse.ts +0 -15
  113. package/model/listUserIdsResponse.ts +0 -13
  114. package/model/log.ts +0 -80
  115. package/model/logQuery.ts +0 -18
  116. package/model/logType.ts +0 -3
  117. package/model/matchLevel.ts +0 -6
  118. package/model/matchedGeoLocation.ts +0 -18
  119. package/model/mode.ts +0 -6
  120. package/model/multipleBatchRequest.ts +0 -17
  121. package/model/multipleBatchResponse.ts +0 -13
  122. package/model/numericFilters.ts +0 -6
  123. package/model/operationIndexParams.ts +0 -18
  124. package/model/operationType.ts +0 -6
  125. package/model/optionalFilters.ts +0 -6
  126. package/model/params.ts +0 -18
  127. package/model/personalization.ts +0 -18
  128. package/model/promote.ts +0 -6
  129. package/model/promoteObjectID.ts +0 -16
  130. package/model/promoteObjectIDs.ts +0 -16
  131. package/model/queryType.ts +0 -6
  132. package/model/range.ts +0 -16
  133. package/model/rankingInfo.ts +0 -68
  134. package/model/reRankingApplyFilter.ts +0 -6
  135. package/model/redirect.ts +0 -10
  136. package/model/redirectRuleIndexData.ts +0 -8
  137. package/model/redirectRuleIndexMetadata.ts +0 -27
  138. package/model/redirectURL.ts +0 -8
  139. package/model/removeStopWords.ts +0 -8
  140. package/model/removeUserIdResponse.ts +0 -8
  141. package/model/removeWordsIfNoResults.ts +0 -6
  142. package/model/renderingContent.ts +0 -16
  143. package/model/replaceAllObjectsResponse.ts +0 -15
  144. package/model/replaceSourceResponse.ts +0 -8
  145. package/model/rule.ts +0 -37
  146. package/model/saveObjectResponse.ts +0 -18
  147. package/model/saveSynonymResponse.ts +0 -18
  148. package/model/scopeType.ts +0 -3
  149. package/model/searchDictionaryEntriesParams.ts +0 -25
  150. package/model/searchDictionaryEntriesResponse.ts +0 -25
  151. package/model/searchForFacetValuesRequest.ts +0 -18
  152. package/model/searchForFacetValuesResponse.ts +0 -20
  153. package/model/searchForFacets.ts +0 -6
  154. package/model/searchForFacetsOptions.ts +0 -27
  155. package/model/searchForHits.ts +0 -6
  156. package/model/searchForHitsOptions.ts +0 -12
  157. package/model/searchHits.ts +0 -20
  158. package/model/searchMethodParams.ts +0 -10
  159. package/model/searchPagination.ts +0 -23
  160. package/model/searchParams.ts +0 -6
  161. package/model/searchParamsObject.ts +0 -9
  162. package/model/searchParamsQuery.ts +0 -8
  163. package/model/searchParamsString.ts +0 -11
  164. package/model/searchQuery.ts +0 -6
  165. package/model/searchResponse.ts +0 -7
  166. package/model/searchResponses.ts +0 -7
  167. package/model/searchResult.ts +0 -6
  168. package/model/searchRulesParams.ts +0 -35
  169. package/model/searchRulesResponse.ts +0 -25
  170. package/model/searchStrategy.ts +0 -6
  171. package/model/searchSynonymsParams.ts +0 -22
  172. package/model/searchSynonymsResponse.ts +0 -15
  173. package/model/searchTypeDefault.ts +0 -6
  174. package/model/searchTypeFacet.ts +0 -6
  175. package/model/searchUserIdsParams.ts +0 -26
  176. package/model/searchUserIdsResponse.ts +0 -33
  177. package/model/securedApiKeyRestrictions.ts +0 -32
  178. package/model/semanticSearch.ts +0 -11
  179. package/model/settingsResponse.ts +0 -6
  180. package/model/snippetResult.ts +0 -5
  181. package/model/snippetResultOption.ts +0 -15
  182. package/model/sortRemainingBy.ts +0 -6
  183. package/model/source.ts +0 -16
  184. package/model/standardEntries.ts +0 -21
  185. package/model/supportedLanguage.ts +0 -74
  186. package/model/synonymHit.ts +0 -45
  187. package/model/synonymType.ts +0 -6
  188. package/model/tagFilters.ts +0 -6
  189. package/model/taskStatus.ts +0 -6
  190. package/model/timeRange.ts +0 -13
  191. package/model/typoTolerance.ts +0 -8
  192. package/model/typoToleranceEnum.ts +0 -6
  193. package/model/updateApiKeyResponse.ts +0 -13
  194. package/model/updatedAtResponse.ts +0 -16
  195. package/model/updatedAtWithObjectIdResponse.ts +0 -21
  196. package/model/updatedRuleResponse.ts +0 -18
  197. package/model/userHighlightResult.ts +0 -9
  198. package/model/userHit.ts +0 -32
  199. package/model/userId.ts +0 -26
  200. package/model/value.ts +0 -17
  201. package/model/widgets.ts +0 -13
  202. package/model/withPrimary.ts +0 -8
@@ -1,13 +0,0 @@
1
- // 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.
2
-
3
- export type UpdateApiKeyResponse = {
4
- /**
5
- * API key.
6
- */
7
- key: string;
8
-
9
- /**
10
- * Date and time when the object was updated, in RFC 3339 format.
11
- */
12
- updatedAt: string;
13
- };
@@ -1,16 +0,0 @@
1
- // 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.
2
-
3
- /**
4
- * Response, taskID, and update timestamp.
5
- */
6
- export type UpdatedAtResponse = {
7
- /**
8
- * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
9
- */
10
- taskID: number;
11
-
12
- /**
13
- * Date and time when the object was updated, in RFC 3339 format.
14
- */
15
- updatedAt: string;
16
- };
@@ -1,21 +0,0 @@
1
- // 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.
2
-
3
- /**
4
- * Response, taskID, unique object identifier, and an update timestamp.
5
- */
6
- export type UpdatedAtWithObjectIdResponse = {
7
- /**
8
- * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
9
- */
10
- taskID?: number;
11
-
12
- /**
13
- * Date and time when the object was updated, in RFC 3339 format.
14
- */
15
- updatedAt?: string;
16
-
17
- /**
18
- * Unique record identifier.
19
- */
20
- objectID?: string;
21
- };
@@ -1,18 +0,0 @@
1
- // 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.
2
-
3
- export type UpdatedRuleResponse = {
4
- /**
5
- * Unique identifier of a rule object.
6
- */
7
- objectID: string;
8
-
9
- /**
10
- * Date and time when the object was updated, in RFC 3339 format.
11
- */
12
- updatedAt: string;
13
-
14
- /**
15
- * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
16
- */
17
- taskID: number;
18
- };
@@ -1,9 +0,0 @@
1
- // 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.
2
-
3
- import type { HighlightResult } from './highlightResult';
4
-
5
- export type UserHighlightResult = {
6
- userID: HighlightResult;
7
-
8
- clusterName: HighlightResult;
9
- };
package/model/userHit.ts DELETED
@@ -1,32 +0,0 @@
1
- // 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.
2
-
3
- import type { UserHighlightResult } from './userHighlightResult';
4
-
5
- export type UserHit = {
6
- /**
7
- * Unique identifier of the user who makes the search request.
8
- */
9
- userID: string;
10
-
11
- /**
12
- * Cluster name.
13
- */
14
- clusterName: string;
15
-
16
- /**
17
- * Number of records in the cluster.
18
- */
19
- nbRecords: number;
20
-
21
- /**
22
- * Data size taken by all the users assigned to the cluster.
23
- */
24
- dataSize: number;
25
-
26
- /**
27
- * userID of the requested user. Same as userID.
28
- */
29
- objectID: string;
30
-
31
- _highlightResult: UserHighlightResult;
32
- };
package/model/userId.ts DELETED
@@ -1,26 +0,0 @@
1
- // 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.
2
-
3
- /**
4
- * Unique user ID.
5
- */
6
- export type UserId = {
7
- /**
8
- * Unique identifier of the user who makes the search request.
9
- */
10
- userID: string;
11
-
12
- /**
13
- * Cluster to which the user is assigned.
14
- */
15
- clusterName: string;
16
-
17
- /**
18
- * Number of records belonging to the user.
19
- */
20
- nbRecords: number;
21
-
22
- /**
23
- * Data size used by the user.
24
- */
25
- dataSize: number;
26
- };
package/model/value.ts DELETED
@@ -1,17 +0,0 @@
1
- // 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.
2
-
3
- import type { SortRemainingBy } from './sortRemainingBy';
4
-
5
- export type Value = {
6
- /**
7
- * Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
8
- */
9
- order?: Array<string>;
10
-
11
- sortRemainingBy?: SortRemainingBy;
12
-
13
- /**
14
- * Hide facet values.
15
- */
16
- hide?: Array<string>;
17
- };
package/model/widgets.ts DELETED
@@ -1,13 +0,0 @@
1
- // 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.
2
-
3
- import type { Banner } from './banner';
4
-
5
- /**
6
- * widgets returned from any rules that are applied to the current search.
7
- */
8
- export type Widgets = {
9
- /**
10
- * banners defined in the merchandising studio for the given search.
11
- */
12
- banners?: Array<Banner>;
13
- };
@@ -1,8 +0,0 @@
1
- // 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.
2
-
3
- export type WithPrimary = {
4
- /**
5
- * Replica indices only: the name of the primary index for this replica.
6
- */
7
- primary?: string;
8
- };