@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,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
- * Whether the whole query string matches or only a part.
5
- */
6
- export type MatchLevel = 'none' | 'partial' | 'full';
@@ -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 MatchedGeoLocation = {
4
- /**
5
- * Latitude of the matched location.
6
- */
7
- lat?: number;
8
-
9
- /**
10
- * Longitude of the matched location.
11
- */
12
- lng?: number;
13
-
14
- /**
15
- * Distance between the matched location and the search location (in meters).
16
- */
17
- distance?: number;
18
- };
package/model/mode.ts DELETED
@@ -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
- * Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
5
- */
6
- export type Mode = 'neuralSearch' | 'keywordSearch';
@@ -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 { Action } from './action';
4
-
5
- export type MultipleBatchRequest = {
6
- action: Action;
7
-
8
- /**
9
- * Operation arguments (varies with specified `action`).
10
- */
11
- body?: Record<string, unknown>;
12
-
13
- /**
14
- * Index name (case-sensitive).
15
- */
16
- indexName: string;
17
- };
@@ -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 MultipleBatchResponse = {
4
- /**
5
- * Task IDs. One for each index.
6
- */
7
- taskID: { [key: string]: number };
8
-
9
- /**
10
- * Unique record identifiers.
11
- */
12
- objectIDs: Array<string>;
13
- };
@@ -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 by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
5
- */
6
- export type NumericFilters = Array<NumericFilters> | string;
@@ -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
- import type { OperationType } from './operationType';
4
- import type { ScopeType } from './scopeType';
5
-
6
- export type OperationIndexParams = {
7
- operation: OperationType;
8
-
9
- /**
10
- * Index name (case-sensitive).
11
- */
12
- destination: string;
13
-
14
- /**
15
- * **Only for copying.** If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules.
16
- */
17
- scope?: Array<ScopeType>;
18
- };
@@ -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
- * Operation to perform on the index.
5
- */
6
- export type OperationType = 'move' | 'copy';
@@ -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
- * Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match. - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
5
- */
6
- export type OptionalFilters = Array<OptionalFilters> | string;
package/model/params.ts DELETED
@@ -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
- import type { AutomaticFacetFilters } from './automaticFacetFilters';
4
- import type { ConsequenceQuery } from './consequenceQuery';
5
- import type { RenderingContent } from './renderingContent';
6
-
7
- /**
8
- * Parameters to apply to this search. You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
9
- */
10
- export type Params = {
11
- query?: ConsequenceQuery;
12
-
13
- automaticFacetFilters?: AutomaticFacetFilters;
14
-
15
- automaticOptionalFacetFilters?: AutomaticFacetFilters;
16
-
17
- renderingContent?: RenderingContent;
18
- };
@@ -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 Personalization = {
4
- /**
5
- * The score of the filters.
6
- */
7
- filtersScore?: number;
8
-
9
- /**
10
- * The score of the ranking.
11
- */
12
- rankingScore?: number;
13
-
14
- /**
15
- * The score of the event.
16
- */
17
- score?: number;
18
- };
package/model/promote.ts DELETED
@@ -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 { PromoteObjectID } from './promoteObjectID';
4
- import type { PromoteObjectIDs } from './promoteObjectIDs';
5
-
6
- export type Promote = PromoteObjectIDs | PromoteObjectID;
@@ -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
- * Record to promote.
5
- */
6
- export type PromoteObjectID = {
7
- /**
8
- * Unique record identifier.
9
- */
10
- objectID: string;
11
-
12
- /**
13
- * Position in the search results where you want to show the promoted records.
14
- */
15
- position: number;
16
- };
@@ -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
- * Records to promote.
5
- */
6
- export type PromoteObjectIDs = {
7
- /**
8
- * Object IDs of the records you want to promote. The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
9
- */
10
- objectIDs: Array<string>;
11
-
12
- /**
13
- * Position in the search results where you want to show the promoted records.
14
- */
15
- position: number;
16
- };
@@ -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
- * Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
5
- */
6
- export type QueryType = 'prefixLast' | 'prefixAll' | 'prefixNone';
package/model/range.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
- * Range object with lower and upper values in meters to define custom ranges.
5
- */
6
- export type Range = {
7
- /**
8
- * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
9
- */
10
- from?: number;
11
-
12
- /**
13
- * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
14
- */
15
- value?: number;
16
- };
@@ -1,68 +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 { MatchedGeoLocation } from './matchedGeoLocation';
4
- import type { Personalization } from './personalization';
5
-
6
- /**
7
- * Object with detailed information about the record\'s ranking.
8
- */
9
- export type RankingInfo = {
10
- /**
11
- * Whether a filter matched the query.
12
- */
13
- filters?: number;
14
-
15
- /**
16
- * Position of the first matched word in the best matching attribute of the record.
17
- */
18
- firstMatchedWord: number;
19
-
20
- /**
21
- * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
22
- */
23
- geoDistance: number;
24
-
25
- /**
26
- * Precision used when computing the geo distance, in meters.
27
- */
28
- geoPrecision?: number;
29
-
30
- matchedGeoLocation?: MatchedGeoLocation;
31
-
32
- personalization?: Personalization;
33
-
34
- /**
35
- * Number of exactly matched words.
36
- */
37
- nbExactWords: number;
38
-
39
- /**
40
- * Number of typos encountered when matching the record.
41
- */
42
- nbTypos: number;
43
-
44
- /**
45
- * Whether the record was promoted by a rule.
46
- */
47
- promoted?: boolean;
48
-
49
- /**
50
- * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
51
- */
52
- proximityDistance?: number;
53
-
54
- /**
55
- * Overall ranking of the record, expressed as a single integer. This attribute is internal.
56
- */
57
- userScore: number;
58
-
59
- /**
60
- * Number of matched words.
61
- */
62
- words?: number;
63
-
64
- /**
65
- * Whether the record is re-ranked.
66
- */
67
- promotedByReRanking?: boolean;
68
- };
@@ -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
- * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
5
- */
6
- export type ReRankingApplyFilter = Array<ReRankingApplyFilter> | string;
package/model/redirect.ts DELETED
@@ -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 { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
4
-
5
- /**
6
- * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
7
- */
8
- export type Redirect = {
9
- index?: Array<RedirectRuleIndexMetadata>;
10
- };
@@ -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
- /**
4
- * Redirect rule data.
5
- */
6
- export type RedirectRuleIndexData = {
7
- ruleObjectID: string;
8
- };
@@ -1,27 +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 { RedirectRuleIndexData } from './redirectRuleIndexData';
4
-
5
- export type RedirectRuleIndexMetadata = {
6
- /**
7
- * Source index for the redirect rule.
8
- */
9
- source: string;
10
-
11
- /**
12
- * Destination index for the redirect rule.
13
- */
14
- dest: string;
15
-
16
- /**
17
- * Reason for the redirect rule.
18
- */
19
- reason: string;
20
-
21
- /**
22
- * Redirect rule status.
23
- */
24
- succeed: boolean;
25
-
26
- data: RedirectRuleIndexData;
27
- };
@@ -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
- /**
4
- * The redirect rule container.
5
- */
6
- export type RedirectURL = {
7
- url?: string;
8
- };
@@ -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 { SupportedLanguage } from './supportedLanguage';
4
-
5
- /**
6
- * Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index.
7
- */
8
- export type RemoveStopWords = Array<SupportedLanguage> | boolean;
@@ -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 RemoveUserIdResponse = {
4
- /**
5
- * Date and time when the object was deleted, in RFC 3339 format.
6
- */
7
- deletedAt: string;
8
- };
@@ -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 removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn\'t return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
5
- */
6
- export type RemoveWordsIfNoResults = 'none' | 'lastWords' | 'firstWords' | 'allOptional';
@@ -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
- import type { FacetOrdering } from './facetOrdering';
4
- import type { RedirectURL } from './redirectURL';
5
- import type { Widgets } from './widgets';
6
-
7
- /**
8
- * Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.
9
- */
10
- export type RenderingContent = {
11
- facetOrdering?: FacetOrdering;
12
-
13
- redirect?: RedirectURL;
14
-
15
- widgets?: Widgets;
16
- };
@@ -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 { BatchResponse } from './batchResponse';
4
- import type { UpdatedAtResponse } from './updatedAtResponse';
5
-
6
- export type ReplaceAllObjectsResponse = {
7
- copyOperationResponse: UpdatedAtResponse;
8
-
9
- /**
10
- * The response of the `batch` request(s).
11
- */
12
- batchResponses: Array<BatchResponse>;
13
-
14
- moveOperationResponse: UpdatedAtResponse;
15
- };
@@ -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 ReplaceSourceResponse = {
4
- /**
5
- * Date and time when the object was updated, in RFC 3339 format.
6
- */
7
- updatedAt: string;
8
- };
package/model/rule.ts DELETED
@@ -1,37 +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 { Condition } from './condition';
4
- import type { Consequence } from './consequence';
5
- import type { TimeRange } from './timeRange';
6
-
7
- /**
8
- * Rule object.
9
- */
10
- export type Rule = {
11
- /**
12
- * Unique identifier of a rule object.
13
- */
14
- objectID: string;
15
-
16
- /**
17
- * Conditions that trigger a rule. Some consequences require specific conditions or don\'t require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
18
- */
19
- conditions?: Array<Condition>;
20
-
21
- consequence?: Consequence;
22
-
23
- /**
24
- * Description of the rule\'s purpose to help you distinguish between different rules.
25
- */
26
- description?: string;
27
-
28
- /**
29
- * Whether the rule is active.
30
- */
31
- enabled?: boolean;
32
-
33
- /**
34
- * Time periods when the rule is active.
35
- */
36
- validity?: Array<TimeRange>;
37
- };
@@ -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 SaveObjectResponse = {
4
- /**
5
- * Date and time when the object was created, in RFC 3339 format.
6
- */
7
- createdAt: string;
8
-
9
- /**
10
- * 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`.
11
- */
12
- taskID: number;
13
-
14
- /**
15
- * Unique record identifier.
16
- */
17
- objectID?: string;
18
- };
@@ -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 SaveSynonymResponse = {
4
- /**
5
- * 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`.
6
- */
7
- taskID: number;
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 synonym object.
16
- */
17
- id: string;
18
- };
@@ -1,3 +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 ScopeType = 'settings' | 'synonyms' | 'rules';
@@ -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 { SupportedLanguage } from './supportedLanguage';
4
-
5
- /**
6
- * Search parameter.
7
- */
8
- export type SearchDictionaryEntriesParams = {
9
- /**
10
- * Search query.
11
- */
12
- query: string;
13
-
14
- /**
15
- * Page of search results to retrieve.
16
- */
17
- page?: number;
18
-
19
- /**
20
- * Number of hits per page.
21
- */
22
- hitsPerPage?: number;
23
-
24
- language?: SupportedLanguage;
25
- };
@@ -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 { DictionaryEntry } from './dictionaryEntry';
4
-
5
- export type SearchDictionaryEntriesResponse = {
6
- /**
7
- * Dictionary entries matching the search criteria.
8
- */
9
- hits: Array<DictionaryEntry>;
10
-
11
- /**
12
- * 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.
13
- */
14
- page: number;
15
-
16
- /**
17
- * Number of results (hits).
18
- */
19
- nbHits: number;
20
-
21
- /**
22
- * Number of pages of results.
23
- */
24
- nbPages: number;
25
- };
@@ -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 SearchForFacetValuesRequest = {
4
- /**
5
- * Search parameters as a URL-encoded query string.
6
- */
7
- params?: string;
8
-
9
- /**
10
- * Text to search inside the facet\'s values.
11
- */
12
- facetQuery?: string;
13
-
14
- /**
15
- * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
16
- */
17
- maxFacetHits?: number;
18
- };
@@ -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 { FacetHits } from './facetHits';
4
-
5
- export type SearchForFacetValuesResponse = {
6
- /**
7
- * Matching facet values.
8
- */
9
- facetHits: Array<FacetHits>;
10
-
11
- /**
12
- * Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
13
- */
14
- exhaustiveFacetsCount: boolean;
15
-
16
- /**
17
- * Time the server took to process the request, in milliseconds.
18
- */
19
- processingTimeMS?: number;
20
- };
@@ -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 { SearchForFacetsOptions } from './searchForFacetsOptions';
4
- import type { SearchParams } from './searchParams';
5
-
6
- export type SearchForFacets = SearchParams & SearchForFacetsOptions;
@@ -1,27 +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 { SearchTypeFacet } from './searchTypeFacet';
4
-
5
- export type SearchForFacetsOptions = {
6
- /**
7
- * Facet name.
8
- */
9
- facet: string;
10
-
11
- /**
12
- * Index name (case-sensitive).
13
- */
14
- indexName: string;
15
-
16
- /**
17
- * Text to search inside the facet\'s values.
18
- */
19
- facetQuery?: string;
20
-
21
- /**
22
- * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
23
- */
24
- maxFacetHits?: number;
25
-
26
- type: SearchTypeFacet;
27
- };
@@ -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 { SearchForHitsOptions } from './searchForHitsOptions';
4
- import type { SearchParams } from './searchParams';
5
-
6
- export type SearchForHits = SearchParams & SearchForHitsOptions;