@algolia/client-search 5.55.1 → 5.56.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/node.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.1";
3245
+ declare const apiClientVersion = "5.56.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
  */
@@ -3449,6 +3449,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3449
3449
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3450
3450
  */
3451
3451
  addApiKey(apiKey: ApiKey, requestOptions?: RequestOptions): Promise<AddApiKeyResponse>;
3452
+ /**
3453
+ * Creates a new API key with specific permissions and restrictions.
3454
+ *
3455
+ * 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.
3456
+ *
3457
+ * Required API Key ACLs:
3458
+ * - admin
3459
+ * @param apiKey - The apiKey object.
3460
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3461
+ * @see addApiKey for the plain version.
3462
+ */
3463
+ addApiKeyWithHTTPInfo(apiKey: ApiKey, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<AddApiKeyResponse>>;
3452
3464
  /**
3453
3465
  * 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
3466
  *
@@ -3461,6 +3473,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3461
3473
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3462
3474
  */
3463
3475
  addOrUpdateObject<T extends object>({ indexName, objectID, body }: AddOrUpdateObjectProps<T>, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
3476
+ /**
3477
+ * 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).
3478
+ *
3479
+ * 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.
3480
+ *
3481
+ * Required API Key ACLs:
3482
+ * - addObject
3483
+ * @param addOrUpdateObject - The addOrUpdateObject object.
3484
+ * @param addOrUpdateObject.indexName - Name of the index on which to perform the operation.
3485
+ * @param addOrUpdateObject.objectID - Unique record identifier.
3486
+ * @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
3487
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3488
+ * @see addOrUpdateObject for the plain version.
3489
+ */
3490
+ addOrUpdateObjectWithHTTPInfo<T extends object>({ indexName, objectID, body }: AddOrUpdateObjectProps<T>, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtWithObjectIdResponse>>;
3464
3491
  /**
3465
3492
  * Adds a source to the list of allowed sources.
3466
3493
  *
@@ -3470,6 +3497,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3470
3497
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3471
3498
  */
3472
3499
  appendSource(source: Source, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
3500
+ /**
3501
+ * Adds a source to the list of allowed sources.
3502
+ *
3503
+ * 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.
3504
+ *
3505
+ * Required API Key ACLs:
3506
+ * - admin
3507
+ * @param source - Source to add.
3508
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3509
+ * @see appendSource for the plain version.
3510
+ */
3511
+ appendSourceWithHTTPInfo(source: Source, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<CreatedAtResponse>>;
3473
3512
  /**
3474
3513
  * 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
3514
  *
@@ -3483,6 +3522,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3483
3522
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3484
3523
  */
3485
3524
  assignUserId({ xAlgoliaUserID, assignUserIdParams }: AssignUserIdProps, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
3525
+ /**
3526
+ * 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.
3527
+ *
3528
+ * 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.
3529
+ *
3530
+ * Required API Key ACLs:
3531
+ * - admin
3532
+ *
3533
+ * @deprecated
3534
+ * @param assignUserId - The assignUserId object.
3535
+ * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
3536
+ * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
3537
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3538
+ * @see assignUserId for the plain version.
3539
+ */
3540
+ assignUserIdWithHTTPInfo({ xAlgoliaUserID, assignUserIdParams }: AssignUserIdProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<CreatedAtResponse>>;
3486
3541
  /**
3487
3542
  * 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
3543
  *
@@ -3494,6 +3549,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3494
3549
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3495
3550
  */
3496
3551
  batch({ indexName, batchWriteParams }: BatchProps, requestOptions?: RequestOptions): Promise<BatchResponse>;
3552
+ /**
3553
+ * 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).
3554
+ *
3555
+ * 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.
3556
+ *
3557
+ * Required API Key ACLs:
3558
+ * - addObject
3559
+ * @param batch - The batch object.
3560
+ * @param batch.indexName - Name of the index on which to perform the operation.
3561
+ * @param batch.batchWriteParams - The batchWriteParams object.
3562
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3563
+ * @see batch for the plain version.
3564
+ */
3565
+ batchWithHTTPInfo({ indexName, batchWriteParams }: BatchProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BatchResponse>>;
3497
3566
  /**
3498
3567
  * Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**.
3499
3568
  *
@@ -3507,6 +3576,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3507
3576
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3508
3577
  */
3509
3578
  batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: BatchAssignUserIdsProps, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
3579
+ /**
3580
+ * Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**.
3581
+ *
3582
+ * 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.
3583
+ *
3584
+ * Required API Key ACLs:
3585
+ * - admin
3586
+ *
3587
+ * @deprecated
3588
+ * @param batchAssignUserIds - The batchAssignUserIds object.
3589
+ * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
3590
+ * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
3591
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3592
+ * @see batchAssignUserIds for the plain version.
3593
+ */
3594
+ batchAssignUserIdsWithHTTPInfo({ xAlgoliaUserID, batchAssignUserIdsParams }: BatchAssignUserIdsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<CreatedAtResponse>>;
3510
3595
  /**
3511
3596
  * Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
3512
3597
  *
@@ -3518,6 +3603,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3518
3603
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3519
3604
  */
3520
3605
  batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }: BatchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3606
+ /**
3607
+ * Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
3608
+ *
3609
+ * 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.
3610
+ *
3611
+ * Required API Key ACLs:
3612
+ * - editSettings
3613
+ * @param batchDictionaryEntries - The batchDictionaryEntries object.
3614
+ * @param batchDictionaryEntries.dictionaryName - Dictionary type in which to search.
3615
+ * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
3616
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3617
+ * @see batchDictionaryEntries for the plain version.
3618
+ */
3619
+ batchDictionaryEntriesWithHTTPInfo({ dictionaryName, batchDictionaryEntriesParams }: BatchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3521
3620
  /**
3522
3621
  * 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
3622
  *
@@ -3529,6 +3628,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3529
3628
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3530
3629
  */
3531
3630
  browse<T>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
3631
+ /**
3632
+ * 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.
3633
+ *
3634
+ * 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.
3635
+ *
3636
+ * Required API Key ACLs:
3637
+ * - browse
3638
+ * @param browse - The browse object.
3639
+ * @param browse.indexName - Name of the index on which to perform the operation.
3640
+ * @param browse.browseParams - The browseParams object.
3641
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3642
+ * @see browse for the plain version.
3643
+ */
3644
+ browseWithHTTPInfo<T>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BrowseResponse<T>>>;
3532
3645
  /**
3533
3646
  * 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
3647
  *
@@ -3539,6 +3652,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3539
3652
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3540
3653
  */
3541
3654
  clearObjects({ indexName }: ClearObjectsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3655
+ /**
3656
+ * 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).
3657
+ *
3658
+ * 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.
3659
+ *
3660
+ * Required API Key ACLs:
3661
+ * - deleteIndex
3662
+ * @param clearObjects - The clearObjects object.
3663
+ * @param clearObjects.indexName - Name of the index on which to perform the operation.
3664
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3665
+ * @see clearObjects for the plain version.
3666
+ */
3667
+ clearObjectsWithHTTPInfo({ indexName }: ClearObjectsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3542
3668
  /**
3543
3669
  * Deletes all rules from the index.
3544
3670
  *
@@ -3550,6 +3676,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3550
3676
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3551
3677
  */
3552
3678
  clearRules({ indexName, forwardToReplicas }: ClearRulesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3679
+ /**
3680
+ * Deletes all rules from the index.
3681
+ *
3682
+ * 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.
3683
+ *
3684
+ * Required API Key ACLs:
3685
+ * - editSettings
3686
+ * @param clearRules - The clearRules object.
3687
+ * @param clearRules.indexName - Name of the index on which to perform the operation.
3688
+ * @param clearRules.forwardToReplicas - Whether changes are applied to replica indices.
3689
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3690
+ * @see clearRules for the plain version.
3691
+ */
3692
+ clearRulesWithHTTPInfo({ indexName, forwardToReplicas }: ClearRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3553
3693
  /**
3554
3694
  * Deletes all synonyms from the index.
3555
3695
  *
@@ -3561,6 +3701,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3561
3701
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3562
3702
  */
3563
3703
  clearSynonyms({ indexName, forwardToReplicas }: ClearSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3704
+ /**
3705
+ * Deletes all synonyms from the index.
3706
+ *
3707
+ * 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.
3708
+ *
3709
+ * Required API Key ACLs:
3710
+ * - editSettings
3711
+ * @param clearSynonyms - The clearSynonyms object.
3712
+ * @param clearSynonyms.indexName - Name of the index on which to perform the operation.
3713
+ * @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
3714
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3715
+ * @see clearSynonyms for the plain version.
3716
+ */
3717
+ clearSynonymsWithHTTPInfo({ indexName, forwardToReplicas }: ClearSynonymsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3564
3718
  /**
3565
3719
  * This method lets you send requests to the Algolia REST API.
3566
3720
  * @param customDelete - The customDelete object.
@@ -3569,6 +3723,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3569
3723
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3570
3724
  */
3571
3725
  customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
3726
+ /**
3727
+ * This method lets you send requests to the Algolia REST API.
3728
+ *
3729
+ * 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.
3730
+ * @param customDelete - The customDelete object.
3731
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
3732
+ * @param customDelete.parameters - Query parameters to apply to the current query.
3733
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3734
+ * @see customDelete for the plain version.
3735
+ */
3736
+ customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
3572
3737
  /**
3573
3738
  * This method lets you send requests to the Algolia REST API.
3574
3739
  * @param customGet - The customGet object.
@@ -3577,6 +3742,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3577
3742
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3578
3743
  */
3579
3744
  customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
3745
+ /**
3746
+ * This method lets you send requests to the Algolia REST API.
3747
+ *
3748
+ * 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.
3749
+ * @param customGet - The customGet object.
3750
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
3751
+ * @param customGet.parameters - Query parameters to apply to the current query.
3752
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3753
+ * @see customGet for the plain version.
3754
+ */
3755
+ customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
3580
3756
  /**
3581
3757
  * This method lets you send requests to the Algolia REST API.
3582
3758
  * @param customPost - The customPost object.
@@ -3586,6 +3762,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3586
3762
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3587
3763
  */
3588
3764
  customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
3765
+ /**
3766
+ * This method lets you send requests to the Algolia REST API.
3767
+ *
3768
+ * 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.
3769
+ * @param customPost - The customPost object.
3770
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
3771
+ * @param customPost.parameters - Query parameters to apply to the current query.
3772
+ * @param customPost.body - Parameters to send with the custom request.
3773
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3774
+ * @see customPost for the plain version.
3775
+ */
3776
+ customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
3589
3777
  /**
3590
3778
  * This method lets you send requests to the Algolia REST API.
3591
3779
  * @param customPut - The customPut object.
@@ -3595,6 +3783,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3595
3783
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3596
3784
  */
3597
3785
  customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
3786
+ /**
3787
+ * This method lets you send requests to the Algolia REST API.
3788
+ *
3789
+ * 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.
3790
+ * @param customPut - The customPut object.
3791
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
3792
+ * @param customPut.parameters - Query parameters to apply to the current query.
3793
+ * @param customPut.body - Parameters to send with the custom request.
3794
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3795
+ * @see customPut for the plain version.
3796
+ */
3797
+ customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
3598
3798
  /**
3599
3799
  * Deletes the API key.
3600
3800
  *
@@ -3605,6 +3805,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3605
3805
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3606
3806
  */
3607
3807
  deleteApiKey({ key }: DeleteApiKeyProps, requestOptions?: RequestOptions): Promise<DeleteApiKeyResponse>;
3808
+ /**
3809
+ * Deletes the API key.
3810
+ *
3811
+ * 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.
3812
+ *
3813
+ * Required API Key ACLs:
3814
+ * - admin
3815
+ * @param deleteApiKey - The deleteApiKey object.
3816
+ * @param deleteApiKey.key - API key.
3817
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3818
+ * @see deleteApiKey for the plain version.
3819
+ */
3820
+ deleteApiKeyWithHTTPInfo({ key }: DeleteApiKeyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteApiKeyResponse>>;
3608
3821
  /**
3609
3822
  * 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
3823
  *
@@ -3616,6 +3829,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3616
3829
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3617
3830
  */
3618
3831
  deleteBy({ indexName, deleteByParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3832
+ /**
3833
+ * 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).
3834
+ *
3835
+ * 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.
3836
+ *
3837
+ * Required API Key ACLs:
3838
+ * - deleteIndex
3839
+ * @param deleteBy - The deleteBy object.
3840
+ * @param deleteBy.indexName - Name of the index on which to perform the operation.
3841
+ * @param deleteBy.deleteByParams - The deleteByParams object.
3842
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3843
+ * @see deleteBy for the plain version.
3844
+ */
3845
+ deleteByWithHTTPInfo({ indexName, deleteByParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3619
3846
  /**
3620
3847
  * 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
3848
  *
@@ -3626,6 +3853,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3626
3853
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3627
3854
  */
3628
3855
  deleteIndex({ indexName }: DeleteIndexProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3856
+ /**
3857
+ * 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).
3858
+ *
3859
+ * 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.
3860
+ *
3861
+ * Required API Key ACLs:
3862
+ * - deleteIndex
3863
+ * @param deleteIndex - The deleteIndex object.
3864
+ * @param deleteIndex.indexName - Name of the index on which to perform the operation.
3865
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3866
+ * @see deleteIndex for the plain version.
3867
+ */
3868
+ deleteIndexWithHTTPInfo({ indexName }: DeleteIndexProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeletedAtResponse>>;
3629
3869
  /**
3630
3870
  * 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
3871
  *
@@ -3637,6 +3877,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3637
3877
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3638
3878
  */
3639
3879
  deleteObject({ indexName, objectID }: DeleteObjectProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3880
+ /**
3881
+ * 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).
3882
+ *
3883
+ * 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.
3884
+ *
3885
+ * Required API Key ACLs:
3886
+ * - deleteObject
3887
+ * @param deleteObject - The deleteObject object.
3888
+ * @param deleteObject.indexName - Name of the index on which to perform the operation.
3889
+ * @param deleteObject.objectID - Unique record identifier.
3890
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3891
+ * @see deleteObject for the plain version.
3892
+ */
3893
+ deleteObjectWithHTTPInfo({ indexName, objectID }: DeleteObjectProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeletedAtResponse>>;
3640
3894
  /**
3641
3895
  * 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
3896
  *
@@ -3649,6 +3903,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3649
3903
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3650
3904
  */
3651
3905
  deleteRule({ indexName, objectID, forwardToReplicas }: DeleteRuleProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
3906
+ /**
3907
+ * 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).
3908
+ *
3909
+ * 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.
3910
+ *
3911
+ * Required API Key ACLs:
3912
+ * - editSettings
3913
+ * @param deleteRule - The deleteRule object.
3914
+ * @param deleteRule.indexName - Name of the index on which to perform the operation.
3915
+ * @param deleteRule.objectID - Unique identifier of a rule object.
3916
+ * @param deleteRule.forwardToReplicas - Whether changes are applied to replica indices.
3917
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3918
+ * @see deleteRule for the plain version.
3919
+ */
3920
+ deleteRuleWithHTTPInfo({ indexName, objectID, forwardToReplicas }: DeleteRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3652
3921
  /**
3653
3922
  * Deletes a source from the list of allowed sources.
3654
3923
  *
@@ -3659,6 +3928,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3659
3928
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3660
3929
  */
3661
3930
  deleteSource({ source }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteSourceResponse>;
3931
+ /**
3932
+ * Deletes a source from the list of allowed sources.
3933
+ *
3934
+ * 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.
3935
+ *
3936
+ * Required API Key ACLs:
3937
+ * - admin
3938
+ * @param deleteSource - The deleteSource object.
3939
+ * @param deleteSource.source - IP address range of the source.
3940
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3941
+ * @see deleteSource for the plain version.
3942
+ */
3943
+ deleteSourceWithHTTPInfo({ source }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteSourceResponse>>;
3662
3944
  /**
3663
3945
  * 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
3946
  *
@@ -3671,6 +3953,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3671
3953
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3672
3954
  */
3673
3955
  deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3956
+ /**
3957
+ * 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).
3958
+ *
3959
+ * 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.
3960
+ *
3961
+ * Required API Key ACLs:
3962
+ * - editSettings
3963
+ * @param deleteSynonym - The deleteSynonym object.
3964
+ * @param deleteSynonym.indexName - Name of the index on which to perform the operation.
3965
+ * @param deleteSynonym.objectID - Unique identifier of a synonym object.
3966
+ * @param deleteSynonym.forwardToReplicas - Whether changes are applied to replica indices.
3967
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3968
+ * @see deleteSynonym for the plain version.
3969
+ */
3970
+ deleteSynonymWithHTTPInfo({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeletedAtResponse>>;
3674
3971
  /**
3675
3972
  * 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
3973
  *
@@ -3681,6 +3978,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3681
3978
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3682
3979
  */
3683
3980
  getApiKey({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<GetApiKeyResponse>;
3981
+ /**
3982
+ * 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>`.
3983
+ *
3984
+ * 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.
3985
+ *
3986
+ * Required API Key ACLs:
3987
+ * - search
3988
+ * @param getApiKey - The getApiKey object.
3989
+ * @param getApiKey.key - API key.
3990
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3991
+ * @see getApiKey for the plain version.
3992
+ */
3993
+ getApiKeyWithHTTPInfo({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetApiKeyResponse>>;
3684
3994
  /**
3685
3995
  * Checks the status of a given application task.
3686
3996
  *
@@ -3691,6 +4001,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3691
4001
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3692
4002
  */
3693
4003
  getAppTask({ taskID }: GetAppTaskProps, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
4004
+ /**
4005
+ * Checks the status of a given application task.
4006
+ *
4007
+ * 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.
4008
+ *
4009
+ * Required API Key ACLs:
4010
+ * - editSettings
4011
+ * @param getAppTask - The getAppTask object.
4012
+ * @param getAppTask.taskID - Unique task identifier.
4013
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4014
+ * @see getAppTask for the plain version.
4015
+ */
4016
+ getAppTaskWithHTTPInfo({ taskID }: GetAppTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetTaskResponse>>;
3694
4017
  /**
3695
4018
  * Lists supported languages with their supported dictionary types and number of custom entries.
3696
4019
  *
@@ -3701,6 +4024,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3701
4024
  getDictionaryLanguages(requestOptions?: RequestOptions | undefined): Promise<{
3702
4025
  [key: string]: Languages;
3703
4026
  }>;
4027
+ /**
4028
+ * Lists supported languages with their supported dictionary types and number of custom entries.
4029
+ *
4030
+ * 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.
4031
+ *
4032
+ * Required API Key ACLs:
4033
+ * - settings
4034
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4035
+ * @see getDictionaryLanguages for the plain version.
4036
+ */
4037
+ getDictionaryLanguagesWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<{
4038
+ [key: string]: Languages;
4039
+ }>>;
3704
4040
  /**
3705
4041
  * Retrieves the languages for which standard dictionary entries are turned off.
3706
4042
  *
@@ -3709,6 +4045,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3709
4045
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3710
4046
  */
3711
4047
  getDictionarySettings(requestOptions?: RequestOptions | undefined): Promise<GetDictionarySettingsResponse>;
4048
+ /**
4049
+ * Retrieves the languages for which standard dictionary entries are turned off.
4050
+ *
4051
+ * 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.
4052
+ *
4053
+ * Required API Key ACLs:
4054
+ * - settings
4055
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4056
+ * @see getDictionarySettings for the plain version.
4057
+ */
4058
+ getDictionarySettingsWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<GetDictionarySettingsResponse>>;
3712
4059
  /**
3713
4060
  * 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
4061
  *
@@ -3722,6 +4069,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3722
4069
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3723
4070
  */
3724
4071
  getLogs({ offset, length, indexName, type }?: GetLogsProps, requestOptions?: RequestOptions | undefined): Promise<GetLogsResponse>;
4072
+ /**
4073
+ * 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.
4074
+ *
4075
+ * 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.
4076
+ *
4077
+ * Required API Key ACLs:
4078
+ * - logs
4079
+ * @param getLogs - The getLogs object.
4080
+ * @param getLogs.offset - First log entry to retrieve. The most recent entries are listed first.
4081
+ * @param getLogs.length - Maximum number of entries to retrieve.
4082
+ * @param getLogs.indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
4083
+ * @param getLogs.type - Type of log entries to retrieve. By default, all log entries are retrieved.
4084
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4085
+ * @see getLogs for the plain version.
4086
+ */
4087
+ getLogsWithHTTPInfo({ offset, length, indexName, type }?: GetLogsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<GetLogsResponse>>;
3725
4088
  /**
3726
4089
  * 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
4090
  *
@@ -3734,6 +4097,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3734
4097
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3735
4098
  */
3736
4099
  getObject<T = Record<string, unknown>>({ indexName, objectID, attributesToRetrieve }: GetObjectProps, requestOptions?: RequestOptions): Promise<T>;
4100
+ /**
4101
+ * 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).
4102
+ *
4103
+ * 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.
4104
+ *
4105
+ * Required API Key ACLs:
4106
+ * - search
4107
+ * @param getObject - The getObject object.
4108
+ * @param getObject.indexName - Name of the index on which to perform the operation.
4109
+ * @param getObject.objectID - Unique record identifier.
4110
+ * @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.
4111
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4112
+ * @see getObject for the plain version.
4113
+ */
4114
+ getObjectWithHTTPInfo<T = Record<string, unknown>>({ indexName, objectID, attributesToRetrieve }: GetObjectProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<T>>;
3737
4115
  /**
3738
4116
  * Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
3739
4117
  *
@@ -3743,6 +4121,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3743
4121
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3744
4122
  */
3745
4123
  getObjects<T>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse<T>>;
4124
+ /**
4125
+ * Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
4126
+ *
4127
+ * 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.
4128
+ *
4129
+ * Required API Key ACLs:
4130
+ * - search
4131
+ * @param getObjectsParams - Request object.
4132
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4133
+ * @see getObjects for the plain version.
4134
+ */
4135
+ getObjectsWithHTTPInfo<T>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetObjectsResponse<T>>>;
3746
4136
  /**
3747
4137
  * 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
4138
  *
@@ -3754,6 +4144,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3754
4144
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3755
4145
  */
3756
4146
  getRule({ indexName, objectID }: GetRuleProps, requestOptions?: RequestOptions): Promise<Rule>;
4147
+ /**
4148
+ * 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).
4149
+ *
4150
+ * 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.
4151
+ *
4152
+ * Required API Key ACLs:
4153
+ * - settings
4154
+ * @param getRule - The getRule object.
4155
+ * @param getRule.indexName - Name of the index on which to perform the operation.
4156
+ * @param getRule.objectID - Unique identifier of a rule object.
4157
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4158
+ * @see getRule for the plain version.
4159
+ */
4160
+ getRuleWithHTTPInfo({ indexName, objectID }: GetRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Rule>>;
3757
4161
  /**
3758
4162
  * Retrieves an object with non-null index settings.
3759
4163
  *
@@ -3765,6 +4169,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3765
4169
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3766
4170
  */
3767
4171
  getSettings({ indexName, getVersion }: GetSettingsProps, requestOptions?: RequestOptions): Promise<SettingsResponse>;
4172
+ /**
4173
+ * Retrieves an object with non-null index settings.
4174
+ *
4175
+ * 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.
4176
+ *
4177
+ * Required API Key ACLs:
4178
+ * - settings
4179
+ * @param getSettings - The getSettings object.
4180
+ * @param getSettings.indexName - Name of the index on which to perform the operation.
4181
+ * @param getSettings.getVersion - When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
4182
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4183
+ * @see getSettings for the plain version.
4184
+ */
4185
+ getSettingsWithHTTPInfo({ indexName, getVersion }: GetSettingsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SettingsResponse>>;
3768
4186
  /**
3769
4187
  * Retrieves all allowed IP addresses with access to your application.
3770
4188
  *
@@ -3773,6 +4191,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3773
4191
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3774
4192
  */
3775
4193
  getSources(requestOptions?: RequestOptions | undefined): Promise<Array<Source>>;
4194
+ /**
4195
+ * Retrieves all allowed IP addresses with access to your application.
4196
+ *
4197
+ * 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.
4198
+ *
4199
+ * Required API Key ACLs:
4200
+ * - admin
4201
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4202
+ * @see getSources for the plain version.
4203
+ */
4204
+ getSourcesWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<Array<Source>>>;
3776
4205
  /**
3777
4206
  * 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
4207
  *
@@ -3784,6 +4213,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3784
4213
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3785
4214
  */
3786
4215
  getSynonym({ indexName, objectID }: GetSynonymProps, requestOptions?: RequestOptions): Promise<SynonymHit>;
4216
+ /**
4217
+ * 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).
4218
+ *
4219
+ * 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.
4220
+ *
4221
+ * Required API Key ACLs:
4222
+ * - settings
4223
+ * @param getSynonym - The getSynonym object.
4224
+ * @param getSynonym.indexName - Name of the index on which to perform the operation.
4225
+ * @param getSynonym.objectID - Unique identifier of a synonym object.
4226
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4227
+ * @see getSynonym for the plain version.
4228
+ */
4229
+ getSynonymWithHTTPInfo({ indexName, objectID }: GetSynonymProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SynonymHit>>;
3787
4230
  /**
3788
4231
  * 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
4232
  *
@@ -3795,6 +4238,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3795
4238
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3796
4239
  */
3797
4240
  getTask({ indexName, taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
4241
+ /**
4242
+ * 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.
4243
+ *
4244
+ * 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.
4245
+ *
4246
+ * Required API Key ACLs:
4247
+ * - addObject
4248
+ * @param getTask - The getTask object.
4249
+ * @param getTask.indexName - Name of the index on which to perform the operation.
4250
+ * @param getTask.taskID - Unique task identifier.
4251
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4252
+ * @see getTask for the plain version.
4253
+ */
4254
+ getTaskWithHTTPInfo({ indexName, taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetTaskResponse>>;
3798
4255
  /**
3799
4256
  * 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
4257
  *
@@ -3805,6 +4262,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3805
4262
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3806
4263
  */
3807
4264
  getTopUserIds(requestOptions?: RequestOptions | undefined): Promise<GetTopUserIdsResponse>;
4265
+ /**
4266
+ * 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.
4267
+ *
4268
+ * 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.
4269
+ *
4270
+ * Required API Key ACLs:
4271
+ * - admin
4272
+ *
4273
+ * @deprecated
4274
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4275
+ * @see getTopUserIds for the plain version.
4276
+ */
4277
+ getTopUserIdsWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<GetTopUserIdsResponse>>;
3808
4278
  /**
3809
4279
  * 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
4280
  *
@@ -3817,6 +4287,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3817
4287
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3818
4288
  */
3819
4289
  getUserId({ userID }: GetUserIdProps, requestOptions?: RequestOptions): Promise<UserId>;
4290
+ /**
4291
+ * 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.
4292
+ *
4293
+ * 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.
4294
+ *
4295
+ * Required API Key ACLs:
4296
+ * - admin
4297
+ *
4298
+ * @deprecated
4299
+ * @param getUserId - The getUserId object.
4300
+ * @param getUserId.userID - Unique identifier of the user who makes the search request.
4301
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4302
+ * @see getUserId for the plain version.
4303
+ */
4304
+ getUserIdWithHTTPInfo({ userID }: GetUserIdProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UserId>>;
3820
4305
  /**
3821
4306
  * 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
4307
  *
@@ -3829,6 +4314,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3829
4314
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3830
4315
  */
3831
4316
  hasPendingMappings({ getClusters }?: HasPendingMappingsProps, requestOptions?: RequestOptions | undefined): Promise<HasPendingMappingsResponse>;
4317
+ /**
4318
+ * 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.
4319
+ *
4320
+ * 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.
4321
+ *
4322
+ * Required API Key ACLs:
4323
+ * - admin
4324
+ *
4325
+ * @deprecated
4326
+ * @param hasPendingMappings - The hasPendingMappings object.
4327
+ * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
4328
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4329
+ * @see hasPendingMappings for the plain version.
4330
+ */
4331
+ hasPendingMappingsWithHTTPInfo({ getClusters }?: HasPendingMappingsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<HasPendingMappingsResponse>>;
3832
4332
  /**
3833
4333
  * Lists all API keys associated with your Algolia application, including their permissions and restrictions.
3834
4334
  *
@@ -3837,6 +4337,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3837
4337
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3838
4338
  */
3839
4339
  listApiKeys(requestOptions?: RequestOptions | undefined): Promise<ListApiKeysResponse>;
4340
+ /**
4341
+ * Lists all API keys associated with your Algolia application, including their permissions and restrictions.
4342
+ *
4343
+ * 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.
4344
+ *
4345
+ * Required API Key ACLs:
4346
+ * - admin
4347
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4348
+ * @see listApiKeys for the plain version.
4349
+ */
4350
+ listApiKeysWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListApiKeysResponse>>;
3840
4351
  /**
3841
4352
  * Lists the available clusters in a multi-cluster setup.
3842
4353
  *
@@ -3846,18 +4357,45 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3846
4357
  * @deprecated
3847
4358
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3848
4359
  */
3849
- listClusters(requestOptions?: RequestOptions | undefined): Promise<ListClustersResponse>;
4360
+ listClusters(requestOptions?: RequestOptions | undefined): Promise<ListClustersResponse>;
4361
+ /**
4362
+ * Lists the available clusters in a multi-cluster setup.
4363
+ *
4364
+ * 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.
4365
+ *
4366
+ * Required API Key ACLs:
4367
+ * - admin
4368
+ *
4369
+ * @deprecated
4370
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4371
+ * @see listClusters for the plain version.
4372
+ */
4373
+ listClustersWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListClustersResponse>>;
4374
+ /**
4375
+ * Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
4376
+ *
4377
+ * Required API Key ACLs:
4378
+ * - listIndexes
4379
+ * @param listIndices - The listIndices object.
4380
+ * @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
4381
+ * @param listIndices.hitsPerPage - Number of hits per page.
4382
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4383
+ */
4384
+ listIndices({ page, hitsPerPage }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<ListIndicesResponse>;
3850
4385
  /**
3851
4386
  * 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
4387
  *
4388
+ * 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.
4389
+ *
3853
4390
  * Required API Key ACLs:
3854
4391
  * - listIndexes
3855
4392
  * @param listIndices - The listIndices object.
3856
4393
  * @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
3857
4394
  * @param listIndices.hitsPerPage - Number of hits per page.
3858
4395
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4396
+ * @see listIndices for the plain version.
3859
4397
  */
3860
- listIndices({ page, hitsPerPage }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<ListIndicesResponse>;
4398
+ listIndicesWithHTTPInfo({ page, hitsPerPage }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListIndicesResponse>>;
3861
4399
  /**
3862
4400
  * 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
4401
  *
@@ -3871,6 +4409,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3871
4409
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3872
4410
  */
3873
4411
  listUserIds({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<ListUserIdsResponse>;
4412
+ /**
4413
+ * 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.
4414
+ *
4415
+ * 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.
4416
+ *
4417
+ * Required API Key ACLs:
4418
+ * - admin
4419
+ *
4420
+ * @deprecated
4421
+ * @param listUserIds - The listUserIds object.
4422
+ * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
4423
+ * @param listUserIds.hitsPerPage - Number of hits per page.
4424
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4425
+ * @see listUserIds for the plain version.
4426
+ */
4427
+ listUserIdsWithHTTPInfo({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListUserIdsResponse>>;
3874
4428
  /**
3875
4429
  * 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
4430
  *
@@ -3880,6 +4434,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3880
4434
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3881
4435
  */
3882
4436
  multipleBatch(batchParams: BatchParams, requestOptions?: RequestOptions): Promise<MultipleBatchResponse>;
4437
+ /**
4438
+ * 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).
4439
+ *
4440
+ * 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.
4441
+ *
4442
+ * Required API Key ACLs:
4443
+ * - addObject
4444
+ * @param batchParams - The batchParams object.
4445
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4446
+ * @see multipleBatch for the plain version.
4447
+ */
4448
+ multipleBatchWithHTTPInfo(batchParams: BatchParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<MultipleBatchResponse>>;
3883
4449
  /**
3884
4450
  * 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
4451
  *
@@ -3891,6 +4457,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3891
4457
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3892
4458
  */
3893
4459
  operationIndex({ indexName, operationIndexParams }: OperationIndexProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4460
+ /**
4461
+ * 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).
4462
+ *
4463
+ * 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.
4464
+ *
4465
+ * Required API Key ACLs:
4466
+ * - addObject
4467
+ * @param operationIndex - The operationIndex object.
4468
+ * @param operationIndex.indexName - Name of the index on which to perform the operation.
4469
+ * @param operationIndex.operationIndexParams - The operationIndexParams object.
4470
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4471
+ * @see operationIndex for the plain version.
4472
+ */
4473
+ operationIndexWithHTTPInfo({ indexName, operationIndexParams }: OperationIndexProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3894
4474
  /**
3895
4475
  * 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
4476
  *
@@ -3904,6 +4484,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3904
4484
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3905
4485
  */
3906
4486
  partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
4487
+ /**
4488
+ * 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).
4489
+ *
4490
+ * 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.
4491
+ *
4492
+ * Required API Key ACLs:
4493
+ * - addObject
4494
+ * @param partialUpdateObject - The partialUpdateObject object.
4495
+ * @param partialUpdateObject.indexName - Name of the index on which to perform the operation.
4496
+ * @param partialUpdateObject.objectID - Unique record identifier.
4497
+ * @param partialUpdateObject.attributesToUpdate - Attributes with their values.
4498
+ * @param partialUpdateObject.createIfNotExists - Whether to create a new record if it doesn\'t exist.
4499
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4500
+ * @see partialUpdateObject for the plain version.
4501
+ */
4502
+ partialUpdateObjectWithHTTPInfo({ indexName, objectID, attributesToUpdate, createIfNotExists }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtWithObjectIdResponse>>;
3907
4503
  /**
3908
4504
  * Deletes a user ID and its associated data from the clusters.
3909
4505
  *
@@ -3916,6 +4512,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3916
4512
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3917
4513
  */
3918
4514
  removeUserId({ userID }: RemoveUserIdProps, requestOptions?: RequestOptions): Promise<RemoveUserIdResponse>;
4515
+ /**
4516
+ * Deletes a user ID and its associated data from the clusters.
4517
+ *
4518
+ * 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.
4519
+ *
4520
+ * Required API Key ACLs:
4521
+ * - admin
4522
+ *
4523
+ * @deprecated
4524
+ * @param removeUserId - The removeUserId object.
4525
+ * @param removeUserId.userID - Unique identifier of the user who makes the search request.
4526
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4527
+ * @see removeUserId for the plain version.
4528
+ */
4529
+ removeUserIdWithHTTPInfo({ userID }: RemoveUserIdProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<RemoveUserIdResponse>>;
3919
4530
  /**
3920
4531
  * Replaces the list of allowed sources.
3921
4532
  *
@@ -3926,6 +4537,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3926
4537
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3927
4538
  */
3928
4539
  replaceSources({ source }: ReplaceSourcesProps, requestOptions?: RequestOptions): Promise<ReplaceSourceResponse>;
4540
+ /**
4541
+ * Replaces the list of allowed sources.
4542
+ *
4543
+ * 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.
4544
+ *
4545
+ * Required API Key ACLs:
4546
+ * - admin
4547
+ * @param replaceSources - The replaceSources object.
4548
+ * @param replaceSources.source - Allowed sources.
4549
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4550
+ * @see replaceSources for the plain version.
4551
+ */
4552
+ replaceSourcesWithHTTPInfo({ source }: ReplaceSourcesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ReplaceSourceResponse>>;
3929
4553
  /**
3930
4554
  * 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
4555
  *
@@ -3936,6 +4560,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3936
4560
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3937
4561
  */
3938
4562
  restoreApiKey({ key }: RestoreApiKeyProps, requestOptions?: RequestOptions): Promise<AddApiKeyResponse>;
4563
+ /**
4564
+ * 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.
4565
+ *
4566
+ * 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.
4567
+ *
4568
+ * Required API Key ACLs:
4569
+ * - admin
4570
+ * @param restoreApiKey - The restoreApiKey object.
4571
+ * @param restoreApiKey.key - API key.
4572
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4573
+ * @see restoreApiKey for the plain version.
4574
+ */
4575
+ restoreApiKeyWithHTTPInfo({ key }: RestoreApiKeyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<AddApiKeyResponse>>;
3939
4576
  /**
3940
4577
  * 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
4578
  *
@@ -3947,6 +4584,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3947
4584
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3948
4585
  */
3949
4586
  saveObject<T extends object>({ indexName, body }: SaveObjectProps<T>, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
4587
+ /**
4588
+ * 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).
4589
+ *
4590
+ * 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.
4591
+ *
4592
+ * Required API Key ACLs:
4593
+ * - addObject
4594
+ * @param saveObject - The saveObject object.
4595
+ * @param saveObject.indexName - Name of the index on which to perform the operation.
4596
+ * @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
4597
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4598
+ * @see saveObject for the plain version.
4599
+ */
4600
+ saveObjectWithHTTPInfo<T extends object>({ indexName, body }: SaveObjectProps<T>, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SaveObjectResponse>>;
3950
4601
  /**
3951
4602
  * 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
4603
  *
@@ -3960,6 +4611,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3960
4611
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3961
4612
  */
3962
4613
  saveRule({ indexName, objectID, rule, forwardToReplicas }: SaveRuleProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4614
+ /**
4615
+ * 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).
4616
+ *
4617
+ * 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.
4618
+ *
4619
+ * Required API Key ACLs:
4620
+ * - editSettings
4621
+ * @param saveRule - The saveRule object.
4622
+ * @param saveRule.indexName - Name of the index on which to perform the operation.
4623
+ * @param saveRule.objectID - Unique identifier of a rule object.
4624
+ * @param saveRule.rule - The rule object.
4625
+ * @param saveRule.forwardToReplicas - Whether changes are applied to replica indices.
4626
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4627
+ * @see saveRule for the plain version.
4628
+ */
4629
+ saveRuleWithHTTPInfo({ indexName, objectID, rule, forwardToReplicas }: SaveRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3963
4630
  /**
3964
4631
  * 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
4632
  *
@@ -3973,6 +4640,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3973
4640
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3974
4641
  */
3975
4642
  saveRules({ indexName, rules, forwardToReplicas, clearExistingRules }: SaveRulesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4643
+ /**
4644
+ * 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).
4645
+ *
4646
+ * 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.
4647
+ *
4648
+ * Required API Key ACLs:
4649
+ * - editSettings
4650
+ * @param saveRules - The saveRules object.
4651
+ * @param saveRules.indexName - Name of the index on which to perform the operation.
4652
+ * @param saveRules.rules - The rules object.
4653
+ * @param saveRules.forwardToReplicas - Whether changes are applied to replica indices.
4654
+ * @param saveRules.clearExistingRules - Whether existing rules should be deleted before adding this batch.
4655
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4656
+ * @see saveRules for the plain version.
4657
+ */
4658
+ saveRulesWithHTTPInfo({ indexName, rules, forwardToReplicas, clearExistingRules }: SaveRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
3976
4659
  /**
3977
4660
  * 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
4661
  *
@@ -3986,6 +4669,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3986
4669
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3987
4670
  */
3988
4671
  saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: SaveSynonymProps, requestOptions?: RequestOptions): Promise<SaveSynonymResponse>;
4672
+ /**
4673
+ * 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).
4674
+ *
4675
+ * 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.
4676
+ *
4677
+ * Required API Key ACLs:
4678
+ * - editSettings
4679
+ * @param saveSynonym - The saveSynonym object.
4680
+ * @param saveSynonym.indexName - Name of the index on which to perform the operation.
4681
+ * @param saveSynonym.objectID - Unique identifier of a synonym object.
4682
+ * @param saveSynonym.synonymHit - The synonymHit object.
4683
+ * @param saveSynonym.forwardToReplicas - Whether changes are applied to replica indices.
4684
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4685
+ * @see saveSynonym for the plain version.
4686
+ */
4687
+ saveSynonymWithHTTPInfo({ indexName, objectID, synonymHit, forwardToReplicas }: SaveSynonymProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SaveSynonymResponse>>;
3989
4688
  /**
3990
4689
  * 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
4690
  *
@@ -3999,6 +4698,22 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3999
4698
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4000
4699
  */
4001
4700
  saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4701
+ /**
4702
+ * 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).
4703
+ *
4704
+ * 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.
4705
+ *
4706
+ * Required API Key ACLs:
4707
+ * - editSettings
4708
+ * @param saveSynonyms - The saveSynonyms object.
4709
+ * @param saveSynonyms.indexName - Name of the index on which to perform the operation.
4710
+ * @param saveSynonyms.synonymHit - The synonymHit object.
4711
+ * @param saveSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
4712
+ * @param saveSynonyms.replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request.
4713
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4714
+ * @see saveSynonyms for the plain version.
4715
+ */
4716
+ saveSynonymsWithHTTPInfo({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
4002
4717
  /**
4003
4718
  * 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
4719
  *
@@ -4008,6 +4723,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4008
4723
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4009
4724
  */
4010
4725
  search<T>(searchMethodParams: SearchMethodParams | LegacySearchMethodProps, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
4726
+ /**
4727
+ * 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.
4728
+ *
4729
+ * 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.
4730
+ *
4731
+ * Required API Key ACLs:
4732
+ * - search
4733
+ * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
4734
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4735
+ * @see search for the plain version.
4736
+ */
4737
+ searchWithHTTPInfo<T>(searchMethodParams: SearchMethodParams | LegacySearchMethodProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchResponses<T>>>;
4011
4738
  /**
4012
4739
  * Searches for standard and custom dictionary entries.
4013
4740
  *
@@ -4019,6 +4746,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4019
4746
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4020
4747
  */
4021
4748
  searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams }: SearchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<SearchDictionaryEntriesResponse>;
4749
+ /**
4750
+ * Searches for standard and custom dictionary entries.
4751
+ *
4752
+ * 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.
4753
+ *
4754
+ * Required API Key ACLs:
4755
+ * - settings
4756
+ * @param searchDictionaryEntries - The searchDictionaryEntries object.
4757
+ * @param searchDictionaryEntries.dictionaryName - Dictionary type in which to search.
4758
+ * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
4759
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4760
+ * @see searchDictionaryEntries for the plain version.
4761
+ */
4762
+ searchDictionaryEntriesWithHTTPInfo({ dictionaryName, searchDictionaryEntriesParams }: SearchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchDictionaryEntriesResponse>>;
4022
4763
  /**
4023
4764
  * 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
4765
  *
@@ -4031,6 +4772,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4031
4772
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4032
4773
  */
4033
4774
  searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps, requestOptions?: RequestOptions): Promise<SearchForFacetValuesResponse>;
4775
+ /**
4776
+ * 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**.
4777
+ *
4778
+ * 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.
4779
+ *
4780
+ * Required API Key ACLs:
4781
+ * - search
4782
+ * @param searchForFacetValues - The searchForFacetValues object.
4783
+ * @param searchForFacetValues.indexName - Name of the index on which to perform the operation.
4784
+ * @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.
4785
+ * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
4786
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4787
+ * @see searchForFacetValues for the plain version.
4788
+ */
4789
+ searchForFacetValuesWithHTTPInfo({ indexName, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchForFacetValuesResponse>>;
4034
4790
  /**
4035
4791
  * Searches for rules in your index.
4036
4792
  *
@@ -4042,6 +4798,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4042
4798
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4043
4799
  */
4044
4800
  searchRules({ indexName, searchRulesParams }: SearchRulesProps, requestOptions?: RequestOptions): Promise<SearchRulesResponse>;
4801
+ /**
4802
+ * Searches for rules in your index.
4803
+ *
4804
+ * 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.
4805
+ *
4806
+ * Required API Key ACLs:
4807
+ * - settings
4808
+ * @param searchRules - The searchRules object.
4809
+ * @param searchRules.indexName - Name of the index on which to perform the operation.
4810
+ * @param searchRules.searchRulesParams - The searchRulesParams object.
4811
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4812
+ * @see searchRules for the plain version.
4813
+ */
4814
+ searchRulesWithHTTPInfo({ indexName, searchRulesParams }: SearchRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchRulesResponse>>;
4045
4815
  /**
4046
4816
  * 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
4817
  *
@@ -4053,6 +4823,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4053
4823
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4054
4824
  */
4055
4825
  searchSingleIndex<T>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<SearchResponse<T>>;
4826
+ /**
4827
+ * 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.
4828
+ *
4829
+ * 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.
4830
+ *
4831
+ * Required API Key ACLs:
4832
+ * - search
4833
+ * @param searchSingleIndex - The searchSingleIndex object.
4834
+ * @param searchSingleIndex.indexName - Name of the index on which to perform the operation.
4835
+ * @param searchSingleIndex.searchParams - The searchParams object.
4836
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4837
+ * @see searchSingleIndex for the plain version.
4838
+ */
4839
+ searchSingleIndexWithHTTPInfo<T>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchResponse<T>>>;
4056
4840
  /**
4057
4841
  * Searches for synonyms in your index.
4058
4842
  *
@@ -4064,6 +4848,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4064
4848
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4065
4849
  */
4066
4850
  searchSynonyms({ indexName, searchSynonymsParams }: SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
4851
+ /**
4852
+ * Searches for synonyms in your index.
4853
+ *
4854
+ * 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.
4855
+ *
4856
+ * Required API Key ACLs:
4857
+ * - settings
4858
+ * @param searchSynonyms - The searchSynonyms object.
4859
+ * @param searchSynonyms.indexName - Name of the index on which to perform the operation.
4860
+ * @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
4861
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4862
+ * @see searchSynonyms for the plain version.
4863
+ */
4864
+ searchSynonymsWithHTTPInfo({ indexName, searchSynonymsParams }: SearchSynonymsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchSynonymsResponse>>;
4067
4865
  /**
4068
4866
  * 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
4867
  *
@@ -4075,6 +4873,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4075
4873
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4076
4874
  */
4077
4875
  searchUserIds(searchUserIdsParams: SearchUserIdsParams, requestOptions?: RequestOptions): Promise<SearchUserIdsResponse>;
4876
+ /**
4877
+ * 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).
4878
+ *
4879
+ * 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.
4880
+ *
4881
+ * Required API Key ACLs:
4882
+ * - admin
4883
+ *
4884
+ * @deprecated
4885
+ * @param searchUserIdsParams - The searchUserIdsParams object.
4886
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4887
+ * @see searchUserIds for the plain version.
4888
+ */
4889
+ searchUserIdsWithHTTPInfo(searchUserIdsParams: SearchUserIdsParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchUserIdsResponse>>;
4078
4890
  /**
4079
4891
  * Turns standard stop word dictionary entries on or off for a given language.
4080
4892
  *
@@ -4084,6 +4896,18 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4084
4896
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4085
4897
  */
4086
4898
  setDictionarySettings(dictionarySettingsParams: DictionarySettingsParams, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4899
+ /**
4900
+ * Turns standard stop word dictionary entries on or off for a given language.
4901
+ *
4902
+ * 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.
4903
+ *
4904
+ * Required API Key ACLs:
4905
+ * - editSettings
4906
+ * @param dictionarySettingsParams - The dictionarySettingsParams object.
4907
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4908
+ * @see setDictionarySettings for the plain version.
4909
+ */
4910
+ setDictionarySettingsWithHTTPInfo(dictionarySettingsParams: DictionarySettingsParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
4087
4911
  /**
4088
4912
  * 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
4913
  *
@@ -4096,6 +4920,21 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4096
4920
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4097
4921
  */
4098
4922
  setSettings({ indexName, indexSettings, forwardToReplicas }: SetSettingsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
4923
+ /**
4924
+ * 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.
4925
+ *
4926
+ * 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.
4927
+ *
4928
+ * Required API Key ACLs:
4929
+ * - editSettings
4930
+ * @param setSettings - The setSettings object.
4931
+ * @param setSettings.indexName - Name of the index on which to perform the operation.
4932
+ * @param setSettings.indexSettings - The indexSettings object.
4933
+ * @param setSettings.forwardToReplicas - Whether changes are applied to replica indices.
4934
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4935
+ * @see setSettings for the plain version.
4936
+ */
4937
+ setSettingsWithHTTPInfo({ indexName, indexSettings, forwardToReplicas }: SetSettingsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdatedAtResponse>>;
4099
4938
  /**
4100
4939
  * Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
4101
4940
  *
@@ -4107,6 +4946,20 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
4107
4946
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4108
4947
  */
4109
4948
  updateApiKey({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<UpdateApiKeyResponse>;
4949
+ /**
4950
+ * Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
4951
+ *
4952
+ * 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.
4953
+ *
4954
+ * Required API Key ACLs:
4955
+ * - admin
4956
+ * @param updateApiKey - The updateApiKey object.
4957
+ * @param updateApiKey.key - API key.
4958
+ * @param updateApiKey.apiKey - The apiKey object.
4959
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4960
+ * @see updateApiKey for the plain version.
4961
+ */
4962
+ updateApiKeyWithHTTPInfo({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<UpdateApiKeyResponse>>;
4110
4963
  };
4111
4964
 
4112
4965
  /**