@algolia/client-search 5.0.0-beta.1 → 5.0.0-beta.10

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 (78) hide show
  1. package/LICENSE +21 -0
  2. package/dist/builds/browser.d.ts +73 -68
  3. package/dist/builds/browser.d.ts.map +1 -1
  4. package/dist/builds/node.d.ts +73 -68
  5. package/dist/builds/node.d.ts.map +1 -1
  6. package/dist/client-search.cjs +137 -12
  7. package/dist/client-search.esm.browser.js +130 -28
  8. package/dist/client-search.esm.node.js +137 -12
  9. package/dist/client-search.umd.js +2 -2
  10. package/dist/model/baseIndexSettings.d.ts +2 -2
  11. package/dist/model/baseIndexSettings.d.ts.map +1 -1
  12. package/dist/model/baseSearchResponse.d.ts +2 -18
  13. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  14. package/dist/model/browsePagination.d.ts +19 -0
  15. package/dist/model/browsePagination.d.ts.map +1 -0
  16. package/dist/model/browseResponse.d.ts +2 -1
  17. package/dist/model/browseResponse.d.ts.map +1 -1
  18. package/dist/model/clientMethodProps.d.ts +31 -23
  19. package/dist/model/clientMethodProps.d.ts.map +1 -1
  20. package/dist/model/facetFilters.d.ts +1 -2
  21. package/dist/model/facetFilters.d.ts.map +1 -1
  22. package/dist/model/fetchedIndex.d.ts +4 -0
  23. package/dist/model/fetchedIndex.d.ts.map +1 -1
  24. package/dist/model/index.d.ts +5 -2
  25. package/dist/model/index.d.ts.map +1 -1
  26. package/dist/model/numericFilters.d.ts +1 -2
  27. package/dist/model/numericFilters.d.ts.map +1 -1
  28. package/dist/model/optionalFilters.d.ts +1 -2
  29. package/dist/model/optionalFilters.d.ts.map +1 -1
  30. package/dist/model/rankingInfo.d.ts +3 -3
  31. package/dist/model/rankingInfo.d.ts.map +1 -1
  32. package/dist/model/reRankingApplyFilter.d.ts +1 -2
  33. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  34. package/dist/model/redirect.d.ts +1 -1
  35. package/dist/model/redirectURL.d.ts +7 -0
  36. package/dist/model/redirectURL.d.ts.map +1 -0
  37. package/dist/model/renderingContent.d.ts +2 -0
  38. package/dist/model/renderingContent.d.ts.map +1 -1
  39. package/dist/model/replaceAllObjectsResponse.d.ts +11 -0
  40. package/dist/model/replaceAllObjectsResponse.d.ts.map +1 -0
  41. package/dist/model/searchForFacetValuesResponse.d.ts +1 -1
  42. package/dist/model/searchPagination.d.ts +19 -0
  43. package/dist/model/searchPagination.d.ts.map +1 -0
  44. package/dist/model/searchResponse.d.ts +2 -1
  45. package/dist/model/searchResponse.d.ts.map +1 -1
  46. package/dist/model/{securedAPIKeyRestrictions.d.ts → securedApiKeyRestrictions.d.ts} +2 -2
  47. package/dist/model/{securedAPIKeyRestrictions.d.ts.map → securedApiKeyRestrictions.d.ts.map} +1 -1
  48. package/dist/model/tagFilters.d.ts +1 -2
  49. package/dist/model/tagFilters.d.ts.map +1 -1
  50. package/dist/model/value.d.ts +4 -0
  51. package/dist/model/value.d.ts.map +1 -1
  52. package/dist/src/searchClient.d.ts +67 -12
  53. package/dist/src/searchClient.d.ts.map +1 -1
  54. package/model/baseIndexSettings.ts +2 -2
  55. package/model/baseSearchResponse.ts +2 -22
  56. package/model/browsePagination.ts +23 -0
  57. package/model/browseResponse.ts +2 -0
  58. package/model/clientMethodProps.ts +42 -26
  59. package/model/facetFilters.ts +1 -3
  60. package/model/fetchedIndex.ts +5 -0
  61. package/model/index.ts +5 -2
  62. package/model/numericFilters.ts +1 -3
  63. package/model/optionalFilters.ts +1 -3
  64. package/model/rankingInfo.ts +3 -3
  65. package/model/reRankingApplyFilter.ts +1 -3
  66. package/model/redirect.ts +1 -1
  67. package/model/{mixedSearchFilters.ts → redirectURL.ts} +6 -1
  68. package/model/renderingContent.ts +3 -0
  69. package/model/replaceAllObjectsResponse.ts +15 -0
  70. package/model/searchForFacetValuesResponse.ts +1 -1
  71. package/model/searchPagination.ts +23 -0
  72. package/model/searchResponse.ts +3 -1
  73. package/model/{securedAPIKeyRestrictions.ts → securedApiKeyRestrictions.ts} +1 -1
  74. package/model/tagFilters.ts +1 -3
  75. package/model/value.ts +5 -0
  76. package/package.json +11 -8
  77. package/dist/model/mixedSearchFilters.d.ts +0 -2
  78. package/dist/model/mixedSearchFilters.d.ts.map +0 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2013-Present Algolia
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/dist/builds/browser.d.ts CHANGED
@@ -10,80 +10,85 @@ export declare function searchClient(appId: string, apiKey: string, options?: Cl
10
10
  appId: string;
11
11
  clearCache(): Promise<void>;
12
12
  readonly _ua: string;
13
- addAlgoliaAgent(segment: string, version?: string | undefined): void;
14
- waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
15
- waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
16
- browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "aggregator">> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T>>;
17
- browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "aggregator">> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
18
- browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "aggregator">> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
19
- searchForHits<T_1>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
20
- results: import("../model").SearchResponse<T_1>[];
13
+ addAlgoliaAgent(segment: string, version?: string): void;
14
+ waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
15
+ waitForAppTask({ taskID, maxRetries, timeout, }: import("../model").WaitForAppTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
16
+ waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
17
+ browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: import("../model").BrowseOptions<import("../model").BrowseResponse<T>> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BrowseResponse<T>>;
18
+ browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: import("../model").BrowseOptions<import("../model").SearchRulesResponse> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchRulesResponse>;
19
+ browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: import("../model").BrowseOptions<import("../model").SearchSynonymsResponse> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchSynonymsResponse>;
20
+ searchForHits<T>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
21
+ results: Array<import("../model").SearchResponse<T>>;
21
22
  }>;
22
- searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
23
+ searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
23
24
  results: import("../model").SearchForFacetValuesResponse[];
24
25
  }>;
