@algolia/client-search 5.9.0 → 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,12 +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 { SearchTypeDefault } from './searchTypeDefault';
4
-
5
- export type SearchForHitsOptions = {
6
- /**
7
- * Index name (case-sensitive).
8
- */
9
- indexName: string;
10
-
11
- type?: SearchTypeDefault;
12
- } & { facet?: never; maxFacetHits?: never; facetQuery?: never };
@@ -1,20 +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 { Hit } from './hit';
4
-
5
- export type SearchHits<T = Record<string, any>> = Record<string, any> & {
6
- /**
7
- * Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
8
- */
9
- hits: Hit<T>[];
10
-
11
- /**
12
- * Search query.
13
- */
14
- query: string;
15
-
16
- /**
17
- * URL-encoded string of all search parameters.
18
- */
19
- params: string;
20
- };
@@ -1,10 +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 { SearchQuery } from './searchQuery';
4
- import type { SearchStrategy } from './searchStrategy';
5
-
6
- export type SearchMethodParams = {
7
- requests: Array<SearchQuery>;
8
-
9
- strategy?: SearchStrategy;
10
- };
@@ -1,23 +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 SearchPagination = {
4
- /**
5
- * Page of search results to retrieve.
6
- */
7
- page?: number;
8
-
9
- /**
10
- * Number of results (hits).
11
- */
12
- nbHits?: number;
13
-
14
- /**
15
- * Number of pages of results.
16
- */
17
- nbPages?: number;
18
-
19
- /**
20
- * Number of hits per page.
21
- */
22
- hitsPerPage?: number;
23
- };
@@ -1,6 +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 { SearchParamsObject } from './searchParamsObject';
4
- import type { SearchParamsString } from './searchParamsString';
5
-
6
- export type SearchParams = SearchParamsString | SearchParamsObject;
@@ -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 { BaseSearchParams } from './baseSearchParams';
4
- import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
5
-
6
- /**
7
- * Each parameter value, including the `query` must not be larger than 512 bytes.
8
- */
9
- export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
@@ -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 SearchParamsQuery = {
4
- /**
5
- * Search query.
6
- */
7
- query?: string;
8
- };
@@ -1,11 +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
- * Search parameters as query string.
5
- */
6
- export type SearchParamsString = {
7
- /**
8
- * Search parameters as a URL-encoded query string.
9
- */
10
- params?: string;
11
- };
@@ -1,6 +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 { SearchForFacets } from './searchForFacets';
4
- import type { SearchForHits } from './searchForHits';
5
-
6
- export type SearchQuery = SearchForHits | SearchForFacets;
@@ -1,7 +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 { BaseSearchResponse } from './baseSearchResponse';
4
- import type { SearchHits } from './searchHits';
5
- import type { SearchPagination } from './searchPagination';
6
-
7
- export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchPagination & SearchHits<T>;
@@ -1,7 +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 { SearchResult } from './searchResult';
4
-
5
- export type SearchResponses<T = Record<string, any>> = {
6
- results: SearchResult<T>[];
7
- };
@@ -1,6 +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 { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
4
- import type { SearchResponse } from './searchResponse';
5
-
6
- export type SearchResult<T = Record<string, any>> = SearchResponse<T> | SearchForFacetValuesResponse;
@@ -1,35 +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 { Anchoring } from './anchoring';
4
-
5
- /**
6
- * Rules search parameters.
7
- */
8
- export type SearchRulesParams = {
9
- /**
10
- * Search query for rules.
11
- */
12
- query?: string;
13
-
14
- anchoring?: Anchoring;
15
-
16
- /**
17
- * Only return rules that match the context (exact match).
18
- */
19
- context?: string;
20
-
21
- /**
22
- * Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
23
- */
24
- page?: number;
25
-
26
- /**
27
- * Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
28
- */
29
- hitsPerPage?: number;
30
-
31
- /**
32
- * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
33
- */
34
- enabled?: boolean | null;
35
- };
@@ -1,25 +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 { Rule } from './rule';
4
-
5
- export type SearchRulesResponse = {
6
- /**
7
- * Rules that matched the search criteria.
8
- */
9
- hits: Array<Rule>;
10
-
11
- /**
12
- * Number of rules that matched the search criteria.
13
- */
14
- nbHits: number;
15
-
16
- /**
17
- * Current page.
18
- */
19
- page: number;
20
-
21
- /**
22
- * Number of pages.
23
- */
24
- nbPages: number;
25
- };
@@ -1,6 +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
- * Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
5
- */
6
- export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
@@ -1,22 +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 { SynonymType } from './synonymType';
4
-
5
- export type SearchSynonymsParams = {
6
- /**
7
- * Search query.
8
- */
9
- query?: string;
10
-
11
- type?: SynonymType;
12
-
13
- /**
14
- * Page of search results to retrieve.
15
- */
16
- page?: number;
17
-
18
- /**
19
- * Number of hits per page.
20
- */
21
- hitsPerPage?: number;
22
- };
@@ -1,15 +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 { SynonymHit } from './synonymHit';
4
-
5
- export type SearchSynonymsResponse = Record<string, any> & {
6
- /**
7
- * Matching synonyms.
8
- */
9
- hits: Array<SynonymHit>;
10
-
11
- /**
12
- * Number of results (hits).
13
- */
14
- nbHits: number;
15
- };
@@ -1,6 +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
- * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
5
- */
6
- export type SearchTypeDefault = 'default';
@@ -1,6 +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
- * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
5
- */
6
- export type SearchTypeFacet = 'facet';
@@ -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
- * OK
5
- */
6
- export type SearchUserIdsParams = {
7
- /**
8
- * Query to search. The search is a prefix search with [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) enabled. An empty query will retrieve all users.
9
- */
10
- query: string;
11
-
12
- /**
13
- * Cluster name.
14
- */
15
- clusterName?: string;
16
-
17
- /**
18
- * Page of search results to retrieve.
19
- */
20
- page?: number;
21
-
22
- /**
23
- * Number of hits per page.
24
- */
25
- hitsPerPage?: number;
26
- };
@@ -1,33 +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 { UserHit } from './userHit';
4
-
5
- /**
6
- * userIDs data.
7
- */
8
- export type SearchUserIdsResponse = {
9
- /**
10
- * User objects that match the query.
11
- */
12
- hits: Array<UserHit>;
13
-
14
- /**
15
- * Number of results (hits).
16
- */
17
- nbHits: number;
18
-
19
- /**
20
- * Page of search results to retrieve.
21
- */
22
- page: number;
23
-
24
- /**
25
- * Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
26
- */
27
- hitsPerPage: number;
28
-
29
- /**
30
- * Date and time when the object was updated, in RFC 3339 format.
31
- */
32
- updatedAt: string;
33
- };
@@ -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 { SearchParamsObject } from './searchParamsObject';
4
-
5
- export type SecuredApiKeyRestrictions = {
6
- searchParams?: SearchParamsObject;
7
-
8
- /**
9
- * Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
10
- */
11
- filters?: string;
12
-
13
- /**
14
- * Timestamp when the secured API key expires, measured in seconds since the Unix epoch.
15
- */
16
- validUntil?: number;
17
-
18
- /**
19
- * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
20
- */
21
- restrictIndices?: Array<string>;
22
-
23
- /**
24
- * IP network that are allowed to use this key. You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
25
- */
26
- restrictSources?: string;
27
-
28
- /**
29
- * Pseudonymous user identifier to restrict usage of this API key to specific users. By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
30
- */
31
- userToken?: string;
32
- };
@@ -1,11 +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
- * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
5
- */
6
- export type SemanticSearch = {
7
- /**
8
- * Indices from which to collect click and conversion events. If null, the current index and all its replicas are used.
9
- */
10
- eventSources?: Array<string> | null;
11
- };
@@ -1,6 +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 { IndexSettings } from './indexSettings';
4
- import type { WithPrimary } from './withPrimary';
5
-
6
- export type SettingsResponse = IndexSettings & WithPrimary;
@@ -1,5 +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 { SnippetResultOption } from './snippetResultOption';
4
-
5
- export type SnippetResult = SnippetResultOption | { [key: string]: SnippetResult } | Array<SnippetResult>;
@@ -1,15 +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 { MatchLevel } from './matchLevel';
4
-
5
- /**
6
- * Snippets that show the context around a matching search query.
7
- */
8
- export type SnippetResultOption = {
9
- /**
10
- * Highlighted attribute value, including HTML tags.
11
- */
12
- value: string;
13
-
14
- matchLevel: MatchLevel;
15
- };
@@ -1,6 +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
- * Order of facet values that aren\'t explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don\'t show facet values that aren\'t explicitly positioned.
5
- */
6
- export type SortRemainingBy = 'count' | 'alpha' | 'hidden';
package/model/source.ts DELETED
@@ -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
- * Source.
5
- */
6
- export type Source = {
7
- /**
8
- * IP address range of the source.
9
- */
10
- source: string;
11
-
12
- /**
13
- * Source description.
14
- */
15
- description?: 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
- * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
5
- */
6
- export type StandardEntries = {
7
- /**
8
- * Key-value pair of a language ISO code and a boolean value.
9
- */
10
- plurals?: { [key: string]: boolean } | null;
11
-
12
- /**
13
- * Key-value pair of a language ISO code and a boolean value.
14
- */
15
- stopwords?: { [key: string]: boolean } | null;
16
-
17
- /**
18
- * Key-value pair of a language ISO code and a boolean value.
19
- */
20
- compounds?: { [key: string]: boolean } | null;
21
- };
@@ -1,74 +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
- * ISO code for a supported language.
5
- */
6
- export type SupportedLanguage =
7
- | 'af'
8
- | 'ar'
9
- | 'az'
10
- | 'bg'
11
- | 'bn'
12
- | 'ca'
13
- | 'cs'
14
- | 'cy'
15
- | 'da'
16
- | 'de'
17
- | 'el'
18
- | 'en'
19
- | 'eo'
20
- | 'es'
21
- | 'et'
22
- | 'eu'
23
- | 'fa'
24
- | 'fi'
25
- | 'fo'
26
- | 'fr'
27
- | 'ga'
28
- | 'gl'
29
- | 'he'
30
- | 'hi'
31
- | 'hu'
32
- | 'hy'
33
- | 'id'
34
- | 'is'
35
- | 'it'
36
- | 'ja'
37
- | 'ka'
38
- | 'kk'
39
- | 'ko'
40
- | 'ku'
41
- | 'ky'
42
- | 'lt'
43
- | 'lv'
44
- | 'mi'
45
- | 'mn'
46
- | 'mr'
47
- | 'ms'
48
- | 'mt'
49
- | 'nb'
50
- | 'nl'
51
- | 'no'
52
- | 'ns'
53
- | 'pl'
54
- | 'ps'
55
- | 'pt'
56
- | 'pt-br'
57
- | 'qu'
58
- | 'ro'
59
- | 'ru'
60
- | 'sk'
61
- | 'sq'
62
- | 'sv'
63
- | 'sw'
64
- | 'ta'
65
- | 'te'
66
- | 'th'
67
- | 'tl'
68
- | 'tn'
69
- | 'tr'
70
- | 'tt'
71
- | 'uk'
72
- | 'ur'
73
- | 'uz'
74
- | 'zh';
@@ -1,45 +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 { SynonymType } from './synonymType';
4
-
5
- /**
6
- * Synonym object.
7
- */
8
- export type SynonymHit = {
9
- /**
10
- * Unique identifier of a synonym object.
11
- */
12
- objectID: string;
13
-
14
- type: SynonymType;
15
-
16
- /**
17
- * Words or phrases considered equivalent.
18
- */
19
- synonyms?: Array<string>;
20
-
21
- /**
22
- * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
23
- */
24
- input?: string;
25
-
26
- /**
27
- * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
28
- */
29
- word?: string;
30
-
31
- /**
32
- * Words to be matched in records.
33
- */
34
- corrections?: Array<string>;
35
-
36
- /**
37
- * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
38
- */
39
- placeholder?: string;
40
-
41
- /**
42
- * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
43
- */
44
- replacements?: Array<string>;
45
- };
@@ -1,6 +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
- * Synonym type.
5
- */
6
- export type SynonymType = 'synonym' | 'onewaysynonym' | 'altcorrection1' | 'altcorrection2' | 'placeholder';
@@ -1,6 +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
- * Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
5
- */
6
- export type TagFilters = Array<TagFilters> | string;
@@ -1,6 +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
- * Task status, `published` if the task is completed, `notPublished` otherwise.
5
- */
6
- export type TaskStatus = 'published' | 'notPublished';
@@ -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 TimeRange = {
4
- /**
5
- * When the rule should start to be active, in Unix epoch time.
6
- */
7
- from: number;
8
-
9
- /**
10
- * When the rule should stop to be active, in Unix epoch time.
11
- */
12
- until: number;
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
- import type { TypoToleranceEnum } from './typoToleranceEnum';
4
-
5
- /**
6
- * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
7
- */
8
- export type TypoTolerance = boolean | TypoToleranceEnum;
@@ -1,6 +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
- * - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
5
- */
6
- export type TypoToleranceEnum = 'min' | 'strict';