@algolia/recommend 5.0.0-alpha.11 → 5.0.0-alpha.110

package/dist/model/baseSearchResponse.d.ts

@@ -1,102 +1,110 @@
-import type { FacetsStats } from './facetsStats';
-import type { RenderingContent } from './renderingContent';
-export declare type BaseSearchResponse = {
-    /**
-     * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
-     */
-    abTestID?: number;
-    /**
-     * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
-     */
-    abTestVariantID?: number;
-    /**
-     * The computed geo location.
-     */
-    aroundLatLng?: string;
-    /**
-     * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
-     */
-    automaticRadius?: string;
-    /**
-     * Whether the facet count is exhaustive or approximate.
-     */
-    exhaustiveFacetsCount?: boolean;
-    /**
-     * Indicate if the nbHits count was exhaustive or approximate.
-     */
-    exhaustiveNbHits: boolean;
-    /**
-     * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
-     */
-    exhaustiveTypo?: boolean;
-    /**
-     * A mapping of each facet name to the corresponding facet counts.
-     */
-    facets?: Record<string, Record<string, number>>;
-    /**
-     * Statistics for numerical facets.
-     */
-    facets_stats?: Record<string, FacetsStats>;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage: number;
-    /**
-     * Index name used for the query.
-     */
-    index?: string;
-    /**
-     * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
-     */
-    indexUsed?: string;
-    /**
-     * Used to return warnings about the query.
-     */
-    message?: string;
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-    /**
-     * Number of pages available for the current query.
-     */
-    nbPages: number;
-    /**
-     * The number of hits selected and sorted by the relevant sort algorithm.
-     */
-    nbSortedHits?: number;
-    /**
-     * Specify the page to retrieve.
-     */
-    page: number;
-    /**
-     * A url-encoded string of all search parameters.
-     */
-    params: string;
-    /**
-     * The query string that will be searched, after normalization.
-     */
-    parsedQuery?: string;
-    /**
-     * Time the server took to process the request, in milliseconds.
-     */
-    processingTimeMS: number;
-    /**
-     * The text to search in the index.
-     */
-    query: string;
-    /**
-     * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
-     */
-    queryAfterRemoval?: string;
-    /**
-     * Actual host name of the server that processed the request.
-     */
-    serverUsed?: string;
-    /**
-     * Lets you store custom data in your indices.
-     */
-    userData?: Record<string, any>;
-    renderingContent?: RenderingContent;
-};
+import type { Exhaustive } from './exhaustive';
+import type { FacetsStats } from './facetsStats';
+import type { Redirect } from './redirect';
+import type { RenderingContent } from './renderingContent';
+export type BaseSearchResponse = Record<string, any> & {
+    /**
+     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
+     */
+    abTestID?: number;
+    /**
+     * Variant ID. This is only included in the response for indices that are part of an A/B test.
+     */
+    abTestVariantID?: number;
+    /**
+     * Computed geographical location.
+     */
+    aroundLatLng?: string;
+    /**
+     * Distance from a central coordinate provided by `aroundLatLng`.
+     */
+    automaticRadius?: string;
+    exhaustive?: Exhaustive;
+    /**
+     * See the `facetsCount` field of the `exhaustive` object in the response.
+     */
+    exhaustiveFacetsCount?: boolean;
+    /**
+     * See the `nbHits` field of the `exhaustive` object in the response.
+     */
+    exhaustiveNbHits?: boolean;
+    /**
+     * See the `typo` field of the `exhaustive` object in the response.
+     */
+    exhaustiveTypo?: boolean;
+    /**
+     * Facet counts.
+     */
+    facets?: Record<string, Record<string, number>>;
+    /**
+     * Statistics for numerical facets.
+     */
+    facets_stats?: Record<string, FacetsStats>;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage: number;
+    /**
+     * Index name used for the query.
+     */
+    index?: string;
+    /**
+     * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
+     */
+    indexUsed?: string;
+    /**
+     * Warnings about the query.
+     */
+    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.
+     */
+    parsedQuery?: string;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    processingTimeMS: number;
+    /**
+     * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
+     */
+    processingTimingsMS?: Record<string, any>;
+    /**
+     * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
+     */
+    queryAfterRemoval?: string;
+    redirect?: Redirect;
+    renderingContent?: RenderingContent;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    serverTimeMS?: number;
+    /**
+     * Host name of the server that processed the request.
+     */
+    serverUsed?: string;
+    /**
+     * An object with custom data.  You can store up to 32&nbsp;kB as custom data.
+     */
+    userData?: any | null;
+    /**
+     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+     */
+    queryID?: string;
+};
 //# sourceMappingURL=baseSearchResponse.d.ts.map

