@algolia/client-search 5.9.0 → 5.10.0-beta.1

package/model/baseSearchResponse.ts

@@ -1,129 +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 { Exhaustive } from './exhaustive';
-import type { FacetStats } from './facetStats';
-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;
-
-  /**
-   * Rules applied to the query.
-   */
-  appliedRules?: Array<Record<string, unknown>>;
-
-  /**
-   * 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?: { [key: string]: { [key: string]: number } };
-
-  /**
-   * Statistics for numerical facets.
-   */
-  facets_stats?: { [key: string]: FacetStats };
-
-  /**
-   * 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 hits selected and sorted by the relevant sort algorithm.
-   */
-  nbSortedHits?: 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, unknown>;
-
-  /**
-   * 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 32kB as custom data.
-   */
-  userData?: Record<string, unknown>;
-
-  /**
-   * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
-   */
-  queryID?: string;
-
-  /**
-   * Whether automatic events collection is enabled for the application.
-   */
-  _automaticInsights?: boolean;
-};

package/model/batchAssignUserIdsParams.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.
-
-/**
- * Assign userID parameters.
- */
-export type BatchAssignUserIdsParams = {
-  /**
-   * Cluster name.
-   */
-  cluster: string;
-
-  /**
-   * User IDs to assign.
-   */
-  users: Array<string>;
-};

package/model/batchDictionaryEntriesParams.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.
-
-import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
-
-/**
- * Request body for updating dictionary entries.
- */
-export type BatchDictionaryEntriesParams = {
-  /**
-   * Whether to replace all custom entries in the dictionary with the ones sent with this request.
-   */
-  clearExistingDictionaryEntries?: boolean;
-
-  /**
-   * List of additions and deletions to your dictionaries.
-   */
-  requests: Array<BatchDictionaryEntriesRequest>;
-};

package/model/batchDictionaryEntriesRequest.ts

@@ -1,10 +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 { DictionaryAction } from './dictionaryAction';
-import type { DictionaryEntry } from './dictionaryEntry';
-
-export type BatchDictionaryEntriesRequest = {
-  action: DictionaryAction;
-
-  body: DictionaryEntry;
-};

package/model/batchParams.ts

@@ -1,10 +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 { MultipleBatchRequest } from './multipleBatchRequest';
-
-/**
- * Batch parameters.
- */
-export type BatchParams = {
-  requests: Array<MultipleBatchRequest>;
-};

package/model/batchRequest.ts

@@ -1,12 +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 { Action } from './action';
-
-export type BatchRequest = {
-  action: Action;
-
-  /**
-   * Operation arguments (varies with specified `action`).
-   */
-  body: Record<string, unknown>;
-};

package/model/batchResponse.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 BatchResponse = {
-  /**
-   * 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;
-
-  /**
-   * Unique record identifiers.
-   */
-  objectIDs: Array<string>;
-};

package/model/batchWriteParams.ts

@@ -1,10 +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 { BatchRequest } from './batchRequest';
-
-/**
- * Batch parameters.
- */
-export type BatchWriteParams = {
-  requests: Array<BatchRequest>;
-};

package/model/booleanString.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 BooleanString = 'true' | 'false';

package/model/browsePagination.ts

@@ -1,23 +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 BrowsePagination = {
-  /**
-   * Page of search results to retrieve.
-   */
-  page?: number;
-
-  /**
-   * Number of results (hits).
-   */
-  nbHits?: number;
-
-  /**
-   * Number of pages of results.
-   */
-  nbPages?: number;
-
-  /**
-   * Number of hits per page.
-   */
-  hitsPerPage?: number;
-};

package/model/browseParams.ts

@@ -1,7 +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 { BrowseParamsObject } from './browseParamsObject';
-
-import type { SearchParamsString } from './searchParamsString';
-
-export type BrowseParams = SearchParamsString | BrowseParamsObject;

package/model/browseParamsObject.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 { Cursor } from './cursor';
-import type { SearchParamsObject } from './searchParamsObject';
-
-export type BrowseParamsObject = SearchParamsObject & Cursor;

package/model/browseResponse.ts

@@ -1,8 +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 { BaseSearchResponse } from './baseSearchResponse';
-import type { BrowsePagination } from './browsePagination';
-import type { Cursor } from './cursor';
-import type { SearchHits } from './searchHits';
-
-export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & BrowsePagination & SearchHits<T> & Cursor;

package/model/builtInOperation.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.
-
-import type { BuiltInOperationType } from './builtInOperationType';
-import type { BuiltInOperationValue } from './builtInOperationValue';
-
-/**
- * Update to perform on the attribute.
- */
-export type BuiltInOperation = {
-  _operation: BuiltInOperationType;
-
-  value: BuiltInOperationValue;
-};

package/model/builtInOperationType.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.
-
-/**
- * How to change the attribute.
- */
-export type BuiltInOperationType =
-  | 'Increment'
-  | 'Decrement'
-  | 'Add'
-  | 'Remove'
-  | 'AddUnique'
-  | 'IncrementFrom'
-  | 'IncrementSet';

package/model/builtInOperationValue.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 BuiltInOperationValue = string | number;