@algolia/client-search 5.55.2 → 5.57.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/browser.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _algolia_client_common from '@algolia/client-common';
2
- import { ChunkedHelperOptions, CreateIterablePromise, CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
2
+ import { ChunkedHelperOptions, CreateIterablePromise, CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
3
3
 
4
4
  type AddApiKeyResponse = {
5
5
  /**
@@ -3242,9 +3242,9 @@ type AccountCopyIndexOptions = ChunkedHelperOptions & {
3242
3242
  batchSize?: number | undefined;
3243
3243
  };
3244
3244
 
3245
- declare const apiClientVersion = "5.55.2";
3245
+ declare const apiClientVersion = "5.57.0";
3246
3246
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
3247
- transporter: _algolia_client_common.Transporter;
3247
+ transporter: _algolia_client_common.TransporterWithHttpInfo;
3248
3248
  /**
3249
3249
  * The `appId` currently in use.
3250
3250
  */
@@ -3407,6 +3407,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3407
3407
  * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
3408
3408
  * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
3409
3409
  *
3410
+ * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
3411
+ *
3410
3412
  * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
3411
3413
  * @param replaceAllObjects - The `replaceAllObjects` object.
3412
3414
  * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -3417,7 +3419,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3417
3419
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
3418
3420
  */
3419
3421
  replaceAllObjects({ indexName, objects, batchSize, scopes, maxRetries, }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<ReplaceAllObjectsResponse>;
3420
- indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
3422
+ indexExists({ indexName }: GetSettingsProps, requestOptions?: RequestOptions | undefined): Promise<boolean>;
3421
3423
  /**
3422
3424
  * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
3423
3425
  * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
@@ -3449,6 +3451,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3449
3451
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3450
3452
  */
3451
3453
  addApiKey(apiKey: ApiKey, requestOptions?: RequestOptions): Promise<AddApiKeyResponse>;
3454
+ /**
3455
+ * Creates a new API key with specific permissions and restrictions.
3456
+ *
3457
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3458
+ *
3459
+ * Required API Key ACLs:
3460
+ * - admin
3461
+ * @param apiKey - The apiKey object.
3462
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3463
+ * @see addApiKey for the plain version.
3464
+ */
3465
+ addApiKeyWithHTTPInfo(apiKey: ApiKey, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<AddApiKeyResponse>>;
3452
3466
  /**
3453
3467
  * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use auto-generated object IDs, use the [`saveObject` operation](https://www.algolia.com/doc/rest-api/search/save-object). To update _some_ attributes of an existing record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object) instead. To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).
3454
3468
  *
@@ -3461,6 +3475,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3461
3475
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3462
3476
  */
3463
3477
  addOrUpdateObject<T extends object>({ indexName, objectID, body }: AddOrUpdateObjectProps<T>, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
3478
+ /**
3479
+ * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use auto-generated object IDs, use the [`saveObject` operation](https://www.algolia.com/doc/rest-api/search/save-object). To update _some_ attributes of an existing record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object) instead. To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).
3480
+ *
3481
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3482
+ *
3483
+ * Required API Key ACLs:
3484
+ * - addObject
3485
+ * @param addOrUpdateObject - The addOrUpdateObject object.
3486
+ * @param addOrUpdateObject.indexName - Name of the index on which to perform the operation.
3487
+ * @param addOrUpdateObject.objectID - Unique record identifier.
3488
+ * @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
3489
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3490
+ * @see addOrUpdateObject for the plain version.
3491
+ */
3492
+ addOrUpdateObjectWithHTTPInfo<T extends object>({ indexName, objectID, body }: AddOrUpdateObjectProps<T>, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtWithObjectIdResponse>>;
3464
3493
  /**
3465
3494
  * Adds a source to the list of allowed sources.
3466
3495
  *
@@ -3470,6 +3499,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3470
3499
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3471
3500
  */
3472
3501
  appendSource(source: Source, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
3502
+ /**
3503
+ * Adds a source to the list of allowed sources.
3504
+ *
3505
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3506
+ *
3507
+ * Required API Key ACLs:
3508
+ * - admin
3509
+ * @param source - Source to add.
3510
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3511
+ * @see appendSource for the plain version.
3512
+ */
3513
+ appendSourceWithHTTPInfo(source: Source, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<CreatedAtResponse>>;
3473
3514
  /**
3474
3515
  * Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.
3475
3516
  *
@@ -3483,6 +3524,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3483
3524
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3484
3525
  */
3485
3526
  assignUserId({ xAlgoliaUserID, assignUserIdParams }: AssignUserIdProps, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
3527
+ /**
3528
+ * Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.
3529
+ *
3530
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3531
+ *
3532
+ * Required API Key ACLs:
3533
+ * - admin
3534
+ *
3535
+ * @deprecated
3536
+ * @param assignUserId - The assignUserId object.
3537
+ * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
3538
+ * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
3539
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3540
+ * @see assignUserId for the plain version.
3541
+ */
3542
+ assignUserIdWithHTTPInfo({ xAlgoliaUserID, assignUserIdParams }: AssignUserIdProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<CreatedAtResponse>>;
3486
3543
  /**
3487
3544
  * Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they\'re specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3488
3545
  *
@@ -3494,6 +3551,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3494
3551
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3495
3552
  */
3496
3553
  batch({ indexName, batchWriteParams }: BatchProps, requestOptions?: RequestOptions): Promise<BatchResponse>;
3554
+ /**
3555
+ * Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they\'re specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3556
+ *
3557
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3558
+ *
3559
+ * Required API Key ACLs:
3560
+ * - addObject
3561
+ * @param batch - The batch object.
3562
+ * @param batch.indexName - Name of the index on which to perform the operation.
3563
+ * @param batch.batchWriteParams - The batchWriteParams object.
3564
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3565
+ * @see batch for the plain version.
3566
+ */
3567
+ batchWithHTTPInfo({ indexName, batchWriteParams }: BatchProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BatchResponse>>;
3497
3568
  /**
3498
3569
  * Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**.
3499
3570
  *
@@ -3507,6 +3578,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3507
3578
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3508
3579
  */
3509
3580
  batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: BatchAssignUserIdsProps, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
3581
+ /**
3582
+ * Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**.
3583
+ *
3584
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3585
+ *
3586
+ * Required API Key ACLs:
3587
+ * - admin
3588
+ *
3589
+ * @deprecated
3590
+ * @param batchAssignUserIds - The batchAssignUserIds object.
3591
+ * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
3592
+ * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
3593
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3594
+ * @see batchAssignUserIds for the plain version.
3595
+ */
3596
+ batchAssignUserIdsWithHTTPInfo({ xAlgoliaUserID, batchAssignUserIdsParams }: BatchAssignUserIdsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<CreatedAtResponse>>;
3510
3597
  /**
3511
3598
  * Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
3512
3599
  *
@@ -3518,6 +3605,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3518
3605
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3519
3606
  */
3520
3607
  batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }: BatchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3608
+ /**
3609
+ * Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
3610
+ *
3611
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3612
+ *
3613
+ * Required API Key ACLs:
3614
+ * - editSettings
3615
+ * @param batchDictionaryEntries - The batchDictionaryEntries object.
3616
+ * @param batchDictionaryEntries.dictionaryName - Dictionary type in which to search.
3617
+ * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
3618
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3619
+ * @see batchDictionaryEntries for the plain version.
3620
+ */
3621
+ batchDictionaryEntriesWithHTTPInfo({ dictionaryName, batchDictionaryEntriesParams }: BatchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3521
3622
  /**
3522
3623
  * Retrieves records from an index, up to 1,000 per request. Searching returns _hits_ (records augmented with highlighting and ranking details). Browsing returns matching records only. Use browse to export your indices. - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There\'s no ranking for typo tolerance, number of matched words, proximity, or geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse requests, they\'re ignored.
3523
3624
  *
@@ -3529,6 +3630,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3529
3630
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3530
3631
  */
3531
3632
  browse<T>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
3633
+ /**
3634
+ * Retrieves records from an index, up to 1,000 per request. Searching returns _hits_ (records augmented with highlighting and ranking details). Browsing returns matching records only. Use browse to export your indices. - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There\'s no ranking for typo tolerance, number of matched words, proximity, or geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse requests, they\'re ignored.
3635
+ *
3636
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3637
+ *
3638
+ * Required API Key ACLs:
3639
+ * - browse
3640
+ * @param browse - The browse object.
3641
+ * @param browse.indexName - Name of the index on which to perform the operation.
3642
+ * @param browse.browseParams - The browseParams object.
3643
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3644
+ * @see browse for the plain version.
3645
+ */
3646
+ browseWithHTTPInfo<T>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BrowseResponse<T>>>;
3532
3647
  /**
3533
3648
  * Deletes only the records from an index while keeping settings, synonyms, and rules. This operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3534
3649
  *
@@ -3539,6 +3654,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3539
3654
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3540
3655
  */
3541
3656
  clearObjects({ indexName }: ClearObjectsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3657
+ /**
3658
+ * Deletes only the records from an index while keeping settings, synonyms, and rules. This operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3659
+ *
3660
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3661
+ *
3662
+ * Required API Key ACLs:
3663
+ * - deleteIndex
3664
+ * @param clearObjects - The clearObjects object.
3665
+ * @param clearObjects.indexName - Name of the index on which to perform the operation.
3666
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3667
+ * @see clearObjects for the plain version.
3668
+ */
3669
+ clearObjectsWithHTTPInfo({ indexName }: ClearObjectsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3542
3670
  /**
3543
3671
  * Deletes all rules from the index.
3544
3672
  *
@@ -3550,6 +3678,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3550
3678
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3551
3679
  */
3552
3680
  clearRules({ indexName, forwardToReplicas }: ClearRulesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3681
+ /**
3682
+ * Deletes all rules from the index.
3683
+ *
3684
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3685
+ *
3686
+ * Required API Key ACLs:
3687
+ * - editSettings
3688
+ * @param clearRules - The clearRules object.
3689
+ * @param clearRules.indexName - Name of the index on which to perform the operation.
3690
+ * @param clearRules.forwardToReplicas - Whether changes are applied to replica indices.
3691
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3692
+ * @see clearRules for the plain version.
3693
+ */
3694
+ clearRulesWithHTTPInfo({ indexName, forwardToReplicas }: ClearRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3553
3695
  /**
3554
3696
  * Deletes all synonyms from the index.
3555
3697
  *
@@ -3561,6 +3703,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3561
3703
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3562
3704
  */
3563
3705
  clearSynonyms({ indexName, forwardToReplicas }: ClearSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3706
+ /**
3707
+ * Deletes all synonyms from the index.
3708
+ *
3709
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3710
+ *
3711
+ * Required API Key ACLs:
3712
+ * - editSettings
3713
+ * @param clearSynonyms - The clearSynonyms object.
3714
+ * @param clearSynonyms.indexName - Name of the index on which to perform the operation.
3715
+ * @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
3716
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3717
+ * @see clearSynonyms for the plain version.
3718
+ */
3719
+ clearSynonymsWithHTTPInfo({ indexName, forwardToReplicas }: ClearSynonymsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3564
3720
  /**
3565
3721
  * This method lets you send requests to the Algolia REST API.
3566
3722
  * @param customDelete - The customDelete object.
@@ -3569,6 +3725,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3569
3725
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3570
3726
  */
3571
3727
  customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
3728
+ /**
3729
+ * This method lets you send requests to the Algolia REST API.
3730
+ *
3731
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3732
+ * @param customDelete - The customDelete object.
3733
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
3734
+ * @param customDelete.parameters - Query parameters to apply to the current query.
3735
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3736
+ * @see customDelete for the plain version.
3737
+ */
3738
+ customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
3572
3739
  /**
3573
3740
  * This method lets you send requests to the Algolia REST API.
3574
3741
  * @param customGet - The customGet object.
@@ -3577,6 +3744,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3577
3744
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3578
3745
  */
3579
3746
  customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
3747
+ /**
3748
+ * This method lets you send requests to the Algolia REST API.
3749
+ *
3750
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3751
+ * @param customGet - The customGet object.
3752
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
3753
+ * @param customGet.parameters - Query parameters to apply to the current query.
3754
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3755
+ * @see customGet for the plain version.
3756
+ */
3757
+ customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
3580
3758
  /**
3581
3759
  * This method lets you send requests to the Algolia REST API.
3582
3760
  * @param customPost - The customPost object.
@@ -3586,6 +3764,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3586
3764
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3587
3765
  */
3588
3766
  customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
3767
+ /**
3768
+ * This method lets you send requests to the Algolia REST API.
3769
+ *
3770
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3771
+ * @param customPost - The customPost object.
3772
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
3773
+ * @param customPost.parameters - Query parameters to apply to the current query.
3774
+ * @param customPost.body - Parameters to send with the custom request.
3775
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3776
+ * @see customPost for the plain version.
3777
+ */
3778
+ customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
3589
3779
  /**
3590
3780
  * This method lets you send requests to the Algolia REST API.
3591
3781
  * @param customPut - The customPut object.
@@ -3595,6 +3785,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3595
3785
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3596
3786
  */
3597
3787
  customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
3788
+ /**
3789
+ * This method lets you send requests to the Algolia REST API.
3790
+ *
3791
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3792
+ * @param customPut - The customPut object.
3793
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
3794
+ * @param customPut.parameters - Query parameters to apply to the current query.
3795
+ * @param customPut.body - Parameters to send with the custom request.
3796
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3797
+ * @see customPut for the plain version.
3798
+ */
3799
+ customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
3598
3800
  /**
3599
3801
  * Deletes the API key.
3600
3802
  *
@@ -3605,6 +3807,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3605
3807
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3606
3808
  */
3607
3809
  deleteApiKey({ key }: DeleteApiKeyProps, requestOptions?: RequestOptions): Promise<DeleteApiKeyResponse>;
3810
+ /**
3811
+ * Deletes the API key.
3812
+ *
3813
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3814
+ *
3815
+ * Required API Key ACLs:
3816
+ * - admin
3817
+ * @param deleteApiKey - The deleteApiKey object.
3818
+ * @param deleteApiKey.key - API key.
3819
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3820
+ * @see deleteApiKey for the plain version.
3821
+ */
3822
+ deleteApiKeyWithHTTPInfo({ key }: DeleteApiKeyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteApiKeyResponse>>;
3608
3823
  /**
3609
3824
  * This operation doesn\'t accept empty filters. This operation is resource-intensive. Use it only if you can\'t get the object IDs of the records you want to delete. It\'s more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3610
3825
  *
@@ -3616,6 +3831,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3616
3831
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3617
3832
  */
3618
3833
  deleteBy({ indexName, deleteByParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3834
+ /**
3835
+ * This operation doesn\'t accept empty filters. This operation is resource-intensive. Use it only if you can\'t get the object IDs of the records you want to delete. It\'s more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3836
+ *
3837
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3838
+ *
3839
+ * Required API Key ACLs:
3840
+ * - deleteIndex
3841
+ * @param deleteBy - The deleteBy object.
3842
+ * @param deleteBy.indexName - Name of the index on which to perform the operation.
3843
+ * @param deleteBy.deleteByParams - The deleteByParams object.
3844
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3845
+ * @see deleteBy for the plain version.
3846
+ */
3847
+ deleteByWithHTTPInfo({ indexName, deleteByParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3619
3848
  /**
3620
3849
  * Deletes an index and all its settings. - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas).
3621
3850
  *
@@ -3626,6 +3855,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3626
3855
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3627
3856
  */
3628
3857
  deleteIndex({ indexName }: DeleteIndexProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3858
+ /**
3859
+ * Deletes an index and all its settings. - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas).
3860
+ *
3861
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3862
+ *
3863
+ * Required API Key ACLs:
3864
+ * - deleteIndex
3865
+ * @param deleteIndex - The deleteIndex object.
3866
+ * @param deleteIndex.indexName - Name of the index on which to perform the operation.
3867
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3868
+ * @see deleteIndex for the plain version.
3869
+ */
3870
+ deleteIndexWithHTTPInfo({ indexName }: DeleteIndexProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeletedAtResponse>>;
3629
3871
  /**
3630
3872
  * Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). To delete records matching a query, use the [`deleteBy` operation](https://www.algolia.com/doc/rest-api/search/delete-by).
3631
3873
  *
@@ -3637,6 +3879,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3637
3879
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3638
3880
  */
3639
3881
  deleteObject({ indexName, objectID }: DeleteObjectProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3882
+ /**
3883
+ * Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). To delete records matching a query, use the [`deleteBy` operation](https://www.algolia.com/doc/rest-api/search/delete-by).
3884
+ *
3885
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3886
+ *
3887
+ * Required API Key ACLs:
3888
+ * - deleteObject
3889
+ * @param deleteObject - The deleteObject object.
3890
+ * @param deleteObject.indexName - Name of the index on which to perform the operation.
3891
+ * @param deleteObject.objectID - Unique record identifier.
3892
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3893
+ * @see deleteObject for the plain version.
3894
+ */
3895
+ deleteObjectWithHTTPInfo({ indexName, objectID }: DeleteObjectProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeletedAtResponse>>;
3640
3896
  /**
3641
3897
  * Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
3642
3898
  *
@@ -3649,6 +3905,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3649
3905
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3650
3906
  */
3651
3907
  deleteRule({ indexName, objectID, forwardToReplicas }: DeleteRuleProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3908
+ /**
3909
+ * Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
3910
+ *
3911
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3912
+ *
3913
+ * Required API Key ACLs:
3914
+ * - editSettings
3915
+ * @param deleteRule - The deleteRule object.
3916
+ * @param deleteRule.indexName - Name of the index on which to perform the operation.
3917
+ * @param deleteRule.objectID - Unique identifier of a rule object.
3918
+ * @param deleteRule.forwardToReplicas - Whether changes are applied to replica indices.
3919
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3920
+ * @see deleteRule for the plain version.
3921
+ */
3922
+ deleteRuleWithHTTPInfo({ indexName, objectID, forwardToReplicas }: DeleteRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3652
3923
  /**
3653
3924
  * Deletes a source from the list of allowed sources.
3654
3925
  *
@@ -3659,6 +3930,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3659
3930
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3660
3931
  */
3661
3932
  deleteSource({ source }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteSourceResponse>;
3933
+ /**
3934
+ * Deletes a source from the list of allowed sources.
3935
+ *
3936
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3937
+ *
3938
+ * Required API Key ACLs:
3939
+ * - admin
3940
+ * @param deleteSource - The deleteSource object.
3941
+ * @param deleteSource.source - IP address range of the source.
3942
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3943
+ * @see deleteSource for the plain version.
3944
+ */
3945
+ deleteSourceWithHTTPInfo({ source }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteSourceResponse>>;
3662
3946
  /**
3663
3947
  * Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms).
3664
3948
  *
@@ -3671,6 +3955,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3671
3955
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3672
3956
  */
3673
3957
  deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3958
+ /**
3959
+ * Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms).
3960
+ *
3961
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3962
+ *
3963
+ * Required API Key ACLs:
3964
+ * - editSettings
3965
+ * @param deleteSynonym - The deleteSynonym object.
3966
+ * @param deleteSynonym.indexName - Name of the index on which to perform the operation.
3967
+ * @param deleteSynonym.objectID - Unique identifier of a synonym object.
3968
+ * @param deleteSynonym.forwardToReplicas - Whether changes are applied to replica indices.
3969
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3970
+ * @see deleteSynonym for the plain version.
3971
+ */
3972
+ deleteSynonymWithHTTPInfo({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeletedAtResponse>>;
3674
3973
  /**
3675
3974
  * Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
3676
3975
  *
@@ -3681,6 +3980,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3681
3980
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3682
3981
  */
3683
3982
  getApiKey({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<GetApiKeyResponse>;
3983
+ /**
3984
+ * Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
3985
+ *
3986
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3987
+ *
3988
+ * Required API Key ACLs:
3989
+ * - search
3990
+ * @param getApiKey - The getApiKey object.
3991
+ * @param getApiKey.key - API key.
3992
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3993
+ * @see getApiKey for the plain version.
3994
+ */
3995
+ getApiKeyWithHTTPInfo({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetApiKeyResponse>>;
3684
3996
  /**
3685
3997
  * Checks the status of a given application task.
3686
3998
  *
@@ -3691,6 +4003,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3691
4003
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3692
4004
  */
3693
4005
  getAppTask({ taskID }: GetAppTaskProps, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
4006
+ /**
4007
+ * Checks the status of a given application task.
4008
+ *
4009
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4010
+ *
4011
+ * Required API Key ACLs:
4012
+ * - editSettings
4013
+ * @param getAppTask - The getAppTask object.
4014
+ * @param getAppTask.taskID - Unique task identifier.
4015
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4016
+ * @see getAppTask for the plain version.
4017
+ */
4018
+ getAppTaskWithHTTPInfo({ taskID }: GetAppTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetTaskResponse>>;
3694
4019
  /**
3695
4020
  * Lists supported languages with their supported dictionary types and number of custom entries.
3696
4021
  *
@@ -3702,13 +4027,37 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3702
4027
  [key: string]: Languages;
3703
4028
  }>;
3704
4029
  /**
3705
- * Retrieves the languages for which standard dictionary entries are turned off.
4030
+ * Lists supported languages with their supported dictionary types and number of custom entries.
4031
+ *
4032
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3706
4033
  *
3707
4034
  * Required API Key ACLs:
3708
4035
  * - settings
3709
4036
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4037
+ * @see getDictionaryLanguages for the plain version.
3710
4038
  */
3711
- getDictionarySettings(requestOptions?: RequestOptions | undefined): Promise<GetDictionarySettingsResponse>;
4039
+ getDictionaryLanguagesWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<{
4040
+ [key: string]: Languages;
4041
+ }>>;
4042
+ /**
4043
+ * Retrieves the languages for which standard dictionary entries are turned off.
4044
+ *
4045
+ * Required API Key ACLs:
4046
+ * - settings
4047
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4048
+ */
4049
+ getDictionarySettings(requestOptions?: RequestOptions | undefined): Promise<GetDictionarySettingsResponse>;
4050
+ /**
4051
+ * Retrieves the languages for which standard dictionary entries are turned off.
4052
+ *
4053
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4054
+ *
4055
+ * Required API Key ACLs:
4056
+ * - settings
4057
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4058
+ * @see getDictionarySettings for the plain version.
4059
+ */
4060
+ getDictionarySettingsWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<GetDictionarySettingsResponse>>;
3712
4061
  /**
3713
4062
  * The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/articles/17245378392977-How-does-Algolia-count-records-and-operations) but doesn\'t appear in the logs itself.
3714
4063
  *
@@ -3722,6 +4071,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3722
4071
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3723
4072
  */
3724
4073
  getLogs({ offset, length, indexName, type }?: GetLogsProps, requestOptions?: RequestOptions | undefined): Promise<GetLogsResponse>;
4074
+ /**
4075
+ * The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/articles/17245378392977-How-does-Algolia-count-records-and-operations) but doesn\'t appear in the logs itself.
4076
+ *
4077
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4078
+ *
4079
+ * Required API Key ACLs:
4080
+ * - logs
4081
+ * @param getLogs - The getLogs object.
4082
+ * @param getLogs.offset - First log entry to retrieve. The most recent entries are listed first.
4083
+ * @param getLogs.length - Maximum number of entries to retrieve.
4084
+ * @param getLogs.indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
4085
+ * @param getLogs.type - Type of log entries to retrieve. By default, all log entries are retrieved.
4086
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4087
+ * @see getLogs for the plain version.
4088
+ */
4089
+ getLogsWithHTTPInfo({ offset, length, indexName, type }?: GetLogsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<GetLogsResponse>>;
3725
4090
  /**
3726
4091
  * Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/get-objects).
3727
4092
  *
@@ -3734,6 +4099,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3734
4099
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3735
4100
  */
3736
4101
  getObject<T = Record<string, unknown>>({ indexName, objectID, attributesToRetrieve }: GetObjectProps, requestOptions?: RequestOptions): Promise<T>;
4102
+ /**
4103
+ * Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/get-objects).
4104
+ *
4105
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4106
+ *
4107
+ * Required API Key ACLs:
4108
+ * - search
4109
+ * @param getObject - The getObject object.
4110
+ * @param getObject.indexName - Name of the index on which to perform the operation.
4111
+ * @param getObject.objectID - Unique record identifier.
4112
+ * @param getObject.attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won\'t be retrieved unless the request is authenticated with the admin API key.
4113
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4114
+ * @see getObject for the plain version.
4115
+ */
4116
+ getObjectWithHTTPInfo<T = Record<string, unknown>>({ indexName, objectID, attributesToRetrieve }: GetObjectProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<T>>;
3737
4117
  /**
3738
4118
  * Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
3739
4119
  *
@@ -3743,6 +4123,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3743
4123
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3744
4124
  */
3745
4125
  getObjects<T>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse<T>>;
4126
+ /**
4127
+ * Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
4128
+ *
4129
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4130
+ *
4131
+ * Required API Key ACLs:
4132
+ * - search
4133
+ * @param getObjectsParams - Request object.
4134
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4135
+ * @see getObjects for the plain version.
4136
+ */
4137
+ getObjectsWithHTTPInfo<T>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetObjectsResponse<T>>>;
3746
4138
  /**
3747
4139
  * Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
3748
4140
  *
@@ -3754,6 +4146,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3754
4146
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3755
4147
  */
3756
4148
  getRule({ indexName, objectID }: GetRuleProps, requestOptions?: RequestOptions): Promise<Rule>;
4149
+ /**
4150
+ * Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
4151
+ *
4152
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4153
+ *
4154
+ * Required API Key ACLs:
4155
+ * - settings
4156
+ * @param getRule - The getRule object.
4157
+ * @param getRule.indexName - Name of the index on which to perform the operation.
4158
+ * @param getRule.objectID - Unique identifier of a rule object.
4159
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4160
+ * @see getRule for the plain version.
4161
+ */
4162
+ getRuleWithHTTPInfo({ indexName, objectID }: GetRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Rule>>;
3757
4163
  /**
3758
4164
  * Retrieves an object with non-null index settings.
3759
4165
  *
@@ -3765,6 +4171,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3765
4171
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3766
4172
  */
3767
4173
  getSettings({ indexName, getVersion }: GetSettingsProps, requestOptions?: RequestOptions): Promise<SettingsResponse>;
4174
+ /**
4175
+ * Retrieves an object with non-null index settings.
4176
+ *
4177
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4178
+ *
4179
+ * Required API Key ACLs:
4180
+ * - settings
4181
+ * @param getSettings - The getSettings object.
4182
+ * @param getSettings.indexName - Name of the index on which to perform the operation.
4183
+ * @param getSettings.getVersion - When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
4184
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4185
+ * @see getSettings for the plain version.
4186
+ */
4187
+ getSettingsWithHTTPInfo({ indexName, getVersion }: GetSettingsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SettingsResponse>>;
3768
4188
  /**
3769
4189
  * Retrieves all allowed IP addresses with access to your application.
3770
4190
  *
@@ -3773,6 +4193,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3773
4193
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3774
4194
  */
3775
4195
  getSources(requestOptions?: RequestOptions | undefined): Promise<Array<Source>>;
4196
+ /**
4197
+ * Retrieves all allowed IP addresses with access to your application.
4198
+ *
4199
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4200
+ *
4201
+ * Required API Key ACLs:
4202
+ * - admin
4203
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4204
+ * @see getSources for the plain version.
4205
+ */
4206
+ getSourcesWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<Array<Source>>>;
3776
4207
  /**
3777
4208
  * Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms).
3778
4209
  *
@@ -3784,6 +4215,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3784
4215
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3785
4216
  */
3786
4217
  getSynonym({ indexName, objectID }: GetSynonymProps, requestOptions?: RequestOptions): Promise<SynonymHit>;
4218
+ /**
4219
+ * Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms).
4220
+ *
4221
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4222
+ *
4223
+ * Required API Key ACLs:
4224
+ * - settings
4225
+ * @param getSynonym - The getSynonym object.
4226
+ * @param getSynonym.indexName - Name of the index on which to perform the operation.
4227
+ * @param getSynonym.objectID - Unique identifier of a synonym object.
4228
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4229
+ * @see getSynonym for the plain version.
4230
+ */
4231
+ getSynonymWithHTTPInfo({ indexName, objectID }: GetSynonymProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SynonymHit>>;
3787
4232
  /**
3788
4233
  * Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks\' responses include a task ID that you can use to check the status.
3789
4234
  *
@@ -3795,6 +4240,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3795
4240
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3796
4241
  */
3797
4242
  getTask({ indexName, taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
4243
+ /**
4244
+ * Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks\' responses include a task ID that you can use to check the status.
4245
+ *
4246
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4247
+ *
4248
+ * Required API Key ACLs:
4249
+ * - addObject
4250
+ * @param getTask - The getTask object.
4251
+ * @param getTask.indexName - Name of the index on which to perform the operation.
4252
+ * @param getTask.taskID - Unique task identifier.
4253
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4254
+ * @see getTask for the plain version.
4255
+ */
4256
+ getTaskWithHTTPInfo({ indexName, taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetTaskResponse>>;
3798
4257
  /**
3799
4258
  * Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
3800
4259
  *
@@ -3805,6 +4264,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3805
4264
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3806
4265
  */
3807
4266
  getTopUserIds(requestOptions?: RequestOptions | undefined): Promise<GetTopUserIdsResponse>;
4267
+ /**
4268
+ * Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
4269
+ *
4270
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4271
+ *
4272
+ * Required API Key ACLs:
4273
+ * - admin
4274
+ *
4275
+ * @deprecated
4276
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4277
+ * @see getTopUserIds for the plain version.
4278
+ */
4279
+ getTopUserIdsWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<GetTopUserIdsResponse>>;
3808
4280
  /**
3809
4281
  * Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
3810
4282
  *
@@ -3817,6 +4289,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3817
4289
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3818
4290
  */
3819
4291
  getUserId({ userID }: GetUserIdProps, requestOptions?: RequestOptions): Promise<UserId>;
4292
+ /**
4293
+ * Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
4294
+ *
4295
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4296
+ *
4297
+ * Required API Key ACLs:
4298
+ * - admin
4299
+ *
4300
+ * @deprecated
4301
+ * @param getUserId - The getUserId object.
4302
+ * @param getUserId.userID - Unique identifier of the user who makes the search request.
4303
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4304
+ * @see getUserId for the plain version.
4305
+ */
4306
+ getUserIdWithHTTPInfo({ userID }: GetUserIdProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UserId>>;
3820
4307
  /**
3821
4308
  * To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
3822
4309
  *
@@ -3829,6 +4316,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3829
4316
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3830
4317
  */
3831
4318
  hasPendingMappings({ getClusters }?: HasPendingMappingsProps, requestOptions?: RequestOptions | undefined): Promise<HasPendingMappingsResponse>;
4319
+ /**
4320
+ * To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
4321
+ *
4322
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4323
+ *
4324
+ * Required API Key ACLs:
4325
+ * - admin
4326
+ *
4327
+ * @deprecated
4328
+ * @param hasPendingMappings - The hasPendingMappings object.
4329
+ * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
4330
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4331
+ * @see hasPendingMappings for the plain version.
4332
+ */
4333
+ hasPendingMappingsWithHTTPInfo({ getClusters }?: HasPendingMappingsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<HasPendingMappingsResponse>>;
3832
4334
  /**
3833
4335
  * Lists all API keys associated with your Algolia application, including their permissions and restrictions.
3834
4336
  *
@@ -3837,6 +4339,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3837
4339
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3838
4340
  */
3839
4341
  listApiKeys(requestOptions?: RequestOptions | undefined): Promise<ListApiKeysResponse>;
4342
+ /**
4343
+ * Lists all API keys associated with your Algolia application, including their permissions and restrictions.
4344
+ *
4345
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4346
+ *
4347
+ * Required API Key ACLs:
4348
+ * - admin
4349
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4350
+ * @see listApiKeys for the plain version.
4351
+ */
4352
+ listApiKeysWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListApiKeysResponse>>;
3840
4353
  /**
3841
4354
  * Lists the available clusters in a multi-cluster setup.
3842
4355
  *
@@ -3847,6 +4360,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3847
4360
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3848
4361
  */
3849
4362
  listClusters(requestOptions?: RequestOptions | undefined): Promise<ListClustersResponse>;
4363
+ /**
4364
+ * Lists the available clusters in a multi-cluster setup.
4365
+ *
4366
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4367
+ *
4368
+ * Required API Key ACLs:
4369
+ * - admin
4370
+ *
4371
+ * @deprecated
4372
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4373
+ * @see listClusters for the plain version.
4374
+ */
4375
+ listClustersWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListClustersResponse>>;
3850
4376
  /**
3851
4377
  * Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
3852
4378
  *
@@ -3858,6 +4384,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3858
4384
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3859
4385
  */
3860
4386
  listIndices({ page, hitsPerPage }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<ListIndicesResponse>;
4387
+ /**
4388
+ * Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
4389
+ *
4390
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4391
+ *
4392
+ * Required API Key ACLs:
4393
+ * - listIndexes
4394
+ * @param listIndices - The listIndices object.
4395
+ * @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
4396
+ * @param listIndices.hitsPerPage - Number of hits per page.
4397
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4398
+ * @see listIndices for the plain version.
4399
+ */
4400
+ listIndicesWithHTTPInfo({ page, hitsPerPage }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListIndicesResponse>>;
3861
4401
  /**
3862
4402
  * Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
3863
4403
  *
@@ -3871,6 +4411,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3871
4411
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3872
4412
  */
3873
4413
  listUserIds({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<ListUserIdsResponse>;
4414
+ /**
4415
+ * Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
4416
+ *
4417
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4418
+ *
4419
+ * Required API Key ACLs:
4420
+ * - admin
4421
+ *
4422
+ * @deprecated
4423
+ * @param listUserIds - The listUserIds object.
4424
+ * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
4425
+ * @param listUserIds.hitsPerPage - Number of hits per page.
4426
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4427
+ * @see listUserIds for the plain version.
4428
+ */
4429
+ listUserIdsWithHTTPInfo({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListUserIdsResponse>>;
3874
4430
  /**
3875
4431
  * Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3876
4432
  *
@@ -3880,6 +4436,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3880
4436
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3881
4437
  */
3882
4438
  multipleBatch(batchParams: BatchParams, requestOptions?: RequestOptions): Promise<MultipleBatchResponse>;
4439
+ /**
4440
+ * Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
4441
+ *
4442
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4443
+ *
4444
+ * Required API Key ACLs:
4445
+ * - addObject
4446
+ * @param batchParams - The batchParams object.
4447
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4448
+ * @see multipleBatch for the plain version.
4449
+ */
4450
+ multipleBatchWithHTTPInfo(batchParams: BatchParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<MultipleBatchResponse>>;
3883
4451
  /**
3884
4452
  * Copies or moves (renames) an index within the same Algolia application. Notes: - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn\'t exist yet, it\'s created. - This operation is resource-intensive. **Copy** - If the source index doesn\'t exist, copying creates a new index with 0 records and default settings. - API keys from the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - For more information, see [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices). **Move** - If the source index doesn\'t exist, moving is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - For more information, see [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3885
4453
  *
@@ -3891,6 +4459,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3891
4459
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3892
4460
  */
3893
4461
  operationIndex({ indexName, operationIndexParams }: OperationIndexProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4462
+ /**
4463
+ * Copies or moves (renames) an index within the same Algolia application. Notes: - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn\'t exist yet, it\'s created. - This operation is resource-intensive. **Copy** - If the source index doesn\'t exist, copying creates a new index with 0 records and default settings. - API keys from the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - For more information, see [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices). **Move** - If the source index doesn\'t exist, moving is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - For more information, see [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
4464
+ *
4465
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4466
+ *
4467
+ * Required API Key ACLs:
4468
+ * - addObject
4469
+ * @param operationIndex - The operationIndex object.
4470
+ * @param operationIndex.indexName - Name of the index on which to perform the operation.
4471
+ * @param operationIndex.operationIndexParams - The operationIndexParams object.
4472
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4473
+ * @see operationIndex for the plain version.
4474
+ */
4475
+ operationIndexWithHTTPInfo({ indexName, operationIndexParams }: OperationIndexProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3894
4476
  /**
3895
4477
  * Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn\'t exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - Use first-level attributes only. Nested attributes aren\'t supported. If you specify a nested attribute, this operation replaces its first-level ancestor. To update attributes without replacing the full record, use these built-in operations. These operations are useful when the initial data isn\'t available. - `Increment`: increment a numeric attribute. - `Decrement`: decrement a numeric attribute. - `Add`: append a number or string element to an array attribute. - `Remove`: remove all matching number or string elements from an array attribute made of numbers or strings. - `AddUnique`: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present. - `IncrementFrom`: increment a numeric integer attribute only if the provided value matches the current value. Otherwise, the update is ignored. Example: If you pass an `IncrementFrom` value of 2 for the `version` attribute but the current value is 1, the API ignores the update. If the object doesn\'t exist, the API only creates it if you pass an `IncrementFrom` value of 0. - `IncrementSet`: increment a numeric integer attribute only if the provided value is greater than the current value. Otherwise, the update is ignored. Example: If you pass an `IncrementSet` value of 2 for the `version` attribute and the current value is 1, the API updates the object. If the object doesn\'t exist yet, the API only creates it if you pass an `IncrementSet` value greater than 0. Specify an operation by providing an object with the attribute to update as the key and its value as an object with these properties: - `_operation`: the operation to apply on the attribute. - `value`: the right-hand side argument to the operation, for example, increment or decrement step, or a value to add or remove. When updating multiple attributes or using multiple operations targeting the same record, use a single partial update for faster processing. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3896
4478
  *
@@ -3904,6 +4486,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3904
4486
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3905
4487
  */
3906
4488
  partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
4489
+ /**
4490
+ * Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn\'t exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - Use first-level attributes only. Nested attributes aren\'t supported. If you specify a nested attribute, this operation replaces its first-level ancestor. To update attributes without replacing the full record, use these built-in operations. These operations are useful when the initial data isn\'t available. - `Increment`: increment a numeric attribute. - `Decrement`: decrement a numeric attribute. - `Add`: append a number or string element to an array attribute. - `Remove`: remove all matching number or string elements from an array attribute made of numbers or strings. - `AddUnique`: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present. - `IncrementFrom`: increment a numeric integer attribute only if the provided value matches the current value. Otherwise, the update is ignored. Example: If you pass an `IncrementFrom` value of 2 for the `version` attribute but the current value is 1, the API ignores the update. If the object doesn\'t exist, the API only creates it if you pass an `IncrementFrom` value of 0. - `IncrementSet`: increment a numeric integer attribute only if the provided value is greater than the current value. Otherwise, the update is ignored. Example: If you pass an `IncrementSet` value of 2 for the `version` attribute and the current value is 1, the API updates the object. If the object doesn\'t exist yet, the API only creates it if you pass an `IncrementSet` value greater than 0. Specify an operation by providing an object with the attribute to update as the key and its value as an object with these properties: - `_operation`: the operation to apply on the attribute. - `value`: the right-hand side argument to the operation, for example, increment or decrement step, or a value to add or remove. When updating multiple attributes or using multiple operations targeting the same record, use a single partial update for faster processing. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
4491
+ *
4492
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4493
+ *
4494
+ * Required API Key ACLs:
4495
+ * - addObject
4496
+ * @param partialUpdateObject - The partialUpdateObject object.
4497
+ * @param partialUpdateObject.indexName - Name of the index on which to perform the operation.
4498
+ * @param partialUpdateObject.objectID - Unique record identifier.
4499
+ * @param partialUpdateObject.attributesToUpdate - Attributes with their values.
4500
+ * @param partialUpdateObject.createIfNotExists - Whether to create a new record if it doesn\'t exist.
4501
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4502
+ * @see partialUpdateObject for the plain version.
4503
+ */
4504
+ partialUpdateObjectWithHTTPInfo({ indexName, objectID, attributesToUpdate, createIfNotExists }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtWithObjectIdResponse>>;
3907
4505
  /**
3908
4506
  * Deletes a user ID and its associated data from the clusters.
3909
4507
  *
@@ -3916,6 +4514,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3916
4514
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3917
4515
  */
3918
4516
  removeUserId({ userID }: RemoveUserIdProps, requestOptions?: RequestOptions): Promise<RemoveUserIdResponse>;
4517
+ /**
4518
+ * Deletes a user ID and its associated data from the clusters.
4519
+ *
4520
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4521
+ *
4522
+ * Required API Key ACLs:
4523
+ * - admin
4524
+ *
4525
+ * @deprecated
4526
+ * @param removeUserId - The removeUserId object.
4527
+ * @param removeUserId.userID - Unique identifier of the user who makes the search request.
4528
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4529
+ * @see removeUserId for the plain version.
4530
+ */
4531
+ removeUserIdWithHTTPInfo({ userID }: RemoveUserIdProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<RemoveUserIdResponse>>;
3919
4532
  /**
3920
4533
  * Replaces the list of allowed sources.
3921
4534
  *
@@ -3926,6 +4539,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3926
4539
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3927
4540
  */
3928
4541
  replaceSources({ source }: ReplaceSourcesProps, requestOptions?: RequestOptions): Promise<ReplaceSourceResponse>;
4542
+ /**
4543
+ * Replaces the list of allowed sources.
4544
+ *
4545
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4546
+ *
4547
+ * Required API Key ACLs:
4548
+ * - admin
4549
+ * @param replaceSources - The replaceSources object.
4550
+ * @param replaceSources.source - Allowed sources.
4551
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4552
+ * @see replaceSources for the plain version.
4553
+ */
4554
+ replaceSourcesWithHTTPInfo({ source }: ReplaceSourcesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ReplaceSourceResponse>>;
3929
4555
  /**
3930
4556
  * Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can\'t be restored.
3931
4557
  *
@@ -3936,6 +4562,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3936
4562
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3937
4563
  */
3938
4564
  restoreApiKey({ key }: RestoreApiKeyProps, requestOptions?: RequestOptions): Promise<AddApiKeyResponse>;
4565
+ /**
4566
+ * Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can\'t be restored.
4567
+ *
4568
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4569
+ *
4570
+ * Required API Key ACLs:
4571
+ * - admin
4572
+ * @param restoreApiKey - The restoreApiKey object.
4573
+ * @param restoreApiKey.key - API key.
4574
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4575
+ * @see restoreApiKey for the plain version.
4576
+ */
4577
+ restoreApiKeyWithHTTPInfo({ key }: RestoreApiKeyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<AddApiKeyResponse>>;
3939
4578
  /**
3940
4579
  * Adds a record to an index or replaces it. - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3941
4580
  *
@@ -3947,6 +4586,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3947
4586
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3948
4587
  */
3949
4588
  saveObject<T extends object>({ indexName, body }: SaveObjectProps<T>, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
4589
+ /**
4590
+ * Adds a record to an index or replaces it. - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
4591
+ *
4592
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4593
+ *
4594
+ * Required API Key ACLs:
4595
+ * - addObject
4596
+ * @param saveObject - The saveObject object.
4597
+ * @param saveObject.indexName - Name of the index on which to perform the operation.
4598
+ * @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
4599
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4600
+ * @see saveObject for the plain version.
4601
+ */
4602
+ saveObjectWithHTTPInfo<T extends object>({ indexName, body }: SaveObjectProps<T>, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SaveObjectResponse>>;
3950
4603
  /**
3951
4604
  * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-rules).
3952
4605
  *
@@ -3960,6 +4613,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3960
4613
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3961
4614
  */
3962
4615
  saveRule({ indexName, objectID, rule, forwardToReplicas }: SaveRuleProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4616
+ /**
4617
+ * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-rules).
4618
+ *
4619
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4620
+ *
4621
+ * Required API Key ACLs:
4622
+ * - editSettings
4623
+ * @param saveRule - The saveRule object.
4624
+ * @param saveRule.indexName - Name of the index on which to perform the operation.
4625
+ * @param saveRule.objectID - Unique identifier of a rule object.
4626
+ * @param saveRule.rule - The rule object.
4627
+ * @param saveRule.forwardToReplicas - Whether changes are applied to replica indices.
4628
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4629
+ * @see saveRule for the plain version.
4630
+ */
4631
+ saveRuleWithHTTPInfo({ indexName, objectID, rule, forwardToReplicas }: SaveRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3963
4632
  /**
3964
4633
  * Create or update multiple rules. If a rule with the specified object ID doesn\'t exist, Algolia creates a new one. Otherwise, existing rules are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3965
4634
  *
@@ -3973,6 +4642,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3973
4642
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3974
4643
  */
3975
4644
  saveRules({ indexName, rules, forwardToReplicas, clearExistingRules }: SaveRulesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4645
+ /**
4646
+ * Create or update multiple rules. If a rule with the specified object ID doesn\'t exist, Algolia creates a new one. Otherwise, existing rules are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
4647
+ *
4648
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4649
+ *
4650
+ * Required API Key ACLs:
4651
+ * - editSettings
4652
+ * @param saveRules - The saveRules object.
4653
+ * @param saveRules.indexName - Name of the index on which to perform the operation.
4654
+ * @param saveRules.rules - The rules object.
4655
+ * @param saveRules.forwardToReplicas - Whether changes are applied to replica indices.
4656
+ * @param saveRules.clearExistingRules - Whether existing rules should be deleted before adding this batch.
4657
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4658
+ * @see saveRules for the plain version.
4659
+ */
4660
+ saveRulesWithHTTPInfo({ indexName, rules, forwardToReplicas, clearExistingRules }: SaveRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3976
4661
  /**
3977
4662
  * If a synonym with the specified object ID doesn\'t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-synonyms).
3978
4663
  *
@@ -3986,6 +4671,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3986
4671
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3987
4672
  */
3988
4673
  saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: SaveSynonymProps, requestOptions?: RequestOptions): Promise<SaveSynonymResponse>;
4674
+ /**
4675
+ * If a synonym with the specified object ID doesn\'t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-synonyms).
4676
+ *
4677
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4678
+ *
4679
+ * Required API Key ACLs:
4680
+ * - editSettings
4681
+ * @param saveSynonym - The saveSynonym object.
4682
+ * @param saveSynonym.indexName - Name of the index on which to perform the operation.
4683
+ * @param saveSynonym.objectID - Unique identifier of a synonym object.
4684
+ * @param saveSynonym.synonymHit - The synonymHit object.
4685
+ * @param saveSynonym.forwardToReplicas - Whether changes are applied to replica indices.
4686
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4687
+ * @see saveSynonym for the plain version.
4688
+ */
4689
+ saveSynonymWithHTTPInfo({ indexName, objectID, synonymHit, forwardToReplicas }: SaveSynonymProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SaveSynonymResponse>>;
3989
4690
  /**
3990
4691
  * If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
3991
4692
  *
@@ -3999,6 +4700,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3999
4700
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4000
4701
  */
4001
4702
  saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4703
+ /**
4704
+ * If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
4705
+ *
4706
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4707
+ *
4708
+ * Required API Key ACLs:
4709
+ * - editSettings
4710
+ * @param saveSynonyms - The saveSynonyms object.
4711
+ * @param saveSynonyms.indexName - Name of the index on which to perform the operation.
4712
+ * @param saveSynonyms.synonymHit - The synonymHit object.
4713
+ * @param saveSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
4714
+ * @param saveSynonyms.replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request.
4715
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4716
+ * @see saveSynonyms for the plain version.
4717
+ */
4718
+ saveSynonymsWithHTTPInfo({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
4002
4719
  /**
4003
4720
  * Runs multiple search queries against one or more indices in a single API request. Use cases include: - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters. If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
4004
4721
  *
@@ -4008,6 +4725,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4008
4725
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4009
4726
  */
4010
4727
  search<T>(searchMethodParams: SearchMethodParams | LegacySearchMethodProps, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
4728
+ /**
4729
+ * Runs multiple search queries against one or more indices in a single API request. Use cases include: - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters. If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
4730
+ *
4731
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4732
+ *
4733
+ * Required API Key ACLs:
4734
+ * - search
4735
+ * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
4736
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4737
+ * @see search for the plain version.
4738
+ */
4739
+ searchWithHTTPInfo<T>(searchMethodParams: SearchMethodParams | LegacySearchMethodProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchResponses<T>>>;
4011
4740
  /**
4012
4741
  * Searches for standard and custom dictionary entries.
4013
4742
  *
@@ -4019,6 +4748,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4019
4748
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4020
4749
  */
4021
4750
  searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams }: SearchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<SearchDictionaryEntriesResponse>;
4751
+ /**
4752
+ * Searches for standard and custom dictionary entries.
4753
+ *
4754
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4755
+ *
4756
+ * Required API Key ACLs:
4757
+ * - settings
4758
+ * @param searchDictionaryEntries - The searchDictionaryEntries object.
4759
+ * @param searchDictionaryEntries.dictionaryName - Dictionary type in which to search.
4760
+ * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
4761
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4762
+ * @see searchDictionaryEntries for the plain version.
4763
+ */
4764
+ searchDictionaryEntriesWithHTTPInfo({ dictionaryName, searchDictionaryEntriesParams }: SearchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchDictionaryEntriesResponse>>;
4022
4765
  /**
4023
4766
  * Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
4024
4767
  *
@@ -4031,6 +4774,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4031
4774
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4032
4775
  */
4033
4776
  searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps, requestOptions?: RequestOptions): Promise<SearchForFacetValuesResponse>;
4777
+ /**
4778
+ * Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
4779
+ *
4780
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4781
+ *
4782
+ * Required API Key ACLs:
4783
+ * - search
4784
+ * @param searchForFacetValues - The searchForFacetValues object.
4785
+ * @param searchForFacetValues.indexName - Name of the index on which to perform the operation.
4786
+ * @param searchForFacetValues.facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
4787
+ * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
4788
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4789
+ * @see searchForFacetValues for the plain version.
4790
+ */
4791
+ searchForFacetValuesWithHTTPInfo({ indexName, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchForFacetValuesResponse>>;
4034
4792
  /**
4035
4793
  * Searches for rules in your index.
4036
4794
  *
@@ -4042,6 +4800,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4042
4800
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4043
4801
  */
4044
4802
  searchRules({ indexName, searchRulesParams }: SearchRulesProps, requestOptions?: RequestOptions): Promise<SearchRulesResponse>;
4803
+ /**
4804
+ * Searches for rules in your index.
4805
+ *
4806
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4807
+ *
4808
+ * Required API Key ACLs:
4809
+ * - settings
4810
+ * @param searchRules - The searchRules object.
4811
+ * @param searchRules.indexName - Name of the index on which to perform the operation.
4812
+ * @param searchRules.searchRulesParams - The searchRulesParams object.
4813
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4814
+ * @see searchRules for the plain version.
4815
+ */
4816
+ searchRulesWithHTTPInfo({ indexName, searchRulesParams }: SearchRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchRulesResponse>>;
4045
4817
  /**
4046
4818
  * Searches a single index and returns matching search results as hits. This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse) or increase the `paginatedLimitedTo` index setting.
4047
4819
  *
@@ -4053,6 +4825,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4053
4825
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4054
4826
  */
4055
4827
  searchSingleIndex<T>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<SearchResponse<T>>;
4828
+ /**
4829
+ * Searches a single index and returns matching search results as hits. This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse) or increase the `paginatedLimitedTo` index setting.
4830
+ *
4831
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4832
+ *
4833
+ * Required API Key ACLs:
4834
+ * - search
4835
+ * @param searchSingleIndex - The searchSingleIndex object.
4836
+ * @param searchSingleIndex.indexName - Name of the index on which to perform the operation.
4837
+ * @param searchSingleIndex.searchParams - The searchParams object.
4838
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4839
+ * @see searchSingleIndex for the plain version.
4840
+ */
4841
+ searchSingleIndexWithHTTPInfo<T>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchResponse<T>>>;
4056
4842
  /**
4057
4843
  * Searches for synonyms in your index.
4058
4844
  *
@@ -4064,6 +4850,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4064
4850
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4065
4851
  */
4066
4852
  searchSynonyms({ indexName, searchSynonymsParams }: SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
4853
+ /**
4854
+ * Searches for synonyms in your index.
4855
+ *
4856
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4857
+ *
4858
+ * Required API Key ACLs:
4859
+ * - settings
4860
+ * @param searchSynonyms - The searchSynonyms object.
4861
+ * @param searchSynonyms.indexName - Name of the index on which to perform the operation.
4862
+ * @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
4863
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4864
+ * @see searchSynonyms for the plain version.
4865
+ */
4866
+ searchSynonymsWithHTTPInfo({ indexName, searchSynonymsParams }: SearchSynonymsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchSynonymsResponse>>;
4067
4867
  /**
4068
4868
  * Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time. To ensure rapid updates, the user IDs index isn\'t built at the same time as the mapping. Instead, it\'s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).
4069
4869
  *
@@ -4075,6 +4875,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4075
4875
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4076
4876
  */
4077
4877
  searchUserIds(searchUserIdsParams: SearchUserIdsParams, requestOptions?: RequestOptions): Promise<SearchUserIdsResponse>;
4878
+ /**
4879
+ * Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time. To ensure rapid updates, the user IDs index isn\'t built at the same time as the mapping. Instead, it\'s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).
4880
+ *
4881
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4882
+ *
4883
+ * Required API Key ACLs:
4884
+ * - admin
4885
+ *
4886
+ * @deprecated
4887
+ * @param searchUserIdsParams - The searchUserIdsParams object.
4888
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4889
+ * @see searchUserIds for the plain version.
4890
+ */
4891
+ searchUserIdsWithHTTPInfo(searchUserIdsParams: SearchUserIdsParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchUserIdsResponse>>;
4078
4892
  /**
4079
4893
  * Turns standard stop word dictionary entries on or off for a given language.
4080
4894
  *
@@ -4084,6 +4898,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4084
4898
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4085
4899
  */
4086
4900
  setDictionarySettings(dictionarySettingsParams: DictionarySettingsParams, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4901
+ /**
4902
+ * Turns standard stop word dictionary entries on or off for a given language.
4903
+ *
4904
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4905
+ *
4906
+ * Required API Key ACLs:
4907
+ * - editSettings
4908
+ * @param dictionarySettingsParams - The dictionarySettingsParams object.
4909
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4910
+ * @see setDictionarySettings for the plain version.
4911
+ */
4912
+ setDictionarySettingsWithHTTPInfo(dictionarySettingsParams: DictionarySettingsParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
4087
4913
  /**
4088
4914
  * Update the specified index settings. Index settings that you don\'t specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.
4089
4915
  *
@@ -4096,6 +4922,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4096
4922
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4097
4923
  */
4098
4924
  setSettings({ indexName, indexSettings, forwardToReplicas }: SetSettingsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4925
+ /**
4926
+ * Update the specified index settings. Index settings that you don\'t specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.
4927
+ *
4928
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4929
+ *
4930
+ * Required API Key ACLs:
4931
+ * - editSettings
4932
+ * @param setSettings - The setSettings object.
4933
+ * @param setSettings.indexName - Name of the index on which to perform the operation.
4934
+ * @param setSettings.indexSettings - The indexSettings object.
4935
+ * @param setSettings.forwardToReplicas - Whether changes are applied to replica indices.
4936
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4937
+ * @see setSettings for the plain version.
4938
+ */
4939
+ setSettingsWithHTTPInfo({ indexName, indexSettings, forwardToReplicas }: SetSettingsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
4099
4940
  /**
4100
4941
  * Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
4101
4942
  *
@@ -4107,6 +4948,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4107
4948
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4108
4949
  */
4109
4950
  updateApiKey({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<UpdateApiKeyResponse>;
4951
+ /**
4952
+ * Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
4953
+ *
4954
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4955
+ *
4956
+ * Required API Key ACLs:
4957
+ * - admin
4958
+ * @param updateApiKey - The updateApiKey object.
4959
+ * @param updateApiKey.key - API key.
4960
+ * @param updateApiKey.apiKey - The apiKey object.
4961
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4962
+ * @see updateApiKey for the plain version.
4963
+ */
4964
+ updateApiKeyWithHTTPInfo({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdateApiKeyResponse>>;
4110
4965
  };
4111
4966
 
4112
4967
  /**