package/dist/model/baseSearchResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}
+{"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/baseTrendingFacetsQuery.d.ts

@@ -0,0 +1,9 @@
+import type { TrendingFacetsModel } from './trendingFacetsModel';
+export type BaseTrendingFacetsQuery = {
+    /**
+     * Facet name for trending models.
+     */
+    facetName: string;
+    model?: TrendingFacetsModel;
+};
+//# sourceMappingURL=baseTrendingFacetsQuery.d.ts.map

package/dist/model/baseTrendingFacetsQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseTrendingFacetsQuery.d.ts","sourceRoot":"","sources":["../../model/baseTrendingFacetsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B,CAAC"}

package/dist/model/baseTrendingItemsQuery.d.ts

@@ -0,0 +1,16 @@
+import type { SearchParamsObject } from './searchParamsObject';
+import type { TrendingItemsModel } from './trendingItemsModel';
+export type BaseTrendingItemsQuery = {
+    /**
+     * Facet name for trending models.
+     */
+    facetName?: string;
+    /**
+     * Facet value for trending models.
+     */
+    facetValue?: string;
+    model?: TrendingItemsModel;
+    queryParameters?: SearchParamsObject;
+    fallbackParameters?: SearchParamsObject;
+};
+//# sourceMappingURL=baseTrendingItemsQuery.d.ts.map

package/dist/model/baseTrendingItemsQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseTrendingItemsQuery.d.ts","sourceRoot":"","sources":["../../model/baseTrendingItemsQuery.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,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAE3B,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}

package/dist/model/clientMethodProps.d.ts

@@ -1,61 +1,128 @@
-/**
- * Properties for the `del` method.
- */
-export declare type DelProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `get` method.
- */
-export declare type GetProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `post` method.
- */
-export declare type PostProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * The parameters to send with the custom request.
-     */
-    body?: Record<string, any>;
-};
-/**
- * Properties for the `put` method.
- */
-export declare type PutProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * The parameters to send with the custom request.
-     */
-    body?: Record<string, any>;
-};
+import type { RecommendModels } from './recommendModels';
+import type { SearchRecommendRulesParams } from './searchRecommendRulesParams';
+/**
+ * Properties for the `customDelete` method.
+ */
+export type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+export type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+export type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * Properties for the `deleteRecommendRule` method.
+ */
+export type DeleteRecommendRuleProps = {
+    /**
+     * Name of the index on which to perform the operation.
+     */
+    indexName: string;
+    /**
+     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     */
+    model: RecommendModels;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+};
+/**
+ * Properties for the `getRecommendRule` method.
+ */
+export type GetRecommendRuleProps = {
+    /**
+     * Name of the index on which to perform the operation.
+     */
+    indexName: string;
+    /**
+     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     */
+    model: RecommendModels;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+};
+/**
+ * Properties for the `getRecommendStatus` method.
+ */
+export type GetRecommendStatusProps = {
+    /**
+     * Name of the index on which to perform the operation.
+     */
+    indexName: string;
+    /**
+     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     */
+    model: RecommendModels;
+    /**
+     * Unique identifier of a task. Numeric value (up to 64bits).
+     */
+    taskID: number;
+};
+/**
+ * Properties for the `searchRecommendRules` method.
+ */
+export type SearchRecommendRulesProps = {
+    /**
+     * Name of the index on which to perform the operation.
+     */
+    indexName: string;
+    /**
+     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     */
+    model: RecommendModels;
+    searchRecommendRulesParams?: SearchRecommendRulesParams;
+};
 //# sourceMappingURL=clientMethodProps.d.ts.map

package/dist/model/clientMethodProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB,0BAA0B,CAAC,EAAE,0BAA0B,CAAC;CACzD,CAAC"}

package/dist/model/condition.d.ts

@@ -0,0 +1,21 @@
+import type { Anchoring } from './anchoring';
+export type Condition = {
+    /**
+     * Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
+     */
+    pattern?: string;
+    anchoring?: Anchoring;
+    /**
+     * Whether the pattern should match plurals, synonyms, and typos.
+     */
+    alternatives?: boolean;
+    /**
+     * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
+     */
+    context?: string;
+    /**
+     * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
+     */
+    filters?: string;
+};
+//# sourceMappingURL=condition.d.ts.map

