@algolia/recommend 4.14.2 → 5.0.0-alpha.11

package/dist/builds/browser.d.ts

@@ -0,0 +1,6 @@
+import type { ClientOptions } from '@algolia/client-common';
+import type { RecommendClient } from '../src/recommendClient';
+export { apiClientVersion, RecommendClient } from '../src/recommendClient';
+export * from '../model';
+export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
+//# sourceMappingURL=browser.d.ts.map

package/dist/builds/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAe5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CA8BjB"}

package/dist/builds/node.d.ts

@@ -0,0 +1,6 @@
+import type { ClientOptions } from '@algolia/client-common';
+import type { RecommendClient } from '../src/recommendClient';
+export { apiClientVersion, RecommendClient } from '../src/recommendClient';
+export * from '../model';
+export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
+//# sourceMappingURL=node.d.ts.map

package/dist/builds/node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CAwBjB"}

package/dist/model/advancedSyntaxFeatures.d.ts

@@ -0,0 +1,2 @@
+export declare type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
+//# sourceMappingURL=advancedSyntaxFeatures.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"advancedSyntaxFeatures.d.ts","sourceRoot":"","sources":["../../model/advancedSyntaxFeatures.ts"],"names":[],"mappings":"AAEA,oBAAY,sBAAsB,GAAG,aAAa,GAAG,cAAc,CAAC"}

package/dist/model/alternativesAsExact.d.ts

@@ -0,0 +1,2 @@
+export declare type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
+//# sourceMappingURL=alternativesAsExact.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"alternativesAsExact.d.ts","sourceRoot":"","sources":["../../model/alternativesAsExact.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAC3B,eAAe,GACf,mBAAmB,GACnB,mBAAmB,CAAC"}

package/dist/model/aroundRadius.d.ts

@@ -0,0 +1,6 @@
+import type { AroundRadiusAll } from './aroundRadiusAll';
+/**
+ * Define the maximum radius for a geo search (in meters).
+ */
+export declare type AroundRadius = AroundRadiusAll | number;
+//# sourceMappingURL=aroundRadius.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aroundRadius.d.ts","sourceRoot":"","sources":["../../model/aroundRadius.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,oBAAY,YAAY,GAAG,eAAe,GAAG,MAAM,CAAC"}

package/dist/model/aroundRadiusAll.d.ts

@@ -0,0 +1,2 @@
+export declare type AroundRadiusAll = 'all';
+//# sourceMappingURL=aroundRadiusAll.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG,KAAK,CAAC"}

package/dist/model/baseRecommendRequest.d.ts

@@ -0,0 +1,18 @@
+import type { SearchParamsObject } from './searchParamsObject';
+export declare type BaseRecommendRequest = {
+    /**
+     * The Algolia index name.
+     */
+    indexName: string;
+    /**
+     * The threshold to use when filtering recommendations by their score.
+     */
+    threshold: number;
+    /**
+     * The max number of recommendations to retrieve. If it\'s set to 0, all the recommendations of the objectID may be returned.
+     */
+    maxRecommendations?: number;
+    queryParameters?: SearchParamsObject;
+    fallbackParameters?: SearchParamsObject;
+};
+//# sourceMappingURL=baseRecommendRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}

package/dist/model/baseRecommendationRequest.d.ts

@@ -0,0 +1,9 @@
+import type { RecommendationModels } from './recommendationModels';
+export declare type BaseRecommendationRequest = {
+    model: RecommendationModels;
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+};
+//# sourceMappingURL=baseRecommendationRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseRecommendationRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendationRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,oBAAY,yBAAyB,GAAG;IACtC,KAAK,EAAE,oBAAoB,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/baseSearchParams.d.ts

@@ -0,0 +1,4 @@
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { SearchParamsQuery } from './searchParamsQuery';
+export declare type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
+//# sourceMappingURL=baseSearchParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseSearchParams.d.ts","sourceRoot":"","sources":["../../model/baseSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,oBAAY,gBAAgB,GAAG,4BAA4B,GAAG,iBAAiB,CAAC"}

package/dist/model/baseSearchParamsWithoutQuery.d.ts

