@algolia/client-search 4.14.1 → 5.0.0-alpha.2

package/model/promoteObjectIDs.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Multiple objectIDs to promote as hits.
+ */
+export type PromoteObjectIDs = {
+  /**
+   * Array of unique identifiers of the objects to promote.
+   */
+  objectIDs: string[];
+  /**
+   * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+   */
+  position: number;
+};

package/model/queryType.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

package/model/rankingInfo.ts

@@ -0,0 +1,53 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+
+export type RankingInfo = {
+  /**
+   * This field is reserved for advanced usage.
+   */
+  filters: number;
+  /**
+   * Position of the most important matched attribute in the attributes to index list.
+   */
+  firstMatchedWord: number;
+  /**
+   * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+   */
+  geoDistance: number;
+  /**
+   * Precision used when computing the geo distance, in meters.
+   */
+  geoPrecision?: number;
+  matchedGeoLocation?: MatchedGeoLocation;
+  personalization?: Personalization;
+  /**
+   * Number of exactly matched words.
+   */
+  nbExactWords: number;
+  /**
+   * Number of typos encountered when matching the record.
+   */
+  nbTypos: number;
+  /**
+   * Present and set to true if a Rule promoted the hit.
+   */
+  promoted: boolean;
+  /**
+   * When the query contains more than one word, the sum of the distances between matched words (in meters).
+   */
+  proximityDistance?: number;
+  /**
+   * Custom ranking for the object, expressed as a single integer value.
+   */
+  userScore: number;
+  /**
+   * Number of matched words, including prefixes and typos.
+   */
+  words: number;
+  /**
+   * Wether the record are promoted by the re-ranking strategy.
+   */
+  promotedByReRanking?: boolean;
+};

package/model/reRankingApplyFilter.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ */
+export type ReRankingApplyFilter = MixedSearchFilters[] | string;

package/model/removeStopWords.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Removes stop (common) words from the query before executing it. RemoveStopWords 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 stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;

package/model/removeUserIdResponse.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type RemoveUserIdResponse = {
+  /**
+   * Date of deletion (ISO-8601 format).
+   */
+  deletedAt: string;
+};

package/model/removeWordsIfNoResults.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ */
+export type RemoveWordsIfNoResults =
+  | 'allOptional'
+  | 'firstWords'
+  | 'lastWords'
+  | 'none';

package/model/renderingContent.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { FacetOrdering } from './facetOrdering';
+
+/**
+ * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ */
+export type RenderingContent = {
+  facetOrdering?: FacetOrdering;
+};

package/model/replaceSourceResponse.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type ReplaceSourceResponse = {
+  /**
+   * Date of last update (ISO-8601 format).
+   */
+  updatedAt: string;
+};

package/model/rule.ts

@@ -0,0 +1,32 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { TimeRange } from './timeRange';
+
+/**
+ * Rule object.
+ */
+export type Rule = {
+  /**
+   * Unique identifier of the object.
+   */
+  objectID: string;
+  /**
+   * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
+   */
+  conditions?: Condition[];
+  consequence?: Consequence;
+  /**
+   * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
+   */
+  description?: string;
+  /**
+   * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+   */
+  enabled?: boolean;
+  /**
+   * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
+   */
+  validity?: TimeRange[];
+};

package/model/saveObjectResponse.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SaveObjectResponse = {
+  createdAt?: string;
+  /**
+   * TaskID of the task to wait for.
+   */
+  taskID?: number;
+  /**
+   * Unique identifier of the object.
+   */
+  objectID?: string;
+};

package/model/saveSynonymResponse.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SaveSynonymResponse = {
+  /**
+   * TaskID of the task to wait for.
+   */
+  taskID: number;
+  /**
+   * Date of last update (ISO-8601 format).
+   */
+  updatedAt: string;
+  /**
+   * ObjectID of the inserted object.
+   */
+  id: string;
+};

package/model/scopeType.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type ScopeType = 'rules' | 'settings' | 'synonyms';

package/model/searchDictionaryEntriesParams.ts

@@ -0,0 +1,23 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The `searchDictionaryEntries` parameters.
+ */
+export type SearchDictionaryEntriesParams = {
+  /**
+   * The text to search in the index.
+   */
+  query: string;
+  /**
+   * Specify the page to retrieve.
+   */
+  page?: number;
+  /**
+   * Set the number of hits per page.
+   */
+  hitsPerPage?: number;
+  /**
+   * Language ISO code supported by the dictionary (e.g., \"en\" for English).
+   */
+  language?: string;
+};

package/model/searchForFacetValuesRequest.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchForFacetValuesRequest = {
+  /**
+   * Search parameters as URL-encoded query string.
+   */
+  params?: string;
+  /**
+   * Text to search inside the facet\'s values.
+   */
+  facetQuery?: string;
+  /**
+   * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+   */
+  maxFacetHits?: number;
+};

package/model/searchForFacetValuesResponse.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { FacetHits } from './facetHits';
+
+export type SearchForFacetValuesResponse = {
+  facetHits: FacetHits[];
+};

package/model/searchForFacets.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchParams } from './searchParams';
+
+export type SearchForFacets = SearchForFacetsOptions & SearchParams;

package/model/searchForFacetsOptions.ts

@@ -0,0 +1,23 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchTypeFacet } from './searchTypeFacet';
+
+export type SearchForFacetsOptions = {
+  /**
+   * The `facet` name.
+   */
+  facet: string;
+  /**
+   * The Algolia index name.
+   */
+  indexName: string;
+  /**
+   * Text to search inside the facet\'s values.
+   */
+  facetQuery?: string;
+  /**
+   * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+   */
+  maxFacetHits?: number;
+  type: SearchTypeFacet;
+};

