algoliasearch 5.0.0-alpha.99 → 5.0.0-beta.10

package/lite/model/deleteByParams.ts

@@ -1,36 +0,0 @@
-// 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 { AroundRadius } from './aroundRadius';
-import type { FacetFilters } from './facetFilters';
-import type { NumericFilters } from './numericFilters';
-import type { TagFilters } from './tagFilters';
-
-export type DeleteByParams = {
-  facetFilters?: FacetFilters;
-
-  /**
-   * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
-   */
-  filters?: string;
-
-  numericFilters?: NumericFilters;
-
-  tagFilters?: TagFilters;
-
-  /**
-   * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
-   */
-  aroundLatLng?: string;
-
-  aroundRadius?: AroundRadius;
-
-  /**
-   * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
-   */
-  insideBoundingBox?: number[][];
-
-  /**
-   * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
-   */
-  insidePolygon?: number[][];
-};

package/lite/model/dictionaryEntry.ts

@@ -1,35 +0,0 @@
-// 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 { DictionaryEntryState } from './dictionaryEntryState';
-
-/**
- * Dictionary entry.
- */
-export type DictionaryEntry = Record<string, any> & {
-  /**
-   * Unique identifier for a dictionary object.
-   */
-  objectID: string;
-
-  /**
-   * [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
-   */
-  language: string;
-
-  /**
-   * Dictionary entry word. Usage depends on the type of dictionary entry. **`stopwordEntry`** The stop word you want to add or update. If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`. **`compoundEntry`** When `decomposition` is empty: adds `word` as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into \"kopf\" and \"kino\". When `decomposition` isn\'t empty: creates a decomposition exception. For example, when decomposition is set to the [\"hund\", \"hutte\"] exception, \"hundehutte\" decomposes into “hund” and “hutte”, discarding the linking \"e\".
-   */
-  word?: string;
-
-  /**
-   * Compound dictionary [word declensions](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/). If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`.
-   */
-  words?: string[];
-
-  /**
-   * For compound entries, governs the behavior of the `word` parameter.
-   */
-  decomposition?: string[];
-
-  state?: DictionaryEntryState;
-};

package/lite/model/dictionaryLanguage.ts

@@ -1,11 +0,0 @@
-// 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.
-
-/**
- * Custom entries for a dictionary.
- */
-export type DictionaryLanguage = {
-  /**
-   * If `0`, the dictionary hasn\'t been customized and only contains standard entries provided by Algolia. If `null`, that feature isn\'t available or isn\'t supported for that language.
-   */
-  nbCustomEntries?: number;
-};

package/lite/model/dictionaryType.ts

@@ -1,3 +0,0 @@
-// 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 DictionaryType = 'compounds' | 'plurals' | 'stopwords';

package/lite/model/fetchedIndex.ts

@@ -1,58 +0,0 @@
-// 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 FetchedIndex = {
-  /**
-   * Index name.
-   */
-  name: string;
-
-  /**
-   * Index creation date. An empty string means that the index has no records.
-   */
-  createdAt: string;
-
-  /**
-   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
-   */
-  updatedAt: string;
-
-  /**
-   * Number of records contained in the index.
-   */
-  entries: number;
-
-  /**
-   * Number of bytes of the index in minified format.
-   */
-  dataSize: number;
-
-  /**
-   * Number of bytes of the index binary file.
-   */
-  fileSize: number;
-
-  /**
-   * Last build time.
-   */
-  lastBuildTimeS: number;
-
-  /**
-   * Number of pending indexing operations. This value is deprecated and should not be used.
-   */
-  numberOfPendingTasks: number;
-
-  /**
-   * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
-   */
-  pendingTask: boolean;
-
-  /**
-   * Only present if the index is a replica. Contains the name of the related primary index.
-   */
-  primary?: string;
-
-  /**
-   * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
-   */
-  replicas?: string[];
-};

package/lite/model/languages.ts

@@ -1,14 +0,0 @@
-// 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 { DictionaryLanguage } from './dictionaryLanguage';
-
-/**
- * Dictionary language.
- */
-export type Languages = {
-  plurals: DictionaryLanguage | null;
-
-  stopwords: DictionaryLanguage | null;
-
-  compounds: DictionaryLanguage | null;
-};

package/lite/model/listIndicesResponse.ts

@@ -1,15 +0,0 @@
-// 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 { FetchedIndex } from './fetchedIndex';
-
-export type ListIndicesResponse = {
-  /**
-   * All indices in your Algolia application.
-   */
-  items: FetchedIndex[];
-
-  /**
-   * Number of pages.
-   */
-  nbPages?: number;
-};

package/lite/model/logType.ts

@@ -1,3 +0,0 @@
-// 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 LogType = 'all' | 'build' | 'error' | 'query';

package/lite/model/mixedSearchFilters.ts

@@ -1,3 +0,0 @@
-// 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 MixedSearchFilters = string[] | string;

package/lite/model/promoteObjectID.ts

@@ -1,16 +0,0 @@
-// 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.
-
-/**
- * Record to promote.
- */
-export type PromoteObjectID = {
-  /**
-   * Unique identifier of the record to promote.
-   */
-  objectID: string;
-
-  /**
-   * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
-   */
-  position: number;
-};

