@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,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 { Anchoring } from './anchoring';
4
-
5
- export type Condition = {
6
- /**
7
- * Query pattern that triggers the rule. You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
8
- */
9
- pattern?: string;
10
-
11
- anchoring?: Anchoring;
12
-
13
- /**
14
- * Whether the pattern should match plurals, synonyms, and typos.
15
- */
16
- alternatives?: boolean;
17
-
18
- /**
19
- * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
20
- */
21
- context?: string;
22
-
23
- /**
24
- * Filters that trigger the rule. You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
25
- */
26
- filters?: string;
27
- };
@@ -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 { ConsequenceHide } from './consequenceHide';
4
- import type { ConsequenceParams } from './consequenceParams';
5
- import type { Promote } from './promote';
6
-
7
- /**
8
- * Effect of the rule. For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
9
- */
10
- export type Consequence = {
11
- params?: ConsequenceParams;
12
-
13
- /**
14
- * Records you want to pin to a specific position in the search results. You can promote up to 300 records, either individually, or as groups of up to 100 records each.
15
- */
16
- promote?: Array<Promote>;
17
-
18
- /**
19
- * Whether promoted records must match an active filter for the consequence to be applied. This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won\'t be shown.
20
- */
21
- filterPromotes?: boolean;
22
-
23
- /**
24
- * Records you want to hide from the search results.
25
- */
26
- hide?: Array<ConsequenceHide>;
27
-
28
- /**
29
- * A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1&nbsp;kB of minified JSON.
30
- */
31
- userData?: any | null;
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
- * Object ID of the record to hide.
5
- */
6
- export type ConsequenceHide = {
7
- /**
8
- * Unique record identifier.
9
- */
10
- objectID: string;
11
- };
@@ -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 { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
4
- import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
5
- import type { Params } from './params';
6
-
7
- export type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
@@ -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 { ConsequenceQueryObject } from './consequenceQueryObject';
4
-
5
- /**
6
- * Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query.
7
- */
8
- export type ConsequenceQuery = ConsequenceQueryObject | string;
@@ -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 { Edit } from './edit';
4
-
5
- export type ConsequenceQueryObject = {
6
- /**
7
- * Words to remove from the search query.
8
- */
9
- remove?: Array<string>;
10
-
11
- /**
12
- * Changes to make to the search query.
13
- */
14
- edits?: Array<Edit>;
15
- };
@@ -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
- * Response and creation timestamp.
5
- */
6
- export type CreatedAtResponse = {
7
- /**
8
- * Date and time when the object was created, in RFC 3339 format.
9
- */
10
- createdAt: string;
11
- };
package/model/cursor.ts DELETED
@@ -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 Cursor = {
4
- /**
5
- * Cursor to get the next page of the response. The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.
6
- */
7
- cursor?: 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
- export type DeleteApiKeyResponse = {
4
- /**
5
- * Date and time when the object was deleted, in RFC 3339 format.
6
- */
7
- deletedAt: string;
8
- };
@@ -1,36 +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 { AroundRadius } from './aroundRadius';
4
- import type { FacetFilters } from './facetFilters';
5
- import type { NumericFilters } from './numericFilters';
6
- import type { TagFilters } from './tagFilters';
7
-
8
- export type DeleteByParams = {
9
- facetFilters?: FacetFilters;
10
-
11
- /**
12
- * Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
13
- */
14
- filters?: string;
15
-
16
- numericFilters?: NumericFilters;
17
-
18
- tagFilters?: TagFilters;
19
-
20
- /**
21
- * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
22
- */
23
- aroundLatLng?: string;
24
-
25
- aroundRadius?: AroundRadius;
26
-
27
- /**
28
- * Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
29
- */
30
- insideBoundingBox?: Array<Array<number>>;
31
-
32
- /**
33
- * Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
34
- */
35
- insidePolygon?: Array<Array<number>>;
36
- };
@@ -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 DeleteSourceResponse = {
4
- /**
5
- * Date and time when the object was deleted, in RFC 3339 format.
6
- */
7
- deletedAt: string;
8
- };
@@ -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 deletion timestamp.
5
- */
6
- export type DeletedAtResponse = {
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 deleted, in RFC 3339 format.
14
- */
15
- deletedAt: string;
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
- * Actions to perform.
5
- */
6
- export type DictionaryAction = 'addEntry' | 'deleteEntry';
@@ -1,36 +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 { DictionaryEntryState } from './dictionaryEntryState';
4
- import type { DictionaryEntryType } from './dictionaryEntryType';
5
- import type { SupportedLanguage } from './supportedLanguage';
6
-
7
- /**
8
- * Dictionary entry.
9
- */
10
- export type DictionaryEntry = Record<string, any> & {
11
- /**
12
- * Unique identifier for the dictionary entry.
13
- */
14
- objectID: string;
15
-
16
- language?: SupportedLanguage;
17
-
18
- /**
19
- * Matching dictionary word for `stopwords` and `compounds` dictionaries.
20
- */
21
- word?: string;
22
-
23
- /**
24
- * Matching words in the `plurals` dictionary including declensions.
25
- */
26
- words?: Array<string>;
27
-
28
- /**
29
- * Invividual components of a compound word in the `compounds` dictionary.
30
- */
31
- decomposition?: Array<string>;
32
-
33
- state?: DictionaryEntryState;
34
-
35
- type?: DictionaryEntryType;
36
- };
@@ -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 a dictionary entry is active.
5
- */
6
- export type DictionaryEntryState = 'enabled' | 'disabled';
@@ -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 a dictionary entry is provided by Algolia (standard), or has been added by you (custom).
5
- */
6
- export type DictionaryEntryType = 'custom' | 'standard';
@@ -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
- * Dictionary type. If `null`, this dictionary type isn\'t supported for the language.
5
- */
6
- export type DictionaryLanguage = {
7
- /**
8
- * Number of custom dictionary entries.
9
- */
10
- nbCustomEntries?: number;
11
- };
@@ -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 { StandardEntries } from './standardEntries';
4
-
5
- /**
6
- * Turn on or off the built-in Algolia stop words for a specific language.
7
- */
8
- export type DictionarySettingsParams = {
9
- disableStandardEntries: StandardEntries;
10
- };
@@ -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 DictionaryType = 'plurals' | 'stopwords' | 'compounds';
package/model/distinct.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
- * Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set.
5
- */
6
- export type Distinct = boolean | number;
package/model/edit.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 { EditType } from './editType';
4
-
5
- export type Edit = {
6
- type?: EditType;
7
-
8
- /**
9
- * Text or patterns to remove from the query string.
10
- */
11
- delete?: string;
12
-
13
- /**
14
- * Text to be added in place of the deleted text inside the query string.
15
- */
16
- insert?: string;
17
- };
package/model/editType.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
- * Type of edit.
5
- */
6
- export type EditType = 'remove' | 'replace';
@@ -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
- * Error.
5
- */
6
- export type ErrorBase = Record<string, any> & {
7
- message?: 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
- * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won\'t.
5
- */
6
- export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
@@ -1,31 +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 certain properties of the search response are calculated exhaustive (exact) or approximated.
5
- */
6
- export type Exhaustive = {
7
- /**
8
- * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
9
- */
10
- facetsCount?: boolean;
11
-
12
- /**
13
- * The value is `false` if not all facet values are retrieved.
14
- */
15
- facetValues?: boolean;
16
-
17
- /**
18
- * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
19
- */
20
- nbHits?: boolean;
21
-
22
- /**
23
- * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
24
- */
25
- rulesMatch?: boolean;
26
-
27
- /**
28
- * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
29
- */
30
- typo?: boolean;
31
- };
@@ -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 facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
5
- */
6
- export type FacetFilters = Array<FacetFilters> | 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
- export type FacetHits = {
4
- /**
5
- * Facet value.
6
- */
7
- value: string;
8
-
9
- /**
10
- * Highlighted attribute value, including HTML tags.
11
- */
12
- highlighted: string;
13
-
14
- /**
15
- * Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
16
- */
17
- count: number;
18
- };
@@ -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 { Facets } from './facets';
4
- import type { Value } from './value';
5
-
6
- /**
7
- * Order of facet names and facet values in your UI.
8
- */
9
- export type FacetOrdering = {
10
- facets?: Facets;
11
-
12
- /**
13
- * Order of facet values. One object for each facet.
14
- */
15
- values?: { [key: string]: Value };
16
- };
@@ -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 FacetStats = {
4
- /**
5
- * Minimum value in the results.
6
- */
7
- min?: number;
8
-
9
- /**
10
- * Maximum value in the results.
11
- */
12
- max?: number;
13
-
14
- /**
15
- * Average facet value in the results.
16
- */
17
- avg?: number;
18
-
19
- /**
20
- * Sum of all values in the results.
21
- */
22
- sum?: number;
23
- };
package/model/facets.ts DELETED
@@ -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
- * Order of facet names.
5
- */
6
- export type Facets = {
7
- /**
8
- * Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
9
- */
10
- order?: Array<string>;
11
- };
@@ -1,63 +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 FetchedIndex = {
4
- /**
5
- * Index name.
6
- */
7
- name: string;
8
-
9
- /**
10
- * Index creation date. An empty string means that the index has no records.
11
- */
12
- createdAt: string;
13
-
14
- /**
15
- * Date and time when the object was updated, in RFC 3339 format.
16
- */
17
- updatedAt: string;
18
-
19
- /**
20
- * Number of records contained in the index.
21
- */
22
- entries: number;
23
-
24
- /**
25
- * Number of bytes of the index in minified format.
26
- */
27
- dataSize: number;
28
-
29
- /**
30
- * Number of bytes of the index binary file.
31
- */
32
- fileSize: number;
33
-
34
- /**
35
- * Last build time.
36
- */
37
- lastBuildTimeS: number;
38
-
39
- /**
40
- * Number of pending indexing operations. This value is deprecated and should not be used.
41
- */
42
- numberOfPendingTasks: number;
43
-
44
- /**
45
- * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
46
- */
47
- pendingTask: boolean;
48
-
49
- /**
50
- * Only present if the index is a replica. Contains the name of the related primary index.
51
- */
52
- primary?: string;
53
-
54
- /**
55
- * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
56
- */
57
- replicas?: Array<string>;
58
-
59
- /**
60
- * Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).
61
- */
62
- virtual?: boolean;
63
- };
@@ -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 { ApiKey } from './apiKey';
4
- import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
5
-
6
- export type GetApiKeyResponse = BaseGetApiKeyResponse & ApiKey;
@@ -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 { StandardEntries } from './standardEntries';
4
-
5
- export type GetDictionarySettingsResponse = {
6
- disableStandardEntries: StandardEntries;
7
- };
@@ -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 { Log } from './log';
4
-
5
- export type GetLogsResponse = {
6
- logs: Array<Log>;
7
- };
@@ -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 { GetObjectsRequest } from './getObjectsRequest';
4
-
5
- /**
6
- * Request parameters.
7
- */
8
- export type GetObjectsParams = {
9
- requests: Array<GetObjectsRequest>;
10
- };
@@ -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
- * Request body for retrieving records.
5
- */
6
- export type GetObjectsRequest = {
7
- /**
8
- * Attributes to retrieve. If not specified, all retrievable attributes are returned.
9
- */
10
- attributesToRetrieve?: Array<string>;
11
-
12
- /**
13
- * Object ID for the record to retrieve.
14
- */
15
- objectID: string;
16
-
17
- /**
18
- * Index from which to retrieve the records.
19
- */
20
- indexName: string;
21
- };
@@ -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 GetObjectsResponse<T = Record<string, any>> = {
4
- /**
5
- * Retrieved records.
6
- */
7
- results?: T[];
8
- };
@@ -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 { TaskStatus } from './taskStatus';
4
-
5
- export type GetTaskResponse = {
6
- status: TaskStatus;
7
- };
@@ -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 { UserId } from './userId';
4
-
5
- /**
6
- * User IDs and clusters.
7
- */
8
- export type GetTopUserIdsResponse = {
9
- /**
10
- * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
11
- */
12
- topUsers: Array<{ [key: string]: Array<UserId> }>;
13
- };
@@ -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 HasPendingMappingsResponse = {
4
- /**
5
- * Whether there are clusters undergoing migration, creation, or deletion.
6
- */
7
- pending: boolean;
8
-
9
- /**
10
- * Cluster pending mapping state: migrating, creating, deleting.
11
- */
12
- clusters?: { [key: string]: Array<string> };
13
- };