package/model/searchForHits.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParams } from './searchParams';
+
+export type SearchForHits = SearchForHitsOptions & SearchParams;

package/model/searchForHitsOptions.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchTypeDefault } from './searchTypeDefault';
+
+export type SearchForHitsOptions = {
+  /**
+   * The Algolia index name.
+   */
+  indexName: string;
+  type?: SearchTypeDefault;
+} & { facet?: never; maxFacetHits?: never; facetQuery?: never };

package/model/searchHits.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Hit } from './hit';
+
+export type SearchHits<T> = {
+  hits: Array<Hit<T>>;
+};

package/model/searchMethodParams.ts

@@ -0,0 +1,9 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchQuery } from './searchQuery';
+import type { SearchStrategy } from './searchStrategy';
+
+export type SearchMethodParams = {
+  requests: SearchQuery[];
+  strategy?: SearchStrategy;
+};

package/model/searchParams.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchParamsObject } from './searchParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+
+export type SearchParams = SearchParamsObject | SearchParamsString;

package/model/searchParamsObject.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;

package/model/searchParamsQuery.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchParamsQuery = {
+  /**
+   * The text to search in the index.
+   */
+  query?: string;
+};

package/model/searchParamsString.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchParamsString = {
+  /**
+   * Search parameters as URL-encoded query string.
+   */
+  params?: string;
+};

package/model/searchQuery.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchForFacets } from './searchForFacets';
+import type { SearchForHits } from './searchForHits';
+
+export type SearchQuery = SearchForFacets | SearchForHits;

package/model/searchResponse.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { SearchHits } from './searchHits';
+
+export type SearchResponse<T> = BaseSearchResponse & SearchHits<T>;

package/model/searchResponses.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchResponse } from './searchResponse';
+
+export type SearchResponses<T> = {
+  results: Array<SearchResponse<T>>;
+};

package/model/searchRulesParams.ts

@@ -0,0 +1,34 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Anchoring } from './anchoring';
+
+/**
+ * Parameters for the search.
+ */
+export type SearchRulesParams = {
+  /**
+   * Full text query.
+   */
+  query?: string;
+  anchoring?: Anchoring;
+  /**
+   * Restricts matches to contextual rules with a specific context (exact match).
+   */
+  context?: string;
+  /**
+   * Requested page (zero-based).
+   */
+  page?: number;
+  /**
+   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   */
+  hitsPerPage?: number;
+  /**
+   * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
+   */
+  enabled?: boolean;
+  /**
+   * A mapping of requestOptions to send along with the request.
+   */
+  requestOptions?: Array<Record<string, any>>;
+};

package/model/searchRulesResponse.ts

@@ -0,0 +1,22 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Rule } from './rule';
+
+export type SearchRulesResponse = {
+  /**
+   * Fetched rules.
+   */
+  hits: Rule[];
+  /**
+   * Number of fetched rules.
+   */
+  nbHits: number;
+  /**
+   * Current page.
+   */
+  page: number;
+  /**
+   * Number of pages.
+   */
+  nbPages: number;
+};

package/model/searchStrategy.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchStrategy = 'none' | 'stopIfEnoughMatches';

package/model/searchSynonymsParams.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchSynonymsParams = {
+  /**
+   * The text to search in the index.
+   */
+  query?: string;
+};

package/model/searchSynonymsResponse.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SynonymHit } from './synonymHit';
+
+export type SearchSynonymsResponse = Record<string, any> & {
+  /**
+   * Array of synonym objects.
+   */
+  hits: SynonymHit[];
+  /**
+   * Number of hits that the search query matched.
+   */
+  nbHits: number;
+};

package/model/searchTypeDefault.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Perform a search query with `default`, will search for facet values if `facet` is given.
+ */
+export type SearchTypeDefault = 'default';

package/model/searchTypeFacet.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Perform a search query with `default`, will search for facet values if `facet` is given.
+ */
+export type SearchTypeFacet = 'facet';

package/model/searchUserIdsParams.ts

@@ -0,0 +1,23 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * OK.
+ */
+export type SearchUserIdsParams = {
+  /**
+   * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
+   */
+  query: string;
+  /**
+   * Name of the cluster.
+   */
+  clusterName?: string;
+  /**
+   * Specify the page to retrieve.
+   */
+  page?: number;
+  /**
+   * Set the number of hits per page.
+   */
+  hitsPerPage?: number;
+};

package/model/searchUserIdsResponse.ts

@@ -0,0 +1,29 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { UserHit } from './userHit';
+
+/**
+ * UserIDs data.
+ */
+export type SearchUserIdsResponse = {
+  /**
+   * List of user object matching the query.
+   */
+  hits: UserHit[];
+  /**
+   * Number of hits that the search query matched.
+   */
+  nbHits: number;
+  /**
+   * Specify the page to retrieve.
+   */
+  page: number;
+  /**
+   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   */
+  hitsPerPage: number;
+  /**
+   * Date of last update (ISO-8601 format).
+   */
+  updatedAt: string;
+};

package/model/snippetResult.ts

@@ -0,0 +1,5 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SnippetResultOption } from './snippetResultOption';
+
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];

package/model/snippetResultOption.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+};

package/model/sortRemainingBy.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ */
+export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/model/source.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The source.
+ */
+export type Source = {
+  /**
+   * The IP range of the source.
+   */
+  source: string;
+  /**
+   * The description of the source.
+   */
+  description?: string;
+};

package/model/standardEntries.ts

@@ -0,0 +1,19 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
+ */
+export type StandardEntries = {
+  /**
+   * Language ISO code.
+   */
+  plurals?: Record<string, boolean> | null;
+  /**
+   * Language ISO code.
+   */
+  stopwords?: Record<string, boolean> | null;
+  /**
+   * Language ISO code.
+   */
+  compounds?: Record<string, boolean> | null;
+};