algoliasearch 5.0.0-alpha.6 → 5.0.0-alpha.7
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.
- package/dist/algoliasearch/builds/browser.d.ts +3 -3
- package/dist/algoliasearch/builds/node.d.ts +4 -4
- package/dist/algoliasearch/lite/model/browseParams.d.ts +4 -0
- package/dist/algoliasearch/lite/model/browseParams.d.ts.map +1 -0
- package/dist/algoliasearch/lite/model/browseParamsObject.d.ts +4 -0
- package/dist/algoliasearch/lite/model/browseParamsObject.d.ts.map +1 -0
- package/dist/algoliasearch/lite/model/browseResponse.d.ts +2 -2
- package/dist/algoliasearch/lite/model/browseResponse.d.ts.map +1 -1
- package/dist/algoliasearch/lite/model/{baseBrowseResponse.d.ts → cursor.d.ts} +2 -2
- package/dist/algoliasearch/lite/model/cursor.d.ts.map +1 -0
- package/dist/algoliasearch/lite/model/index.d.ts +3 -1
- package/dist/algoliasearch/lite/model/index.d.ts.map +1 -1
- package/dist/algoliasearch/lite/src/liteClient.d.ts +1 -1
- package/dist/algoliasearch.cjs.js +11 -11
- package/dist/algoliasearch.esm.browser.js +11 -11
- package/dist/algoliasearch.esm.node.js +11 -11
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/builds/browser.d.ts +3 -3
- package/dist/builds/node.d.ts +3 -3
- package/dist/client-abtesting/src/abtestingClient.d.ts +1 -1
- package/dist/client-analytics/src/analyticsClient.d.ts +1 -1
- package/dist/client-personalization/src/personalizationClient.d.ts +1 -1
- package/dist/client-search/model/browseParams.d.ts +4 -0
- package/dist/client-search/model/browseParams.d.ts.map +1 -0
- package/dist/client-search/model/browseParamsObject.d.ts +4 -0
- package/dist/client-search/model/browseParamsObject.d.ts.map +1 -0
- package/dist/client-search/model/browseResponse.d.ts +2 -2
- package/dist/client-search/model/browseResponse.d.ts.map +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +2 -2
- package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-search/model/{baseBrowseResponse.d.ts → cursor.d.ts} +2 -2
- package/dist/client-search/model/cursor.d.ts.map +1 -0
- package/dist/client-search/model/index.d.ts +3 -2
- package/dist/client-search/model/index.d.ts.map +1 -1
- package/dist/client-search/src/searchClient.d.ts +5 -5
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/builds/browser.d.ts +3 -3
- package/dist/lite/builds/node.d.ts +3 -3
- package/dist/lite/lite/model/browseParams.d.ts +4 -0
- package/dist/lite/lite/model/browseParams.d.ts.map +1 -0
- package/dist/lite/lite/model/browseParamsObject.d.ts +4 -0
- package/dist/lite/lite/model/browseParamsObject.d.ts.map +1 -0
- package/dist/lite/lite/model/browseResponse.d.ts +2 -2
- package/dist/lite/lite/model/browseResponse.d.ts.map +1 -1
- package/dist/lite/lite/model/{baseBrowseResponse.d.ts → cursor.d.ts} +2 -2
- package/dist/lite/lite/model/cursor.d.ts.map +1 -0
- package/dist/lite/lite/model/index.d.ts +3 -1
- package/dist/lite/lite/model/index.d.ts.map +1 -1
- package/dist/lite/lite/src/liteClient.d.ts +1 -1
- package/dist/lite/lite.cjs.js +1 -1
- package/dist/lite/lite.esm.browser.js +1 -1
- package/dist/lite/lite.esm.node.js +1 -1
- package/dist/lite/lite.umd.js +2 -2
- package/lite/model/browseParams.ts +6 -0
- package/lite/model/browseParamsObject.ts +6 -0
- package/lite/model/browseResponse.ts +3 -3
- package/lite/model/{baseBrowseResponse.ts → cursor.ts} +1 -1
- package/lite/model/index.ts +3 -1
- package/lite/src/liteClient.ts +1 -1
- package/package.json +8 -8
- package/dist/algoliasearch/lite/model/baseBrowseResponse.d.ts.map +0 -1
- package/dist/client-search/model/baseBrowseResponse.d.ts.map +0 -1
- package/dist/client-search/model/browseRequest.d.ts +0 -11
- package/dist/client-search/model/browseRequest.d.ts.map +0 -1
- package/dist/lite/lite/model/baseBrowseResponse.d.ts.map +0 -1
|
@@ -4,7 +4,7 @@ import type { ClientOptions } from '@algolia/client-common';
|
|
|
4
4
|
import type { Region as PersonalizationRegion, PersonalizationClient } from '@algolia/client-personalization/src/personalizationClient';
|
|
5
5
|
import type { InitClientOptions, InitClientRegion } from './models';
|
|
6
6
|
export * from './models';
|
|
7
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
7
|
+
export declare const apiClientVersion = "5.0.0-alpha.7";
|
|
8
8
|
/**
|
|
9
9
|
* The client type.
|
|
10
10
|
*/
|
|
@@ -20,7 +20,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
20
20
|
addAlgoliaAgent(segment: string, version?: string | undefined): void;
|
|
21
21
|
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("@algolia/client-search/model/clientMethodProps").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getTaskResponse").GetTaskResponse>;
|
|
22
22
|
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("@algolia/client-search/model/clientMethodProps").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("@algolia/client-search/model/getApiKeyResponse").GetApiKeyResponse>;
|
|
23
|
-
browseObjects<T>({ indexName,
|
|
23
|
+
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
|
|
24
24
|
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
25
25
|
browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
|
|
26
26
|
addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
|
|
@@ -30,7 +30,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
30
30
|
batch({ indexName, batchWriteParams }: import("@algolia/client-search/model/clientMethodProps").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse>;
|
|
31
31
|
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("@algolia/client-search/model/clientMethodProps").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
32
32
|
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
33
|
-
browse<T_1>({ indexName,
|
|
33
|
+
browse<T_1>({ indexName, browseParams }: import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T_1>>;
|
|
34
34
|
clearAllSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearAllSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
35
35
|
clearObjects({ indexName }: import("@algolia/client-search/model/clientMethodProps").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
36
36
|
clearRules({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
@@ -4,7 +4,7 @@ import type { ClientOptions } from '@algolia/client-common';
|
|
|
4
4
|
import type { Region as PersonalizationRegion, PersonalizationClient } from '@algolia/client-personalization/src/personalizationClient';
|
|
5
5
|
import type { InitClientOptions, InitClientRegion } from './models';
|
|
6
6
|
export * from './models';
|
|
7
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
7
|
+
export declare const apiClientVersion = "5.0.0-alpha.7";
|
|
8
8
|
/**
|
|
9
9
|
* The client type.
|
|
10
10
|
*/
|
|
@@ -20,7 +20,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
20
20
|
addAlgoliaAgent(segment: string, version?: string | undefined): void;
|
|
21
21
|
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("@algolia/client-search/model/clientMethodProps").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/getTaskResponse").GetTaskResponse>;
|
|
22
22
|
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("@algolia/client-search/model/clientMethodProps").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("@algolia/client-search/model/getApiKeyResponse").GetApiKeyResponse>;
|
|
23
|
-
browseObjects<T>({ indexName,
|
|
23
|
+
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
|
|
24
24
|
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
25
25
|
browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>, "aggregator">> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
|
|
26
26
|
addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
|
|
@@ -30,7 +30,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
30
30
|
batch({ indexName, batchWriteParams }: import("@algolia/client-search/model/clientMethodProps").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse>;
|
|
31
31
|
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("@algolia/client-search/model/clientMethodProps").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;
|
|
32
32
|
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
33
|
-
browse<T_1>({ indexName,
|
|
33
|
+
browse<T_1>({ indexName, browseParams }: import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T_1>>;
|
|
34
34
|
clearAllSynonyms({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearAllSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
35
35
|
clearObjects({ indexName }: import("@algolia/client-search/model/clientMethodProps").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
36
36
|
clearRules({ indexName, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
@@ -74,7 +74,7 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
|
|
|
74
74
|
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("@algolia/client-search/model/clientMethodProps").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
75
75
|
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("@algolia/client-search/model/clientMethodProps").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/saveSynonymResponse").SaveSynonymResponse>;
|
|
76
76
|
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("@algolia/client-search/model/clientMethodProps").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
77
|
-
search<T_3>(searchMethodParams: import("@algolia/client-search/model/
|
|
77
|
+
search<T_3>(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchResponses").SearchResponses<T_3>>;
|
|
78
78
|
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("@algolia/client-search/model/clientMethodProps").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/updatedAtResponse").UpdatedAtResponse>;
|
|
79
79
|
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("@algolia/client-search/model/clientMethodProps").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse>;
|
|
80
80
|
searchRules({ indexName, searchRulesParams }: import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"browseParams.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/browseParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,oBAAY,YAAY,GAAG,kBAAkB,GAAG,kBAAkB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"browseParamsObject.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/browseParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,oBAAY,kBAAkB,GAAG,MAAM,GAAG,kBAAkB,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { BaseBrowseResponse } from './baseBrowseResponse';
|
|
2
1
|
import type { BaseSearchResponse } from './baseSearchResponse';
|
|
2
|
+
import type { Cursor } from './cursor';
|
|
3
3
|
import type { SearchHits } from './searchHits';
|
|
4
|
-
export declare type BrowseResponse<T = Record<string, any>> =
|
|
4
|
+
export declare type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & Cursor & SearchHits<T>;
|
|
5
5
|
//# sourceMappingURL=browseResponse.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browseResponse.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/browseResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"browseResponse.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/browseResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,MAAM,GACN,UAAU,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
export declare type
|
|
1
|
+
export declare type Cursor = {
|
|
2
2
|
/**
|
|
3
3
|
* Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
|
|
4
4
|
*/
|
|
5
5
|
cursor?: string;
|
|
6
6
|
};
|
|
7
|
-
//# sourceMappingURL=
|
|
7
|
+
//# sourceMappingURL=cursor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cursor.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/cursor.ts"],"names":[],"mappings":"AAEA,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
|
|
@@ -10,12 +10,13 @@ export * from './aroundRadiusAll';
|
|
|
10
10
|
export * from './attributeToUpdate';
|
|
11
11
|
export * from './automaticFacetFilter';
|
|
12
12
|
export * from './automaticFacetFilters';
|
|
13
|
-
export * from './baseBrowseResponse';
|
|
14
13
|
export * from './baseGetApiKeyResponse';
|
|
15
14
|
export * from './baseIndexSettings';
|
|
16
15
|
export * from './baseSearchParams';
|
|
17
16
|
export * from './baseSearchParamsWithoutQuery';
|
|
18
17
|
export * from './baseSearchResponse';
|
|
18
|
+
export * from './browseParams';
|
|
19
|
+
export * from './browseParamsObject';
|
|
19
20
|
export * from './browseResponse';
|
|
20
21
|
export * from './builtInOperation';
|
|
21
22
|
export * from './builtInOperationType';
|
|
@@ -25,6 +26,7 @@ export * from './consequenceHide';
|
|
|
25
26
|
export * from './consequenceParams';
|
|
26
27
|
export * from './consequenceQuery';
|
|
27
28
|
export * from './consequenceQueryObject';
|
|
29
|
+
export * from './cursor';
|
|
28
30
|
export * from './dictionaryAction';
|
|
29
31
|
export * from './dictionaryEntry';
|
|
30
32
|
export * from './dictionaryEntryState';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/index.ts"],"names":[],"mappings":"AAEA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/index.ts"],"names":[],"mappings":"AAEA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,OAAO,CAAC;AACtB,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}
|
|
@@ -2,7 +2,7 @@ import type { CreateClientOptions, RequestOptions } from '@algolia/client-common
|
|
|
2
2
|
import type { PostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
|
|
3
3
|
import type { SearchMethodParams } from '../model/searchMethodParams';
|
|
4
4
|
import type { SearchResponses } from '../model/searchResponses';
|
|
5
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
5
|
+
export declare const apiClientVersion = "5.0.0-alpha.7";
|
|
6
6
|
export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
7
7
|
transporter: import("@algolia/client-common").Transporter;
|
|
8
8
|
/**
|
|
@@ -6,7 +6,7 @@ var clientCommon = require('@algolia/client-common');
|
|
|
6
6
|
var requesterNodeHttp = require('@algolia/requester-node-http');
|
|
7
7
|
|
|
8
8
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
9
|
-
const apiClientVersion$4 = '5.0.0-alpha.
|
|
9
|
+
const apiClientVersion$4 = '5.0.0-alpha.7';
|
|
10
10
|
const REGIONS$2 = ['de', 'us'];
|
|
11
11
|
function getDefaultHosts$3(region) {
|
|
12
12
|
const url = !region
|
|
@@ -297,7 +297,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
297
297
|
}
|
|
298
298
|
|
|
299
299
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
300
|
-
const apiClientVersion$3 = '5.0.0-alpha.
|
|
300
|
+
const apiClientVersion$3 = '5.0.0-alpha.7';
|
|
301
301
|
const REGIONS$1 = ['de', 'us'];
|
|
302
302
|
function getDefaultHosts$2(region) {
|
|
303
303
|
const url = !region
|
|
@@ -1194,7 +1194,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1194
1194
|
}
|
|
1195
1195
|
|
|
1196
1196
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
1197
|
-
const apiClientVersion$2 = '5.0.0-alpha.
|
|
1197
|
+
const apiClientVersion$2 = '5.0.0-alpha.7';
|
|
1198
1198
|
const REGIONS = ['eu', 'us'];
|
|
1199
1199
|
function getDefaultHosts$1(region) {
|
|
1200
1200
|
const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
|
|
@@ -1451,7 +1451,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
1451
1451
|
}
|
|
1452
1452
|
|
|
1453
1453
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
1454
|
-
const apiClientVersion$1 = '5.0.0-alpha.
|
|
1454
|
+
const apiClientVersion$1 = '5.0.0-alpha.7';
|
|
1455
1455
|
function getDefaultHosts(appId) {
|
|
1456
1456
|
return [
|
|
1457
1457
|
{
|
|
@@ -1614,19 +1614,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1614
1614
|
* @summary Helper method that iterates on the `browse` method.
|
|
1615
1615
|
* @param browseObjects - The browseObjects object.
|
|
1616
1616
|
* @param browseObjects.indexName - The index in which to perform the request.
|
|
1617
|
-
* @param browseObjects.
|
|
1617
|
+
* @param browseObjects.browseParams - The `browse` parameters.
|
|
1618
1618
|
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
|
|
1619
1619
|
* @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
|
|
1620
1620
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
|
|
1621
1621
|
*/
|
|
1622
|
-
browseObjects({ indexName,
|
|
1622
|
+
browseObjects({ indexName, browseParams, ...browseObjectsOptions }, requestOptions) {
|
|
1623
1623
|
return clientCommon.createIterablePromise({
|
|
1624
1624
|
func: (previousResponse) => {
|
|
1625
1625
|
return this.browse({
|
|
1626
1626
|
indexName,
|
|
1627
|
-
|
|
1627
|
+
browseParams: {
|
|
1628
1628
|
cursor: previousResponse ? previousResponse.cursor : undefined,
|
|
1629
|
-
...
|
|
1629
|
+
...browseParams,
|
|
1630
1630
|
},
|
|
1631
1631
|
}, requestOptions);
|
|
1632
1632
|
},
|
|
@@ -1914,10 +1914,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1914
1914
|
* @summary Retrieve all index content.
|
|
1915
1915
|
* @param browse - The browse object.
|
|
1916
1916
|
* @param browse.indexName - The index in which to perform the request.
|
|
1917
|
-
* @param browse.
|
|
1917
|
+
* @param browse.browseParams - The browseParams object.
|
|
1918
1918
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1919
1919
|
*/
|
|
1920
|
-
browse({ indexName,
|
|
1920
|
+
browse({ indexName, browseParams }, requestOptions) {
|
|
1921
1921
|
if (!indexName) {
|
|
1922
1922
|
throw new Error('Parameter `indexName` is required when calling `browse`.');
|
|
1923
1923
|
}
|
|
@@ -1929,7 +1929,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1929
1929
|
path: requestPath,
|
|
1930
1930
|
queryParameters,
|
|
1931
1931
|
headers,
|
|
1932
|
-
data:
|
|
1932
|
+
data: browseParams ? browseParams : {},
|
|
1933
1933
|
};
|
|
1934
1934
|
return transporter.request(request, requestOptions);
|
|
1935
1935
|
},
|
|
@@ -715,7 +715,7 @@ const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
|
|
|
715
715
|
const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
|
|
716
716
|
|
|
717
717
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
718
|
-
const apiClientVersion$4 = '5.0.0-alpha.
|
|
718
|
+
const apiClientVersion$4 = '5.0.0-alpha.7';
|
|
719
719
|
const REGIONS$2 = ['de', 'us'];
|
|
720
720
|
function getDefaultHosts$3(region) {
|
|
721
721
|
const url = !region
|
|
@@ -1006,7 +1006,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1006
1006
|
}
|
|
1007
1007
|
|
|
1008
1008
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
1009
|
-
const apiClientVersion$3 = '5.0.0-alpha.
|
|
1009
|
+
const apiClientVersion$3 = '5.0.0-alpha.7';
|
|
1010
1010
|
const REGIONS$1 = ['de', 'us'];
|
|
1011
1011
|
function getDefaultHosts$2(region) {
|
|
1012
1012
|
const url = !region
|
|
@@ -1903,7 +1903,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1903
1903
|
}
|
|
1904
1904
|
|
|
1905
1905
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
1906
|
-
const apiClientVersion$2 = '5.0.0-alpha.
|
|
1906
|
+
const apiClientVersion$2 = '5.0.0-alpha.7';
|
|
1907
1907
|
const REGIONS = ['eu', 'us'];
|
|
1908
1908
|
function getDefaultHosts$1(region) {
|
|
1909
1909
|
const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
|
|
@@ -2160,7 +2160,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
2160
2160
|
}
|
|
2161
2161
|
|
|
2162
2162
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2163
|
-
const apiClientVersion$1 = '5.0.0-alpha.
|
|
2163
|
+
const apiClientVersion$1 = '5.0.0-alpha.7';
|
|
2164
2164
|
function getDefaultHosts(appId) {
|
|
2165
2165
|
return [
|
|
2166
2166
|
{
|
|
@@ -2323,19 +2323,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2323
2323
|
* @summary Helper method that iterates on the `browse` method.
|
|
2324
2324
|
* @param browseObjects - The browseObjects object.
|
|
2325
2325
|
* @param browseObjects.indexName - The index in which to perform the request.
|
|
2326
|
-
* @param browseObjects.
|
|
2326
|
+
* @param browseObjects.browseParams - The `browse` parameters.
|
|
2327
2327
|
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
|
|
2328
2328
|
* @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
|
|
2329
2329
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
|
|
2330
2330
|
*/
|
|
2331
|
-
browseObjects({ indexName,
|
|
2331
|
+
browseObjects({ indexName, browseParams, ...browseObjectsOptions }, requestOptions) {
|
|
2332
2332
|
return createIterablePromise({
|
|
2333
2333
|
func: (previousResponse) => {
|
|
2334
2334
|
return this.browse({
|
|
2335
2335
|
indexName,
|
|
2336
|
-
|
|
2336
|
+
browseParams: {
|
|
2337
2337
|
cursor: previousResponse ? previousResponse.cursor : undefined,
|
|
2338
|
-
...
|
|
2338
|
+
...browseParams,
|
|
2339
2339
|
},
|
|
2340
2340
|
}, requestOptions);
|
|
2341
2341
|
},
|
|
@@ -2623,10 +2623,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2623
2623
|
* @summary Retrieve all index content.
|
|
2624
2624
|
* @param browse - The browse object.
|
|
2625
2625
|
* @param browse.indexName - The index in which to perform the request.
|
|
2626
|
-
* @param browse.
|
|
2626
|
+
* @param browse.browseParams - The browseParams object.
|
|
2627
2627
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2628
2628
|
*/
|
|
2629
|
-
browse({ indexName,
|
|
2629
|
+
browse({ indexName, browseParams }, requestOptions) {
|
|
2630
2630
|
if (!indexName) {
|
|
2631
2631
|
throw new Error('Parameter `indexName` is required when calling `browse`.');
|
|
2632
2632
|
}
|
|
@@ -2638,7 +2638,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2638
2638
|
path: requestPath,
|
|
2639
2639
|
queryParameters,
|
|
2640
2640
|
headers,
|
|
2641
|
-
data:
|
|
2641
|
+
data: browseParams ? browseParams : {},
|
|
2642
2642
|
};
|
|
2643
2643
|
return transporter.request(request, requestOptions);
|
|
2644
2644
|
},
|
|
@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise,
|
|
|
2
2
|
import { createHttpRequester } from '@algolia/requester-node-http';
|
|
3
3
|
|
|
4
4
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
5
|
-
const apiClientVersion$4 = '5.0.0-alpha.
|
|
5
|
+
const apiClientVersion$4 = '5.0.0-alpha.7';
|
|
6
6
|
const REGIONS$2 = ['de', 'us'];
|
|
7
7
|
function getDefaultHosts$3(region) {
|
|
8
8
|
const url = !region
|
|
@@ -293,7 +293,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
293
293
|
}
|
|
294
294
|
|
|
295
295
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
296
|
-
const apiClientVersion$3 = '5.0.0-alpha.
|
|
296
|
+
const apiClientVersion$3 = '5.0.0-alpha.7';
|
|
297
297
|
const REGIONS$1 = ['de', 'us'];
|
|
298
298
|
function getDefaultHosts$2(region) {
|
|
299
299
|
const url = !region
|
|
@@ -1190,7 +1190,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1190
1190
|
}
|
|
1191
1191
|
|
|
1192
1192
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
1193
|
-
const apiClientVersion$2 = '5.0.0-alpha.
|
|
1193
|
+
const apiClientVersion$2 = '5.0.0-alpha.7';
|
|
1194
1194
|
const REGIONS = ['eu', 'us'];
|
|
1195
1195
|
function getDefaultHosts$1(region) {
|
|
1196
1196
|
const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
|
|
@@ -1447,7 +1447,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
1447
1447
|
}
|
|
1448
1448
|
|
|
1449
1449
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
1450
|
-
const apiClientVersion$1 = '5.0.0-alpha.
|
|
1450
|
+
const apiClientVersion$1 = '5.0.0-alpha.7';
|
|
1451
1451
|
function getDefaultHosts(appId) {
|
|
1452
1452
|
return [
|
|
1453
1453
|
{
|
|
@@ -1610,19 +1610,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1610
1610
|
* @summary Helper method that iterates on the `browse` method.
|
|
1611
1611
|
* @param browseObjects - The browseObjects object.
|
|
1612
1612
|
* @param browseObjects.indexName - The index in which to perform the request.
|
|
1613
|
-
* @param browseObjects.
|
|
1613
|
+
* @param browseObjects.browseParams - The `browse` parameters.
|
|
1614
1614
|
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
|
|
1615
1615
|
* @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
|
|
1616
1616
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
|
|
1617
1617
|
*/
|
|
1618
|
-
browseObjects({ indexName,
|
|
1618
|
+
browseObjects({ indexName, browseParams, ...browseObjectsOptions }, requestOptions) {
|
|
1619
1619
|
return createIterablePromise({
|
|
1620
1620
|
func: (previousResponse) => {
|
|
1621
1621
|
return this.browse({
|
|
1622
1622
|
indexName,
|
|
1623
|
-
|
|
1623
|
+
browseParams: {
|
|
1624
1624
|
cursor: previousResponse ? previousResponse.cursor : undefined,
|
|
1625
|
-
...
|
|
1625
|
+
...browseParams,
|
|
1626
1626
|
},
|
|
1627
1627
|
}, requestOptions);
|
|
1628
1628
|
},
|
|
@@ -1910,10 +1910,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1910
1910
|
* @summary Retrieve all index content.
|
|
1911
1911
|
* @param browse - The browse object.
|
|
1912
1912
|
* @param browse.indexName - The index in which to perform the request.
|
|
1913
|
-
* @param browse.
|
|
1913
|
+
* @param browse.browseParams - The browseParams object.
|
|
1914
1914
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1915
1915
|
*/
|
|
1916
|
-
browse({ indexName,
|
|
1916
|
+
browse({ indexName, browseParams }, requestOptions) {
|
|
1917
1917
|
if (!indexName) {
|
|
1918
1918
|
throw new Error('Parameter `indexName` is required when calling `browse`.');
|
|
1919
1919
|
}
|
|
@@ -1925,7 +1925,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1925
1925
|
path: requestPath,
|
|
1926
1926
|
queryParameters,
|
|
1927
1927
|
headers,
|
|
1928
|
-
data:
|
|
1928
|
+
data: browseParams ? browseParams : {},
|
|
1929
1929
|
};
|
|
1930
1930
|
return transporter.request(request, requestOptions);
|
|
1931
1931
|
},
|