algoliasearch 4.14.2 → 5.0.0-alpha.11

package/dist/client-search/model/clientMethodProps.d.ts

@@ -0,0 +1,715 @@
+import type { CreateIterablePromise } from '@algolia/client-common';
+import type { ApiKey } from './apiKey';
+import type { AssignUserIdParams } from './assignUserIdParams';
+import type { AttributeToUpdate } from './attributeToUpdate';
+import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
+import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
+import type { BatchWriteParams } from './batchWriteParams';
+import type { BrowseParams } from './browseParams';
+import type { DictionaryType } from './dictionaryType';
+import type { IndexSettings } from './indexSettings';
+import type { LogType } from './logType';
+import type { OperationIndexParams } from './operationIndexParams';
+import type { Rule } from './rule';
+import type { SearchDictionaryEntriesParams } from './searchDictionaryEntriesParams';
+import type { SearchForFacetValuesRequest } from './searchForFacetValuesRequest';
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParams } from './searchParams';
+import type { SearchParamsObject } from './searchParamsObject';
+import type { SearchRulesParams } from './searchRulesParams';
+import type { SearchSynonymsParams } from './searchSynonymsParams';
+import type { Source } from './source';
+import type { SynonymHit } from './synonymHit';
+import type { SynonymType } from './synonymType';
+/**
+ * Properties for the `addOrUpdateObject` method.
+ */
+export declare type AddOrUpdateObjectProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+    /**
+     * The Algolia object.
+     */
+    body: Record<string, any>;
+};
+/**
+ * Properties for the `assignUserId` method.
+ */
+export declare type AssignUserIdProps = {
+    /**
+     * UserID to assign.
+     */
+    xAlgoliaUserID: string;
+    assignUserIdParams: AssignUserIdParams;
+};
+/**
+ * Properties for the `batch` method.
+ */
+export declare type BatchProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    batchWriteParams: BatchWriteParams;
+};
+/**
+ * Properties for the `batchAssignUserIds` method.
+ */
+export declare type BatchAssignUserIdsProps = {
+    /**
+     * UserID to assign.
+     */
+    xAlgoliaUserID: string;
+    batchAssignUserIdsParams: BatchAssignUserIdsParams;
+};
+/**
+ * Properties for the `batchDictionaryEntries` method.
+ */
+export declare type BatchDictionaryEntriesProps = {
+    /**
+     * The dictionary to search in.
+     */
+    dictionaryName: DictionaryType;
+    batchDictionaryEntriesParams: BatchDictionaryEntriesParams;
+};
+/**
+ * Properties for the `browse` method.
+ */
+export declare type BrowseProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    browseParams?: BrowseParams;
+};
+/**
+ * Properties for the `clearAllSynonyms` method.
+ */
+export declare type ClearAllSynonymsProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+};
+/**
+ * Properties for the `clearObjects` method.
+ */
+export declare type ClearObjectsProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+};
+/**
+ * Properties for the `clearRules` method.
+ */
+export declare type ClearRulesProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+};
+/**
+ * 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 `deleteApiKey` method.
+ */
+export declare type DeleteApiKeyProps = {
+    /**
+     * API Key string.
+     */
+    key: string;
+};
+/**
+ * Properties for the `deleteBy` method.
+ */
+export declare type DeleteByProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    searchParams: SearchParams;
+};
+/**
+ * Properties for the `deleteIndex` method.
+ */
+export declare type DeleteIndexProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+};
+/**
+ * Properties for the `deleteObject` method.
+ */
+export declare type DeleteObjectProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+};
+/**
+ * Properties for the `deleteRule` method.
+ */
+export declare type DeleteRuleProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+};
+/**
+ * Properties for the `deleteSource` method.
+ */
+export declare type DeleteSourceProps = {
+    /**
+     * The IP range of the source.
+     */
+    source: string;
+};
+/**
+ * Properties for the `deleteSynonym` method.
+ */
+export declare type DeleteSynonymProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+};
+/**
+ * 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 `getApiKey` method.
+ */
+export declare type GetApiKeyProps = {
+    /**
+     * API Key string.
+     */
+    key: string;
+};
+/**
+ * Properties for the `getLogs` method.
+ */
+export declare type GetLogsProps = {
+    /**
+     * First entry to retrieve (zero-based). Log entries are sorted by decreasing date, therefore 0 designates the most recent log entry.
+     */
+    offset?: number;
+    /**
+     * Maximum number of entries to retrieve. The maximum allowed value is 1000.
+     */
+    length?: number;
+    /**
+     * Index for which log entries should be retrieved. When omitted, log entries are retrieved across all indices.
+     */
+    indexName?: string;
+    /**
+     * Type of log entries to retrieve. When omitted, all log entries are retrieved.
+     */
+    type?: LogType;
+};
+/**
+ * Properties for the `getObject` method.
+ */
+export declare type GetObjectProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+    /**
+     * List of attributes to retrieve. If not specified, all retrievable attributes are returned.
+     */
+    attributesToRetrieve?: string[];
+};
+/**
+ * Properties for the `getRule` method.
+ */
+export declare type GetRuleProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+};
+/**
+ * Properties for the `getSettings` method.
+ */
+export declare type GetSettingsProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+};
+/**
+ * Properties for the `getSynonym` method.
+ */
+export declare type GetSynonymProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+};
+/**
+ * Properties for the `getTask` method.
+ */
+export declare type GetTaskProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an task. Numeric value (up to 64bits).
+     */
+    taskID: number;
+};
+/**
+ * Properties for the `getUserId` method.
+ */
+export declare type GetUserIdProps = {
+    /**
+     * UserID to assign.
+     */
+    userID: string;
+};
+/**
+ * Properties for the `hasPendingMappings` method.
+ */
+export declare type HasPendingMappingsProps = {
+    /**
+     * If the clusters pending mapping state should be on the response.
+     */
+    getClusters?: boolean;
+};
+/**
+ * Properties for the `listIndices` method.
+ */
+export declare type ListIndicesProps = {
+    /**
+     * Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
+     */
+    page?: number;
+};
+/**
+ * Properties for the `listUserIds` method.
+ */
+export declare type ListUserIdsProps = {
+    /**
+     * Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
+     */
+    page?: number;
+    /**
+     * Maximum number of objects to retrieve.
+     */
+    hitsPerPage?: number;
+};
+/**
+ * Properties for the `operationIndex` method.
+ */
+export declare type OperationIndexProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    operationIndexParams: OperationIndexParams;
+};
+/**
+ * Properties for the `partialUpdateObject` method.
+ */
+export declare type PartialUpdateObjectProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+    /**
+     * Map of attribute(s) to update.
+     */
+    attributesToUpdate: Record<string, AttributeToUpdate>;
+    /**
+     * Creates the record if it does not exist yet.
+     */
+    createIfNotExists?: boolean;
+};
+/**
+ * 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>;
+};
+/**
+ * Properties for the `removeUserId` method.
+ */
+export declare type RemoveUserIdProps = {
+    /**
+     * UserID to assign.
+     */
+    userID: string;
+};
+/**
+ * Properties for the `replaceSources` method.
+ */
+export declare type ReplaceSourcesProps = {
+    /**
+     * The sources to allow.
+     */
+    source: Source[];
+};
+/**
+ * Properties for the `restoreApiKey` method.
+ */
+export declare type RestoreApiKeyProps = {
+    /**
+     * API Key string.
+     */
+    key: string;
+};
+/**
+ * Properties for the `saveObject` method.
+ */
+export declare type SaveObjectProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * The Algolia record.
+     */
+    body: Record<string, any>;
+};
+/**
+ * Properties for the `saveRule` method.
+ */
+export declare type SaveRuleProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+    rule: Rule;
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+};
+/**
+ * Properties for the `saveRules` method.
+ */
+export declare type SaveRulesProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    rules: Rule[];
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+    /**
+     * When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
+     */
+    clearExistingRules?: boolean;
+};
+/**
+ * Properties for the `saveSynonym` method.
+ */
+export declare type SaveSynonymProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Unique identifier of an object.
+     */
+    objectID: string;
+    synonymHit: SynonymHit;
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+};
+/**
+ * Properties for the `saveSynonyms` method.
+ */
+export declare type SaveSynonymsProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    synonymHit: SynonymHit[];
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+    /**
+     * Replace all synonyms of the index with the ones sent with this request.
+     */
+    replaceExistingSynonyms?: boolean;
+};
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+declare type LegacySearchParams = {
+    params?: SearchParamsObject;
+};
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+declare type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+declare type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
+declare type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
+/**
+ * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
+ */
+export declare type LegacySearchMethodProps = LegacySearchQuery[];
+/**
+ * Properties for the `searchDictionaryEntries` method.
+ */
+export declare type SearchDictionaryEntriesProps = {
+    /**
+     * The dictionary to search in.
+     */
+    dictionaryName: DictionaryType;
+    searchDictionaryEntriesParams: SearchDictionaryEntriesParams;
+};
+/**
+ * Properties for the `searchForFacetValues` method.
+ */
+export declare type SearchForFacetValuesProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * The facet name.
+     */
+    facetName: string;
+    searchForFacetValuesRequest?: SearchForFacetValuesRequest;
+};
+/**
+ * Properties for the `searchRules` method.
+ */
+export declare type SearchRulesProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    searchRulesParams?: SearchRulesParams;
+};
+/**
+ * Properties for the `searchSingleIndex` method.
+ */
+export declare type SearchSingleIndexProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    searchParams?: SearchParams;
+};
+/**
+ * Properties for the `searchSynonyms` method.
+ */
+export declare type SearchSynonymsProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    /**
+     * Only search for specific types of synonyms.
+     */
+    type?: SynonymType;
+    /**
+     * Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
+     */
+    page?: number;
+    /**
+     * Maximum number of objects to retrieve.
+     */
+    hitsPerPage?: number;
+    /**
+     * The body of the the `searchSynonyms` method.
+     */
+    searchSynonymsParams?: SearchSynonymsParams;
+};
+/**
+ * Properties for the `setSettings` method.
+ */
+export declare type SetSettingsProps = {
+    /**
+     * The index in which to perform the request.
+     */
+    indexName: string;
+    indexSettings: IndexSettings;
+    /**
+     * When true, changes are also propagated to replicas of the given indexName.
+     */
+    forwardToReplicas?: boolean;
+};
+/**
+ * Properties for the `updateApiKey` method.
+ */
+export declare type UpdateApiKeyProps = {
+    /**
+     * API Key string.
+     */
+    key: string;
+    apiKey: ApiKey;
+};
+/**
+ * The `browseObjects`, `browseRules`, `browseSynonyms` options.
+ */
+export declare type BrowseOptions<T> = Partial<Pick<CreateIterablePromise<T>, 'validate'>> & Required<Pick<CreateIterablePromise<T>, 'aggregator'>>;
+declare type WaitForOptions = Partial<{
+    /**
+     * The maximum number of retries. 50 by default.
+     */
+    maxRetries: number;
+    /**
+     * The function to decide how long to wait between retries.
+     */
+    timeout: (retryCount: number) => number;
+}>;
+export declare type WaitForTaskOptions = WaitForOptions & {
+    /**
+     * The `indexName` where the operation was performed.
+     */
+    indexName: string;
+    /**
+     * The `taskID` returned by the method response.
+     */
+    taskID: number;
+};
+export declare type WaitForApiKeyOptions = WaitForOptions & {
+    /**
+     * The API Key.
+     */
+    key: string;
+} & ({
+    /**
+     * The operation that has been performed, used to compute the stop condition.
+     */
+    operation: 'add' | 'delete';
+    apiKey?: never;
+} | {
+    /**
+     * The operation that has been performed, used to compute the stop condition.
+     */
+    operation: 'update';
+    /**
+     * The updated fields, used to compute the stop condition.
+     */
+    apiKey: Partial<ApiKey>;
+});
+export {};
+//# sourceMappingURL=clientMethodProps.d.ts.map