algoliasearch 5.0.0-beta.1 → 5.0.0-beta.11

package/dist/recommend/model/searchRecommendRulesParams.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Recommend rules parameters.
+ */
+export type SearchRecommendRulesParams = {
+    /**
+     * Search query.
+     */
+    query?: string;
+    /**
+     * Only search for rules with matching context.
+     */
+    context?: string;
+    /**
+     * Requested page of the API response.
+     */
+    page?: number;
+    /**
+     * Maximum number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property.
+     */
+    enabled?: boolean;
+    /**
+     * Filter expression. This only searches for rules matching the filter expression.
+     */
+    filters?: string;
+    /**
+     * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
+     */
+    facets?: string[];
+    /**
+     * Maximum number of values to return for each facet.
+     */
+    maxValuesPerFacet?: number;
+};
+//# sourceMappingURL=searchRecommendRulesParams.d.ts.map

package/dist/recommend/model/searchRecommendRulesParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchRecommendRulesParams.d.ts","sourceRoot":"","sources":["../../../../recommend/model/searchRecommendRulesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}

package/dist/recommend/model/searchRecommendRulesResponse.d.ts

@@ -0,0 +1,20 @@
+import type { RecommendRule } from './recommendRule';
+export type SearchRecommendRulesResponse = {
+    /**
+     * Recommend rules that match the search criteria.
+     */
+    hits: RecommendRule[];
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+    /**
+     * Page of search results to retrieve.
+     */
+    page: number;
+    /**
+     * Number of pages of results.
+     */
+    nbPages: number;
+};
+//# sourceMappingURL=searchRecommendRulesResponse.d.ts.map

package/dist/recommend/model/searchRecommendRulesResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchRecommendRulesResponse.d.ts","sourceRoot":"","sources":["../../../../recommend/model/searchRecommendRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,aAAa,EAAE,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/recommend/model/semanticSearch.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
+ */
+export type SemanticSearch = {
+    /**
+     * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
+     */
+    eventSources?: string[] | null;
+};
+//# sourceMappingURL=semanticSearch.d.ts.map

package/dist/recommend/model/semanticSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semanticSearch.d.ts","sourceRoot":"","sources":["../../../../recommend/model/semanticSearch.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC,CAAC"}

package/dist/recommend/model/snippetResult.d.ts

@@ -0,0 +1,3 @@
+import type { SnippetResultOption } from './snippetResultOption';
+export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption | SnippetResultOption[];
+//# sourceMappingURL=snippetResult.d.ts.map

package/dist/recommend/model/snippetResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../../../recommend/model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,GACnB,mBAAmB,EAAE,CAAC"}

package/dist/recommend/model/snippetResultOption.d.ts