package/dist/model/condition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../model/condition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/consequence.d.ts

@@ -0,0 +1,26 @@
+import type { ConsequenceHide } from './consequenceHide';
+import type { ConsequenceParams } from './consequenceParams';
+import type { Promote } from './promote';
+/**
+ * Effect of the rule.  For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
+ */
+export type Consequence = {
+    params?: ConsequenceParams;
+    /**
+     * Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
+     */
+    promote?: Promote[];
+    /**
+     * Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won\'t be shown.
+     */
+    filterPromotes?: boolean;
+    /**
+     * Records you want to hide from the search results.
+     */
+    hide?: ConsequenceHide[];
+    /**
+     * A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1 kB of minified JSON.
+     */
+    userData?: any | null;
+};
+//# sourceMappingURL=consequence.d.ts.map

package/dist/model/consequence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consequence.d.ts","sourceRoot":"","sources":["../../model/consequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CACvB,CAAC"}

package/dist/model/consequenceHide.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Object ID of the record to hide.
+ */
+export type ConsequenceHide = {
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+};
+//# sourceMappingURL=consequenceHide.d.ts.map

package/dist/model/consequenceHide.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceHide.d.ts","sourceRoot":"","sources":["../../model/consequenceHide.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/consequenceParams.d.ts

@@ -0,0 +1,5 @@
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+import type { Params } from './params';
+export type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
+//# sourceMappingURL=consequenceParams.d.ts.map

package/dist/model/consequenceParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceParams.d.ts","sourceRoot":"","sources":["../../model/consequenceParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,iBAAiB,GAAG,4BAA4B,GAC1D,2BAA2B,GAC3B,MAAM,CAAC"}

package/dist/model/consequenceQuery.d.ts

@@ -0,0 +1,6 @@
+import type { ConsequenceQueryObject } from './consequenceQueryObject';
+/**
+ * Replace or edit the search query.  If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query.
+ */
+export type ConsequenceQuery = ConsequenceQueryObject | string;
+//# sourceMappingURL=consequenceQuery.d.ts.map

package/dist/model/consequenceQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceQuery.d.ts","sourceRoot":"","sources":["../../model/consequenceQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,MAAM,CAAC"}

package/dist/model/consequenceQueryObject.d.ts

@@ -0,0 +1,12 @@
+import type { Edit } from './edit';
+export type ConsequenceQueryObject = {
+    /**
+     * Words to remove from the search query.
+     */
+    remove?: string[];
+    /**
+     * Changes to make to the search query.
+     */
+    edits?: Edit[];
+};
+//# sourceMappingURL=consequenceQueryObject.d.ts.map

package/dist/model/consequenceQueryObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceQueryObject.d.ts","sourceRoot":"","sources":["../../model/consequenceQueryObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB,CAAC"}

package/dist/model/deletedAtResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Response, taskID, and deletion timestamp.
+ */
+export type DeletedAtResponse = {
+    /**
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+     */
+    taskID: number;
+    /**
+     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    deletedAt: string;
+};
+//# sourceMappingURL=deletedAtResponse.d.ts.map

package/dist/model/deletedAtResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deletedAtResponse.d.ts","sourceRoot":"","sources":["../../model/deletedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/distinct.d.ts

@@ -1,5 +1,5 @@
-/**
- * Enables de-duplication or grouping of results.
- */
-export declare type Distinct = boolean | number;
+/**
+ * Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
+ */
+export type Distinct = boolean | number;
 //# sourceMappingURL=distinct.d.ts.map

package/dist/model/distinct.d.ts.map

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

package/dist/model/edit.d.ts

@@ -0,0 +1,13 @@
+import type { EditType } from './editType';
+export type Edit = {
+    type?: EditType;
+    /**
+     * Text or patterns to remove from the query string.
+     */
+    delete?: string;
+    /**
+     * Text to be added in place of the deleted text inside the query string.
+     */
+    insert?: string;
+};
+//# sourceMappingURL=edit.d.ts.map

package/dist/model/edit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edit.d.ts","sourceRoot":"","sources":["../../model/edit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/editType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Type of edit.
+ */
+export type EditType = 'remove' | 'replace';
+//# sourceMappingURL=editType.d.ts.map

package/dist/model/editType.d.ts.map

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