algoliasearch 5.0.0-beta.1 → 5.0.0-beta.3

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;
-
-  /**
-   * Date and time when the object was updated, in RFC 3339 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/operationType.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.
-
-/**
- * Operation to perform on the index.
- */
-export type OperationType = 'copy' | 'move';

package/lite/model/promote.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.
-
-import type { PromoteObjectID } from './promoteObjectID';
-import type { PromoteObjectIDs } from './promoteObjectIDs';
-
-export type Promote = PromoteObjectID | PromoteObjectIDs;

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 record identifier.
-   */
-  objectID: string;
-
-  /**
-   * Position in the search results where you want to show the promoted records.
-   */
-  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 = {
-  /**
-   * Object IDs of the records you want to promote.  The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
-   */
-  objectIDs: string[];
-
-  /**
-   * Position in the search results where you want to show the promoted records.
-   */
-  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 of a rule object.
-   */
-  objectID: string;
-
-  /**
-   * Conditions that trigger a rule.  Some consequences require specific conditions or don\'t require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
-   */
-  conditions?: Condition[];
-
-  consequence?: Consequence;
-
-  /**
-   * Description of the rule\'s purpose to help you distinguish between different rules.
-   */
-  description?: string;
-
-  /**
-   * Whether the rule is active.
-   */
-  enabled?: boolean;
-
-  /**
-   * Time periods when the rule is active.
-   */
-  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/searchDictionaryEntriesResponse.ts

@@ -1,25 +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 { DictionaryEntry } from './dictionaryEntry';
-
-export type SearchDictionaryEntriesResponse = {
-  /**
-   * Dictionary entries matching the search criteria.
-   */
-  hits: DictionaryEntry[];
-
-  /**
-   * Requested page of the API response.
-   */
-  page: number;
-
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-
-  /**
-   * Number of pages of results.
-   */
-  nbPages: number;
-};

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> & {
-  /**
-   * Matching synonyms.
-   */
-  hits: SynonymHit[];
-
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-};

package/lite/model/securedAPIKeyRestrictions.ts

@@ -1,32 +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 { SearchParamsObject } from './searchParamsObject';
-
-export type SecuredAPIKeyRestrictions = {
-  searchParams?: SearchParamsObject;
-
-  /**
-   * Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
-   */
-  filters?: string;
-
-  /**
-   * Timestamp when the secured API key expires, measured in seconds since the Unix epoch.
-   */
-  validUntil?: number;
-
-  /**
-   * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
-   */
-  restrictIndices?: string[];
-
-  /**
-   * IP network that are allowed to use this key.  You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
-   */
-  restrictSources?: string;
-
-  /**
-   * Pseudonymous user identifier to restrict usage of this API key to specific users.  By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
-   */
-  userToken?: string;
-};

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.
-
-/**
- * Task status, `published` if the task is completed, `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 = {
-  /**
-   * When the rule should start to be active, in Unix epoch time.
-   */
-  from: number;
-
-  /**
-   * When the rule should stop to be active, in Unix epoch time.
-   */
-  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 identifier of a rule object.
-   */
-  objectID: string;
-
-  /**
-   * Date and time when the object was updated, in RFC 3339 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](#tag/Indices/operation/getTask) 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 = {
-  /**
-   * Unique identifier of the user who makes the search request.
-   */
-  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;
-};