@@ -0,0 +1,123 @@
+import type { AroundRadius } from './aroundRadius';
+import type { FacetFilters } from './facetFilters';
+import type { NumericFilters } from './numericFilters';
+import type { OptionalFilters } from './optionalFilters';
+import type { ReRankingApplyFilter } from './reRankingApplyFilter';
+import type { TagFilters } from './tagFilters';
+export declare type BaseSearchParamsWithoutQuery = {
+    /**
+     * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
+     */
+    similarQuery?: string;
+    /**
+     * Filter the query with numeric, facet and/or tag filters.
+     */
+    filters?: string;
+    facetFilters?: FacetFilters;
+    optionalFilters?: OptionalFilters;
+    numericFilters?: NumericFilters;
+    tagFilters?: TagFilters;
+    /**
+     * Determines how to calculate the total score for filtering.
+     */
+    sumOrFiltersScores?: boolean;
+    /**
+     * Retrieve facets and their facet values.
+     */
+    facets?: string[];
+    /**
+     * Maximum number of facet values to return for each facet during a regular search.
+     */
+    maxValuesPerFacet?: number;
+    /**
+     * Force faceting to be applied after de-duplication (via the Distinct setting).
+     */
+    facetingAfterDistinct?: boolean;
+    /**
+     * Controls how facet values are fetched.
+     */
+    sortFacetValuesBy?: string;
+    /**
+     * Specify the page to retrieve.
+     */
+    page?: number;
+    /**
+     * Specify the offset of the first hit to return.
+     */
+    offset?: number;
+    /**
+     * Set the number of hits to retrieve (used only with offset).
+     */
+    length?: number;
+    /**
+     * Search for entries around a central geolocation, enabling a geo search within a circular area.
+     */
+    aroundLatLng?: string;
+    /**
+     * Search for entries around a given location automatically computed from the requester\'s IP address.
+     */
+    aroundLatLngViaIP?: boolean;
+    aroundRadius?: AroundRadius;
+    /**
+     * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
+     */
+    aroundPrecision?: number;
+    /**
+     * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
+     */
+    minimumAroundRadius?: number;
+    /**
+     * Search inside a rectangular area (in geo coordinates).
+     */
+    insideBoundingBox?: number[];
+    /**
+     * Search inside a polygon (in geo coordinates).
+     */
+    insidePolygon?: number[];
+    /**
+     * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
+     */
+    naturalLanguages?: string[];
+    /**
+     * Enables contextual rules.
+     */
+    ruleContexts?: string[];
+    /**
+     * Define the impact of the Personalization feature.
+     */
+    personalizationImpact?: number;
+    /**
+     * Associates a certain user token with the current search.
+     */
+    userToken?: string;
+    /**
+     * Retrieve detailed ranking information.
+     */
+    getRankingInfo?: boolean;
+    /**
+     * Enable the Click Analytics feature.
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Whether the current query will be taken into account in the Analytics.
+     */
+    analytics?: boolean;
+    /**
+     * List of tags to apply to the query for analytics purposes.
+     */
+    analyticsTags?: string[];
+    /**
+     * Whether to include or exclude a query from the processing-time percentile computation.
+     */
+    percentileComputation?: boolean;
+    /**
+     * Whether this search should participate in running AB tests.
+     */
+    enableABTest?: boolean;
+    /**
+     * Whether this search should use AI Re-Ranking.
+     */
+    enableReRanking?: boolean;
+    reRankingApplyFilter?: ReRankingApplyFilter | null;
+};
+//# sourceMappingURL=baseSearchParamsWithoutQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACpD,CAAC"}

package/dist/model/baseSearchResponse.d.ts

@@ -0,0 +1,102 @@
+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;
+};
+//# sourceMappingURL=baseSearchResponse.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/baseTrendingRequest.d.ts

@@ -0,0 +1,13 @@
+import type { TrendingModels } from './trendingModels';
+export declare type BaseTrendingRequest = {
+    model: TrendingModels;
+    /**
+     * The facet name to use for trending models.
+     */
+    facetName?: string;
+    /**
+     * The facet value to use for trending models.
+     */
+    facetValue?: string;
+};
+//# sourceMappingURL=baseTrendingRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseTrendingRequest.d.ts","sourceRoot":"","sources":["../../model/baseTrendingRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,mBAAmB,GAAG;IAChC,KAAK,EAAE,cAAc,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/model/clientMethodProps.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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>;
+};
+//# sourceMappingURL=clientMethodProps.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/distinct.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Enables de-duplication or grouping of results.
+ */
+export declare type Distinct = boolean | number;
+//# sourceMappingURL=distinct.d.ts.map

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

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

package/dist/model/errorBase.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Error.
+ */
+export declare type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+//# sourceMappingURL=errorBase.d.ts.map

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

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

