@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/README.md +4 -4
- package/dist/browser.d.ts +858 -5
- package/dist/builds/browser.js +1909 -91
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +4 -4
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +6 -6
- package/dist/builds/fetch.js +1909 -91
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +1909 -91
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +1909 -91
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +1909 -91
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +858 -5
- package/dist/node.d.cts +858 -5
- package/dist/node.d.ts +858 -5
- package/dist/src/searchClient.cjs +1909 -91
- package/dist/src/searchClient.cjs.map +1 -1
- package/dist/src/searchClient.js +1909 -91
- package/dist/src/searchClient.js.map +1 -1
- package/dist/worker.d.ts +858 -5
- package/package.json +9 -9
package/dist/builds/node.cjs
CHANGED
|
@@ -31,7 +31,7 @@ var import_requester_node_http = require("@algolia/requester-node-http");
|
|
|
31
31
|
|
|
32
32
|
// src/searchClient.ts
|
|
33
33
|
var import_client_common = require("@algolia/client-common");
|
|
34
|
-
var apiClientVersion = "5.
|
|
34
|
+
var apiClientVersion = "5.56.0";
|
|
35
35
|
function getDefaultHosts(appId) {
|
|
36
36
|
return [
|
|
37
37
|
{
|
|
@@ -598,6 +598,32 @@ function createSearchClient({
|
|
|
598
598
|
};
|
|
599
599
|
return transporter.request(request, requestOptions);
|
|
600
600
|
},
|
|
601
|
+
/**
|
|
602
|
+
* Creates a new API key with specific permissions and restrictions.
|
|
603
|
+
*
|
|
604
|
+
* 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.
|
|
605
|
+
*
|
|
606
|
+
* Required API Key ACLs:
|
|
607
|
+
* - admin
|
|
608
|
+
* @param apiKey - The apiKey object.
|
|
609
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
610
|
+
* @see addApiKey for the plain version.
|
|
611
|
+
*/
|
|
612
|
+
addApiKeyWithHTTPInfo(apiKey, requestOptions) {
|
|
613
|
+
(0, import_client_common.validateRequired)("apiKey", "addApiKeyWithHTTPInfo", apiKey);
|
|
614
|
+
(0, import_client_common.validateRequired)("apiKey.acl", "addApiKeyWithHTTPInfo", apiKey.acl);
|
|
615
|
+
const requestPath = "/1/keys";
|
|
616
|
+
const headers = {};
|
|
617
|
+
const queryParameters = {};
|
|
618
|
+
const request = {
|
|
619
|
+
method: "POST",
|
|
620
|
+
path: requestPath,
|
|
621
|
+
queryParameters,
|
|
622
|
+
headers,
|
|
623
|
+
data: apiKey
|
|
624
|
+
};
|
|
625
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
626
|
+
},
|
|
601
627
|
/**
|
|
602
628
|
* 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).
|
|
603
629
|
*
|
|
@@ -625,6 +651,36 @@ function createSearchClient({
|
|
|
625
651
|
};
|
|
626
652
|
return transporter.request(request, requestOptions);
|
|
627
653
|
},
|
|
654
|
+
/**
|
|
655
|
+
* 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).
|
|
656
|
+
*
|
|
657
|
+
* 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.
|
|
658
|
+
*
|
|
659
|
+
* Required API Key ACLs:
|
|
660
|
+
* - addObject
|
|
661
|
+
* @param addOrUpdateObject - The addOrUpdateObject object.
|
|
662
|
+
* @param addOrUpdateObject.indexName - Name of the index on which to perform the operation.
|
|
663
|
+
* @param addOrUpdateObject.objectID - Unique record identifier.
|
|
664
|
+
* @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
|
|
665
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
666
|
+
* @see addOrUpdateObject for the plain version.
|
|
667
|
+
*/
|
|
668
|
+
addOrUpdateObjectWithHTTPInfo({ indexName, objectID, body }, requestOptions) {
|
|
669
|
+
(0, import_client_common.validateRequired)("indexName", "addOrUpdateObjectWithHTTPInfo", indexName);
|
|
670
|
+
(0, import_client_common.validateRequired)("objectID", "addOrUpdateObjectWithHTTPInfo", objectID);
|
|
671
|
+
(0, import_client_common.validateRequired)("body", "addOrUpdateObjectWithHTTPInfo", body);
|
|
672
|
+
const requestPath = "/1/indexes/{indexName}/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
673
|
+
const headers = {};
|
|
674
|
+
const queryParameters = {};
|
|
675
|
+
const request = {
|
|
676
|
+
method: "PUT",
|
|
677
|
+
path: requestPath,
|
|
678
|
+
queryParameters,
|
|
679
|
+
headers,
|
|
680
|
+
data: body
|
|
681
|
+
};
|
|
682
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
683
|
+
},
|
|
628
684
|
/**
|
|
629
685
|
* Adds a source to the list of allowed sources.
|
|
630
686
|
*
|
|
@@ -648,6 +704,32 @@ function createSearchClient({
|
|
|
648
704
|
};
|
|
649
705
|
return transporter.request(request, requestOptions);
|
|
650
706
|
},
|
|
707
|
+
/**
|
|
708
|
+
* Adds a source to the list of allowed sources.
|
|
709
|
+
*
|
|
710
|
+
* 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.
|
|
711
|
+
*
|
|
712
|
+
* Required API Key ACLs:
|
|
713
|
+
* - admin
|
|
714
|
+
* @param source - Source to add.
|
|
715
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
716
|
+
* @see appendSource for the plain version.
|
|
717
|
+
*/
|
|
718
|
+
appendSourceWithHTTPInfo(source, requestOptions) {
|
|
719
|
+
(0, import_client_common.validateRequired)("source", "appendSourceWithHTTPInfo", source);
|
|
720
|
+
(0, import_client_common.validateRequired)("source.source", "appendSourceWithHTTPInfo", source.source);
|
|
721
|
+
const requestPath = "/1/security/sources/append";
|
|
722
|
+
const headers = {};
|
|
723
|
+
const queryParameters = {};
|
|
724
|
+
const request = {
|
|
725
|
+
method: "POST",
|
|
726
|
+
path: requestPath,
|
|
727
|
+
queryParameters,
|
|
728
|
+
headers,
|
|
729
|
+
data: source
|
|
730
|
+
};
|
|
731
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
732
|
+
},
|
|
651
733
|
/**
|
|
652
734
|
* 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.
|
|
653
735
|
*
|
|
@@ -679,6 +761,40 @@ function createSearchClient({
|
|
|
679
761
|
};
|
|
680
762
|
return transporter.request(request, requestOptions);
|
|
681
763
|
},
|
|
764
|
+
/**
|
|
765
|
+
* 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.
|
|
766
|
+
*
|
|
767
|
+
* 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.
|
|
768
|
+
*
|
|
769
|
+
* Required API Key ACLs:
|
|
770
|
+
* - admin
|
|
771
|
+
*
|
|
772
|
+
* @deprecated
|
|
773
|
+
* @param assignUserId - The assignUserId object.
|
|
774
|
+
* @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
|
|
775
|
+
* @param assignUserId.assignUserIdParams - The assignUserIdParams object.
|
|
776
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
777
|
+
* @see assignUserId for the plain version.
|
|
778
|
+
*/
|
|
779
|
+
assignUserIdWithHTTPInfo({ xAlgoliaUserID, assignUserIdParams }, requestOptions) {
|
|
780
|
+
(0, import_client_common.validateRequired)("xAlgoliaUserID", "assignUserIdWithHTTPInfo", xAlgoliaUserID);
|
|
781
|
+
(0, import_client_common.validateRequired)("assignUserIdParams", "assignUserIdWithHTTPInfo", assignUserIdParams);
|
|
782
|
+
(0, import_client_common.validateRequired)("assignUserIdParams.cluster", "assignUserIdWithHTTPInfo", assignUserIdParams.cluster);
|
|
783
|
+
const requestPath = "/1/clusters/mapping";
|
|
784
|
+
const headers = {};
|
|
785
|
+
const queryParameters = {};
|
|
786
|
+
if (xAlgoliaUserID !== void 0) {
|
|
787
|
+
headers["X-Algolia-User-ID"] = xAlgoliaUserID.toString();
|
|
788
|
+
}
|
|
789
|
+
const request = {
|
|
790
|
+
method: "POST",
|
|
791
|
+
path: requestPath,
|
|
792
|
+
queryParameters,
|
|
793
|
+
headers,
|
|
794
|
+
data: assignUserIdParams
|
|
795
|
+
};
|
|
796
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
797
|
+
},
|
|
682
798
|
/**
|
|
683
799
|
* 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).
|
|
684
800
|
*
|
|
@@ -705,6 +821,35 @@ function createSearchClient({
|
|
|
705
821
|
};
|
|
706
822
|
return transporter.request(request, requestOptions);
|
|
707
823
|
},
|
|
824
|
+
/**
|
|
825
|
+
* 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).
|
|
826
|
+
*
|
|
827
|
+
* 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.
|
|
828
|
+
*
|
|
829
|
+
* Required API Key ACLs:
|
|
830
|
+
* - addObject
|
|
831
|
+
* @param batch - The batch object.
|
|
832
|
+
* @param batch.indexName - Name of the index on which to perform the operation.
|
|
833
|
+
* @param batch.batchWriteParams - The batchWriteParams object.
|
|
834
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
835
|
+
* @see batch for the plain version.
|
|
836
|
+
*/
|
|
837
|
+
batchWithHTTPInfo({ indexName, batchWriteParams }, requestOptions) {
|
|
838
|
+
(0, import_client_common.validateRequired)("indexName", "batchWithHTTPInfo", indexName);
|
|
839
|
+
(0, import_client_common.validateRequired)("batchWriteParams", "batchWithHTTPInfo", batchWriteParams);
|
|
840
|
+
(0, import_client_common.validateRequired)("batchWriteParams.requests", "batchWithHTTPInfo", batchWriteParams.requests);
|
|
841
|
+
const requestPath = "/1/indexes/{indexName}/batch".replace("{indexName}", encodeURIComponent(indexName));
|
|
842
|
+
const headers = {};
|
|
843
|
+
const queryParameters = {};
|
|
844
|
+
const request = {
|
|
845
|
+
method: "POST",
|
|
846
|
+
path: requestPath,
|
|
847
|
+
queryParameters,
|
|
848
|
+
headers,
|
|
849
|
+
data: batchWriteParams
|
|
850
|
+
};
|
|
851
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
852
|
+
},
|
|
708
853
|
/**
|
|
709
854
|
* Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**.
|
|
710
855
|
*
|
|
@@ -737,6 +882,49 @@ function createSearchClient({
|
|
|
737
882
|
};
|
|
738
883
|
return transporter.request(request, requestOptions);
|
|
739
884
|
},
|
|
885
|
+
/**
|
|
886
|
+
* Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**.
|
|
887
|
+
*
|
|
888
|
+
* 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.
|
|
889
|
+
*
|
|
890
|
+
* Required API Key ACLs:
|
|
891
|
+
* - admin
|
|
892
|
+
*
|
|
893
|
+
* @deprecated
|
|
894
|
+
* @param batchAssignUserIds - The batchAssignUserIds object.
|
|
895
|
+
* @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
|
|
896
|
+
* @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
|
|
897
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
898
|
+
* @see batchAssignUserIds for the plain version.
|
|
899
|
+
*/
|
|
900
|
+
batchAssignUserIdsWithHTTPInfo({ xAlgoliaUserID, batchAssignUserIdsParams }, requestOptions) {
|
|
901
|
+
(0, import_client_common.validateRequired)("xAlgoliaUserID", "batchAssignUserIdsWithHTTPInfo", xAlgoliaUserID);
|
|
902
|
+
(0, import_client_common.validateRequired)("batchAssignUserIdsParams", "batchAssignUserIdsWithHTTPInfo", batchAssignUserIdsParams);
|
|
903
|
+
(0, import_client_common.validateRequired)(
|
|
904
|
+
"batchAssignUserIdsParams.cluster",
|
|
905
|
+
"batchAssignUserIdsWithHTTPInfo",
|
|
906
|
+
batchAssignUserIdsParams.cluster
|
|
907
|
+
);
|
|
908
|
+
(0, import_client_common.validateRequired)(
|
|
909
|
+
"batchAssignUserIdsParams.users",
|
|
910
|
+
"batchAssignUserIdsWithHTTPInfo",
|
|
911
|
+
batchAssignUserIdsParams.users
|
|
912
|
+
);
|
|
913
|
+
const requestPath = "/1/clusters/mapping/batch";
|
|
914
|
+
const headers = {};
|
|
915
|
+
const queryParameters = {};
|
|
916
|
+
if (xAlgoliaUserID !== void 0) {
|
|
917
|
+
headers["X-Algolia-User-ID"] = xAlgoliaUserID.toString();
|
|
918
|
+
}
|
|
919
|
+
const request = {
|
|
920
|
+
method: "POST",
|
|
921
|
+
path: requestPath,
|
|
922
|
+
queryParameters,
|
|
923
|
+
headers,
|
|
924
|
+
data: batchAssignUserIdsParams
|
|
925
|
+
};
|
|
926
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
927
|
+
},
|
|
740
928
|
/**
|
|
741
929
|
* Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
|
|
742
930
|
*
|
|
@@ -770,6 +958,46 @@ function createSearchClient({
|
|
|
770
958
|
};
|
|
771
959
|
return transporter.request(request, requestOptions);
|
|
772
960
|
},
|
|
961
|
+
/**
|
|
962
|
+
* Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
|
|
963
|
+
*
|
|
964
|
+
* 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.
|
|
965
|
+
*
|
|
966
|
+
* Required API Key ACLs:
|
|
967
|
+
* - editSettings
|
|
968
|
+
* @param batchDictionaryEntries - The batchDictionaryEntries object.
|
|
969
|
+
* @param batchDictionaryEntries.dictionaryName - Dictionary type in which to search.
|
|
970
|
+
* @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
|
|
971
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
972
|
+
* @see batchDictionaryEntries for the plain version.
|
|
973
|
+
*/
|
|
974
|
+
batchDictionaryEntriesWithHTTPInfo({ dictionaryName, batchDictionaryEntriesParams }, requestOptions) {
|
|
975
|
+
(0, import_client_common.validateRequired)("dictionaryName", "batchDictionaryEntriesWithHTTPInfo", dictionaryName);
|
|
976
|
+
(0, import_client_common.validateRequired)(
|
|
977
|
+
"batchDictionaryEntriesParams",
|
|
978
|
+
"batchDictionaryEntriesWithHTTPInfo",
|
|
979
|
+
batchDictionaryEntriesParams
|
|
980
|
+
);
|
|
981
|
+
(0, import_client_common.validateRequired)(
|
|
982
|
+
"batchDictionaryEntriesParams.requests",
|
|
983
|
+
"batchDictionaryEntriesWithHTTPInfo",
|
|
984
|
+
batchDictionaryEntriesParams.requests
|
|
985
|
+
);
|
|
986
|
+
const requestPath = "/1/dictionaries/{dictionaryName}/batch".replace(
|
|
987
|
+
"{dictionaryName}",
|
|
988
|
+
encodeURIComponent(dictionaryName)
|
|
989
|
+
);
|
|
990
|
+
const headers = {};
|
|
991
|
+
const queryParameters = {};
|
|
992
|
+
const request = {
|
|
993
|
+
method: "POST",
|
|
994
|
+
path: requestPath,
|
|
995
|
+
queryParameters,
|
|
996
|
+
headers,
|
|
997
|
+
data: batchDictionaryEntriesParams
|
|
998
|
+
};
|
|
999
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1000
|
+
},
|
|
773
1001
|
/**
|
|
774
1002
|
* 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.
|
|
775
1003
|
*
|
|
@@ -795,6 +1023,34 @@ function createSearchClient({
|
|
|
795
1023
|
};
|
|
796
1024
|
return transporter.request(request, requestOptions);
|
|
797
1025
|
},
|
|
1026
|
+
/**
|
|
1027
|
+
* 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.
|
|
1028
|
+
*
|
|
1029
|
+
* 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.
|
|
1030
|
+
*
|
|
1031
|
+
* Required API Key ACLs:
|
|
1032
|
+
* - browse
|
|
1033
|
+
* @param browse - The browse object.
|
|
1034
|
+
* @param browse.indexName - Name of the index on which to perform the operation.
|
|
1035
|
+
* @param browse.browseParams - The browseParams object.
|
|
1036
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1037
|
+
* @see browse for the plain version.
|
|
1038
|
+
*/
|
|
1039
|
+
browseWithHTTPInfo({ indexName, browseParams }, requestOptions) {
|
|
1040
|
+
(0, import_client_common.validateRequired)("indexName", "browseWithHTTPInfo", indexName);
|
|
1041
|
+
const requestPath = "/1/indexes/{indexName}/browse".replace("{indexName}", encodeURIComponent(indexName));
|
|
1042
|
+
const headers = {};
|
|
1043
|
+
const queryParameters = {};
|
|
1044
|
+
const request = {
|
|
1045
|
+
method: "POST",
|
|
1046
|
+
path: requestPath,
|
|
1047
|
+
queryParameters,
|
|
1048
|
+
headers,
|
|
1049
|
+
data: browseParams ? browseParams : {},
|
|
1050
|
+
useReadTransporter: true
|
|
1051
|
+
};
|
|
1052
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1053
|
+
},
|
|
798
1054
|
/**
|
|
799
1055
|
* 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).
|
|
800
1056
|
*
|
|
@@ -817,6 +1073,31 @@ function createSearchClient({
|
|
|
817
1073
|
};
|
|
818
1074
|
return transporter.request(request, requestOptions);
|
|
819
1075
|
},
|
|
1076
|
+
/**
|
|
1077
|
+
* 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).
|
|
1078
|
+
*
|
|
1079
|
+
* 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.
|
|
1080
|
+
*
|
|
1081
|
+
* Required API Key ACLs:
|
|
1082
|
+
* - deleteIndex
|
|
1083
|
+
* @param clearObjects - The clearObjects object.
|
|
1084
|
+
* @param clearObjects.indexName - Name of the index on which to perform the operation.
|
|
1085
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1086
|
+
* @see clearObjects for the plain version.
|
|
1087
|
+
*/
|
|
1088
|
+
clearObjectsWithHTTPInfo({ indexName }, requestOptions) {
|
|
1089
|
+
(0, import_client_common.validateRequired)("indexName", "clearObjectsWithHTTPInfo", indexName);
|
|
1090
|
+
const requestPath = "/1/indexes/{indexName}/clear".replace("{indexName}", encodeURIComponent(indexName));
|
|
1091
|
+
const headers = {};
|
|
1092
|
+
const queryParameters = {};
|
|
1093
|
+
const request = {
|
|
1094
|
+
method: "POST",
|
|
1095
|
+
path: requestPath,
|
|
1096
|
+
queryParameters,
|
|
1097
|
+
headers
|
|
1098
|
+
};
|
|
1099
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1100
|
+
},
|
|
820
1101
|
/**
|
|
821
1102
|
* Deletes all rules from the index.
|
|
822
1103
|
*
|
|
@@ -844,18 +1125,21 @@ function createSearchClient({
|
|
|
844
1125
|
return transporter.request(request, requestOptions);
|
|
845
1126
|
},
|
|
846
1127
|
/**
|
|
847
|
-
* Deletes all
|
|
1128
|
+
* Deletes all rules from the index.
|
|
1129
|
+
*
|
|
1130
|
+
* 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.
|
|
848
1131
|
*
|
|
849
1132
|
* Required API Key ACLs:
|
|
850
1133
|
* - editSettings
|
|
851
|
-
* @param
|
|
852
|
-
* @param
|
|
853
|
-
* @param
|
|
1134
|
+
* @param clearRules - The clearRules object.
|
|
1135
|
+
* @param clearRules.indexName - Name of the index on which to perform the operation.
|
|
1136
|
+
* @param clearRules.forwardToReplicas - Whether changes are applied to replica indices.
|
|
854
1137
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1138
|
+
* @see clearRules for the plain version.
|
|
855
1139
|
*/
|
|
856
|
-
|
|
857
|
-
(0, import_client_common.validateRequired)("indexName", "
|
|
858
|
-
const requestPath = "/1/indexes/{indexName}/
|
|
1140
|
+
clearRulesWithHTTPInfo({ indexName, forwardToReplicas }, requestOptions) {
|
|
1141
|
+
(0, import_client_common.validateRequired)("indexName", "clearRulesWithHTTPInfo", indexName);
|
|
1142
|
+
const requestPath = "/1/indexes/{indexName}/rules/clear".replace("{indexName}", encodeURIComponent(indexName));
|
|
859
1143
|
const headers = {};
|
|
860
1144
|
const queryParameters = {};
|
|
861
1145
|
if (forwardToReplicas !== void 0) {
|
|
@@ -867,22 +1151,28 @@ function createSearchClient({
|
|
|
867
1151
|
queryParameters,
|
|
868
1152
|
headers
|
|
869
1153
|
};
|
|
870
|
-
return transporter.
|
|
1154
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
871
1155
|
},
|
|
872
1156
|
/**
|
|
873
|
-
*
|
|
874
|
-
*
|
|
875
|
-
*
|
|
876
|
-
*
|
|
1157
|
+
* Deletes all synonyms from the index.
|
|
1158
|
+
*
|
|
1159
|
+
* Required API Key ACLs:
|
|
1160
|
+
* - editSettings
|
|
1161
|
+
* @param clearSynonyms - The clearSynonyms object.
|
|
1162
|
+
* @param clearSynonyms.indexName - Name of the index on which to perform the operation.
|
|
1163
|
+
* @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
|
|
877
1164
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
878
1165
|
*/
|
|
879
|
-
|
|
880
|
-
(0, import_client_common.validateRequired)("
|
|
881
|
-
const requestPath = "/{
|
|
1166
|
+
clearSynonyms({ indexName, forwardToReplicas }, requestOptions) {
|
|
1167
|
+
(0, import_client_common.validateRequired)("indexName", "clearSynonyms", indexName);
|
|
1168
|
+
const requestPath = "/1/indexes/{indexName}/synonyms/clear".replace("{indexName}", encodeURIComponent(indexName));
|
|
882
1169
|
const headers = {};
|
|
883
|
-
const queryParameters =
|
|
1170
|
+
const queryParameters = {};
|
|
1171
|
+
if (forwardToReplicas !== void 0) {
|
|
1172
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
1173
|
+
}
|
|
884
1174
|
const request = {
|
|
885
|
-
method: "
|
|
1175
|
+
method: "POST",
|
|
886
1176
|
path: requestPath,
|
|
887
1177
|
queryParameters,
|
|
888
1178
|
headers
|
|
@@ -890,7 +1180,79 @@ function createSearchClient({
|
|
|
890
1180
|
return transporter.request(request, requestOptions);
|
|
891
1181
|
},
|
|
892
1182
|
/**
|
|
893
|
-
*
|
|
1183
|
+
* Deletes all synonyms from the index.
|
|
1184
|
+
*
|
|
1185
|
+
* 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.
|
|
1186
|
+
*
|
|
1187
|
+
* Required API Key ACLs:
|
|
1188
|
+
* - editSettings
|
|
1189
|
+
* @param clearSynonyms - The clearSynonyms object.
|
|
1190
|
+
* @param clearSynonyms.indexName - Name of the index on which to perform the operation.
|
|
1191
|
+
* @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
|
|
1192
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1193
|
+
* @see clearSynonyms for the plain version.
|
|
1194
|
+
*/
|
|
1195
|
+
clearSynonymsWithHTTPInfo({ indexName, forwardToReplicas }, requestOptions) {
|
|
1196
|
+
(0, import_client_common.validateRequired)("indexName", "clearSynonymsWithHTTPInfo", indexName);
|
|
1197
|
+
const requestPath = "/1/indexes/{indexName}/synonyms/clear".replace("{indexName}", encodeURIComponent(indexName));
|
|
1198
|
+
const headers = {};
|
|
1199
|
+
const queryParameters = {};
|
|
1200
|
+
if (forwardToReplicas !== void 0) {
|
|
1201
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
1202
|
+
}
|
|
1203
|
+
const request = {
|
|
1204
|
+
method: "POST",
|
|
1205
|
+
path: requestPath,
|
|
1206
|
+
queryParameters,
|
|
1207
|
+
headers
|
|
1208
|
+
};
|
|
1209
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1210
|
+
},
|
|
1211
|
+
/**
|
|
1212
|
+
* This method lets you send requests to the Algolia REST API.
|
|
1213
|
+
* @param customDelete - The customDelete object.
|
|
1214
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
1215
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
1216
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1217
|
+
*/
|
|
1218
|
+
customDelete({ path, parameters }, requestOptions) {
|
|
1219
|
+
(0, import_client_common.validateRequired)("path", "customDelete", path);
|
|
1220
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
1221
|
+
const headers = {};
|
|
1222
|
+
const queryParameters = parameters ? parameters : {};
|
|
1223
|
+
const request = {
|
|
1224
|
+
method: "DELETE",
|
|
1225
|
+
path: requestPath,
|
|
1226
|
+
queryParameters,
|
|
1227
|
+
headers
|
|
1228
|
+
};
|
|
1229
|
+
return transporter.request(request, requestOptions);
|
|
1230
|
+
},
|
|
1231
|
+
/**
|
|
1232
|
+
* This method lets you send requests to the Algolia REST API.
|
|
1233
|
+
*
|
|
1234
|
+
* 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.
|
|
1235
|
+
* @param customDelete - The customDelete object.
|
|
1236
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
1237
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
1238
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1239
|
+
* @see customDelete for the plain version.
|
|
1240
|
+
*/
|
|
1241
|
+
customDeleteWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
1242
|
+
(0, import_client_common.validateRequired)("path", "customDeleteWithHTTPInfo", path);
|
|
1243
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
1244
|
+
const headers = {};
|
|
1245
|
+
const queryParameters = parameters ? parameters : {};
|
|
1246
|
+
const request = {
|
|
1247
|
+
method: "DELETE",
|
|
1248
|
+
path: requestPath,
|
|
1249
|
+
queryParameters,
|
|
1250
|
+
headers
|
|
1251
|
+
};
|
|
1252
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1253
|
+
},
|
|
1254
|
+
/**
|
|
1255
|
+
* This method lets you send requests to the Algolia REST API.
|
|
894
1256
|
* @param customGet - The customGet object.
|
|
895
1257
|
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
896
1258
|
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
@@ -909,6 +1271,29 @@ function createSearchClient({
|
|
|
909
1271
|
};
|
|
910
1272
|
return transporter.request(request, requestOptions);
|
|
911
1273
|
},
|
|
1274
|
+
/**
|
|
1275
|
+
* This method lets you send requests to the Algolia REST API.
|
|
1276
|
+
*
|
|
1277
|
+
* 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.
|
|
1278
|
+
* @param customGet - The customGet object.
|
|
1279
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
1280
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
1281
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1282
|
+
* @see customGet for the plain version.
|
|
1283
|
+
*/
|
|
1284
|
+
customGetWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
1285
|
+
(0, import_client_common.validateRequired)("path", "customGetWithHTTPInfo", path);
|
|
1286
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
1287
|
+
const headers = {};
|
|
1288
|
+
const queryParameters = parameters ? parameters : {};
|
|
1289
|
+
const request = {
|
|
1290
|
+
method: "GET",
|
|
1291
|
+
path: requestPath,
|
|
1292
|
+
queryParameters,
|
|
1293
|
+
headers
|
|
1294
|
+
};
|
|
1295
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1296
|
+
},
|
|
912
1297
|
/**
|
|
913
1298
|
* This method lets you send requests to the Algolia REST API.
|
|
914
1299
|
* @param customPost - The customPost object.
|
|
@@ -931,6 +1316,31 @@ function createSearchClient({
|
|
|
931
1316
|
};
|
|
932
1317
|
return transporter.request(request, requestOptions);
|
|
933
1318
|
},
|
|
1319
|
+
/**
|
|
1320
|
+
* This method lets you send requests to the Algolia REST API.
|
|
1321
|
+
*
|
|
1322
|
+
* 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.
|
|
1323
|
+
* @param customPost - The customPost object.
|
|
1324
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
1325
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
1326
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
1327
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1328
|
+
* @see customPost for the plain version.
|
|
1329
|
+
*/
|
|
1330
|
+
customPostWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
1331
|
+
(0, import_client_common.validateRequired)("path", "customPostWithHTTPInfo", path);
|
|
1332
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
1333
|
+
const headers = {};
|
|
1334
|
+
const queryParameters = parameters ? parameters : {};
|
|
1335
|
+
const request = {
|
|
1336
|
+
method: "POST",
|
|
1337
|
+
path: requestPath,
|
|
1338
|
+
queryParameters,
|
|
1339
|
+
headers,
|
|
1340
|
+
data: body ? body : {}
|
|
1341
|
+
};
|
|
1342
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1343
|
+
},
|
|
934
1344
|
/**
|
|
935
1345
|
* This method lets you send requests to the Algolia REST API.
|
|
936
1346
|
* @param customPut - The customPut object.
|
|
@@ -953,6 +1363,31 @@ function createSearchClient({
|
|
|
953
1363
|
};
|
|
954
1364
|
return transporter.request(request, requestOptions);
|
|
955
1365
|
},
|
|
1366
|
+
/**
|
|
1367
|
+
* This method lets you send requests to the Algolia REST API.
|
|
1368
|
+
*
|
|
1369
|
+
* 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.
|
|
1370
|
+
* @param customPut - The customPut object.
|
|
1371
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
1372
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
1373
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
1374
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1375
|
+
* @see customPut for the plain version.
|
|
1376
|
+
*/
|
|
1377
|
+
customPutWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
1378
|
+
(0, import_client_common.validateRequired)("path", "customPutWithHTTPInfo", path);
|
|
1379
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
1380
|
+
const headers = {};
|
|
1381
|
+
const queryParameters = parameters ? parameters : {};
|
|
1382
|
+
const request = {
|
|
1383
|
+
method: "PUT",
|
|
1384
|
+
path: requestPath,
|
|
1385
|
+
queryParameters,
|
|
1386
|
+
headers,
|
|
1387
|
+
data: body ? body : {}
|
|
1388
|
+
};
|
|
1389
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1390
|
+
},
|
|
956
1391
|
/**
|
|
957
1392
|
* Deletes the API key.
|
|
958
1393
|
*
|
|
@@ -975,6 +1410,31 @@ function createSearchClient({
|
|
|
975
1410
|
};
|
|
976
1411
|
return transporter.request(request, requestOptions);
|
|
977
1412
|
},
|
|
1413
|
+
/**
|
|
1414
|
+
* Deletes the API key.
|
|
1415
|
+
*
|
|
1416
|
+
* 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.
|
|
1417
|
+
*
|
|
1418
|
+
* Required API Key ACLs:
|
|
1419
|
+
* - admin
|
|
1420
|
+
* @param deleteApiKey - The deleteApiKey object.
|
|
1421
|
+
* @param deleteApiKey.key - API key.
|
|
1422
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1423
|
+
* @see deleteApiKey for the plain version.
|
|
1424
|
+
*/
|
|
1425
|
+
deleteApiKeyWithHTTPInfo({ key }, requestOptions) {
|
|
1426
|
+
(0, import_client_common.validateRequired)("key", "deleteApiKeyWithHTTPInfo", key);
|
|
1427
|
+
const requestPath = "/1/keys/{key}".replace("{key}", encodeURIComponent(key));
|
|
1428
|
+
const headers = {};
|
|
1429
|
+
const queryParameters = {};
|
|
1430
|
+
const request = {
|
|
1431
|
+
method: "DELETE",
|
|
1432
|
+
path: requestPath,
|
|
1433
|
+
queryParameters,
|
|
1434
|
+
headers
|
|
1435
|
+
};
|
|
1436
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1437
|
+
},
|
|
978
1438
|
/**
|
|
979
1439
|
* 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).
|
|
980
1440
|
*
|
|
@@ -1000,6 +1460,34 @@ function createSearchClient({
|
|
|
1000
1460
|
};
|
|
1001
1461
|
return transporter.request(request, requestOptions);
|
|
1002
1462
|
},
|
|
1463
|
+
/**
|
|
1464
|
+
* 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).
|
|
1465
|
+
*
|
|
1466
|
+
* 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.
|
|
1467
|
+
*
|
|
1468
|
+
* Required API Key ACLs:
|
|
1469
|
+
* - deleteIndex
|
|
1470
|
+
* @param deleteBy - The deleteBy object.
|
|
1471
|
+
* @param deleteBy.indexName - Name of the index on which to perform the operation.
|
|
1472
|
+
* @param deleteBy.deleteByParams - The deleteByParams object.
|
|
1473
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1474
|
+
* @see deleteBy for the plain version.
|
|
1475
|
+
*/
|
|
1476
|
+
deleteByWithHTTPInfo({ indexName, deleteByParams }, requestOptions) {
|
|
1477
|
+
(0, import_client_common.validateRequired)("indexName", "deleteByWithHTTPInfo", indexName);
|
|
1478
|
+
(0, import_client_common.validateRequired)("deleteByParams", "deleteByWithHTTPInfo", deleteByParams);
|
|
1479
|
+
const requestPath = "/1/indexes/{indexName}/deleteByQuery".replace("{indexName}", encodeURIComponent(indexName));
|
|
1480
|
+
const headers = {};
|
|
1481
|
+
const queryParameters = {};
|
|
1482
|
+
const request = {
|
|
1483
|
+
method: "POST",
|
|
1484
|
+
path: requestPath,
|
|
1485
|
+
queryParameters,
|
|
1486
|
+
headers,
|
|
1487
|
+
data: deleteByParams
|
|
1488
|
+
};
|
|
1489
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1490
|
+
},
|
|
1003
1491
|
/**
|
|
1004
1492
|
* 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).
|
|
1005
1493
|
*
|
|
@@ -1022,6 +1510,31 @@ function createSearchClient({
|
|
|
1022
1510
|
};
|
|
1023
1511
|
return transporter.request(request, requestOptions);
|
|
1024
1512
|
},
|
|
1513
|
+
/**
|
|
1514
|
+
* 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).
|
|
1515
|
+
*
|
|
1516
|
+
* 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.
|
|
1517
|
+
*
|
|
1518
|
+
* Required API Key ACLs:
|
|
1519
|
+
* - deleteIndex
|
|
1520
|
+
* @param deleteIndex - The deleteIndex object.
|
|
1521
|
+
* @param deleteIndex.indexName - Name of the index on which to perform the operation.
|
|
1522
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1523
|
+
* @see deleteIndex for the plain version.
|
|
1524
|
+
*/
|
|
1525
|
+
deleteIndexWithHTTPInfo({ indexName }, requestOptions) {
|
|
1526
|
+
(0, import_client_common.validateRequired)("indexName", "deleteIndexWithHTTPInfo", indexName);
|
|
1527
|
+
const requestPath = "/1/indexes/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
|
|
1528
|
+
const headers = {};
|
|
1529
|
+
const queryParameters = {};
|
|
1530
|
+
const request = {
|
|
1531
|
+
method: "DELETE",
|
|
1532
|
+
path: requestPath,
|
|
1533
|
+
queryParameters,
|
|
1534
|
+
headers
|
|
1535
|
+
};
|
|
1536
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1537
|
+
},
|
|
1025
1538
|
/**
|
|
1026
1539
|
* 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).
|
|
1027
1540
|
*
|
|
@@ -1046,6 +1559,33 @@ function createSearchClient({
|
|
|
1046
1559
|
};
|
|
1047
1560
|
return transporter.request(request, requestOptions);
|
|
1048
1561
|
},
|
|
1562
|
+
/**
|
|
1563
|
+
* 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).
|
|
1564
|
+
*
|
|
1565
|
+
* 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.
|
|
1566
|
+
*
|
|
1567
|
+
* Required API Key ACLs:
|
|
1568
|
+
* - deleteObject
|
|
1569
|
+
* @param deleteObject - The deleteObject object.
|
|
1570
|
+
* @param deleteObject.indexName - Name of the index on which to perform the operation.
|
|
1571
|
+
* @param deleteObject.objectID - Unique record identifier.
|
|
1572
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1573
|
+
* @see deleteObject for the plain version.
|
|
1574
|
+
*/
|
|
1575
|
+
deleteObjectWithHTTPInfo({ indexName, objectID }, requestOptions) {
|
|
1576
|
+
(0, import_client_common.validateRequired)("indexName", "deleteObjectWithHTTPInfo", indexName);
|
|
1577
|
+
(0, import_client_common.validateRequired)("objectID", "deleteObjectWithHTTPInfo", objectID);
|
|
1578
|
+
const requestPath = "/1/indexes/{indexName}/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
1579
|
+
const headers = {};
|
|
1580
|
+
const queryParameters = {};
|
|
1581
|
+
const request = {
|
|
1582
|
+
method: "DELETE",
|
|
1583
|
+
path: requestPath,
|
|
1584
|
+
queryParameters,
|
|
1585
|
+
headers
|
|
1586
|
+
};
|
|
1587
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1588
|
+
},
|
|
1049
1589
|
/**
|
|
1050
1590
|
* 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).
|
|
1051
1591
|
*
|
|
@@ -1074,6 +1614,37 @@ function createSearchClient({
|
|
|
1074
1614
|
};
|
|
1075
1615
|
return transporter.request(request, requestOptions);
|
|
1076
1616
|
},
|
|
1617
|
+
/**
|
|
1618
|
+
* 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).
|
|
1619
|
+
*
|
|
1620
|
+
* 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.
|
|
1621
|
+
*
|
|
1622
|
+
* Required API Key ACLs:
|
|
1623
|
+
* - editSettings
|
|
1624
|
+
* @param deleteRule - The deleteRule object.
|
|
1625
|
+
* @param deleteRule.indexName - Name of the index on which to perform the operation.
|
|
1626
|
+
* @param deleteRule.objectID - Unique identifier of a rule object.
|
|
1627
|
+
* @param deleteRule.forwardToReplicas - Whether changes are applied to replica indices.
|
|
1628
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1629
|
+
* @see deleteRule for the plain version.
|
|
1630
|
+
*/
|
|
1631
|
+
deleteRuleWithHTTPInfo({ indexName, objectID, forwardToReplicas }, requestOptions) {
|
|
1632
|
+
(0, import_client_common.validateRequired)("indexName", "deleteRuleWithHTTPInfo", indexName);
|
|
1633
|
+
(0, import_client_common.validateRequired)("objectID", "deleteRuleWithHTTPInfo", objectID);
|
|
1634
|
+
const requestPath = "/1/indexes/{indexName}/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
1635
|
+
const headers = {};
|
|
1636
|
+
const queryParameters = {};
|
|
1637
|
+
if (forwardToReplicas !== void 0) {
|
|
1638
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
1639
|
+
}
|
|
1640
|
+
const request = {
|
|
1641
|
+
method: "DELETE",
|
|
1642
|
+
path: requestPath,
|
|
1643
|
+
queryParameters,
|
|
1644
|
+
headers
|
|
1645
|
+
};
|
|
1646
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1647
|
+
},
|
|
1077
1648
|
/**
|
|
1078
1649
|
* Deletes a source from the list of allowed sources.
|
|
1079
1650
|
*
|
|
@@ -1096,6 +1667,31 @@ function createSearchClient({
|
|
|
1096
1667
|
};
|
|
1097
1668
|
return transporter.request(request, requestOptions);
|
|
1098
1669
|
},
|
|
1670
|
+
/**
|
|
1671
|
+
* Deletes a source from the list of allowed sources.
|
|
1672
|
+
*
|
|
1673
|
+
* 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.
|
|
1674
|
+
*
|
|
1675
|
+
* Required API Key ACLs:
|
|
1676
|
+
* - admin
|
|
1677
|
+
* @param deleteSource - The deleteSource object.
|
|
1678
|
+
* @param deleteSource.source - IP address range of the source.
|
|
1679
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1680
|
+
* @see deleteSource for the plain version.
|
|
1681
|
+
*/
|
|
1682
|
+
deleteSourceWithHTTPInfo({ source }, requestOptions) {
|
|
1683
|
+
(0, import_client_common.validateRequired)("source", "deleteSourceWithHTTPInfo", source);
|
|
1684
|
+
const requestPath = "/1/security/sources/{source}".replace("{source}", encodeURIComponent(source));
|
|
1685
|
+
const headers = {};
|
|
1686
|
+
const queryParameters = {};
|
|
1687
|
+
const request = {
|
|
1688
|
+
method: "DELETE",
|
|
1689
|
+
path: requestPath,
|
|
1690
|
+
queryParameters,
|
|
1691
|
+
headers
|
|
1692
|
+
};
|
|
1693
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1694
|
+
},
|
|
1099
1695
|
/**
|
|
1100
1696
|
* 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).
|
|
1101
1697
|
*
|
|
@@ -1125,13 +1721,44 @@ function createSearchClient({
|
|
|
1125
1721
|
return transporter.request(request, requestOptions);
|
|
1126
1722
|
},
|
|
1127
1723
|
/**
|
|
1128
|
-
*
|
|
1724
|
+
* 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).
|
|
1725
|
+
*
|
|
1726
|
+
* 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.
|
|
1129
1727
|
*
|
|
1130
1728
|
* Required API Key ACLs:
|
|
1131
|
-
* -
|
|
1132
|
-
* @param
|
|
1133
|
-
* @param
|
|
1134
|
-
* @param
|
|
1729
|
+
* - editSettings
|
|
1730
|
+
* @param deleteSynonym - The deleteSynonym object.
|
|
1731
|
+
* @param deleteSynonym.indexName - Name of the index on which to perform the operation.
|
|
1732
|
+
* @param deleteSynonym.objectID - Unique identifier of a synonym object.
|
|
1733
|
+
* @param deleteSynonym.forwardToReplicas - Whether changes are applied to replica indices.
|
|
1734
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1735
|
+
* @see deleteSynonym for the plain version.
|
|
1736
|
+
*/
|
|
1737
|
+
deleteSynonymWithHTTPInfo({ indexName, objectID, forwardToReplicas }, requestOptions) {
|
|
1738
|
+
(0, import_client_common.validateRequired)("indexName", "deleteSynonymWithHTTPInfo", indexName);
|
|
1739
|
+
(0, import_client_common.validateRequired)("objectID", "deleteSynonymWithHTTPInfo", objectID);
|
|
1740
|
+
const requestPath = "/1/indexes/{indexName}/synonyms/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
1741
|
+
const headers = {};
|
|
1742
|
+
const queryParameters = {};
|
|
1743
|
+
if (forwardToReplicas !== void 0) {
|
|
1744
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
1745
|
+
}
|
|
1746
|
+
const request = {
|
|
1747
|
+
method: "DELETE",
|
|
1748
|
+
path: requestPath,
|
|
1749
|
+
queryParameters,
|
|
1750
|
+
headers
|
|
1751
|
+
};
|
|
1752
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1753
|
+
},
|
|
1754
|
+
/**
|
|
1755
|
+
* 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>`.
|
|
1756
|
+
*
|
|
1757
|
+
* Required API Key ACLs:
|
|
1758
|
+
* - search
|
|
1759
|
+
* @param getApiKey - The getApiKey object.
|
|
1760
|
+
* @param getApiKey.key - API key.
|
|
1761
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1135
1762
|
*/
|
|
1136
1763
|
getApiKey({ key }, requestOptions) {
|
|
1137
1764
|
(0, import_client_common.validateRequired)("key", "getApiKey", key);
|
|
@@ -1146,6 +1773,31 @@ function createSearchClient({
|
|
|
1146
1773
|
};
|
|
1147
1774
|
return transporter.request(request, requestOptions);
|
|
1148
1775
|
},
|
|
1776
|
+
/**
|
|
1777
|
+
* 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>`.
|
|
1778
|
+
*
|
|
1779
|
+
* 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.
|
|
1780
|
+
*
|
|
1781
|
+
* Required API Key ACLs:
|
|
1782
|
+
* - search
|
|
1783
|
+
* @param getApiKey - The getApiKey object.
|
|
1784
|
+
* @param getApiKey.key - API key.
|
|
1785
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1786
|
+
* @see getApiKey for the plain version.
|
|
1787
|
+
*/
|
|
1788
|
+
getApiKeyWithHTTPInfo({ key }, requestOptions) {
|
|
1789
|
+
(0, import_client_common.validateRequired)("key", "getApiKeyWithHTTPInfo", key);
|
|
1790
|
+
const requestPath = "/1/keys/{key}".replace("{key}", encodeURIComponent(key));
|
|
1791
|
+
const headers = {};
|
|
1792
|
+
const queryParameters = {};
|
|
1793
|
+
const request = {
|
|
1794
|
+
method: "GET",
|
|
1795
|
+
path: requestPath,
|
|
1796
|
+
queryParameters,
|
|
1797
|
+
headers
|
|
1798
|
+
};
|
|
1799
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1800
|
+
},
|
|
1149
1801
|
/**
|
|
1150
1802
|
* Checks the status of a given application task.
|
|
1151
1803
|
*
|
|
@@ -1168,6 +1820,31 @@ function createSearchClient({
|
|
|
1168
1820
|
};
|
|
1169
1821
|
return transporter.request(request, requestOptions);
|
|
1170
1822
|
},
|
|
1823
|
+
/**
|
|
1824
|
+
* Checks the status of a given application task.
|
|
1825
|
+
*
|
|
1826
|
+
* 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.
|
|
1827
|
+
*
|
|
1828
|
+
* Required API Key ACLs:
|
|
1829
|
+
* - editSettings
|
|
1830
|
+
* @param getAppTask - The getAppTask object.
|
|
1831
|
+
* @param getAppTask.taskID - Unique task identifier.
|
|
1832
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1833
|
+
* @see getAppTask for the plain version.
|
|
1834
|
+
*/
|
|
1835
|
+
getAppTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1836
|
+
(0, import_client_common.validateRequired)("taskID", "getAppTaskWithHTTPInfo", taskID);
|
|
1837
|
+
const requestPath = "/1/task/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1838
|
+
const headers = {};
|
|
1839
|
+
const queryParameters = {};
|
|
1840
|
+
const request = {
|
|
1841
|
+
method: "GET",
|
|
1842
|
+
path: requestPath,
|
|
1843
|
+
queryParameters,
|
|
1844
|
+
headers
|
|
1845
|
+
};
|
|
1846
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1847
|
+
},
|
|
1171
1848
|
/**
|
|
1172
1849
|
* Lists supported languages with their supported dictionary types and number of custom entries.
|
|
1173
1850
|
*
|
|
@@ -1187,6 +1864,28 @@ function createSearchClient({
|
|
|
1187
1864
|
};
|
|
1188
1865
|
return transporter.request(request, requestOptions);
|
|
1189
1866
|
},
|
|
1867
|
+
/**
|
|
1868
|
+
* Lists supported languages with their supported dictionary types and number of custom entries.
|
|
1869
|
+
*
|
|
1870
|
+
* 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.
|
|
1871
|
+
*
|
|
1872
|
+
* Required API Key ACLs:
|
|
1873
|
+
* - settings
|
|
1874
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1875
|
+
* @see getDictionaryLanguages for the plain version.
|
|
1876
|
+
*/
|
|
1877
|
+
getDictionaryLanguagesWithHTTPInfo(requestOptions) {
|
|
1878
|
+
const requestPath = "/1/dictionaries/*/languages";
|
|
1879
|
+
const headers = {};
|
|
1880
|
+
const queryParameters = {};
|
|
1881
|
+
const request = {
|
|
1882
|
+
method: "GET",
|
|
1883
|
+
path: requestPath,
|
|
1884
|
+
queryParameters,
|
|
1885
|
+
headers
|
|
1886
|
+
};
|
|
1887
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1888
|
+
},
|
|
1190
1889
|
/**
|
|
1191
1890
|
* Retrieves the languages for which standard dictionary entries are turned off.
|
|
1192
1891
|
*
|
|
@@ -1206,6 +1905,28 @@ function createSearchClient({
|
|
|
1206
1905
|
};
|
|
1207
1906
|
return transporter.request(request, requestOptions);
|
|
1208
1907
|
},
|
|
1908
|
+
/**
|
|
1909
|
+
* Retrieves the languages for which standard dictionary entries are turned off.
|
|
1910
|
+
*
|
|
1911
|
+
* 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.
|
|
1912
|
+
*
|
|
1913
|
+
* Required API Key ACLs:
|
|
1914
|
+
* - settings
|
|
1915
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1916
|
+
* @see getDictionarySettings for the plain version.
|
|
1917
|
+
*/
|
|
1918
|
+
getDictionarySettingsWithHTTPInfo(requestOptions) {
|
|
1919
|
+
const requestPath = "/1/dictionaries/*/settings";
|
|
1920
|
+
const headers = {};
|
|
1921
|
+
const queryParameters = {};
|
|
1922
|
+
const request = {
|
|
1923
|
+
method: "GET",
|
|
1924
|
+
path: requestPath,
|
|
1925
|
+
queryParameters,
|
|
1926
|
+
headers
|
|
1927
|
+
};
|
|
1928
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1929
|
+
},
|
|
1209
1930
|
/**
|
|
1210
1931
|
* 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.
|
|
1211
1932
|
*
|
|
@@ -1242,6 +1963,45 @@ function createSearchClient({
|
|
|
1242
1963
|
};
|
|
1243
1964
|
return transporter.request(request, requestOptions);
|
|
1244
1965
|
},
|
|
1966
|
+
/**
|
|
1967
|
+
* 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.
|
|
1968
|
+
*
|
|
1969
|
+
* 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.
|
|
1970
|
+
*
|
|
1971
|
+
* Required API Key ACLs:
|
|
1972
|
+
* - logs
|
|
1973
|
+
* @param getLogs - The getLogs object.
|
|
1974
|
+
* @param getLogs.offset - First log entry to retrieve. The most recent entries are listed first.
|
|
1975
|
+
* @param getLogs.length - Maximum number of entries to retrieve.
|
|
1976
|
+
* @param getLogs.indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
|
|
1977
|
+
* @param getLogs.type - Type of log entries to retrieve. By default, all log entries are retrieved.
|
|
1978
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1979
|
+
* @see getLogs for the plain version.
|
|
1980
|
+
*/
|
|
1981
|
+
getLogsWithHTTPInfo({ offset, length, indexName, type } = {}, requestOptions = void 0) {
|
|
1982
|
+
const requestPath = "/1/logs";
|
|
1983
|
+
const headers = {};
|
|
1984
|
+
const queryParameters = {};
|
|
1985
|
+
if (offset !== void 0) {
|
|
1986
|
+
queryParameters["offset"] = offset.toString();
|
|
1987
|
+
}
|
|
1988
|
+
if (length !== void 0) {
|
|
1989
|
+
queryParameters["length"] = length.toString();
|
|
1990
|
+
}
|
|
1991
|
+
if (indexName !== void 0) {
|
|
1992
|
+
queryParameters["indexName"] = indexName.toString();
|
|
1993
|
+
}
|
|
1994
|
+
if (type !== void 0) {
|
|
1995
|
+
queryParameters["type"] = type.toString();
|
|
1996
|
+
}
|
|
1997
|
+
const request = {
|
|
1998
|
+
method: "GET",
|
|
1999
|
+
path: requestPath,
|
|
2000
|
+
queryParameters,
|
|
2001
|
+
headers
|
|
2002
|
+
};
|
|
2003
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2004
|
+
},
|
|
1245
2005
|
/**
|
|
1246
2006
|
* 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).
|
|
1247
2007
|
*
|
|
@@ -1270,6 +2030,37 @@ function createSearchClient({
|
|
|
1270
2030
|
};
|
|
1271
2031
|
return transporter.request(request, requestOptions);
|
|
1272
2032
|
},
|
|
2033
|
+
/**
|
|
2034
|
+
* 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).
|
|
2035
|
+
*
|
|
2036
|
+
* 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.
|
|
2037
|
+
*
|
|
2038
|
+
* Required API Key ACLs:
|
|
2039
|
+
* - search
|
|
2040
|
+
* @param getObject - The getObject object.
|
|
2041
|
+
* @param getObject.indexName - Name of the index on which to perform the operation.
|
|
2042
|
+
* @param getObject.objectID - Unique record identifier.
|
|
2043
|
+
* @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.
|
|
2044
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2045
|
+
* @see getObject for the plain version.
|
|
2046
|
+
*/
|
|
2047
|
+
getObjectWithHTTPInfo({ indexName, objectID, attributesToRetrieve }, requestOptions) {
|
|
2048
|
+
(0, import_client_common.validateRequired)("indexName", "getObjectWithHTTPInfo", indexName);
|
|
2049
|
+
(0, import_client_common.validateRequired)("objectID", "getObjectWithHTTPInfo", objectID);
|
|
2050
|
+
const requestPath = "/1/indexes/{indexName}/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
2051
|
+
const headers = {};
|
|
2052
|
+
const queryParameters = {};
|
|
2053
|
+
if (attributesToRetrieve !== void 0) {
|
|
2054
|
+
queryParameters["attributesToRetrieve"] = attributesToRetrieve.toString();
|
|
2055
|
+
}
|
|
2056
|
+
const request = {
|
|
2057
|
+
method: "GET",
|
|
2058
|
+
path: requestPath,
|
|
2059
|
+
queryParameters,
|
|
2060
|
+
headers
|
|
2061
|
+
};
|
|
2062
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2063
|
+
},
|
|
1273
2064
|
/**
|
|
1274
2065
|
* Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
|
|
1275
2066
|
*
|
|
@@ -1295,20 +2086,246 @@ function createSearchClient({
|
|
|
1295
2086
|
};
|
|
1296
2087
|
return transporter.request(request, requestOptions);
|
|
1297
2088
|
},
|
|
2089
|
+
/**
|
|
2090
|
+
* Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
|
|
2091
|
+
*
|
|
2092
|
+
* 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.
|
|
2093
|
+
*
|
|
2094
|
+
* Required API Key ACLs:
|
|
2095
|
+
* - search
|
|
2096
|
+
* @param getObjectsParams - Request object.
|
|
2097
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2098
|
+
* @see getObjects for the plain version.
|
|
2099
|
+
*/
|
|
2100
|
+
getObjectsWithHTTPInfo(getObjectsParams, requestOptions) {
|
|
2101
|
+
(0, import_client_common.validateRequired)("getObjectsParams", "getObjectsWithHTTPInfo", getObjectsParams);
|
|
2102
|
+
(0, import_client_common.validateRequired)("getObjectsParams.requests", "getObjectsWithHTTPInfo", getObjectsParams.requests);
|
|
2103
|
+
const requestPath = "/1/indexes/*/objects";
|
|
2104
|
+
const headers = {};
|
|
2105
|
+
const queryParameters = {};
|
|
2106
|
+
const request = {
|
|
2107
|
+
method: "POST",
|
|
2108
|
+
path: requestPath,
|
|
2109
|
+
queryParameters,
|
|
2110
|
+
headers,
|
|
2111
|
+
data: getObjectsParams,
|
|
2112
|
+
useReadTransporter: true,
|
|
2113
|
+
cacheable: true
|
|
2114
|
+
};
|
|
2115
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2116
|
+
},
|
|
2117
|
+
/**
|
|
2118
|
+
* 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).
|
|
2119
|
+
*
|
|
2120
|
+
* Required API Key ACLs:
|
|
2121
|
+
* - settings
|
|
2122
|
+
* @param getRule - The getRule object.
|
|
2123
|
+
* @param getRule.indexName - Name of the index on which to perform the operation.
|
|
2124
|
+
* @param getRule.objectID - Unique identifier of a rule object.
|
|
2125
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2126
|
+
*/
|
|
2127
|
+
getRule({ indexName, objectID }, requestOptions) {
|
|
2128
|
+
(0, import_client_common.validateRequired)("indexName", "getRule", indexName);
|
|
2129
|
+
(0, import_client_common.validateRequired)("objectID", "getRule", objectID);
|
|
2130
|
+
const requestPath = "/1/indexes/{indexName}/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
2131
|
+
const headers = {};
|
|
2132
|
+
const queryParameters = {};
|
|
2133
|
+
const request = {
|
|
2134
|
+
method: "GET",
|
|
2135
|
+
path: requestPath,
|
|
2136
|
+
queryParameters,
|
|
2137
|
+
headers
|
|
2138
|
+
};
|
|
2139
|
+
return transporter.request(request, requestOptions);
|
|
2140
|
+
},
|
|
1298
2141
|
/**
|
|
1299
2142
|
* 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).
|
|
1300
2143
|
*
|
|
2144
|
+
* 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.
|
|
2145
|
+
*
|
|
1301
2146
|
* Required API Key ACLs:
|
|
1302
2147
|
* - settings
|
|
1303
2148
|
* @param getRule - The getRule object.
|
|
1304
2149
|
* @param getRule.indexName - Name of the index on which to perform the operation.
|
|
1305
2150
|
* @param getRule.objectID - Unique identifier of a rule object.
|
|
1306
2151
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2152
|
+
* @see getRule for the plain version.
|
|
2153
|
+
*/
|
|
2154
|
+
getRuleWithHTTPInfo({ indexName, objectID }, requestOptions) {
|
|
2155
|
+
(0, import_client_common.validateRequired)("indexName", "getRuleWithHTTPInfo", indexName);
|
|
2156
|
+
(0, import_client_common.validateRequired)("objectID", "getRuleWithHTTPInfo", objectID);
|
|
2157
|
+
const requestPath = "/1/indexes/{indexName}/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
2158
|
+
const headers = {};
|
|
2159
|
+
const queryParameters = {};
|
|
2160
|
+
const request = {
|
|
2161
|
+
method: "GET",
|
|
2162
|
+
path: requestPath,
|
|
2163
|
+
queryParameters,
|
|
2164
|
+
headers
|
|
2165
|
+
};
|
|
2166
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2167
|
+
},
|
|
2168
|
+
/**
|
|
2169
|
+
* Retrieves an object with non-null index settings.
|
|
2170
|
+
*
|
|
2171
|
+
* Required API Key ACLs:
|
|
2172
|
+
* - settings
|
|
2173
|
+
* @param getSettings - The getSettings object.
|
|
2174
|
+
* @param getSettings.indexName - Name of the index on which to perform the operation.
|
|
2175
|
+
* @param getSettings.getVersion - When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
|
|
2176
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2177
|
+
*/
|
|
2178
|
+
getSettings({ indexName, getVersion }, requestOptions) {
|
|
2179
|
+
(0, import_client_common.validateRequired)("indexName", "getSettings", indexName);
|
|
2180
|
+
const requestPath = "/1/indexes/{indexName}/settings".replace("{indexName}", encodeURIComponent(indexName));
|
|
2181
|
+
const headers = {};
|
|
2182
|
+
const queryParameters = {};
|
|
2183
|
+
if (getVersion !== void 0) {
|
|
2184
|
+
queryParameters["getVersion"] = getVersion.toString();
|
|
2185
|
+
}
|
|
2186
|
+
const request = {
|
|
2187
|
+
method: "GET",
|
|
2188
|
+
path: requestPath,
|
|
2189
|
+
queryParameters,
|
|
2190
|
+
headers
|
|
2191
|
+
};
|
|
2192
|
+
return transporter.request(request, requestOptions);
|
|
2193
|
+
},
|
|
2194
|
+
/**
|
|
2195
|
+
* Retrieves an object with non-null index settings.
|
|
2196
|
+
*
|
|
2197
|
+
* 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.
|
|
2198
|
+
*
|
|
2199
|
+
* Required API Key ACLs:
|
|
2200
|
+
* - settings
|
|
2201
|
+
* @param getSettings - The getSettings object.
|
|
2202
|
+
* @param getSettings.indexName - Name of the index on which to perform the operation.
|
|
2203
|
+
* @param getSettings.getVersion - When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
|
|
2204
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2205
|
+
* @see getSettings for the plain version.
|
|
2206
|
+
*/
|
|
2207
|
+
getSettingsWithHTTPInfo({ indexName, getVersion }, requestOptions) {
|
|
2208
|
+
(0, import_client_common.validateRequired)("indexName", "getSettingsWithHTTPInfo", indexName);
|
|
2209
|
+
const requestPath = "/1/indexes/{indexName}/settings".replace("{indexName}", encodeURIComponent(indexName));
|
|
2210
|
+
const headers = {};
|
|
2211
|
+
const queryParameters = {};
|
|
2212
|
+
if (getVersion !== void 0) {
|
|
2213
|
+
queryParameters["getVersion"] = getVersion.toString();
|
|
2214
|
+
}
|
|
2215
|
+
const request = {
|
|
2216
|
+
method: "GET",
|
|
2217
|
+
path: requestPath,
|
|
2218
|
+
queryParameters,
|
|
2219
|
+
headers
|
|
2220
|
+
};
|
|
2221
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2222
|
+
},
|
|
2223
|
+
/**
|
|
2224
|
+
* Retrieves all allowed IP addresses with access to your application.
|
|
2225
|
+
*
|
|
2226
|
+
* Required API Key ACLs:
|
|
2227
|
+
* - admin
|
|
2228
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2229
|
+
*/
|
|
2230
|
+
getSources(requestOptions) {
|
|
2231
|
+
const requestPath = "/1/security/sources";
|
|
2232
|
+
const headers = {};
|
|
2233
|
+
const queryParameters = {};
|
|
2234
|
+
const request = {
|
|
2235
|
+
method: "GET",
|
|
2236
|
+
path: requestPath,
|
|
2237
|
+
queryParameters,
|
|
2238
|
+
headers
|
|
2239
|
+
};
|
|
2240
|
+
return transporter.request(request, requestOptions);
|
|
2241
|
+
},
|
|
2242
|
+
/**
|
|
2243
|
+
* Retrieves all allowed IP addresses with access to your application.
|
|
2244
|
+
*
|
|
2245
|
+
* 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.
|
|
2246
|
+
*
|
|
2247
|
+
* Required API Key ACLs:
|
|
2248
|
+
* - admin
|
|
2249
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2250
|
+
* @see getSources for the plain version.
|
|
2251
|
+
*/
|
|
2252
|
+
getSourcesWithHTTPInfo(requestOptions) {
|
|
2253
|
+
const requestPath = "/1/security/sources";
|
|
2254
|
+
const headers = {};
|
|
2255
|
+
const queryParameters = {};
|
|
2256
|
+
const request = {
|
|
2257
|
+
method: "GET",
|
|
2258
|
+
path: requestPath,
|
|
2259
|
+
queryParameters,
|
|
2260
|
+
headers
|
|
2261
|
+
};
|
|
2262
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2263
|
+
},
|
|
2264
|
+
/**
|
|
2265
|
+
* 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).
|
|
2266
|
+
*
|
|
2267
|
+
* Required API Key ACLs:
|
|
2268
|
+
* - settings
|
|
2269
|
+
* @param getSynonym - The getSynonym object.
|
|
2270
|
+
* @param getSynonym.indexName - Name of the index on which to perform the operation.
|
|
2271
|
+
* @param getSynonym.objectID - Unique identifier of a synonym object.
|
|
2272
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2273
|
+
*/
|
|
2274
|
+
getSynonym({ indexName, objectID }, requestOptions) {
|
|
2275
|
+
(0, import_client_common.validateRequired)("indexName", "getSynonym", indexName);
|
|
2276
|
+
(0, import_client_common.validateRequired)("objectID", "getSynonym", objectID);
|
|
2277
|
+
const requestPath = "/1/indexes/{indexName}/synonyms/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
2278
|
+
const headers = {};
|
|
2279
|
+
const queryParameters = {};
|
|
2280
|
+
const request = {
|
|
2281
|
+
method: "GET",
|
|
2282
|
+
path: requestPath,
|
|
2283
|
+
queryParameters,
|
|
2284
|
+
headers
|
|
2285
|
+
};
|
|
2286
|
+
return transporter.request(request, requestOptions);
|
|
2287
|
+
},
|
|
2288
|
+
/**
|
|
2289
|
+
* 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).
|
|
2290
|
+
*
|
|
2291
|
+
* 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.
|
|
2292
|
+
*
|
|
2293
|
+
* Required API Key ACLs:
|
|
2294
|
+
* - settings
|
|
2295
|
+
* @param getSynonym - The getSynonym object.
|
|
2296
|
+
* @param getSynonym.indexName - Name of the index on which to perform the operation.
|
|
2297
|
+
* @param getSynonym.objectID - Unique identifier of a synonym object.
|
|
2298
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2299
|
+
* @see getSynonym for the plain version.
|
|
2300
|
+
*/
|
|
2301
|
+
getSynonymWithHTTPInfo({ indexName, objectID }, requestOptions) {
|
|
2302
|
+
(0, import_client_common.validateRequired)("indexName", "getSynonymWithHTTPInfo", indexName);
|
|
2303
|
+
(0, import_client_common.validateRequired)("objectID", "getSynonymWithHTTPInfo", objectID);
|
|
2304
|
+
const requestPath = "/1/indexes/{indexName}/synonyms/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
2305
|
+
const headers = {};
|
|
2306
|
+
const queryParameters = {};
|
|
2307
|
+
const request = {
|
|
2308
|
+
method: "GET",
|
|
2309
|
+
path: requestPath,
|
|
2310
|
+
queryParameters,
|
|
2311
|
+
headers
|
|
2312
|
+
};
|
|
2313
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2314
|
+
},
|
|
2315
|
+
/**
|
|
2316
|
+
* 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.
|
|
2317
|
+
*
|
|
2318
|
+
* Required API Key ACLs:
|
|
2319
|
+
* - addObject
|
|
2320
|
+
* @param getTask - The getTask object.
|
|
2321
|
+
* @param getTask.indexName - Name of the index on which to perform the operation.
|
|
2322
|
+
* @param getTask.taskID - Unique task identifier.
|
|
2323
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1307
2324
|
*/
|
|
1308
|
-
|
|
1309
|
-
(0, import_client_common.validateRequired)("indexName", "
|
|
1310
|
-
(0, import_client_common.validateRequired)("
|
|
1311
|
-
const requestPath = "/1/indexes/{indexName}/
|
|
2325
|
+
getTask({ indexName, taskID }, requestOptions) {
|
|
2326
|
+
(0, import_client_common.validateRequired)("indexName", "getTask", indexName);
|
|
2327
|
+
(0, import_client_common.validateRequired)("taskID", "getTask", taskID);
|
|
2328
|
+
const requestPath = "/1/indexes/{indexName}/task/{taskID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{taskID}", encodeURIComponent(taskID));
|
|
1312
2329
|
const headers = {};
|
|
1313
2330
|
const queryParameters = {};
|
|
1314
2331
|
const request = {
|
|
@@ -1320,40 +2337,43 @@ function createSearchClient({
|
|
|
1320
2337
|
return transporter.request(request, requestOptions);
|
|
1321
2338
|
},
|
|
1322
2339
|
/**
|
|
1323
|
-
*
|
|
2340
|
+
* 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.
|
|
2341
|
+
*
|
|
2342
|
+
* 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.
|
|
1324
2343
|
*
|
|
1325
2344
|
* Required API Key ACLs:
|
|
1326
|
-
* -
|
|
1327
|
-
* @param
|
|
1328
|
-
* @param
|
|
1329
|
-
* @param
|
|
2345
|
+
* - addObject
|
|
2346
|
+
* @param getTask - The getTask object.
|
|
2347
|
+
* @param getTask.indexName - Name of the index on which to perform the operation.
|
|
2348
|
+
* @param getTask.taskID - Unique task identifier.
|
|
1330
2349
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2350
|
+
* @see getTask for the plain version.
|
|
1331
2351
|
*/
|
|
1332
|
-
|
|
1333
|
-
(0, import_client_common.validateRequired)("indexName", "
|
|
1334
|
-
|
|
2352
|
+
getTaskWithHTTPInfo({ indexName, taskID }, requestOptions) {
|
|
2353
|
+
(0, import_client_common.validateRequired)("indexName", "getTaskWithHTTPInfo", indexName);
|
|
2354
|
+
(0, import_client_common.validateRequired)("taskID", "getTaskWithHTTPInfo", taskID);
|
|
2355
|
+
const requestPath = "/1/indexes/{indexName}/task/{taskID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{taskID}", encodeURIComponent(taskID));
|
|
1335
2356
|
const headers = {};
|
|
1336
2357
|
const queryParameters = {};
|
|
1337
|
-
if (getVersion !== void 0) {
|
|
1338
|
-
queryParameters["getVersion"] = getVersion.toString();
|
|
1339
|
-
}
|
|
1340
2358
|
const request = {
|
|
1341
2359
|
method: "GET",
|
|
1342
2360
|
path: requestPath,
|
|
1343
2361
|
queryParameters,
|
|
1344
2362
|
headers
|
|
1345
2363
|
};
|
|
1346
|
-
return transporter.
|
|
2364
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1347
2365
|
},
|
|
1348
2366
|
/**
|
|
1349
|
-
*
|
|
2367
|
+
* 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.
|
|
1350
2368
|
*
|
|
1351
2369
|
* Required API Key ACLs:
|
|
1352
2370
|
* - admin
|
|
2371
|
+
*
|
|
2372
|
+
* @deprecated
|
|
1353
2373
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1354
2374
|
*/
|
|
1355
|
-
|
|
1356
|
-
const requestPath = "/1/
|
|
2375
|
+
getTopUserIds(requestOptions) {
|
|
2376
|
+
const requestPath = "/1/clusters/mapping/top";
|
|
1357
2377
|
const headers = {};
|
|
1358
2378
|
const queryParameters = {};
|
|
1359
2379
|
const request = {
|
|
@@ -1365,19 +2385,19 @@ function createSearchClient({
|
|
|
1365
2385
|
return transporter.request(request, requestOptions);
|
|
1366
2386
|
},
|
|
1367
2387
|
/**
|
|
1368
|
-
*
|
|
2388
|
+
* 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.
|
|
2389
|
+
*
|
|
2390
|
+
* 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.
|
|
1369
2391
|
*
|
|
1370
2392
|
* Required API Key ACLs:
|
|
1371
|
-
* -
|
|
1372
|
-
*
|
|
1373
|
-
* @
|
|
1374
|
-
* @param getSynonym.objectID - Unique identifier of a synonym object.
|
|
2393
|
+
* - admin
|
|
2394
|
+
*
|
|
2395
|
+
* @deprecated
|
|
1375
2396
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2397
|
+
* @see getTopUserIds for the plain version.
|
|
1376
2398
|
*/
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
(0, import_client_common.validateRequired)("objectID", "getSynonym", objectID);
|
|
1380
|
-
const requestPath = "/1/indexes/{indexName}/synonyms/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
2399
|
+
getTopUserIdsWithHTTPInfo(requestOptions) {
|
|
2400
|
+
const requestPath = "/1/clusters/mapping/top";
|
|
1381
2401
|
const headers = {};
|
|
1382
2402
|
const queryParameters = {};
|
|
1383
2403
|
const request = {
|
|
@@ -1386,22 +2406,22 @@ function createSearchClient({
|
|
|
1386
2406
|
queryParameters,
|
|
1387
2407
|
headers
|
|
1388
2408
|
};
|
|
1389
|
-
return transporter.
|
|
2409
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1390
2410
|
},
|
|
1391
2411
|
/**
|
|
1392
|
-
*
|
|
2412
|
+
* 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.
|
|
1393
2413
|
*
|
|
1394
2414
|
* Required API Key ACLs:
|
|
1395
|
-
* -
|
|
1396
|
-
*
|
|
1397
|
-
* @
|
|
1398
|
-
* @param
|
|
2415
|
+
* - admin
|
|
2416
|
+
*
|
|
2417
|
+
* @deprecated
|
|
2418
|
+
* @param getUserId - The getUserId object.
|
|
2419
|
+
* @param getUserId.userID - Unique identifier of the user who makes the search request.
|
|
1399
2420
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1400
2421
|
*/
|
|
1401
|
-
|
|
1402
|
-
(0, import_client_common.validateRequired)("
|
|
1403
|
-
|
|
1404
|
-
const requestPath = "/1/indexes/{indexName}/task/{taskID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{taskID}", encodeURIComponent(taskID));
|
|
2422
|
+
getUserId({ userID }, requestOptions) {
|
|
2423
|
+
(0, import_client_common.validateRequired)("userID", "getUserId", userID);
|
|
2424
|
+
const requestPath = "/1/clusters/mapping/{userID}".replace("{userID}", encodeURIComponent(userID));
|
|
1405
2425
|
const headers = {};
|
|
1406
2426
|
const queryParameters = {};
|
|
1407
2427
|
const request = {
|
|
@@ -1413,16 +2433,22 @@ function createSearchClient({
|
|
|
1413
2433
|
return transporter.request(request, requestOptions);
|
|
1414
2434
|
},
|
|
1415
2435
|
/**
|
|
1416
|
-
*
|
|
2436
|
+
* 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.
|
|
2437
|
+
*
|
|
2438
|
+
* 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.
|
|
1417
2439
|
*
|
|
1418
2440
|
* Required API Key ACLs:
|
|
1419
2441
|
* - admin
|
|
1420
2442
|
*
|
|
1421
2443
|
* @deprecated
|
|
2444
|
+
* @param getUserId - The getUserId object.
|
|
2445
|
+
* @param getUserId.userID - Unique identifier of the user who makes the search request.
|
|
1422
2446
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2447
|
+
* @see getUserId for the plain version.
|
|
1423
2448
|
*/
|
|
1424
|
-
|
|
1425
|
-
|
|
2449
|
+
getUserIdWithHTTPInfo({ userID }, requestOptions) {
|
|
2450
|
+
(0, import_client_common.validateRequired)("userID", "getUserIdWithHTTPInfo", userID);
|
|
2451
|
+
const requestPath = "/1/clusters/mapping/{userID}".replace("{userID}", encodeURIComponent(userID));
|
|
1426
2452
|
const headers = {};
|
|
1427
2453
|
const queryParameters = {};
|
|
1428
2454
|
const request = {
|
|
@@ -1431,24 +2457,26 @@ function createSearchClient({
|
|
|
1431
2457
|
queryParameters,
|
|
1432
2458
|
headers
|
|
1433
2459
|
};
|
|
1434
|
-
return transporter.
|
|
2460
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1435
2461
|
},
|
|
1436
2462
|
/**
|
|
1437
|
-
*
|
|
2463
|
+
* 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.
|
|
1438
2464
|
*
|
|
1439
2465
|
* Required API Key ACLs:
|
|
1440
2466
|
* - admin
|
|
1441
2467
|
*
|
|
1442
2468
|
* @deprecated
|
|
1443
|
-
* @param
|
|
1444
|
-
* @param
|
|
2469
|
+
* @param hasPendingMappings - The hasPendingMappings object.
|
|
2470
|
+
* @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
|
|
1445
2471
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1446
2472
|
*/
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
const requestPath = "/1/clusters/mapping/{userID}".replace("{userID}", encodeURIComponent(userID));
|
|
2473
|
+
hasPendingMappings({ getClusters } = {}, requestOptions = void 0) {
|
|
2474
|
+
const requestPath = "/1/clusters/mapping/pending";
|
|
1450
2475
|
const headers = {};
|
|
1451
2476
|
const queryParameters = {};
|
|
2477
|
+
if (getClusters !== void 0) {
|
|
2478
|
+
queryParameters["getClusters"] = getClusters.toString();
|
|
2479
|
+
}
|
|
1452
2480
|
const request = {
|
|
1453
2481
|
method: "GET",
|
|
1454
2482
|
path: requestPath,
|
|
@@ -1460,6 +2488,8 @@ function createSearchClient({
|
|
|
1460
2488
|
/**
|
|
1461
2489
|
* 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.
|
|
1462
2490
|
*
|
|
2491
|
+
* 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.
|
|
2492
|
+
*
|
|
1463
2493
|
* Required API Key ACLs:
|
|
1464
2494
|
* - admin
|
|
1465
2495
|
*
|
|
@@ -1467,8 +2497,9 @@ function createSearchClient({
|
|
|
1467
2497
|
* @param hasPendingMappings - The hasPendingMappings object.
|
|
1468
2498
|
* @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
|
|
1469
2499
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2500
|
+
* @see hasPendingMappings for the plain version.
|
|
1470
2501
|
*/
|
|
1471
|
-
|
|
2502
|
+
hasPendingMappingsWithHTTPInfo({ getClusters } = {}, requestOptions = void 0) {
|
|
1472
2503
|
const requestPath = "/1/clusters/mapping/pending";
|
|
1473
2504
|
const headers = {};
|
|
1474
2505
|
const queryParameters = {};
|
|
@@ -1481,7 +2512,7 @@ function createSearchClient({
|
|
|
1481
2512
|
queryParameters,
|
|
1482
2513
|
headers
|
|
1483
2514
|
};
|
|
1484
|
-
return transporter.
|
|
2515
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1485
2516
|
},
|
|
1486
2517
|
/**
|
|
1487
2518
|
* Lists all API keys associated with your Algolia application, including their permissions and restrictions.
|
|
@@ -1502,6 +2533,28 @@ function createSearchClient({
|
|
|
1502
2533
|
};
|
|
1503
2534
|
return transporter.request(request, requestOptions);
|
|
1504
2535
|
},
|
|
2536
|
+
/**
|
|
2537
|
+
* Lists all API keys associated with your Algolia application, including their permissions and restrictions.
|
|
2538
|
+
*
|
|
2539
|
+
* 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.
|
|
2540
|
+
*
|
|
2541
|
+
* Required API Key ACLs:
|
|
2542
|
+
* - admin
|
|
2543
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2544
|
+
* @see listApiKeys for the plain version.
|
|
2545
|
+
*/
|
|
2546
|
+
listApiKeysWithHTTPInfo(requestOptions) {
|
|
2547
|
+
const requestPath = "/1/keys";
|
|
2548
|
+
const headers = {};
|
|
2549
|
+
const queryParameters = {};
|
|
2550
|
+
const request = {
|
|
2551
|
+
method: "GET",
|
|
2552
|
+
path: requestPath,
|
|
2553
|
+
queryParameters,
|
|
2554
|
+
headers
|
|
2555
|
+
};
|
|
2556
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2557
|
+
},
|
|
1505
2558
|
/**
|
|
1506
2559
|
* Lists the available clusters in a multi-cluster setup.
|
|
1507
2560
|
*
|
|
@@ -1523,6 +2576,30 @@ function createSearchClient({
|
|
|
1523
2576
|
};
|
|
1524
2577
|
return transporter.request(request, requestOptions);
|
|
1525
2578
|
},
|
|
2579
|
+
/**
|
|
2580
|
+
* Lists the available clusters in a multi-cluster setup.
|
|
2581
|
+
*
|
|
2582
|
+
* 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.
|
|
2583
|
+
*
|
|
2584
|
+
* Required API Key ACLs:
|
|
2585
|
+
* - admin
|
|
2586
|
+
*
|
|
2587
|
+
* @deprecated
|
|
2588
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2589
|
+
* @see listClusters for the plain version.
|
|
2590
|
+
*/
|
|
2591
|
+
listClustersWithHTTPInfo(requestOptions) {
|
|
2592
|
+
const requestPath = "/1/clusters";
|
|
2593
|
+
const headers = {};
|
|
2594
|
+
const queryParameters = {};
|
|
2595
|
+
const request = {
|
|
2596
|
+
method: "GET",
|
|
2597
|
+
path: requestPath,
|
|
2598
|
+
queryParameters,
|
|
2599
|
+
headers
|
|
2600
|
+
};
|
|
2601
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2602
|
+
},
|
|
1526
2603
|
/**
|
|
1527
2604
|
* Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
|
|
1528
2605
|
*
|
|
@@ -1551,6 +2628,37 @@ function createSearchClient({
|
|
|
1551
2628
|
};
|
|
1552
2629
|
return transporter.request(request, requestOptions);
|
|
1553
2630
|
},
|
|
2631
|
+
/**
|
|
2632
|
+
* Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
|
|
2633
|
+
*
|
|
2634
|
+
* 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.
|
|
2635
|
+
*
|
|
2636
|
+
* Required API Key ACLs:
|
|
2637
|
+
* - listIndexes
|
|
2638
|
+
* @param listIndices - The listIndices object.
|
|
2639
|
+
* @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
|
|
2640
|
+
* @param listIndices.hitsPerPage - Number of hits per page.
|
|
2641
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2642
|
+
* @see listIndices for the plain version.
|
|
2643
|
+
*/
|
|
2644
|
+
listIndicesWithHTTPInfo({ page, hitsPerPage } = {}, requestOptions = void 0) {
|
|
2645
|
+
const requestPath = "/1/indexes";
|
|
2646
|
+
const headers = {};
|
|
2647
|
+
const queryParameters = {};
|
|
2648
|
+
if (page !== void 0) {
|
|
2649
|
+
queryParameters["page"] = page.toString();
|
|
2650
|
+
}
|
|
2651
|
+
if (hitsPerPage !== void 0) {
|
|
2652
|
+
queryParameters["hitsPerPage"] = hitsPerPage.toString();
|
|
2653
|
+
}
|
|
2654
|
+
const request = {
|
|
2655
|
+
method: "GET",
|
|
2656
|
+
path: requestPath,
|
|
2657
|
+
queryParameters,
|
|
2658
|
+
headers
|
|
2659
|
+
};
|
|
2660
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2661
|
+
},
|
|
1554
2662
|
/**
|
|
1555
2663
|
* 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.
|
|
1556
2664
|
*
|
|
@@ -1581,6 +2689,39 @@ function createSearchClient({
|
|
|
1581
2689
|
};
|
|
1582
2690
|
return transporter.request(request, requestOptions);
|
|
1583
2691
|
},
|
|
2692
|
+
/**
|
|
2693
|
+
* 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.
|
|
2694
|
+
*
|
|
2695
|
+
* 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.
|
|
2696
|
+
*
|
|
2697
|
+
* Required API Key ACLs:
|
|
2698
|
+
* - admin
|
|
2699
|
+
*
|
|
2700
|
+
* @deprecated
|
|
2701
|
+
* @param listUserIds - The listUserIds object.
|
|
2702
|
+
* @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
|
|
2703
|
+
* @param listUserIds.hitsPerPage - Number of hits per page.
|
|
2704
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2705
|
+
* @see listUserIds for the plain version.
|
|
2706
|
+
*/
|
|
2707
|
+
listUserIdsWithHTTPInfo({ page, hitsPerPage } = {}, requestOptions = void 0) {
|
|
2708
|
+
const requestPath = "/1/clusters/mapping";
|
|
2709
|
+
const headers = {};
|
|
2710
|
+
const queryParameters = {};
|
|
2711
|
+
if (page !== void 0) {
|
|
2712
|
+
queryParameters["page"] = page.toString();
|
|
2713
|
+
}
|
|
2714
|
+
if (hitsPerPage !== void 0) {
|
|
2715
|
+
queryParameters["hitsPerPage"] = hitsPerPage.toString();
|
|
2716
|
+
}
|
|
2717
|
+
const request = {
|
|
2718
|
+
method: "GET",
|
|
2719
|
+
path: requestPath,
|
|
2720
|
+
queryParameters,
|
|
2721
|
+
headers
|
|
2722
|
+
};
|
|
2723
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2724
|
+
},
|
|
1584
2725
|
/**
|
|
1585
2726
|
* 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).
|
|
1586
2727
|
*
|
|
@@ -1604,6 +2745,32 @@ function createSearchClient({
|
|
|
1604
2745
|
};
|
|
1605
2746
|
return transporter.request(request, requestOptions);
|
|
1606
2747
|
},
|
|
2748
|
+
/**
|
|
2749
|
+
* 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).
|
|
2750
|
+
*
|
|
2751
|
+
* 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.
|
|
2752
|
+
*
|
|
2753
|
+
* Required API Key ACLs:
|
|
2754
|
+
* - addObject
|
|
2755
|
+
* @param batchParams - The batchParams object.
|
|
2756
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2757
|
+
* @see multipleBatch for the plain version.
|
|
2758
|
+
*/
|
|
2759
|
+
multipleBatchWithHTTPInfo(batchParams, requestOptions) {
|
|
2760
|
+
(0, import_client_common.validateRequired)("batchParams", "multipleBatchWithHTTPInfo", batchParams);
|
|
2761
|
+
(0, import_client_common.validateRequired)("batchParams.requests", "multipleBatchWithHTTPInfo", batchParams.requests);
|
|
2762
|
+
const requestPath = "/1/indexes/*/batch";
|
|
2763
|
+
const headers = {};
|
|
2764
|
+
const queryParameters = {};
|
|
2765
|
+
const request = {
|
|
2766
|
+
method: "POST",
|
|
2767
|
+
path: requestPath,
|
|
2768
|
+
queryParameters,
|
|
2769
|
+
headers,
|
|
2770
|
+
data: batchParams
|
|
2771
|
+
};
|
|
2772
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2773
|
+
},
|
|
1607
2774
|
/**
|
|
1608
2775
|
* 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).
|
|
1609
2776
|
*
|
|
@@ -1627,13 +2794,80 @@ function createSearchClient({
|
|
|
1627
2794
|
path: requestPath,
|
|
1628
2795
|
queryParameters,
|
|
1629
2796
|
headers,
|
|
1630
|
-
data: operationIndexParams
|
|
2797
|
+
data: operationIndexParams
|
|
2798
|
+
};
|
|
2799
|
+
return transporter.request(request, requestOptions);
|
|
2800
|
+
},
|
|
2801
|
+
/**
|
|
2802
|
+
* 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).
|
|
2803
|
+
*
|
|
2804
|
+
* 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.
|
|
2805
|
+
*
|
|
2806
|
+
* Required API Key ACLs:
|
|
2807
|
+
* - addObject
|
|
2808
|
+
* @param operationIndex - The operationIndex object.
|
|
2809
|
+
* @param operationIndex.indexName - Name of the index on which to perform the operation.
|
|
2810
|
+
* @param operationIndex.operationIndexParams - The operationIndexParams object.
|
|
2811
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2812
|
+
* @see operationIndex for the plain version.
|
|
2813
|
+
*/
|
|
2814
|
+
operationIndexWithHTTPInfo({ indexName, operationIndexParams }, requestOptions) {
|
|
2815
|
+
(0, import_client_common.validateRequired)("indexName", "operationIndexWithHTTPInfo", indexName);
|
|
2816
|
+
(0, import_client_common.validateRequired)("operationIndexParams", "operationIndexWithHTTPInfo", operationIndexParams);
|
|
2817
|
+
(0, import_client_common.validateRequired)("operationIndexParams.operation", "operationIndexWithHTTPInfo", operationIndexParams.operation);
|
|
2818
|
+
(0, import_client_common.validateRequired)(
|
|
2819
|
+
"operationIndexParams.destination",
|
|
2820
|
+
"operationIndexWithHTTPInfo",
|
|
2821
|
+
operationIndexParams.destination
|
|
2822
|
+
);
|
|
2823
|
+
const requestPath = "/1/indexes/{indexName}/operation".replace("{indexName}", encodeURIComponent(indexName));
|
|
2824
|
+
const headers = {};
|
|
2825
|
+
const queryParameters = {};
|
|
2826
|
+
const request = {
|
|
2827
|
+
method: "POST",
|
|
2828
|
+
path: requestPath,
|
|
2829
|
+
queryParameters,
|
|
2830
|
+
headers,
|
|
2831
|
+
data: operationIndexParams
|
|
2832
|
+
};
|
|
2833
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2834
|
+
},
|
|
2835
|
+
/**
|
|
2836
|
+
* 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).
|
|
2837
|
+
*
|
|
2838
|
+
* Required API Key ACLs:
|
|
2839
|
+
* - addObject
|
|
2840
|
+
* @param partialUpdateObject - The partialUpdateObject object.
|
|
2841
|
+
* @param partialUpdateObject.indexName - Name of the index on which to perform the operation.
|
|
2842
|
+
* @param partialUpdateObject.objectID - Unique record identifier.
|
|
2843
|
+
* @param partialUpdateObject.attributesToUpdate - Attributes with their values.
|
|
2844
|
+
* @param partialUpdateObject.createIfNotExists - Whether to create a new record if it doesn\'t exist.
|
|
2845
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2846
|
+
*/
|
|
2847
|
+
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists }, requestOptions) {
|
|
2848
|
+
(0, import_client_common.validateRequired)("indexName", "partialUpdateObject", indexName);
|
|
2849
|
+
(0, import_client_common.validateRequired)("objectID", "partialUpdateObject", objectID);
|
|
2850
|
+
(0, import_client_common.validateRequired)("attributesToUpdate", "partialUpdateObject", attributesToUpdate);
|
|
2851
|
+
const requestPath = "/1/indexes/{indexName}/{objectID}/partial".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
2852
|
+
const headers = {};
|
|
2853
|
+
const queryParameters = {};
|
|
2854
|
+
if (createIfNotExists !== void 0) {
|
|
2855
|
+
queryParameters["createIfNotExists"] = createIfNotExists.toString();
|
|
2856
|
+
}
|
|
2857
|
+
const request = {
|
|
2858
|
+
method: "POST",
|
|
2859
|
+
path: requestPath,
|
|
2860
|
+
queryParameters,
|
|
2861
|
+
headers,
|
|
2862
|
+
data: attributesToUpdate
|
|
1631
2863
|
};
|
|
1632
2864
|
return transporter.request(request, requestOptions);
|
|
1633
2865
|
},
|
|
1634
2866
|
/**
|
|
1635
2867
|
* 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).
|
|
1636
2868
|
*
|
|
2869
|
+
* 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.
|
|
2870
|
+
*
|
|
1637
2871
|
* Required API Key ACLs:
|
|
1638
2872
|
* - addObject
|
|
1639
2873
|
* @param partialUpdateObject - The partialUpdateObject object.
|
|
@@ -1642,11 +2876,12 @@ function createSearchClient({
|
|
|
1642
2876
|
* @param partialUpdateObject.attributesToUpdate - Attributes with their values.
|
|
1643
2877
|
* @param partialUpdateObject.createIfNotExists - Whether to create a new record if it doesn\'t exist.
|
|
1644
2878
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2879
|
+
* @see partialUpdateObject for the plain version.
|
|
1645
2880
|
*/
|
|
1646
|
-
|
|
1647
|
-
(0, import_client_common.validateRequired)("indexName", "
|
|
1648
|
-
(0, import_client_common.validateRequired)("objectID", "
|
|
1649
|
-
(0, import_client_common.validateRequired)("attributesToUpdate", "
|
|
2881
|
+
partialUpdateObjectWithHTTPInfo({ indexName, objectID, attributesToUpdate, createIfNotExists }, requestOptions) {
|
|
2882
|
+
(0, import_client_common.validateRequired)("indexName", "partialUpdateObjectWithHTTPInfo", indexName);
|
|
2883
|
+
(0, import_client_common.validateRequired)("objectID", "partialUpdateObjectWithHTTPInfo", objectID);
|
|
2884
|
+
(0, import_client_common.validateRequired)("attributesToUpdate", "partialUpdateObjectWithHTTPInfo", attributesToUpdate);
|
|
1650
2885
|
const requestPath = "/1/indexes/{indexName}/{objectID}/partial".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
1651
2886
|
const headers = {};
|
|
1652
2887
|
const queryParameters = {};
|
|
@@ -1660,7 +2895,7 @@ function createSearchClient({
|
|
|
1660
2895
|
headers,
|
|
1661
2896
|
data: attributesToUpdate
|
|
1662
2897
|
};
|
|
1663
|
-
return transporter.
|
|
2898
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1664
2899
|
},
|
|
1665
2900
|
/**
|
|
1666
2901
|
* Deletes a user ID and its associated data from the clusters.
|
|
@@ -1686,6 +2921,33 @@ function createSearchClient({
|
|
|
1686
2921
|
};
|
|
1687
2922
|
return transporter.request(request, requestOptions);
|
|
1688
2923
|
},
|
|
2924
|
+
/**
|
|
2925
|
+
* Deletes a user ID and its associated data from the clusters.
|
|
2926
|
+
*
|
|
2927
|
+
* 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.
|
|
2928
|
+
*
|
|
2929
|
+
* Required API Key ACLs:
|
|
2930
|
+
* - admin
|
|
2931
|
+
*
|
|
2932
|
+
* @deprecated
|
|
2933
|
+
* @param removeUserId - The removeUserId object.
|
|
2934
|
+
* @param removeUserId.userID - Unique identifier of the user who makes the search request.
|
|
2935
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2936
|
+
* @see removeUserId for the plain version.
|
|
2937
|
+
*/
|
|
2938
|
+
removeUserIdWithHTTPInfo({ userID }, requestOptions) {
|
|
2939
|
+
(0, import_client_common.validateRequired)("userID", "removeUserIdWithHTTPInfo", userID);
|
|
2940
|
+
const requestPath = "/1/clusters/mapping/{userID}".replace("{userID}", encodeURIComponent(userID));
|
|
2941
|
+
const headers = {};
|
|
2942
|
+
const queryParameters = {};
|
|
2943
|
+
const request = {
|
|
2944
|
+
method: "DELETE",
|
|
2945
|
+
path: requestPath,
|
|
2946
|
+
queryParameters,
|
|
2947
|
+
headers
|
|
2948
|
+
};
|
|
2949
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2950
|
+
},
|
|
1689
2951
|
/**
|
|
1690
2952
|
* Replaces the list of allowed sources.
|
|
1691
2953
|
*
|
|
@@ -1709,6 +2971,32 @@ function createSearchClient({
|
|
|
1709
2971
|
};
|
|
1710
2972
|
return transporter.request(request, requestOptions);
|
|
1711
2973
|
},
|
|
2974
|
+
/**
|
|
2975
|
+
* Replaces the list of allowed sources.
|
|
2976
|
+
*
|
|
2977
|
+
* 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.
|
|
2978
|
+
*
|
|
2979
|
+
* Required API Key ACLs:
|
|
2980
|
+
* - admin
|
|
2981
|
+
* @param replaceSources - The replaceSources object.
|
|
2982
|
+
* @param replaceSources.source - Allowed sources.
|
|
2983
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2984
|
+
* @see replaceSources for the plain version.
|
|
2985
|
+
*/
|
|
2986
|
+
replaceSourcesWithHTTPInfo({ source }, requestOptions) {
|
|
2987
|
+
(0, import_client_common.validateRequired)("source", "replaceSourcesWithHTTPInfo", source);
|
|
2988
|
+
const requestPath = "/1/security/sources";
|
|
2989
|
+
const headers = {};
|
|
2990
|
+
const queryParameters = {};
|
|
2991
|
+
const request = {
|
|
2992
|
+
method: "PUT",
|
|
2993
|
+
path: requestPath,
|
|
2994
|
+
queryParameters,
|
|
2995
|
+
headers,
|
|
2996
|
+
data: source
|
|
2997
|
+
};
|
|
2998
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2999
|
+
},
|
|
1712
3000
|
/**
|
|
1713
3001
|
* 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.
|
|
1714
3002
|
*
|
|
@@ -1731,6 +3019,31 @@ function createSearchClient({
|
|
|
1731
3019
|
};
|
|
1732
3020
|
return transporter.request(request, requestOptions);
|
|
1733
3021
|
},
|
|
3022
|
+
/**
|
|
3023
|
+
* 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.
|
|
3024
|
+
*
|
|
3025
|
+
* 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.
|
|
3026
|
+
*
|
|
3027
|
+
* Required API Key ACLs:
|
|
3028
|
+
* - admin
|
|
3029
|
+
* @param restoreApiKey - The restoreApiKey object.
|
|
3030
|
+
* @param restoreApiKey.key - API key.
|
|
3031
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3032
|
+
* @see restoreApiKey for the plain version.
|
|
3033
|
+
*/
|
|
3034
|
+
restoreApiKeyWithHTTPInfo({ key }, requestOptions) {
|
|
3035
|
+
(0, import_client_common.validateRequired)("key", "restoreApiKeyWithHTTPInfo", key);
|
|
3036
|
+
const requestPath = "/1/keys/{key}/restore".replace("{key}", encodeURIComponent(key));
|
|
3037
|
+
const headers = {};
|
|
3038
|
+
const queryParameters = {};
|
|
3039
|
+
const request = {
|
|
3040
|
+
method: "POST",
|
|
3041
|
+
path: requestPath,
|
|
3042
|
+
queryParameters,
|
|
3043
|
+
headers
|
|
3044
|
+
};
|
|
3045
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3046
|
+
},
|
|
1734
3047
|
/**
|
|
1735
3048
|
* 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).
|
|
1736
3049
|
*
|
|
@@ -1756,6 +3069,34 @@ function createSearchClient({
|
|
|
1756
3069
|
};
|
|
1757
3070
|
return transporter.request(request, requestOptions);
|
|
1758
3071
|
},
|
|
3072
|
+
/**
|
|
3073
|
+
* 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).
|
|
3074
|
+
*
|
|
3075
|
+
* 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.
|
|
3076
|
+
*
|
|
3077
|
+
* Required API Key ACLs:
|
|
3078
|
+
* - addObject
|
|
3079
|
+
* @param saveObject - The saveObject object.
|
|
3080
|
+
* @param saveObject.indexName - Name of the index on which to perform the operation.
|
|
3081
|
+
* @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
|
|
3082
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3083
|
+
* @see saveObject for the plain version.
|
|
3084
|
+
*/
|
|
3085
|
+
saveObjectWithHTTPInfo({ indexName, body }, requestOptions) {
|
|
3086
|
+
(0, import_client_common.validateRequired)("indexName", "saveObjectWithHTTPInfo", indexName);
|
|
3087
|
+
(0, import_client_common.validateRequired)("body", "saveObjectWithHTTPInfo", body);
|
|
3088
|
+
const requestPath = "/1/indexes/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
|
|
3089
|
+
const headers = {};
|
|
3090
|
+
const queryParameters = {};
|
|
3091
|
+
const request = {
|
|
3092
|
+
method: "POST",
|
|
3093
|
+
path: requestPath,
|
|
3094
|
+
queryParameters,
|
|
3095
|
+
headers,
|
|
3096
|
+
data: body
|
|
3097
|
+
};
|
|
3098
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3099
|
+
},
|
|
1759
3100
|
/**
|
|
1760
3101
|
* 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).
|
|
1761
3102
|
*
|
|
@@ -1789,6 +3130,42 @@ function createSearchClient({
|
|
|
1789
3130
|
};
|
|
1790
3131
|
return transporter.request(request, requestOptions);
|
|
1791
3132
|
},
|
|
3133
|
+
/**
|
|
3134
|
+
* 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).
|
|
3135
|
+
*
|
|
3136
|
+
* 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.
|
|
3137
|
+
*
|
|
3138
|
+
* Required API Key ACLs:
|
|
3139
|
+
* - editSettings
|
|
3140
|
+
* @param saveRule - The saveRule object.
|
|
3141
|
+
* @param saveRule.indexName - Name of the index on which to perform the operation.
|
|
3142
|
+
* @param saveRule.objectID - Unique identifier of a rule object.
|
|
3143
|
+
* @param saveRule.rule - The rule object.
|
|
3144
|
+
* @param saveRule.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3145
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3146
|
+
* @see saveRule for the plain version.
|
|
3147
|
+
*/
|
|
3148
|
+
saveRuleWithHTTPInfo({ indexName, objectID, rule, forwardToReplicas }, requestOptions) {
|
|
3149
|
+
(0, import_client_common.validateRequired)("indexName", "saveRuleWithHTTPInfo", indexName);
|
|
3150
|
+
(0, import_client_common.validateRequired)("objectID", "saveRuleWithHTTPInfo", objectID);
|
|
3151
|
+
(0, import_client_common.validateRequired)("rule", "saveRuleWithHTTPInfo", rule);
|
|
3152
|
+
(0, import_client_common.validateRequired)("rule.objectID", "saveRuleWithHTTPInfo", rule.objectID);
|
|
3153
|
+
(0, import_client_common.validateRequired)("rule.consequence", "saveRuleWithHTTPInfo", rule.consequence);
|
|
3154
|
+
const requestPath = "/1/indexes/{indexName}/rules/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
3155
|
+
const headers = {};
|
|
3156
|
+
const queryParameters = {};
|
|
3157
|
+
if (forwardToReplicas !== void 0) {
|
|
3158
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
3159
|
+
}
|
|
3160
|
+
const request = {
|
|
3161
|
+
method: "PUT",
|
|
3162
|
+
path: requestPath,
|
|
3163
|
+
queryParameters,
|
|
3164
|
+
headers,
|
|
3165
|
+
data: rule
|
|
3166
|
+
};
|
|
3167
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3168
|
+
},
|
|
1792
3169
|
/**
|
|
1793
3170
|
* 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).
|
|
1794
3171
|
*
|
|
@@ -1822,6 +3199,42 @@ function createSearchClient({
|
|
|
1822
3199
|
};
|
|
1823
3200
|
return transporter.request(request, requestOptions);
|
|
1824
3201
|
},
|
|
3202
|
+
/**
|
|
3203
|
+
* 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).
|
|
3204
|
+
*
|
|
3205
|
+
* 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.
|
|
3206
|
+
*
|
|
3207
|
+
* Required API Key ACLs:
|
|
3208
|
+
* - editSettings
|
|
3209
|
+
* @param saveRules - The saveRules object.
|
|
3210
|
+
* @param saveRules.indexName - Name of the index on which to perform the operation.
|
|
3211
|
+
* @param saveRules.rules - The rules object.
|
|
3212
|
+
* @param saveRules.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3213
|
+
* @param saveRules.clearExistingRules - Whether existing rules should be deleted before adding this batch.
|
|
3214
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3215
|
+
* @see saveRules for the plain version.
|
|
3216
|
+
*/
|
|
3217
|
+
saveRulesWithHTTPInfo({ indexName, rules, forwardToReplicas, clearExistingRules }, requestOptions) {
|
|
3218
|
+
(0, import_client_common.validateRequired)("indexName", "saveRulesWithHTTPInfo", indexName);
|
|
3219
|
+
(0, import_client_common.validateRequired)("rules", "saveRulesWithHTTPInfo", rules);
|
|
3220
|
+
const requestPath = "/1/indexes/{indexName}/rules/batch".replace("{indexName}", encodeURIComponent(indexName));
|
|
3221
|
+
const headers = {};
|
|
3222
|
+
const queryParameters = {};
|
|
3223
|
+
if (forwardToReplicas !== void 0) {
|
|
3224
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
3225
|
+
}
|
|
3226
|
+
if (clearExistingRules !== void 0) {
|
|
3227
|
+
queryParameters["clearExistingRules"] = clearExistingRules.toString();
|
|
3228
|
+
}
|
|
3229
|
+
const request = {
|
|
3230
|
+
method: "POST",
|
|
3231
|
+
path: requestPath,
|
|
3232
|
+
queryParameters,
|
|
3233
|
+
headers,
|
|
3234
|
+
data: rules
|
|
3235
|
+
};
|
|
3236
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3237
|
+
},
|
|
1825
3238
|
/**
|
|
1826
3239
|
* 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).
|
|
1827
3240
|
*
|
|
@@ -1855,6 +3268,42 @@ function createSearchClient({
|
|
|
1855
3268
|
};
|
|
1856
3269
|
return transporter.request(request, requestOptions);
|
|
1857
3270
|
},
|
|
3271
|
+
/**
|
|
3272
|
+
* 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).
|
|
3273
|
+
*
|
|
3274
|
+
* 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.
|
|
3275
|
+
*
|
|
3276
|
+
* Required API Key ACLs:
|
|
3277
|
+
* - editSettings
|
|
3278
|
+
* @param saveSynonym - The saveSynonym object.
|
|
3279
|
+
* @param saveSynonym.indexName - Name of the index on which to perform the operation.
|
|
3280
|
+
* @param saveSynonym.objectID - Unique identifier of a synonym object.
|
|
3281
|
+
* @param saveSynonym.synonymHit - The synonymHit object.
|
|
3282
|
+
* @param saveSynonym.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3283
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3284
|
+
* @see saveSynonym for the plain version.
|
|
3285
|
+
*/
|
|
3286
|
+
saveSynonymWithHTTPInfo({ indexName, objectID, synonymHit, forwardToReplicas }, requestOptions) {
|
|
3287
|
+
(0, import_client_common.validateRequired)("indexName", "saveSynonymWithHTTPInfo", indexName);
|
|
3288
|
+
(0, import_client_common.validateRequired)("objectID", "saveSynonymWithHTTPInfo", objectID);
|
|
3289
|
+
(0, import_client_common.validateRequired)("synonymHit", "saveSynonymWithHTTPInfo", synonymHit);
|
|
3290
|
+
(0, import_client_common.validateRequired)("synonymHit.objectID", "saveSynonymWithHTTPInfo", synonymHit.objectID);
|
|
3291
|
+
(0, import_client_common.validateRequired)("synonymHit.type", "saveSynonymWithHTTPInfo", synonymHit.type);
|
|
3292
|
+
const requestPath = "/1/indexes/{indexName}/synonyms/{objectID}".replace("{indexName}", encodeURIComponent(indexName)).replace("{objectID}", encodeURIComponent(objectID));
|
|
3293
|
+
const headers = {};
|
|
3294
|
+
const queryParameters = {};
|
|
3295
|
+
if (forwardToReplicas !== void 0) {
|
|
3296
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
3297
|
+
}
|
|
3298
|
+
const request = {
|
|
3299
|
+
method: "PUT",
|
|
3300
|
+
path: requestPath,
|
|
3301
|
+
queryParameters,
|
|
3302
|
+
headers,
|
|
3303
|
+
data: synonymHit
|
|
3304
|
+
};
|
|
3305
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3306
|
+
},
|
|
1858
3307
|
/**
|
|
1859
3308
|
* 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).
|
|
1860
3309
|
*
|
|
@@ -1873,30 +3322,115 @@ function createSearchClient({
|
|
|
1873
3322
|
const requestPath = "/1/indexes/{indexName}/synonyms/batch".replace("{indexName}", encodeURIComponent(indexName));
|
|
1874
3323
|
const headers = {};
|
|
1875
3324
|
const queryParameters = {};
|
|
1876
|
-
if (forwardToReplicas !== void 0) {
|
|
1877
|
-
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
1878
|
-
}
|
|
1879
|
-
if (replaceExistingSynonyms !== void 0) {
|
|
1880
|
-
queryParameters["replaceExistingSynonyms"] = replaceExistingSynonyms.toString();
|
|
1881
|
-
}
|
|
3325
|
+
if (forwardToReplicas !== void 0) {
|
|
3326
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
3327
|
+
}
|
|
3328
|
+
if (replaceExistingSynonyms !== void 0) {
|
|
3329
|
+
queryParameters["replaceExistingSynonyms"] = replaceExistingSynonyms.toString();
|
|
3330
|
+
}
|
|
3331
|
+
const request = {
|
|
3332
|
+
method: "POST",
|
|
3333
|
+
path: requestPath,
|
|
3334
|
+
queryParameters,
|
|
3335
|
+
headers,
|
|
3336
|
+
data: synonymHit
|
|
3337
|
+
};
|
|
3338
|
+
return transporter.request(request, requestOptions);
|
|
3339
|
+
},
|
|
3340
|
+
/**
|
|
3341
|
+
* 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).
|
|
3342
|
+
*
|
|
3343
|
+
* 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.
|
|
3344
|
+
*
|
|
3345
|
+
* Required API Key ACLs:
|
|
3346
|
+
* - editSettings
|
|
3347
|
+
* @param saveSynonyms - The saveSynonyms object.
|
|
3348
|
+
* @param saveSynonyms.indexName - Name of the index on which to perform the operation.
|
|
3349
|
+
* @param saveSynonyms.synonymHit - The synonymHit object.
|
|
3350
|
+
* @param saveSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3351
|
+
* @param saveSynonyms.replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request.
|
|
3352
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3353
|
+
* @see saveSynonyms for the plain version.
|
|
3354
|
+
*/
|
|
3355
|
+
saveSynonymsWithHTTPInfo({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }, requestOptions) {
|
|
3356
|
+
(0, import_client_common.validateRequired)("indexName", "saveSynonymsWithHTTPInfo", indexName);
|
|
3357
|
+
(0, import_client_common.validateRequired)("synonymHit", "saveSynonymsWithHTTPInfo", synonymHit);
|
|
3358
|
+
const requestPath = "/1/indexes/{indexName}/synonyms/batch".replace("{indexName}", encodeURIComponent(indexName));
|
|
3359
|
+
const headers = {};
|
|
3360
|
+
const queryParameters = {};
|
|
3361
|
+
if (forwardToReplicas !== void 0) {
|
|
3362
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
3363
|
+
}
|
|
3364
|
+
if (replaceExistingSynonyms !== void 0) {
|
|
3365
|
+
queryParameters["replaceExistingSynonyms"] = replaceExistingSynonyms.toString();
|
|
3366
|
+
}
|
|
3367
|
+
const request = {
|
|
3368
|
+
method: "POST",
|
|
3369
|
+
path: requestPath,
|
|
3370
|
+
queryParameters,
|
|
3371
|
+
headers,
|
|
3372
|
+
data: synonymHit
|
|
3373
|
+
};
|
|
3374
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3375
|
+
},
|
|
3376
|
+
/**
|
|
3377
|
+
* 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.
|
|
3378
|
+
*
|
|
3379
|
+
* Required API Key ACLs:
|
|
3380
|
+
* - search
|
|
3381
|
+
* @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
|
|
3382
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3383
|
+
*/
|
|
3384
|
+
search(searchMethodParams, requestOptions) {
|
|
3385
|
+
if (searchMethodParams && Array.isArray(searchMethodParams)) {
|
|
3386
|
+
const newSignatureRequest = {
|
|
3387
|
+
requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
|
|
3388
|
+
if (legacyRequest.type === "facet") {
|
|
3389
|
+
return {
|
|
3390
|
+
...legacyRequest,
|
|
3391
|
+
...params,
|
|
3392
|
+
type: "facet"
|
|
3393
|
+
};
|
|
3394
|
+
}
|
|
3395
|
+
return {
|
|
3396
|
+
...legacyRequest,
|
|
3397
|
+
...params,
|
|
3398
|
+
facet: void 0,
|
|
3399
|
+
maxFacetHits: void 0,
|
|
3400
|
+
facetQuery: void 0
|
|
3401
|
+
};
|
|
3402
|
+
})
|
|
3403
|
+
};
|
|
3404
|
+
searchMethodParams = newSignatureRequest;
|
|
3405
|
+
}
|
|
3406
|
+
(0, import_client_common.validateRequired)("searchMethodParams", "search", searchMethodParams);
|
|
3407
|
+
(0, import_client_common.validateRequired)("searchMethodParams.requests", "search", searchMethodParams.requests);
|
|
3408
|
+
const requestPath = "/1/indexes/*/queries";
|
|
3409
|
+
const headers = {};
|
|
3410
|
+
const queryParameters = {};
|
|
1882
3411
|
const request = {
|
|
1883
3412
|
method: "POST",
|
|
1884
3413
|
path: requestPath,
|
|
1885
3414
|
queryParameters,
|
|
1886
3415
|
headers,
|
|
1887
|
-
data:
|
|
3416
|
+
data: searchMethodParams,
|
|
3417
|
+
useReadTransporter: true,
|
|
3418
|
+
cacheable: true
|
|
1888
3419
|
};
|
|
1889
3420
|
return transporter.request(request, requestOptions);
|
|
1890
3421
|
},
|
|
1891
3422
|
/**
|
|
1892
3423
|
* 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.
|
|
1893
3424
|
*
|
|
3425
|
+
* 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.
|
|
3426
|
+
*
|
|
1894
3427
|
* Required API Key ACLs:
|
|
1895
3428
|
* - search
|
|
1896
3429
|
* @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
|
|
1897
3430
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3431
|
+
* @see search for the plain version.
|
|
1898
3432
|
*/
|
|
1899
|
-
|
|
3433
|
+
searchWithHTTPInfo(searchMethodParams, requestOptions) {
|
|
1900
3434
|
if (searchMethodParams && Array.isArray(searchMethodParams)) {
|
|
1901
3435
|
const newSignatureRequest = {
|
|
1902
3436
|
requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
|
|
@@ -1918,8 +3452,8 @@ function createSearchClient({
|
|
|
1918
3452
|
};
|
|
1919
3453
|
searchMethodParams = newSignatureRequest;
|
|
1920
3454
|
}
|
|
1921
|
-
(0, import_client_common.validateRequired)("searchMethodParams", "
|
|
1922
|
-
(0, import_client_common.validateRequired)("searchMethodParams.requests", "
|
|
3455
|
+
(0, import_client_common.validateRequired)("searchMethodParams", "searchWithHTTPInfo", searchMethodParams);
|
|
3456
|
+
(0, import_client_common.validateRequired)("searchMethodParams.requests", "searchWithHTTPInfo", searchMethodParams.requests);
|
|
1923
3457
|
const requestPath = "/1/indexes/*/queries";
|
|
1924
3458
|
const headers = {};
|
|
1925
3459
|
const queryParameters = {};
|
|
@@ -1932,7 +3466,7 @@ function createSearchClient({
|
|
|
1932
3466
|
useReadTransporter: true,
|
|
1933
3467
|
cacheable: true
|
|
1934
3468
|
};
|
|
1935
|
-
return transporter.
|
|
3469
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1936
3470
|
},
|
|
1937
3471
|
/**
|
|
1938
3472
|
* Searches for standard and custom dictionary entries.
|
|
@@ -1969,6 +3503,48 @@ function createSearchClient({
|
|
|
1969
3503
|
};
|
|
1970
3504
|
return transporter.request(request, requestOptions);
|
|
1971
3505
|
},
|
|
3506
|
+
/**
|
|
3507
|
+
* Searches for standard and custom dictionary entries.
|
|
3508
|
+
*
|
|
3509
|
+
* 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.
|
|
3510
|
+
*
|
|
3511
|
+
* Required API Key ACLs:
|
|
3512
|
+
* - settings
|
|
3513
|
+
* @param searchDictionaryEntries - The searchDictionaryEntries object.
|
|
3514
|
+
* @param searchDictionaryEntries.dictionaryName - Dictionary type in which to search.
|
|
3515
|
+
* @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
|
|
3516
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3517
|
+
* @see searchDictionaryEntries for the plain version.
|
|
3518
|
+
*/
|
|
3519
|
+
searchDictionaryEntriesWithHTTPInfo({ dictionaryName, searchDictionaryEntriesParams }, requestOptions) {
|
|
3520
|
+
(0, import_client_common.validateRequired)("dictionaryName", "searchDictionaryEntriesWithHTTPInfo", dictionaryName);
|
|
3521
|
+
(0, import_client_common.validateRequired)(
|
|
3522
|
+
"searchDictionaryEntriesParams",
|
|
3523
|
+
"searchDictionaryEntriesWithHTTPInfo",
|
|
3524
|
+
searchDictionaryEntriesParams
|
|
3525
|
+
);
|
|
3526
|
+
(0, import_client_common.validateRequired)(
|
|
3527
|
+
"searchDictionaryEntriesParams.query",
|
|
3528
|
+
"searchDictionaryEntriesWithHTTPInfo",
|
|
3529
|
+
searchDictionaryEntriesParams.query
|
|
3530
|
+
);
|
|
3531
|
+
const requestPath = "/1/dictionaries/{dictionaryName}/search".replace(
|
|
3532
|
+
"{dictionaryName}",
|
|
3533
|
+
encodeURIComponent(dictionaryName)
|
|
3534
|
+
);
|
|
3535
|
+
const headers = {};
|
|
3536
|
+
const queryParameters = {};
|
|
3537
|
+
const request = {
|
|
3538
|
+
method: "POST",
|
|
3539
|
+
path: requestPath,
|
|
3540
|
+
queryParameters,
|
|
3541
|
+
headers,
|
|
3542
|
+
data: searchDictionaryEntriesParams,
|
|
3543
|
+
useReadTransporter: true,
|
|
3544
|
+
cacheable: true
|
|
3545
|
+
};
|
|
3546
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3547
|
+
},
|
|
1972
3548
|
/**
|
|
1973
3549
|
* 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**.
|
|
1974
3550
|
*
|
|
@@ -1997,6 +3573,37 @@ function createSearchClient({
|
|
|
1997
3573
|
};
|
|
1998
3574
|
return transporter.request(request, requestOptions);
|
|
1999
3575
|
},
|
|
3576
|
+
/**
|
|
3577
|
+
* 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**.
|
|
3578
|
+
*
|
|
3579
|
+
* 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.
|
|
3580
|
+
*
|
|
3581
|
+
* Required API Key ACLs:
|
|
3582
|
+
* - search
|
|
3583
|
+
* @param searchForFacetValues - The searchForFacetValues object.
|
|
3584
|
+
* @param searchForFacetValues.indexName - Name of the index on which to perform the operation.
|
|
3585
|
+
* @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.
|
|
3586
|
+
* @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
|
|
3587
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3588
|
+
* @see searchForFacetValues for the plain version.
|
|
3589
|
+
*/
|
|
3590
|
+
searchForFacetValuesWithHTTPInfo({ indexName, facetName, searchForFacetValuesRequest }, requestOptions) {
|
|
3591
|
+
(0, import_client_common.validateRequired)("indexName", "searchForFacetValuesWithHTTPInfo", indexName);
|
|
3592
|
+
(0, import_client_common.validateRequired)("facetName", "searchForFacetValuesWithHTTPInfo", facetName);
|
|
3593
|
+
const requestPath = "/1/indexes/{indexName}/facets/{facetName}/query".replace("{indexName}", encodeURIComponent(indexName)).replace("{facetName}", encodeURIComponent(facetName));
|
|
3594
|
+
const headers = {};
|
|
3595
|
+
const queryParameters = {};
|
|
3596
|
+
const request = {
|
|
3597
|
+
method: "POST",
|
|
3598
|
+
path: requestPath,
|
|
3599
|
+
queryParameters,
|
|
3600
|
+
headers,
|
|
3601
|
+
data: searchForFacetValuesRequest ? searchForFacetValuesRequest : {},
|
|
3602
|
+
useReadTransporter: true,
|
|
3603
|
+
cacheable: true
|
|
3604
|
+
};
|
|
3605
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3606
|
+
},
|
|
2000
3607
|
/**
|
|
2001
3608
|
* Searches for rules in your index.
|
|
2002
3609
|
*
|
|
@@ -2023,6 +3630,35 @@ function createSearchClient({
|
|
|
2023
3630
|
};
|
|
2024
3631
|
return transporter.request(request, requestOptions);
|
|
2025
3632
|
},
|
|
3633
|
+
/**
|
|
3634
|
+
* Searches for rules in your index.
|
|
3635
|
+
*
|
|
3636
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3637
|
+
*
|
|
3638
|
+
* Required API Key ACLs:
|
|
3639
|
+
* - settings
|
|
3640
|
+
* @param searchRules - The searchRules object.
|
|
3641
|
+
* @param searchRules.indexName - Name of the index on which to perform the operation.
|
|
3642
|
+
* @param searchRules.searchRulesParams - The searchRulesParams object.
|
|
3643
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3644
|
+
* @see searchRules for the plain version.
|
|
3645
|
+
*/
|
|
3646
|
+
searchRulesWithHTTPInfo({ indexName, searchRulesParams }, requestOptions) {
|
|
3647
|
+
(0, import_client_common.validateRequired)("indexName", "searchRulesWithHTTPInfo", indexName);
|
|
3648
|
+
const requestPath = "/1/indexes/{indexName}/rules/search".replace("{indexName}", encodeURIComponent(indexName));
|
|
3649
|
+
const headers = {};
|
|
3650
|
+
const queryParameters = {};
|
|
3651
|
+
const request = {
|
|
3652
|
+
method: "POST",
|
|
3653
|
+
path: requestPath,
|
|
3654
|
+
queryParameters,
|
|
3655
|
+
headers,
|
|
3656
|
+
data: searchRulesParams ? searchRulesParams : {},
|
|
3657
|
+
useReadTransporter: true,
|
|
3658
|
+
cacheable: true
|
|
3659
|
+
};
|
|
3660
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3661
|
+
},
|
|
2026
3662
|
/**
|
|
2027
3663
|
* 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.
|
|
2028
3664
|
*
|
|
@@ -2049,6 +3685,35 @@ function createSearchClient({
|
|
|
2049
3685
|
};
|
|
2050
3686
|
return transporter.request(request, requestOptions);
|
|
2051
3687
|
},
|
|
3688
|
+
/**
|
|
3689
|
+
* 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.
|
|
3690
|
+
*
|
|
3691
|
+
* 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.
|
|
3692
|
+
*
|
|
3693
|
+
* Required API Key ACLs:
|
|
3694
|
+
* - search
|
|
3695
|
+
* @param searchSingleIndex - The searchSingleIndex object.
|
|
3696
|
+
* @param searchSingleIndex.indexName - Name of the index on which to perform the operation.
|
|
3697
|
+
* @param searchSingleIndex.searchParams - The searchParams object.
|
|
3698
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3699
|
+
* @see searchSingleIndex for the plain version.
|
|
3700
|
+
*/
|
|
3701
|
+
searchSingleIndexWithHTTPInfo({ indexName, searchParams }, requestOptions) {
|
|
3702
|
+
(0, import_client_common.validateRequired)("indexName", "searchSingleIndexWithHTTPInfo", indexName);
|
|
3703
|
+
const requestPath = "/1/indexes/{indexName}/query".replace("{indexName}", encodeURIComponent(indexName));
|
|
3704
|
+
const headers = {};
|
|
3705
|
+
const queryParameters = {};
|
|
3706
|
+
const request = {
|
|
3707
|
+
method: "POST",
|
|
3708
|
+
path: requestPath,
|
|
3709
|
+
queryParameters,
|
|
3710
|
+
headers,
|
|
3711
|
+
data: searchParams ? searchParams : {},
|
|
3712
|
+
useReadTransporter: true,
|
|
3713
|
+
cacheable: true
|
|
3714
|
+
};
|
|
3715
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3716
|
+
},
|
|
2052
3717
|
/**
|
|
2053
3718
|
* Searches for synonyms in your index.
|
|
2054
3719
|
*
|
|
@@ -2078,6 +3743,38 @@ function createSearchClient({
|
|
|
2078
3743
|
};
|
|
2079
3744
|
return transporter.request(request, requestOptions);
|
|
2080
3745
|
},
|
|
3746
|
+
/**
|
|
3747
|
+
* Searches for synonyms in your index.
|
|
3748
|
+
*
|
|
3749
|
+
* 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.
|
|
3750
|
+
*
|
|
3751
|
+
* Required API Key ACLs:
|
|
3752
|
+
* - settings
|
|
3753
|
+
* @param searchSynonyms - The searchSynonyms object.
|
|
3754
|
+
* @param searchSynonyms.indexName - Name of the index on which to perform the operation.
|
|
3755
|
+
* @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
|
|
3756
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3757
|
+
* @see searchSynonyms for the plain version.
|
|
3758
|
+
*/
|
|
3759
|
+
searchSynonymsWithHTTPInfo({ indexName, searchSynonymsParams }, requestOptions) {
|
|
3760
|
+
(0, import_client_common.validateRequired)("indexName", "searchSynonymsWithHTTPInfo", indexName);
|
|
3761
|
+
const requestPath = "/1/indexes/{indexName}/synonyms/search".replace(
|
|
3762
|
+
"{indexName}",
|
|
3763
|
+
encodeURIComponent(indexName)
|
|
3764
|
+
);
|
|
3765
|
+
const headers = {};
|
|
3766
|
+
const queryParameters = {};
|
|
3767
|
+
const request = {
|
|
3768
|
+
method: "POST",
|
|
3769
|
+
path: requestPath,
|
|
3770
|
+
queryParameters,
|
|
3771
|
+
headers,
|
|
3772
|
+
data: searchSynonymsParams ? searchSynonymsParams : {},
|
|
3773
|
+
useReadTransporter: true,
|
|
3774
|
+
cacheable: true
|
|
3775
|
+
};
|
|
3776
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3777
|
+
},
|
|
2081
3778
|
/**
|
|
2082
3779
|
* 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).
|
|
2083
3780
|
*
|
|
@@ -2105,6 +3802,36 @@ function createSearchClient({
|
|
|
2105
3802
|
};
|
|
2106
3803
|
return transporter.request(request, requestOptions);
|
|
2107
3804
|
},
|
|
3805
|
+
/**
|
|
3806
|
+
* 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).
|
|
3807
|
+
*
|
|
3808
|
+
* 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.
|
|
3809
|
+
*
|
|
3810
|
+
* Required API Key ACLs:
|
|
3811
|
+
* - admin
|
|
3812
|
+
*
|
|
3813
|
+
* @deprecated
|
|
3814
|
+
* @param searchUserIdsParams - The searchUserIdsParams object.
|
|
3815
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3816
|
+
* @see searchUserIds for the plain version.
|
|
3817
|
+
*/
|
|
3818
|
+
searchUserIdsWithHTTPInfo(searchUserIdsParams, requestOptions) {
|
|
3819
|
+
(0, import_client_common.validateRequired)("searchUserIdsParams", "searchUserIdsWithHTTPInfo", searchUserIdsParams);
|
|
3820
|
+
(0, import_client_common.validateRequired)("searchUserIdsParams.query", "searchUserIdsWithHTTPInfo", searchUserIdsParams.query);
|
|
3821
|
+
const requestPath = "/1/clusters/mapping/search";
|
|
3822
|
+
const headers = {};
|
|
3823
|
+
const queryParameters = {};
|
|
3824
|
+
const request = {
|
|
3825
|
+
method: "POST",
|
|
3826
|
+
path: requestPath,
|
|
3827
|
+
queryParameters,
|
|
3828
|
+
headers,
|
|
3829
|
+
data: searchUserIdsParams,
|
|
3830
|
+
useReadTransporter: true,
|
|
3831
|
+
cacheable: true
|
|
3832
|
+
};
|
|
3833
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3834
|
+
},
|
|
2108
3835
|
/**
|
|
2109
3836
|
* Turns standard stop word dictionary entries on or off for a given language.
|
|
2110
3837
|
*
|
|
@@ -2132,6 +3859,36 @@ function createSearchClient({
|
|
|
2132
3859
|
};
|
|
2133
3860
|
return transporter.request(request, requestOptions);
|
|
2134
3861
|
},
|
|
3862
|
+
/**
|
|
3863
|
+
* Turns standard stop word dictionary entries on or off for a given language.
|
|
3864
|
+
*
|
|
3865
|
+
* 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.
|
|
3866
|
+
*
|
|
3867
|
+
* Required API Key ACLs:
|
|
3868
|
+
* - editSettings
|
|
3869
|
+
* @param dictionarySettingsParams - The dictionarySettingsParams object.
|
|
3870
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3871
|
+
* @see setDictionarySettings for the plain version.
|
|
3872
|
+
*/
|
|
3873
|
+
setDictionarySettingsWithHTTPInfo(dictionarySettingsParams, requestOptions) {
|
|
3874
|
+
(0, import_client_common.validateRequired)("dictionarySettingsParams", "setDictionarySettingsWithHTTPInfo", dictionarySettingsParams);
|
|
3875
|
+
(0, import_client_common.validateRequired)(
|
|
3876
|
+
"dictionarySettingsParams.disableStandardEntries",
|
|
3877
|
+
"setDictionarySettingsWithHTTPInfo",
|
|
3878
|
+
dictionarySettingsParams.disableStandardEntries
|
|
3879
|
+
);
|
|
3880
|
+
const requestPath = "/1/dictionaries/*/settings";
|
|
3881
|
+
const headers = {};
|
|
3882
|
+
const queryParameters = {};
|
|
3883
|
+
const request = {
|
|
3884
|
+
method: "PUT",
|
|
3885
|
+
path: requestPath,
|
|
3886
|
+
queryParameters,
|
|
3887
|
+
headers,
|
|
3888
|
+
data: dictionarySettingsParams
|
|
3889
|
+
};
|
|
3890
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3891
|
+
},
|
|
2135
3892
|
/**
|
|
2136
3893
|
* 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.
|
|
2137
3894
|
*
|
|
@@ -2161,6 +3918,38 @@ function createSearchClient({
|
|
|
2161
3918
|
};
|
|
2162
3919
|
return transporter.request(request, requestOptions);
|
|
2163
3920
|
},
|
|
3921
|
+
/**
|
|
3922
|
+
* 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.
|
|
3923
|
+
*
|
|
3924
|
+
* 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.
|
|
3925
|
+
*
|
|
3926
|
+
* Required API Key ACLs:
|
|
3927
|
+
* - editSettings
|
|
3928
|
+
* @param setSettings - The setSettings object.
|
|
3929
|
+
* @param setSettings.indexName - Name of the index on which to perform the operation.
|
|
3930
|
+
* @param setSettings.indexSettings - The indexSettings object.
|
|
3931
|
+
* @param setSettings.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3932
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3933
|
+
* @see setSettings for the plain version.
|
|
3934
|
+
*/
|
|
3935
|
+
setSettingsWithHTTPInfo({ indexName, indexSettings, forwardToReplicas }, requestOptions) {
|
|
3936
|
+
(0, import_client_common.validateRequired)("indexName", "setSettingsWithHTTPInfo", indexName);
|
|
3937
|
+
(0, import_client_common.validateRequired)("indexSettings", "setSettingsWithHTTPInfo", indexSettings);
|
|
3938
|
+
const requestPath = "/1/indexes/{indexName}/settings".replace("{indexName}", encodeURIComponent(indexName));
|
|
3939
|
+
const headers = {};
|
|
3940
|
+
const queryParameters = {};
|
|
3941
|
+
if (forwardToReplicas !== void 0) {
|
|
3942
|
+
queryParameters["forwardToReplicas"] = forwardToReplicas.toString();
|
|
3943
|
+
}
|
|
3944
|
+
const request = {
|
|
3945
|
+
method: "PUT",
|
|
3946
|
+
path: requestPath,
|
|
3947
|
+
queryParameters,
|
|
3948
|
+
headers,
|
|
3949
|
+
data: indexSettings
|
|
3950
|
+
};
|
|
3951
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3952
|
+
},
|
|
2164
3953
|
/**
|
|
2165
3954
|
* Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
|
|
2166
3955
|
*
|
|
@@ -2186,6 +3975,35 @@ function createSearchClient({
|
|
|
2186
3975
|
data: apiKey
|
|
2187
3976
|
};
|
|
2188
3977
|
return transporter.request(request, requestOptions);
|
|
3978
|
+
},
|
|
3979
|
+
/**
|
|
3980
|
+
* Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
|
|
3981
|
+
*
|
|
3982
|
+
* 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.
|
|
3983
|
+
*
|
|
3984
|
+
* Required API Key ACLs:
|
|
3985
|
+
* - admin
|
|
3986
|
+
* @param updateApiKey - The updateApiKey object.
|
|
3987
|
+
* @param updateApiKey.key - API key.
|
|
3988
|
+
* @param updateApiKey.apiKey - The apiKey object.
|
|
3989
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3990
|
+
* @see updateApiKey for the plain version.
|
|
3991
|
+
*/
|
|
3992
|
+
updateApiKeyWithHTTPInfo({ key, apiKey }, requestOptions) {
|
|
3993
|
+
(0, import_client_common.validateRequired)("key", "updateApiKeyWithHTTPInfo", key);
|
|
3994
|
+
(0, import_client_common.validateRequired)("apiKey", "updateApiKeyWithHTTPInfo", apiKey);
|
|
3995
|
+
(0, import_client_common.validateRequired)("apiKey.acl", "updateApiKeyWithHTTPInfo", apiKey.acl);
|
|
3996
|
+
const requestPath = "/1/keys/{key}".replace("{key}", encodeURIComponent(key));
|
|
3997
|
+
const headers = {};
|
|
3998
|
+
const queryParameters = {};
|
|
3999
|
+
const request = {
|
|
4000
|
+
method: "PUT",
|
|
4001
|
+
path: requestPath,
|
|
4002
|
+
queryParameters,
|
|
4003
|
+
headers,
|
|
4004
|
+
data: apiKey
|
|
4005
|
+
};
|
|
4006
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2189
4007
|
}
|
|
2190
4008
|
};
|
|
2191
4009
|
}
|