package/lite/model/promoteObjectIDs.ts

@@ -1,16 +0,0 @@
-// 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.
-
-/**
- * Records to promote.
- */
-export type PromoteObjectIDs = {
-  /**
-   * Unique identifiers of the records to promote.
-   */
-  objectIDs: string[];
-
-  /**
-   * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
-   */
-  position: number;
-};

package/lite/model/rule.ts

@@ -1,37 +0,0 @@
-// 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 { Condition } from './condition';
-import type { Consequence } from './consequence';
-import type { TimeRange } from './timeRange';
-
-/**
- * Rule object.
- */
-export type Rule = {
-  /**
-   * Unique identifier for a rule object.
-   */
-  objectID: string;
-
-  /**
-   * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
-   */
-  conditions?: Condition[];
-
-  consequence?: Consequence;
-
-  /**
-   * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
-   */
-  description?: string;
-
-  /**
-   * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
-   */
-  enabled?: boolean;
-
-  /**
-   * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
-   */
-  validity?: TimeRange[];
-};

package/lite/model/scopeType.ts

@@ -1,3 +0,0 @@
-// 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 ScopeType = 'rules' | 'settings' | 'synonyms';

package/lite/model/searchSynonymsResponse.ts

@@ -1,15 +0,0 @@
-// 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 { SynonymHit } from './synonymHit';
-
-export type SearchSynonymsResponse = Record<string, any> & {
-  /**
-   * Synonym objects.
-   */
-  hits: SynonymHit[];
-
-  /**
-   * Number of hits the search query matched.
-   */
-  nbHits: number;
-};

package/lite/model/source.ts

@@ -1,16 +0,0 @@
-// 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.
-
-/**
- * Source.
- */
-export type Source = {
-  /**
-   * IP address range of the source.
-   */
-  source: string;
-
-  /**
-   * Source description.
-   */
-  description?: string;
-};

package/lite/model/standardEntries.ts

@@ -1,21 +0,0 @@
-// 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.
-
-/**
- * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
- */
-export type StandardEntries = {
-  /**
-   * Key-value pair of a language ISO code and a boolean value.
-   */
-  plurals?: Record<string, boolean> | null;
-
-  /**
-   * Key-value pair of a language ISO code and a boolean value.
-   */
-  stopwords?: Record<string, boolean> | null;
-
-  /**
-   * Key-value pair of a language ISO code and a boolean value.
-   */
-  compounds?: Record<string, boolean> | null;
-};

package/lite/model/synonymHit.ts

@@ -1,45 +0,0 @@
-// 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 { SynonymType } from './synonymType';
-
-/**
- * Synonym object.
- */
-export type SynonymHit = {
-  /**
-   * Unique identifier of a synonym object.
-   */
-  objectID: string;
-
-  type: SynonymType;
-
-  /**
-   * Words or phrases considered equivalent.
-   */
-  synonyms?: string[];
-
-  /**
-   * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
-   */
-  input?: string;
-
-  /**
-   * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
-   */
-  word?: string;
-
-  /**
-   * Words to be matched in records.
-   */
-  corrections?: string[];
-
-  /**
-   * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
-   */
-  placeholder?: string;
-
-  /**
-   * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
-   */
-  replacements?: string[];
-};

package/lite/model/synonymType.ts

@@ -1,11 +0,0 @@
-// 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.
-
-/**
- * Synonym type.
- */
-export type SynonymType =
-  | 'altcorrection1'
-  | 'altcorrection2'
-  | 'onewaysynonym'
-  | 'placeholder'
-  | 'synonym';

package/lite/model/taskStatus.ts

@@ -1,6 +0,0 @@
-// 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.
-
-/**
- * _published_ if the task has been processed, _notPublished_ otherwise.
- */
-export type TaskStatus = 'notPublished' | 'published';

package/lite/model/timeRange.ts

@@ -1,13 +0,0 @@
-// 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 TimeRange = {
-  /**
-   * Lower bound of the time range (Unix timestamp).
-   */
-  from: number;
-
-  /**
-   * Upper bound of the time range (Unix timestamp).
-   */
-  until: number;
-};

package/lite/model/updatedRuleResponse.ts

@@ -1,18 +0,0 @@
-// 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 UpdatedRuleResponse = {
-  /**
-   * Unique object identifier.
-   */
-  objectID: string;
-
-  /**
-   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
-   */
-  updatedAt: string;
-
-  /**
-   * 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 and this `taskID`.
-   */
-  taskID: number;
-};

package/lite/model/userId.ts

@@ -1,26 +0,0 @@
-// 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.
-
-/**
- * Unique user ID.
- */
-export type UserId = {
-  /**
-   * UserID of the user.
-   */
-  userID: string;
-
-  /**
-   * Cluster to which the user is assigned.
-   */
-  clusterName: string;
-
-  /**
-   * Number of records belonging to the user.
-   */
-  nbRecords: number;
-
-  /**
-   * Data size used by the user.
-   */
-  dataSize: number;
-};