25
- chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse[]>;
26
- replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceAllObjectsResponse>;
27
- addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
28
- addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
29
- appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
30
- assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
31
- batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse>;
32
- batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
33
- batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
34
- browse<T_2>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T_2>>;
35
- clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
36
- clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
37
- clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
38
- customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
39
- customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
40
- customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
41
- customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
42
- deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteApiKeyResponse>;
43
- deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
44
- deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
45
- deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
46
- deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
47
- deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteSourceResponse>;
48
- deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
49
- getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetApiKeyResponse>;
50
- getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("../model").Languages>>;
51
- getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetDictionarySettingsResponse>;
26
+ chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
27
+ saveObjects({ indexName, objects }: import("../model").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
28
+ deleteObjects({ indexName, objectIDs }: import("../model").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
29
+ partialUpdateObjects({ indexName, objects, createIfNotExists }: import("../model").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
30
+ replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ReplaceAllObjectsResponse>;
31
+ addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AddApiKeyResponse>;
32
+ addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
33
+ appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
34
+ assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
35
+ batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse>;
36
+ batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
37
+ batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
38
+ browse<T>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BrowseResponse<T>>;
39
+ clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
40
+ clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
41
+ clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
42
+ customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
43
+ customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
44
+ customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
45
+ customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
46
+ deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteApiKeyResponse>;
47
+ deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
48
+ deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
49
+ deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
50
+ deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
51
+ deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteSourceResponse>;
52
+ deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
53
+ getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetApiKeyResponse>;
54
+ getAppTask({ taskID }: import("../model").GetAppTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
55
+ getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, import("../model").Languages>>;
56
+ getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetDictionarySettingsResponse>;
52
57
  getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
53
- getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
54
- getObjects<T_3>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetObjectsResponse<T_3>>;
55
- getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Rule>;
56
- getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexSettings>;
57
- getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Source[]>;
58
- getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SynonymHit>;
59
- getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
60
- getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTopUserIdsResponse>;
61
- getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UserId>;
58
+ getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, string>>;
59
+ getObjects<T>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetObjectsResponse<T>>;
60
+ getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Rule>;
61
+ getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").IndexSettings>;
62
+ getSources(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Source[]>;
63
+ getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SynonymHit>;
64
+ getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
65
+ getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopUserIdsResponse>;
66
+ getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UserId>;
62
67
  hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
63
- listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListApiKeysResponse>;
64
- listClusters(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListClustersResponse>;
68
+ listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListApiKeysResponse>;
69
+ listClusters(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListClustersResponse>;
65
70
  listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
66
71
  listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
67
- multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").MultipleBatchResponse>;
68
- operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
69
- partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
70
- removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RemoveUserIdResponse>;
71
- replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceSourceResponse>;
72
- restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
73
- saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveObjectResponse>;
74
- saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedRuleResponse>;
75
- saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
76
- saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveSynonymResponse>;
77
- saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
78
- search<T_4>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponses<T_4>>;
79
- searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchDictionaryEntriesResponse>;
80
- searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchForFacetValuesResponse>;
81
- searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
82
- searchSingleIndex<T_5>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponse<T_5>>;
83
- searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
84
- searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchUserIdsResponse>;
85
- setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
86
- setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
87
- updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdateApiKeyResponse>;
72
+ multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").MultipleBatchResponse>;
73
+ operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
74
+ partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
75
+ removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").RemoveUserIdResponse>;
76
+ replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ReplaceSourceResponse>;
77
+ restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AddApiKeyResponse>;
78
+ saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SaveObjectResponse>;
79
+ saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedRuleResponse>;
80
+ saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
81
+ saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SaveSynonymResponse>;
82
+ saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
83
+ search<T>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchResponses<T>>;
84
+ searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchDictionaryEntriesResponse>;
85
+ searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchForFacetValuesResponse>;
86
+ searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchRulesResponse>;
87
+ searchSingleIndex<T>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchResponse<T>>;
88
+ searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchSynonymsResponse>;
89
+ searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchUserIdsResponse>;
90
+ setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
91
+ setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
92
+ updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdateApiKeyResponse>;
88
93
  };
89
94
  //# sourceMappingURL=browser.d.ts.map
package/dist/builds/browser.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAa5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+BxB"}
1
+ {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAa5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+BxB"}
package/dist/builds/node.d.ts CHANGED
@@ -28,80 +28,85 @@ export declare function searchClient(appId: string, apiKey: string, options?: Cl
28
28
  appId: string;
29
29
  clearCache(): Promise<void>;
30
30
  _ua: string;
31
- addAlgoliaAgent(segment: string, version?: string | undefined): void;
32
- waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
33
- waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
34
- browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "aggregator">> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T>>;
35
- browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "aggregator">> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
36
- browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "aggregator">> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
37
- searchForHits<T_1>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
38
- results: import("../model").SearchResponse<T_1>[];
31
+ addAlgoliaAgent(segment: string, version?: string): void;
32
+ waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
33
+ waitForAppTask({ taskID, maxRetries, timeout, }: import("../model").WaitForAppTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
34
+ waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
35
+ browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: import("../model").BrowseOptions<import("../model").BrowseResponse<T>> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BrowseResponse<T>>;
36
+ browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: import("../model").BrowseOptions<import("../model").SearchRulesResponse> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchRulesResponse>;
37
+ browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: import("../model").BrowseOptions<import("../model").SearchSynonymsResponse> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchSynonymsResponse>;
38
+ searchForHits<T>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
39
+ results: Array<import("../model").SearchResponse<T>>;
39
40
  }>;
40
- searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
41
+ searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
41
42
  results: import("../model").SearchForFacetValuesResponse[];
42
43
  }>;
43
- chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse[]>;
44
- replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceAllObjectsResponse>;
45
- addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
46
- addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
47
- appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
48
- assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
49
- batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse>;
50
- batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
51
- batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
52
- browse<T_2>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T_2>>;
53
- clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
54
- clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
55
- clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
56
- customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
57
- customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
58
- customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
59
- customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
60
- deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteApiKeyResponse>;
61
- deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
62
- deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
63
- deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
64
- deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
65
- deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteSourceResponse>;
66
- deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
67
- getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetApiKeyResponse>;
68
- getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("../model").Languages>>;
69
- getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetDictionarySettingsResponse>;
44
+ chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
45
+ saveObjects({ indexName, objects }: import("../model").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
46
+ deleteObjects({ indexName, objectIDs }: import("../model").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
47
+ partialUpdateObjects({ indexName, objects, createIfNotExists }: import("../model").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
48
+ replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ReplaceAllObjectsResponse>;
49
+ addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AddApiKeyResponse>;
50
+ addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
51
+ appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
52
+ assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
53
+ batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse>;
54
+ batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
55
+ batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
56
+ browse<T>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BrowseResponse<T>>;
57
+ clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
58
+ clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
59
+ clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
60
+ customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
61
+ customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
62
+ customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
63
+ customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
64
+ deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteApiKeyResponse>;
65
+ deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
66
+ deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
67
+ deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
68
+ deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
69
+ deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteSourceResponse>;
70
+ deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
71
+ getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetApiKeyResponse>;
72
+ getAppTask({ taskID }: import("../model").GetAppTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
73
+ getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, import("../model").Languages>>;
74
+ getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetDictionarySettingsResponse>;
70
75
  getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
71
- getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
72
- getObjects<T_3>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetObjectsResponse<T_3>>;
73
- getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Rule>;
74
- getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexSettings>;
75
- getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Source[]>;
76
- getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SynonymHit>;
77
- getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
78
- getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTopUserIdsResponse>;
79
- getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UserId>;
76
+ getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, string>>;
77
+ getObjects<T>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetObjectsResponse<T>>;
78
+ getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Rule>;
79
+ getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").IndexSettings>;
80
+ getSources(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Source[]>;
81
+ getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SynonymHit>;
82
+ getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
83
+ getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopUserIdsResponse>;
84
+ getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UserId>;
80
85
  hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
81
- listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListApiKeysResponse>;
82
- listClusters(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListClustersResponse>;
86
+ listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListApiKeysResponse>;
87
+ listClusters(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListClustersResponse>;
83
88
  listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
84
89
  listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
85
- multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").MultipleBatchResponse>;
86
- operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
87
- partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
88
- removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RemoveUserIdResponse>;
89
- replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceSourceResponse>;
90
- restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
91
- saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveObjectResponse>;
92
- saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedRuleResponse>;
93
- saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
94
- saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveSynonymResponse>;
95
- saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
96
- search<T_4>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponses<T_4>>;
97
- searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchDictionaryEntriesResponse>;
98
- searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchForFacetValuesResponse>;
99
- searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
100
- searchSingleIndex<T_5>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponse<T_5>>;
101
- searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
102
- searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchUserIdsResponse>;
103
- setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
104
- setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
105
- updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdateApiKeyResponse>;
90
+ multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").MultipleBatchResponse>;
91
+ operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
92
+ partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
93
+ removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").RemoveUserIdResponse>;
94
+ replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ReplaceSourceResponse>;
95
+ restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AddApiKeyResponse>;
96
+ saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SaveObjectResponse>;
97
+ saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedRuleResponse>;
98
+ saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
99
+ saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SaveSynonymResponse>;
100
+ saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
101
+ search<T>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchResponses<T>>;
102
+ searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchDictionaryEntriesResponse>;
103
+ searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchForFacetValuesResponse>;
104
+ searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchRulesResponse>;
105
+ searchSingleIndex<T>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchResponse<T>>;
106
+ searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchSynonymsResponse>;
107
+ searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchUserIdsResponse>;
108
+ setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
109
+ setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
110
+ updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdateApiKeyResponse>;
106
111
  };
107
112
  //# sourceMappingURL=node.d.ts.map
package/dist/builds/node.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;IA2BrB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;IASxC;;;;;;OAMG;0DAGA,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvD"}
1
+ {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;IA2BrB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;IA+BxC;;;;;;OAMG;0DAGA,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvD"}