@@ -0,0 +1,12 @@
+import type { MatchLevel } from './matchLevel';
+/**
+ * Snippets that show the context around a matching search query.
+ */
+export type SnippetResultOption = {
+    /**
+     * Highlighted attribute value, including HTML tags.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+};
+//# sourceMappingURL=snippetResultOption.d.ts.map

package/dist/recommend/model/snippetResultOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../../../recommend/model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}

package/dist/recommend/model/sortRemainingBy.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  - `count`.   Order remaining facet values by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Sort facet values alphabetically.  - `hidden`.   Don\'t show facet values that aren\'t explicitly positioned.
+ */
+export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
+//# sourceMappingURL=sortRemainingBy.d.ts.map

package/dist/recommend/model/sortRemainingBy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortRemainingBy.d.ts","sourceRoot":"","sources":["../../../../recommend/model/sortRemainingBy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC"}

package/dist/recommend/model/supportedLanguage.d.ts

@@ -0,0 +1,5 @@
+/**
+ * ISO code for a supported language.
+ */
+export type SupportedLanguage = 'af' | 'ar' | 'az' | 'bg' | 'bn' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fo' | 'fr' | 'ga' | 'gl' | 'he' | 'hi' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kk' | 'ko' | 'ku' | 'ky' | 'lt' | 'lv' | 'mi' | 'mn' | 'mr' | 'ms' | 'mt' | 'nb' | 'nl' | 'no' | 'ns' | 'pl' | 'ps' | 'pt-br' | 'pt' | 'qu' | 'ro' | 'ru' | 'sk' | 'sq' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tn' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'zh';
+//# sourceMappingURL=supportedLanguage.d.ts.map

package/dist/recommend/model/supportedLanguage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"supportedLanguage.d.ts","sourceRoot":"","sources":["../../../../recommend/model/supportedLanguage.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC"}

package/dist/recommend/model/tagFilters.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
+ */
+export type TagFilters = TagFilters[] | string;
+//# sourceMappingURL=tagFilters.d.ts.map

package/dist/recommend/model/tagFilters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagFilters.d.ts","sourceRoot":"","sources":["../../../../recommend/model/tagFilters.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC"}

package/dist/recommend/model/taskStatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"taskStatus.d.ts","sourceRoot":"","sources":["../../../../recommend/model/taskStatus.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,WAAW,CAAC"}

package/dist/recommend/model/trendingFacetHit.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Trending facet hit.
+ */
+export type TrendingFacetHit = {
+    /**
+     * Recommendation score.
+     */
+    _score: number;
+    /**
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetName: string;
+    /**
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetValue: string;
+};
+//# sourceMappingURL=trendingFacetHit.d.ts.map

package/dist/recommend/model/trendingFacetHit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingFacetHit.d.ts","sourceRoot":"","sources":["../../../../recommend/model/trendingFacetHit.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/recommend/model/trendingFacets.d.ts

@@ -0,0 +1,11 @@
+import type { FallbackParams } from './fallbackParams';
+import type { TrendingFacetsModel } from './trendingFacetsModel';
+export type TrendingFacets = {
+    /**
+     * Facet attribute for which to retrieve trending facet values.
+     */
+    facetName: any | null;
+    model: TrendingFacetsModel;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=trendingFacets.d.ts.map

package/dist/recommend/model/trendingFacets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingFacets.d.ts","sourceRoot":"","sources":["../../../../recommend/model/trendingFacets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB,KAAK,EAAE,mBAAmB,CAAC;IAE3B,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/recommend/model/trendingFacetsModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
+ */
+export type TrendingFacetsModel = 'trending-facets';
+//# sourceMappingURL=trendingFacetsModel.d.ts.map

package/dist/recommend/model/trendingFacetsModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingFacetsModel.d.ts","sourceRoot":"","sources":["../../../../recommend/model/trendingFacetsModel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,CAAC"}

package/dist/recommend/model/trendingFacetsQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { TrendingFacets } from './trendingFacets';
+export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
+//# sourceMappingURL=trendingFacetsQuery.d.ts.map

package/dist/recommend/model/trendingFacetsQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingFacetsQuery.d.ts","sourceRoot":"","sources":["../../../../recommend/model/trendingFacetsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,cAAc,CAAC"}

package/dist/recommend/model/trendingItems.d.ts

@@ -0,0 +1,15 @@
+import type { SearchParamsObject } from './searchParamsObject';
+import type { TrendingItemsModel } from './trendingItemsModel';
+export type TrendingItems = {
+    /**
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetName?: string;
+    /**
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetValue?: string;
+    model: TrendingItemsModel;
+    fallbackParameters?: SearchParamsObject;
+};
+//# sourceMappingURL=trendingItems.d.ts.map

package/dist/recommend/model/trendingItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingItems.d.ts","sourceRoot":"","sources":["../../../../recommend/model/trendingItems.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,kBAAkB,CAAC;IAE1B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}

package/dist/recommend/model/trendingItemsModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Trending items model.  Trending items are determined from the number of conversion events collected on them.
+ */
+export type TrendingItemsModel = 'trending-items';
+//# sourceMappingURL=trendingItemsModel.d.ts.map

package/dist/recommend/model/trendingItemsModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingItemsModel.d.ts","sourceRoot":"","sources":["../../../../recommend/model/trendingItemsModel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,CAAC"}

package/dist/recommend/model/trendingItemsQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { TrendingItems } from './trendingItems';
+export type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
+//# sourceMappingURL=trendingItemsQuery.d.ts.map

package/dist/recommend/model/trendingItemsQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingItemsQuery.d.ts","sourceRoot":"","sources":["../../../../recommend/model/trendingItemsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,aAAa,CAAC"}

package/dist/recommend/model/typoTolerance.d.ts

@@ -0,0 +1,6 @@
+import type { TypoToleranceEnum } from './typoToleranceEnum';
+/**
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
+ */
+export type TypoTolerance = TypoToleranceEnum | boolean;
+//# sourceMappingURL=typoTolerance.d.ts.map

package/dist/recommend/model/typoTolerance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typoTolerance.d.ts","sourceRoot":"","sources":["../../../../recommend/model/typoTolerance.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,OAAO,CAAC"}

package/dist/recommend/model/typoToleranceEnum.d.ts

@@ -0,0 +1,5 @@
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
+export type TypoToleranceEnum = 'min' | 'strict';
+//# sourceMappingURL=typoToleranceEnum.d.ts.map

package/dist/recommend/model/typoToleranceEnum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../../recommend/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}

package/dist/recommend/model/value.d.ts

@@ -0,0 +1,13 @@
+import type { SortRemainingBy } from './sortRemainingBy';
+export type Value = {
+    /**
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
+     */
+    order?: string[];
+    sortRemainingBy?: SortRemainingBy;
+    /**
+     * Hide facet values.
+     */
+    hide?: string[];
+};
+//# sourceMappingURL=value.d.ts.map

package/dist/recommend/model/value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../recommend/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}

package/dist/recommend/src/recommendClient.d.ts

@@ -0,0 +1,132 @@
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteRecommendRuleProps, GetRecommendRuleProps, GetRecommendStatusProps, LegacyGetRecommendationsParams, SearchRecommendRulesProps } from '../model/clientMethodProps';
+import type { DeletedAtResponse } from '../model/deletedAtResponse';
+import type { GetRecommendTaskResponse } from '../model/getRecommendTaskResponse';
+import type { GetRecommendationsParams } from '../model/getRecommendationsParams';
+import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
+import type { RecommendRule } from '../model/recommendRule';
+import type { SearchRecommendRulesResponse } from '../model/searchRecommendRulesResponse';
+export declare const apiClientVersion = "5.0.0-beta.11";
+export declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.parameters - Query parameters to apply to the current query.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Deletes a Recommend rule from a recommendation scenario.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param deleteRecommendRule - The deleteRecommendRule object.
+     * @param deleteRecommendRule.indexName - Name of the index on which to perform the operation.
+     * @param deleteRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param deleteRecommendRule.objectID - Unique record identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    deleteRecommendRule({ indexName, model, objectID }: DeleteRecommendRuleProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
+    /**
+     * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param getRecommendRule - The getRecommendRule object.
+     * @param getRecommendRule.indexName - Name of the index on which to perform the operation.
+     * @param getRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param getRecommendRule.objectID - Unique record identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendRule({ indexName, model, objectID }: GetRecommendRuleProps, requestOptions?: RequestOptions): Promise<RecommendRule>;
+    /**
+     * Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param getRecommendStatus - The getRecommendStatus object.
+     * @param getRecommendStatus.indexName - Name of the index on which to perform the operation.
+     * @param getRecommendStatus.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param getRecommendStatus.taskID - Unique task identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendStatus({ indexName, model, taskID }: GetRecommendStatusProps, requestOptions?: RequestOptions): Promise<GetRecommendTaskResponse>;
+    /**
+     * Retrieves recommendations from selected AI models.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param getRecommendationsParams - The getRecommendationsParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendations(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: RequestOptions): Promise<GetRecommendationsResponse>;
+    /**
+     * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param searchRecommendRules - The searchRecommendRules object.
+     * @param searchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param searchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param searchRecommendRules.searchRecommendRulesParams - The searchRecommendRulesParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    searchRecommendRules({ indexName, model, searchRecommendRulesParams, }: SearchRecommendRulesProps, requestOptions?: RequestOptions): Promise<SearchRecommendRulesResponse>;
+};
+//# sourceMappingURL=recommendClient.d.ts.map

package/dist/recommend/src/recommendClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendClient.d.ts","sourceRoot":"","sources":["../../../../recommend/src/recommendClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,8BAA8B,EAC9B,yBAAyB,EAC1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAE1F,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAsChD,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;;;OAWG;wDAE+B,wBAAwB,mBACvC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAqC7B;;;;;;;;;;;OAWG;qDAE+B,qBAAqB,mBACpC,cAAc,GAC9B,OAAO,CAAC,aAAa,CAAC;IAqCzB;;;;;;;;;;;OAWG;qDAE6B,uBAAuB,mBACpC,cAAc,GAC9B,OAAO,CAAC,wBAAwB,CAAC;IAoCpC;;;;;;;;OAQG;iDAGG,wBAAwB,GACxB,8BAA8B,mBACjB,cAAc,GAC9B,OAAO,CAAC,0BAA0B,CAAC;IAuCtC;;;;;;;;;;;OAWG;4EAME,yBAAyB,mBACX,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;EAiC3C"}

package/lite/model/baseIndexSettings.ts

@@ -74,9 +74,9 @@ export type BaseIndexSettings = {
   searchableAttributes?: string[];
 
   /**
-   * An object with custom data.  You can store up to 32 kB as custom data.
+   * An object with custom data.  You can store up to 32kB as custom data.
    */
-  userData?: any | null;
+  userData?: Record<string, any>;
 
   /**
    * Characters and their normalized replacements. This overrides Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).

package/lite/model/baseRecommendRequest.ts

@@ -0,0 +1,22 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { SearchParams } from './searchParams';
+
+export type BaseRecommendRequest = {
+  /**
+   * Index name (case-sensitive).
+   */
+  indexName: string;
+
+  /**
+   * Minimum score a recommendation must have to be included in the response.
+   */
+  threshold: number;
+
+  /**
+   * Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
+   */
+  maxRecommendations?: number;
+
+  queryParameters?: SearchParams;
+};