package/dist/model/exactOnSingleWordQuery.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Controls how the exact ranking criterion is computed when the query contains only one word.
+ */
+export declare type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
+//# sourceMappingURL=exactOnSingleWordQuery.d.ts.map

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

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

package/dist/model/facetFilters.d.ts

@@ -0,0 +1,6 @@
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Filter hits by facet value.
+ */
+export declare type FacetFilters = MixedSearchFilters[] | string;
+//# sourceMappingURL=facetFilters.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"facetFilters.d.ts","sourceRoot":"","sources":["../../model/facetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,YAAY,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/model/facetOrdering.d.ts

@@ -0,0 +1,13 @@
+import type { Facets } from './facets';
+import type { Value } from './value';
+/**
+ * Defining how facets should be ordered.
+ */
+export declare type FacetOrdering = {
+    facets?: Facets;
+    /**
+     * The ordering of facet values, within an individual list.
+     */
+    values?: Record<string, Value>;
+};
+//# sourceMappingURL=facetOrdering.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"facetOrdering.d.ts","sourceRoot":"","sources":["../../model/facetOrdering.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,oBAAY,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAChC,CAAC"}

package/dist/model/facets.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The ordering of facets (widgets).
+ */
+export declare type Facets = {
+    /**
+     * Pinned order of facet lists.
+     */
+    order?: string[];
+};
+//# sourceMappingURL=facets.d.ts.map

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

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

package/dist/model/facetsStats.d.ts

@@ -0,0 +1,19 @@
+export declare type FacetsStats = {
+    /**
+     * The minimum value in the result set.
+     */
+    min?: number;
+    /**
+     * The maximum value in the result set.
+     */
+    max?: number;
+    /**
+     * The average facet value in the result set.
+     */
+    avg?: number;
+    /**
+     * The sum of all values in the result set.
+     */
+    sum?: number;
+};
+//# sourceMappingURL=facetsStats.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"facetsStats.d.ts","sourceRoot":"","sources":["../../model/facetsStats.ts"],"names":[],"mappings":"AAEA,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/model/getRecommendationsParams.d.ts

@@ -0,0 +1,11 @@
+import type { RecommendationsRequest } from './recommendationsRequest';
+/**
+ * The `getRecommendations` parameters.
+ */
+export declare type GetRecommendationsParams = {
+    /**
+     * The `getRecommendations` requests.
+     */
+    requests: RecommendationsRequest[];
+};
+//# sourceMappingURL=getRecommendationsParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getRecommendationsParams.d.ts","sourceRoot":"","sources":["../../model/getRecommendationsParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;GAEG;AACH,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACpC,CAAC"}

package/dist/model/getRecommendationsResponse.d.ts

@@ -0,0 +1,5 @@
+import type { RecommendationsResponse } from './recommendationsResponse';
+export declare type GetRecommendationsResponse = {
+    results?: RecommendationsResponse[];
+};
+//# sourceMappingURL=getRecommendationsResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getRecommendationsResponse.d.ts","sourceRoot":"","sources":["../../model/getRecommendationsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEzE,oBAAY,0BAA0B,GAAG;IACvC,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAC;CACrC,CAAC"}

package/dist/model/highlightResult.d.ts

@@ -0,0 +1,3 @@
+import type { HighlightResultOption } from './highlightResultOption';
+export declare type HighlightResult = HighlightResultOption | HighlightResultOption[];
+//# sourceMappingURL=highlightResult.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"highlightResult.d.ts","sourceRoot":"","sources":["../../model/highlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,oBAAY,eAAe,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,CAAC"}

package/dist/model/highlightResultOption.d.ts

@@ -0,0 +1,20 @@
+import type { MatchLevel } from './matchLevel';
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export declare type HighlightResultOption = {
+    /**
+     * Markup text with occurrences highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+    /**
+     * List of words from the query that matched the object.
+     */
+    matchedWords: string[];
+    /**
+     * Whether the entire attribute value is highlighted.
+     */
+    fullyHighlighted?: boolean;
+};
+//# sourceMappingURL=highlightResultOption.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"highlightResultOption.d.ts","sourceRoot":"","sources":["../../model/highlightResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC"}

package/dist/model/ignorePlurals.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ */
+export declare type IgnorePlurals = string[] | boolean;
+//# sourceMappingURL=ignorePlurals.d.ts.map

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

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