package/lite/model/baseSearchResponse.ts

@@ -53,11 +53,6 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   facets_stats?: Record<string, FacetsStats>;
 
-  /**
-   * Number of hits per page.
-   */
-  hitsPerPage: number;
-
   /**
    * Index name used for the query.
    */
@@ -73,26 +68,11 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   message?: string;
 
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-
-  /**
-   * Number of pages of results.
-   */
-  nbPages: number;
-
   /**
    * Number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
 
-  /**
-   * Page of search results to retrieve.
-   */
-  page: number;
-
   /**
    * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
    */
@@ -128,9 +108,9 @@ export type BaseSearchResponse = Record<string, any> & {
   serverUsed?: string;
 
   /**
-   * An object with custom data.  You can store up to 32&nbsp;kB as custom data.
+   * An object with custom data.  You can store up to 32kB as custom data.
    */
-  userData?: any | null;
+  userData?: Record<string, any>;
 
   /**
    * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).

package/lite/model/boughtTogetherQuery.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { FrequentlyBoughtTogether } from './frequentlyBoughtTogether';
+
+export type BoughtTogetherQuery = BaseRecommendRequest &
+  FrequentlyBoughtTogether;

package/lite/model/browsePagination.ts

@@ -0,0 +1,23 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type BrowsePagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page?: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits?: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages?: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number;
+};

package/lite/model/browseResponse.ts

@@ -1,9 +1,11 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { BaseSearchResponse } from './baseSearchResponse';
+import type { BrowsePagination } from './browsePagination';
 import type { Cursor } from './cursor';
 import type { SearchHits } from './searchHits';
 
 export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse &
+  BrowsePagination &
   Cursor &
   SearchHits<T>;

package/lite/model/clientMethodProps.ts

@@ -1,5 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+import type { RecommendationsRequest } from './recommendationsRequest';
 import type { SearchForFacetsOptions } from './searchForFacetsOptions';
 import type { SearchForHitsOptions } from './searchForHitsOptions';
 import type { SearchParamsObject } from './searchParamsObject';
@@ -22,6 +23,13 @@ export type CustomPostProps = {
   body?: Record<string, any>;
 };
 
+/**
+ * Recommend method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `GetRecommendationsParams` type for performances and future proof reasons.
+ */
+export type LegacyGetRecommendationsParams = RecommendationsRequest[];
+
 /**
  * In v4, the search parameters are wrapped in a `params` parameter.
  *

package/lite/model/facetFilters.ts

@@ -1,8 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { MixedSearchFilters } from './mixedSearchFilters';
-
 /**
  * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
-export type FacetFilters = MixedSearchFilters[] | string;
+export type FacetFilters = FacetFilters[] | string;

package/lite/model/{attributeToUpdate.ts → fallbackParams.ts}

@@ -1,5 +1,5 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { BuiltInOperation } from './builtInOperation';
+import type { SearchParamsObject } from './searchParamsObject';
 
-export type AttributeToUpdate = BuiltInOperation | string;
+export type FallbackParams = Record<string, any> & SearchParamsObject;

package/lite/model/{builtInOperationType.ts → fbtModel.ts}

@@ -1,13 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * How to change the attribute.
+ * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
  */
-export type BuiltInOperationType =
-  | 'Add'
-  | 'AddUnique'
-  | 'Decrement'
-  | 'Increment'
-  | 'IncrementFrom'
-  | 'IncrementSet'
-  | 'Remove';
+export type FbtModel = 'bought-together';