algolia 3.0.0.alpha.12 → 3.0.0.alpha.13
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.openapi-generator/FILES +1 -0
- data/CHANGELOG.md +6 -0
- data/Gemfile.lock +4 -4
- data/lib/algolia/api/abtesting_client.rb +8 -4
- data/lib/algolia/api/analytics_client.rb +146 -282
- data/lib/algolia/api/ingestion_client.rb +4 -4
- data/lib/algolia/api/insights_client.rb +7 -7
- data/lib/algolia/api/recommend_client.rb +12 -12
- data/lib/algolia/api/search_client.rb +242 -242
- data/lib/algolia/models/abtesting/ab_test_response.rb +1 -1
- data/lib/algolia/models/analytics/search_no_result_event.rb +1 -1
- data/lib/algolia/models/analytics/top_search.rb +1 -1
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +1 -1
- data/lib/algolia/models/ingestion/action_type.rb +2 -1
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +223 -0
- data/lib/algolia/models/ingestion/source_input.rb +1 -0
- data/lib/algolia/models/ingestion/source_type.rb +2 -1
- data/lib/algolia/models/ingestion/source_update_input.rb +1 -0
- data/lib/algolia/models/ingestion/streaming_trigger.rb +221 -0
- data/lib/algolia/models/ingestion/streaming_trigger_type.rb +32 -0
- data/lib/algolia/models/ingestion/streaming_utils_input.rb +199 -0
- data/lib/algolia/models/ingestion/task_create_trigger.rb +1 -0
- data/lib/algolia/models/ingestion/task_input.rb +2 -1
- data/lib/algolia/models/ingestion/trigger.rb +1 -0
- data/lib/algolia/models/ingestion/trigger_type.rb +2 -1
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +6 -6
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +6 -6
- data/lib/algolia/models/insights/clicked_filters.rb +6 -6
- data/lib/algolia/models/insights/clicked_object_ids.rb +6 -6
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +7 -7
- data/lib/algolia/models/insights/converted_filters.rb +6 -6
- data/lib/algolia/models/insights/converted_object_ids.rb +6 -6
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +6 -6
- data/lib/algolia/models/insights/discount.rb +1 -1
- data/lib/algolia/models/insights/insights_events.rb +1 -1
- data/lib/algolia/models/insights/object_data.rb +1 -1
- data/lib/algolia/models/insights/object_data_after_search.rb +1 -1
- data/lib/algolia/models/insights/price.rb +1 -1
- data/lib/algolia/models/insights/purchased_object_ids.rb +6 -6
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +6 -6
- data/lib/algolia/models/insights/viewed_filters.rb +6 -6
- data/lib/algolia/models/insights/viewed_object_ids.rb +6 -6
- data/lib/algolia/models/recommend/around_precision.rb +1 -1
- data/lib/algolia/models/recommend/around_precision_from_value_inner.rb +3 -0
- data/lib/algolia/models/recommend/around_radius.rb +1 -1
- data/lib/algolia/models/recommend/automatic_facet_filter.rb +4 -4
- data/lib/algolia/models/recommend/automatic_facet_filters.rb +1 -1
- data/lib/algolia/models/recommend/base_recommend_request.rb +1 -1
- data/lib/algolia/models/recommend/base_recommendations_query.rb +1 -1
- data/lib/algolia/models/recommend/base_recommended_for_you_query_parameters.rb +1 -1
- data/lib/algolia/models/recommend/base_search_params.rb +58 -38
- data/lib/algolia/models/recommend/base_search_params_without_query.rb +57 -37
- data/lib/algolia/models/recommend/base_search_response.rb +20 -6
- data/lib/algolia/models/recommend/condition.rb +32 -7
- data/lib/algolia/models/recommend/consequence.rb +33 -5
- data/lib/algolia/models/recommend/consequence_hide.rb +2 -2
- data/lib/algolia/models/recommend/consequence_params.rb +101 -79
- data/lib/algolia/models/recommend/consequence_query.rb +1 -1
- data/lib/algolia/models/recommend/consequence_query_object.rb +2 -2
- data/lib/algolia/models/recommend/deleted_at_response.rb +1 -1
- data/lib/algolia/models/recommend/distinct.rb +1 -1
- data/lib/algolia/models/recommend/edit.rb +1 -1
- data/lib/algolia/models/recommend/facet_filters.rb +1 -1
- data/lib/algolia/models/recommend/facet_ordering.rb +2 -2
- data/lib/algolia/models/recommend/facets.rb +2 -2
- data/lib/algolia/models/recommend/highlight_result_option.rb +3 -3
- data/lib/algolia/models/recommend/ignore_plurals.rb +1 -1
- data/lib/algolia/models/recommend/index_settings_as_search_params.rb +46 -44
- data/lib/algolia/models/recommend/numeric_filters.rb +1 -1
- data/lib/algolia/models/recommend/optional_filters.rb +1 -1
- data/lib/algolia/models/recommend/params.rb +1 -1
- data/lib/algolia/models/recommend/promote_object_id.rb +2 -2
- data/lib/algolia/models/recommend/promote_object_ids.rb +16 -2
- data/lib/algolia/models/recommend/ranking_info.rb +120 -7
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +1 -1
- data/lib/algolia/models/recommend/recommend_hit.rb +3 -3
- data/lib/algolia/models/recommend/recommendations_hits.rb +1 -1
- data/lib/algolia/models/recommend/recommendations_query.rb +2 -2
- data/lib/algolia/models/recommend/recommendations_results.rb +21 -7
- data/lib/algolia/models/recommend/recommended_for_you_query.rb +1 -1
- data/lib/algolia/models/recommend/recommended_for_you_query_parameters.rb +102 -80
- data/lib/algolia/models/recommend/remove_stop_words.rb +1 -1
- data/lib/algolia/models/recommend/rendering_content.rb +1 -1
- data/lib/algolia/models/recommend/search_params_object.rb +102 -80
- data/lib/algolia/models/recommend/search_params_query.rb +1 -1
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -2
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +17 -3
- data/lib/algolia/models/recommend/semantic_search.rb +2 -2
- data/lib/algolia/models/recommend/snippet_result_option.rb +2 -2
- data/lib/algolia/models/recommend/tag_filters.rb +1 -1
- data/lib/algolia/models/recommend/trending_facets_query.rb +1 -1
- data/lib/algolia/models/recommend/trending_items_query.rb +1 -1
- data/lib/algolia/models/recommend/typo_tolerance.rb +1 -1
- data/lib/algolia/models/recommend/value.rb +1 -1
- data/lib/algolia/models/search/add_api_key_response.rb +1 -1
- data/lib/algolia/models/search/api_key.rb +8 -8
- data/lib/algolia/models/search/around_precision.rb +1 -1
- data/lib/algolia/models/search/around_precision_from_value_inner.rb +3 -0
- data/lib/algolia/models/search/around_radius.rb +1 -1
- data/lib/algolia/models/search/automatic_facet_filter.rb +4 -4
- data/lib/algolia/models/search/automatic_facet_filters.rb +1 -1
- data/lib/algolia/models/search/base_index_settings.rb +44 -18
- data/lib/algolia/models/search/base_search_params.rb +58 -38
- data/lib/algolia/models/search/base_search_params_without_query.rb +57 -37
- data/lib/algolia/models/search/base_search_response.rb +20 -6
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +3 -3
- data/lib/algolia/models/search/batch_response.rb +2 -2
- data/lib/algolia/models/search/browse_params_object.rb +103 -81
- data/lib/algolia/models/search/browse_response.rb +23 -8
- data/lib/algolia/models/search/built_in_operation.rb +2 -2
- data/lib/algolia/models/search/condition.rb +32 -7
- data/lib/algolia/models/search/consequence.rb +33 -5
- data/lib/algolia/models/search/consequence_hide.rb +2 -2
- data/lib/algolia/models/search/consequence_params.rb +101 -79
- data/lib/algolia/models/search/consequence_query.rb +1 -1
- data/lib/algolia/models/search/consequence_query_object.rb +2 -2
- data/lib/algolia/models/search/created_at_response.rb +1 -1
- data/lib/algolia/models/search/cursor.rb +1 -1
- data/lib/algolia/models/search/delete_by_params.rb +4 -4
- data/lib/algolia/models/search/deleted_at_response.rb +1 -1
- data/lib/algolia/models/search/dictionary_entry.rb +5 -5
- data/lib/algolia/models/search/dictionary_language.rb +2 -2
- data/lib/algolia/models/search/dictionary_settings_params.rb +1 -1
- data/lib/algolia/models/search/distinct.rb +1 -1
- data/lib/algolia/models/search/edit.rb +1 -1
- data/lib/algolia/models/search/facet_filters.rb +1 -1
- data/lib/algolia/models/search/facet_hits.rb +2 -2
- data/lib/algolia/models/search/facet_ordering.rb +2 -2
- data/lib/algolia/models/search/facets.rb +2 -2
- data/lib/algolia/models/search/get_api_key_response.rb +8 -8
- data/lib/algolia/models/search/get_objects_request.rb +3 -3
- data/lib/algolia/models/search/get_objects_response.rb +1 -1
- data/lib/algolia/models/search/has_pending_mappings_response.rb +1 -1
- data/lib/algolia/models/search/highlight_result_option.rb +3 -3
- data/lib/algolia/models/search/hit.rb +4 -4
- data/lib/algolia/models/search/ignore_plurals.rb +1 -1
- data/lib/algolia/models/search/index_settings.rb +89 -61
- data/lib/algolia/models/search/index_settings_as_search_params.rb +46 -44
- data/lib/algolia/models/search/log.rb +39 -11
- data/lib/algolia/models/search/log_query.rb +1 -1
- data/lib/algolia/models/search/multiple_batch_response.rb +2 -2
- data/lib/algolia/models/search/numeric_filters.rb +1 -1
- data/lib/algolia/models/search/operation_index_params.rb +2 -2
- data/lib/algolia/models/search/optional_filters.rb +1 -1
- data/lib/algolia/models/search/params.rb +1 -1
- data/lib/algolia/models/search/promote_object_id.rb +2 -2
- data/lib/algolia/models/search/promote_object_ids.rb +16 -2
- data/lib/algolia/models/search/ranking_info.rb +120 -7
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +1 -1
- data/lib/algolia/models/search/remove_stop_words.rb +1 -1
- data/lib/algolia/models/search/rendering_content.rb +1 -1
- data/lib/algolia/models/search/rule.rb +23 -5
- data/lib/algolia/models/search/save_object_response.rb +3 -3
- data/lib/algolia/models/search/save_synonym_response.rb +1 -1
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +18 -4
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +251 -0
- data/lib/algolia/models/search/search_for_facet_values_request.rb +1 -1
- data/lib/algolia/models/search/search_for_facet_values_response.rb +1 -0
- data/lib/algolia/models/search/search_for_facets.rb +103 -81
- data/lib/algolia/models/search/search_for_facets_options.rb +2 -2
- data/lib/algolia/models/search/search_for_hits.rb +103 -81
- data/lib/algolia/models/search/search_for_hits_options.rb +1 -1
- data/lib/algolia/models/search/search_hits.rb +2 -1
- data/lib/algolia/models/search/search_params_object.rb +102 -80
- data/lib/algolia/models/search/search_params_query.rb +1 -1
- data/lib/algolia/models/search/search_response.rb +22 -7
- data/lib/algolia/models/search/search_rules_params.rb +8 -20
- data/lib/algolia/models/search/search_rules_response.rb +2 -2
- data/lib/algolia/models/search/search_synonyms_params.rb +16 -2
- data/lib/algolia/models/search/search_synonyms_response.rb +2 -2
- data/lib/algolia/models/search/search_user_ids_params.rb +15 -1
- data/lib/algolia/models/search/search_user_ids_response.rb +16 -2
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +5 -5
- data/lib/algolia/models/search/semantic_search.rb +2 -2
- data/lib/algolia/models/search/snippet_result_option.rb +2 -2
- data/lib/algolia/models/search/tag_filters.rb +1 -1
- data/lib/algolia/models/search/time_range.rb +2 -2
- data/lib/algolia/models/search/typo_tolerance.rb +1 -1
- data/lib/algolia/models/search/updated_at_response.rb +1 -1
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +2 -2
- data/lib/algolia/models/search/updated_rule_response.rb +2 -2
- data/lib/algolia/models/search/user_hit.rb +1 -1
- data/lib/algolia/models/search/user_id.rb +1 -1
- data/lib/algolia/models/search/value.rb +1 -1
- data/lib/algolia/version.rb +1 -1
- metadata +7 -2
@@ -29,7 +29,7 @@ module Algolia
|
|
29
29
|
new(config)
|
30
30
|
end
|
31
31
|
|
32
|
-
#
|
32
|
+
# Creates a new API key with specific permissions and restrictions.
|
33
33
|
#
|
34
34
|
# Required API Key ACLs:
|
35
35
|
# - admin
|
@@ -61,7 +61,7 @@ module Algolia
|
|
61
61
|
@api_client.call_api(:POST, path, new_options)
|
62
62
|
end
|
63
63
|
|
64
|
-
#
|
64
|
+
# Creates a new API key with specific permissions and restrictions.
|
65
65
|
#
|
66
66
|
# Required API Key ACLs:
|
67
67
|
# - admin
|
@@ -73,13 +73,13 @@ module Algolia
|
|
73
73
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::AddApiKeyResponse')
|
74
74
|
end
|
75
75
|
|
76
|
-
# If
|
76
|
+
# If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
|
77
77
|
#
|
78
78
|
# Required API Key ACLs:
|
79
79
|
# - addObject
|
80
|
-
# @param index_name [String]
|
81
|
-
# @param object_id [String] Unique record
|
82
|
-
# @param body [Object]
|
80
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
81
|
+
# @param object_id [String] Unique record identifier. (required)
|
82
|
+
# @param body [Object] The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)
|
83
83
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
84
84
|
# @return [Http::Response] the response
|
85
85
|
def add_or_update_object_with_http_info(index_name, object_id, body, request_options = {})
|
@@ -116,13 +116,13 @@ module Algolia
|
|
116
116
|
@api_client.call_api(:PUT, path, new_options)
|
117
117
|
end
|
118
118
|
|
119
|
-
# If
|
119
|
+
# If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
|
120
120
|
#
|
121
121
|
# Required API Key ACLs:
|
122
122
|
# - addObject
|
123
|
-
# @param index_name [String]
|
124
|
-
# @param object_id [String] Unique record
|
125
|
-
# @param body [Object]
|
123
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
124
|
+
# @param object_id [String] Unique record identifier. (required)
|
125
|
+
# @param body [Object] The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)
|
126
126
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
127
127
|
# @return [UpdatedAtWithObjectIdResponse]
|
128
128
|
def add_or_update_object(index_name, object_id, body, request_options = {})
|
@@ -130,7 +130,7 @@ module Algolia
|
|
130
130
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtWithObjectIdResponse')
|
131
131
|
end
|
132
132
|
|
133
|
-
#
|
133
|
+
# Adds a source to the list of allowed sources.
|
134
134
|
#
|
135
135
|
# Required API Key ACLs:
|
136
136
|
# - admin
|
@@ -162,7 +162,7 @@ module Algolia
|
|
162
162
|
@api_client.call_api(:POST, path, new_options)
|
163
163
|
end
|
164
164
|
|
165
|
-
#
|
165
|
+
# Adds a source to the list of allowed sources.
|
166
166
|
#
|
167
167
|
# Required API Key ACLs:
|
168
168
|
# - admin
|
@@ -174,11 +174,11 @@ module Algolia
|
|
174
174
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::CreatedAtResponse')
|
175
175
|
end
|
176
176
|
|
177
|
-
#
|
177
|
+
# 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.
|
178
178
|
#
|
179
179
|
# Required API Key ACLs:
|
180
180
|
# - admin
|
181
|
-
# @param x_algolia_user_id [String]
|
181
|
+
# @param x_algolia_user_id [String] User ID to assign. (required)
|
182
182
|
# @param assign_user_id_params [AssignUserIdParams] (required)
|
183
183
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
184
184
|
# @return [Http::Response] the response
|
@@ -218,11 +218,11 @@ module Algolia
|
|
218
218
|
@api_client.call_api(:POST, path, new_options)
|
219
219
|
end
|
220
220
|
|
221
|
-
#
|
221
|
+
# 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.
|
222
222
|
#
|
223
223
|
# Required API Key ACLs:
|
224
224
|
# - admin
|
225
|
-
# @param x_algolia_user_id [String]
|
225
|
+
# @param x_algolia_user_id [String] User ID to assign. (required)
|
226
226
|
# @param assign_user_id_params [AssignUserIdParams] (required)
|
227
227
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
228
228
|
# @return [CreatedAtResponse]
|
@@ -231,9 +231,9 @@ module Algolia
|
|
231
231
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::CreatedAtResponse')
|
232
232
|
end
|
233
233
|
|
234
|
-
#
|
234
|
+
# 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.
|
235
235
|
|
236
|
-
# @param index_name [String]
|
236
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
237
237
|
# @param batch_write_params [BatchWriteParams] (required)
|
238
238
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
239
239
|
# @return [Http::Response] the response
|
@@ -266,9 +266,9 @@ module Algolia
|
|
266
266
|
@api_client.call_api(:POST, path, new_options)
|
267
267
|
end
|
268
268
|
|
269
|
-
#
|
269
|
+
# 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.
|
270
270
|
|
271
|
-
# @param index_name [String]
|
271
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
272
272
|
# @param batch_write_params [BatchWriteParams] (required)
|
273
273
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
274
274
|
# @return [BatchResponse]
|
@@ -277,11 +277,11 @@ module Algolia
|
|
277
277
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::BatchResponse')
|
278
278
|
end
|
279
279
|
|
280
|
-
#
|
280
|
+
# Assigns multiple user IDs to a cluster. **You can't move users with this operation**.
|
281
281
|
#
|
282
282
|
# Required API Key ACLs:
|
283
283
|
# - admin
|
284
|
-
# @param x_algolia_user_id [String]
|
284
|
+
# @param x_algolia_user_id [String] User ID to assign. (required)
|
285
285
|
# @param batch_assign_user_ids_params [BatchAssignUserIdsParams] (required)
|
286
286
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
287
287
|
# @return [Http::Response] the response
|
@@ -321,11 +321,11 @@ module Algolia
|
|
321
321
|
@api_client.call_api(:POST, path, new_options)
|
322
322
|
end
|
323
323
|
|
324
|
-
#
|
324
|
+
# Assigns multiple user IDs to a cluster. **You can't move users with this operation**.
|
325
325
|
#
|
326
326
|
# Required API Key ACLs:
|
327
327
|
# - admin
|
328
|
-
# @param x_algolia_user_id [String]
|
328
|
+
# @param x_algolia_user_id [String] User ID to assign. (required)
|
329
329
|
# @param batch_assign_user_ids_params [BatchAssignUserIdsParams] (required)
|
330
330
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
331
331
|
# @return [CreatedAtResponse]
|
@@ -334,11 +334,11 @@ module Algolia
|
|
334
334
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::CreatedAtResponse')
|
335
335
|
end
|
336
336
|
|
337
|
-
#
|
337
|
+
# Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
|
338
338
|
#
|
339
339
|
# Required API Key ACLs:
|
340
340
|
# - editSettings
|
341
|
-
# @param dictionary_name [DictionaryType] Dictionary to search
|
341
|
+
# @param dictionary_name [DictionaryType] Dictionary type in which to search. (required)
|
342
342
|
# @param batch_dictionary_entries_params [BatchDictionaryEntriesParams] (required)
|
343
343
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
344
344
|
# @return [Http::Response] the response
|
@@ -371,11 +371,11 @@ module Algolia
|
|
371
371
|
@api_client.call_api(:POST, path, new_options)
|
372
372
|
end
|
373
373
|
|
374
|
-
#
|
374
|
+
# Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
|
375
375
|
#
|
376
376
|
# Required API Key ACLs:
|
377
377
|
# - editSettings
|
378
|
-
# @param dictionary_name [DictionaryType] Dictionary to search
|
378
|
+
# @param dictionary_name [DictionaryType] Dictionary type in which to search. (required)
|
379
379
|
# @param batch_dictionary_entries_params [BatchDictionaryEntriesParams] (required)
|
380
380
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
381
381
|
# @return [UpdatedAtResponse]
|
@@ -384,11 +384,11 @@ module Algolia
|
|
384
384
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
385
385
|
end
|
386
386
|
|
387
|
-
#
|
387
|
+
# Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.
|
388
388
|
#
|
389
389
|
# Required API Key ACLs:
|
390
390
|
# - browse
|
391
|
-
# @param index_name [String]
|
391
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
392
392
|
# @param browse_params [BrowseParams]
|
393
393
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
394
394
|
# @return [Http::Response] the response
|
@@ -417,11 +417,11 @@ module Algolia
|
|
417
417
|
@api_client.call_api(:POST, path, new_options)
|
418
418
|
end
|
419
419
|
|
420
|
-
#
|
420
|
+
# Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.
|
421
421
|
#
|
422
422
|
# Required API Key ACLs:
|
423
423
|
# - browse
|
424
|
-
# @param index_name [String]
|
424
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
425
425
|
# @param browse_params [BrowseParams]
|
426
426
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
427
427
|
# @return [BrowseResponse]
|
@@ -430,11 +430,11 @@ module Algolia
|
|
430
430
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::BrowseResponse')
|
431
431
|
end
|
432
432
|
|
433
|
-
#
|
433
|
+
# Deletes only the records from an index while keeping settings, synonyms, and rules.
|
434
434
|
#
|
435
435
|
# Required API Key ACLs:
|
436
436
|
# - deleteIndex
|
437
|
-
# @param index_name [String]
|
437
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
438
438
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
439
439
|
# @return [Http::Response] the response
|
440
440
|
def clear_objects_with_http_info(index_name, request_options = {})
|
@@ -462,11 +462,11 @@ module Algolia
|
|
462
462
|
@api_client.call_api(:POST, path, new_options)
|
463
463
|
end
|
464
464
|
|
465
|
-
#
|
465
|
+
# Deletes only the records from an index while keeping settings, synonyms, and rules.
|
466
466
|
#
|
467
467
|
# Required API Key ACLs:
|
468
468
|
# - deleteIndex
|
469
|
-
# @param index_name [String]
|
469
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
470
470
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
471
471
|
# @return [UpdatedAtResponse]
|
472
472
|
def clear_objects(index_name, request_options = {})
|
@@ -474,12 +474,12 @@ module Algolia
|
|
474
474
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
475
475
|
end
|
476
476
|
|
477
|
-
#
|
477
|
+
# Deletes all rules from the index.
|
478
478
|
#
|
479
479
|
# Required API Key ACLs:
|
480
480
|
# - editSettings
|
481
|
-
# @param index_name [String]
|
482
|
-
# @param forward_to_replicas [Boolean]
|
481
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
482
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
483
483
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
484
484
|
# @return [Http::Response] the response
|
485
485
|
def clear_rules_with_http_info(index_name, forward_to_replicas = nil, request_options = {})
|
@@ -508,12 +508,12 @@ module Algolia
|
|
508
508
|
@api_client.call_api(:POST, path, new_options)
|
509
509
|
end
|
510
510
|
|
511
|
-
#
|
511
|
+
# Deletes all rules from the index.
|
512
512
|
#
|
513
513
|
# Required API Key ACLs:
|
514
514
|
# - editSettings
|
515
|
-
# @param index_name [String]
|
516
|
-
# @param forward_to_replicas [Boolean]
|
515
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
516
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
517
517
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
518
518
|
# @return [UpdatedAtResponse]
|
519
519
|
def clear_rules(index_name, forward_to_replicas = nil, request_options = {})
|
@@ -521,12 +521,12 @@ module Algolia
|
|
521
521
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
522
522
|
end
|
523
523
|
|
524
|
-
#
|
524
|
+
# Deletes all synonyms from the index.
|
525
525
|
#
|
526
526
|
# Required API Key ACLs:
|
527
527
|
# - editSettings
|
528
|
-
# @param index_name [String]
|
529
|
-
# @param forward_to_replicas [Boolean]
|
528
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
529
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
530
530
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
531
531
|
# @return [Http::Response] the response
|
532
532
|
def clear_synonyms_with_http_info(index_name, forward_to_replicas = nil, request_options = {})
|
@@ -555,12 +555,12 @@ module Algolia
|
|
555
555
|
@api_client.call_api(:POST, path, new_options)
|
556
556
|
end
|
557
557
|
|
558
|
-
#
|
558
|
+
# Deletes all synonyms from the index.
|
559
559
|
#
|
560
560
|
# Required API Key ACLs:
|
561
561
|
# - editSettings
|
562
|
-
# @param index_name [String]
|
563
|
-
# @param forward_to_replicas [Boolean]
|
562
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
563
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
564
564
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
565
565
|
# @return [UpdatedAtResponse]
|
566
566
|
def clear_synonyms(index_name, forward_to_replicas = nil, request_options = {})
|
@@ -744,7 +744,7 @@ module Algolia
|
|
744
744
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
745
745
|
end
|
746
746
|
|
747
|
-
#
|
747
|
+
# Deletes the API key.
|
748
748
|
#
|
749
749
|
# Required API Key ACLs:
|
750
750
|
# - admin
|
@@ -776,7 +776,7 @@ module Algolia
|
|
776
776
|
@api_client.call_api(:DELETE, path, new_options)
|
777
777
|
end
|
778
778
|
|
779
|
-
#
|
779
|
+
# Deletes the API key.
|
780
780
|
#
|
781
781
|
# Required API Key ACLs:
|
782
782
|
# - admin
|
@@ -788,11 +788,11 @@ module Algolia
|
|
788
788
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::DeleteApiKeyResponse')
|
789
789
|
end
|
790
790
|
|
791
|
-
# This operation doesn't
|
791
|
+
# This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).
|
792
792
|
#
|
793
793
|
# Required API Key ACLs:
|
794
794
|
# - deleteIndex
|
795
|
-
# @param index_name [String]
|
795
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
796
796
|
# @param delete_by_params [DeleteByParams] (required)
|
797
797
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
798
798
|
# @return [Http::Response] the response
|
@@ -825,11 +825,11 @@ module Algolia
|
|
825
825
|
@api_client.call_api(:POST, path, new_options)
|
826
826
|
end
|
827
827
|
|
828
|
-
# This operation doesn't
|
828
|
+
# This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).
|
829
829
|
#
|
830
830
|
# Required API Key ACLs:
|
831
831
|
# - deleteIndex
|
832
|
-
# @param index_name [String]
|
832
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
833
833
|
# @param delete_by_params [DeleteByParams] (required)
|
834
834
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
835
835
|
# @return [DeletedAtResponse]
|
@@ -838,11 +838,11 @@ module Algolia
|
|
838
838
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::DeletedAtResponse')
|
839
839
|
end
|
840
840
|
|
841
|
-
#
|
841
|
+
# 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/).
|
842
842
|
#
|
843
843
|
# Required API Key ACLs:
|
844
844
|
# - deleteIndex
|
845
|
-
# @param index_name [String]
|
845
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
846
846
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
847
847
|
# @return [Http::Response] the response
|
848
848
|
def delete_index_with_http_info(index_name, request_options = {})
|
@@ -870,11 +870,11 @@ module Algolia
|
|
870
870
|
@api_client.call_api(:DELETE, path, new_options)
|
871
871
|
end
|
872
872
|
|
873
|
-
#
|
873
|
+
# 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/).
|
874
874
|
#
|
875
875
|
# Required API Key ACLs:
|
876
876
|
# - deleteIndex
|
877
|
-
# @param index_name [String]
|
877
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
878
878
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
879
879
|
# @return [DeletedAtResponse]
|
880
880
|
def delete_index(index_name, request_options = {})
|
@@ -882,12 +882,12 @@ module Algolia
|
|
882
882
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::DeletedAtResponse')
|
883
883
|
end
|
884
884
|
|
885
|
-
# To delete
|
885
|
+
# Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
|
886
886
|
#
|
887
887
|
# Required API Key ACLs:
|
888
888
|
# - deleteObject
|
889
|
-
# @param index_name [String]
|
890
|
-
# @param object_id [String] Unique record
|
889
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
890
|
+
# @param object_id [String] Unique record identifier. (required)
|
891
891
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
892
892
|
# @return [Http::Response] the response
|
893
893
|
def delete_object_with_http_info(index_name, object_id, request_options = {})
|
@@ -920,12 +920,12 @@ module Algolia
|
|
920
920
|
@api_client.call_api(:DELETE, path, new_options)
|
921
921
|
end
|
922
922
|
|
923
|
-
# To delete
|
923
|
+
# Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
|
924
924
|
#
|
925
925
|
# Required API Key ACLs:
|
926
926
|
# - deleteObject
|
927
|
-
# @param index_name [String]
|
928
|
-
# @param object_id [String] Unique record
|
927
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
928
|
+
# @param object_id [String] Unique record identifier. (required)
|
929
929
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
930
930
|
# @return [DeletedAtResponse]
|
931
931
|
def delete_object(index_name, object_id, request_options = {})
|
@@ -933,13 +933,13 @@ module Algolia
|
|
933
933
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::DeletedAtResponse')
|
934
934
|
end
|
935
935
|
|
936
|
-
#
|
936
|
+
# Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
937
937
|
#
|
938
938
|
# Required API Key ACLs:
|
939
939
|
# - editSettings
|
940
|
-
# @param index_name [String]
|
940
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
941
941
|
# @param object_id [String] Unique identifier of a rule object. (required)
|
942
|
-
# @param forward_to_replicas [Boolean]
|
942
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
943
943
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
944
944
|
# @return [Http::Response] the response
|
945
945
|
def delete_rule_with_http_info(index_name, object_id, forward_to_replicas = nil, request_options = {})
|
@@ -973,13 +973,13 @@ module Algolia
|
|
973
973
|
@api_client.call_api(:DELETE, path, new_options)
|
974
974
|
end
|
975
975
|
|
976
|
-
#
|
976
|
+
# Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
977
977
|
#
|
978
978
|
# Required API Key ACLs:
|
979
979
|
# - editSettings
|
980
|
-
# @param index_name [String]
|
980
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
981
981
|
# @param object_id [String] Unique identifier of a rule object. (required)
|
982
|
-
# @param forward_to_replicas [Boolean]
|
982
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
983
983
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
984
984
|
# @return [UpdatedAtResponse]
|
985
985
|
def delete_rule(index_name, object_id, forward_to_replicas = nil, request_options = {})
|
@@ -987,7 +987,7 @@ module Algolia
|
|
987
987
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
988
988
|
end
|
989
989
|
|
990
|
-
#
|
990
|
+
# Deletes a source from the list of allowed sources.
|
991
991
|
#
|
992
992
|
# Required API Key ACLs:
|
993
993
|
# - admin
|
@@ -1019,7 +1019,7 @@ module Algolia
|
|
1019
1019
|
@api_client.call_api(:DELETE, path, new_options)
|
1020
1020
|
end
|
1021
1021
|
|
1022
|
-
#
|
1022
|
+
# Deletes a source from the list of allowed sources.
|
1023
1023
|
#
|
1024
1024
|
# Required API Key ACLs:
|
1025
1025
|
# - admin
|
@@ -1031,13 +1031,13 @@ module Algolia
|
|
1031
1031
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::DeleteSourceResponse')
|
1032
1032
|
end
|
1033
1033
|
|
1034
|
-
#
|
1034
|
+
# Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
|
1035
1035
|
#
|
1036
1036
|
# Required API Key ACLs:
|
1037
1037
|
# - editSettings
|
1038
|
-
# @param index_name [String]
|
1038
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1039
1039
|
# @param object_id [String] Unique identifier of a synonym object. (required)
|
1040
|
-
# @param forward_to_replicas [Boolean]
|
1040
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
1041
1041
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1042
1042
|
# @return [Http::Response] the response
|
1043
1043
|
def delete_synonym_with_http_info(index_name, object_id, forward_to_replicas = nil, request_options = {})
|
@@ -1071,13 +1071,13 @@ module Algolia
|
|
1071
1071
|
@api_client.call_api(:DELETE, path, new_options)
|
1072
1072
|
end
|
1073
1073
|
|
1074
|
-
#
|
1074
|
+
# Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
|
1075
1075
|
#
|
1076
1076
|
# Required API Key ACLs:
|
1077
1077
|
# - editSettings
|
1078
|
-
# @param index_name [String]
|
1078
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1079
1079
|
# @param object_id [String] Unique identifier of a synonym object. (required)
|
1080
|
-
# @param forward_to_replicas [Boolean]
|
1080
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
1081
1081
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1082
1082
|
# @return [DeletedAtResponse]
|
1083
1083
|
def delete_synonym(index_name, object_id, forward_to_replicas = nil, request_options = {})
|
@@ -1085,7 +1085,7 @@ module Algolia
|
|
1085
1085
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::DeletedAtResponse')
|
1086
1086
|
end
|
1087
1087
|
|
1088
|
-
#
|
1088
|
+
# 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.
|
1089
1089
|
|
1090
1090
|
# @param key [String] API key. (required)
|
1091
1091
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
@@ -1115,7 +1115,7 @@ module Algolia
|
|
1115
1115
|
@api_client.call_api(:GET, path, new_options)
|
1116
1116
|
end
|
1117
1117
|
|
1118
|
-
#
|
1118
|
+
# 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.
|
1119
1119
|
|
1120
1120
|
# @param key [String] API key. (required)
|
1121
1121
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
@@ -1125,7 +1125,7 @@ module Algolia
|
|
1125
1125
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::GetApiKeyResponse')
|
1126
1126
|
end
|
1127
1127
|
|
1128
|
-
# Lists
|
1128
|
+
# Lists supported languages with their supported dictionary types and number of custom entries.
|
1129
1129
|
#
|
1130
1130
|
# Required API Key ACLs:
|
1131
1131
|
# - settings
|
@@ -1151,7 +1151,7 @@ module Algolia
|
|
1151
1151
|
@api_client.call_api(:GET, path, new_options)
|
1152
1152
|
end
|
1153
1153
|
|
1154
|
-
# Lists
|
1154
|
+
# Lists supported languages with their supported dictionary types and number of custom entries.
|
1155
1155
|
#
|
1156
1156
|
# Required API Key ACLs:
|
1157
1157
|
# - settings
|
@@ -1162,7 +1162,7 @@ module Algolia
|
|
1162
1162
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::Hash<String, Languages>')
|
1163
1163
|
end
|
1164
1164
|
|
1165
|
-
#
|
1165
|
+
# Retrieves the languages for which standard dictionary entries are turned off.
|
1166
1166
|
#
|
1167
1167
|
# Required API Key ACLs:
|
1168
1168
|
# - settings
|
@@ -1188,7 +1188,7 @@ module Algolia
|
|
1188
1188
|
@api_client.call_api(:GET, path, new_options)
|
1189
1189
|
end
|
1190
1190
|
|
1191
|
-
#
|
1191
|
+
# Retrieves the languages for which standard dictionary entries are turned off.
|
1192
1192
|
#
|
1193
1193
|
# Required API Key ACLs:
|
1194
1194
|
# - settings
|
@@ -1199,14 +1199,14 @@ module Algolia
|
|
1199
1199
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::GetDictionarySettingsResponse')
|
1200
1200
|
end
|
1201
1201
|
|
1202
|
-
# 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.
|
1202
|
+
# 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/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.
|
1203
1203
|
#
|
1204
1204
|
# Required API Key ACLs:
|
1205
1205
|
# - logs
|
1206
|
-
# @param offset [Integer] First log entry to retrieve.
|
1206
|
+
# @param offset [Integer] First log entry to retrieve. The most recent entries are listed first. (default to 0)
|
1207
1207
|
# @param length [Integer] Maximum number of entries to retrieve. (default to 10)
|
1208
|
-
# @param index_name [String] Index for which log entries
|
1209
|
-
# @param type [LogType] Type of log entries to retrieve.
|
1208
|
+
# @param index_name [String] Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
|
1209
|
+
# @param type [LogType] Type of log entries to retrieve. By default, all log entries are retrieved. (default to 'all')
|
1210
1210
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1211
1211
|
# @return [Http::Response] the response
|
1212
1212
|
def get_logs_with_http_info(offset = nil, length = nil, index_name = nil, type = nil, request_options = {})
|
@@ -1237,14 +1237,14 @@ module Algolia
|
|
1237
1237
|
@api_client.call_api(:GET, path, new_options)
|
1238
1238
|
end
|
1239
1239
|
|
1240
|
-
# 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.
|
1240
|
+
# 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/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.
|
1241
1241
|
#
|
1242
1242
|
# Required API Key ACLs:
|
1243
1243
|
# - logs
|
1244
|
-
# @param offset [Integer] First log entry to retrieve.
|
1244
|
+
# @param offset [Integer] First log entry to retrieve. The most recent entries are listed first. (default to 0)
|
1245
1245
|
# @param length [Integer] Maximum number of entries to retrieve. (default to 10)
|
1246
|
-
# @param index_name [String] Index for which log entries
|
1247
|
-
# @param type [LogType] Type of log entries to retrieve.
|
1246
|
+
# @param index_name [String] Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
|
1247
|
+
# @param type [LogType] Type of log entries to retrieve. By default, all log entries are retrieved. (default to 'all')
|
1248
1248
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1249
1249
|
# @return [GetLogsResponse]
|
1250
1250
|
def get_logs(offset = nil, length = nil, index_name = nil, type = nil, request_options = {})
|
@@ -1252,13 +1252,13 @@ module Algolia
|
|
1252
1252
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::GetLogsResponse')
|
1253
1253
|
end
|
1254
1254
|
|
1255
|
-
# To
|
1255
|
+
# Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
|
1256
1256
|
#
|
1257
1257
|
# Required API Key ACLs:
|
1258
1258
|
# - search
|
1259
|
-
# @param index_name [String]
|
1260
|
-
# @param object_id [String] Unique record
|
1261
|
-
# @param attributes_to_retrieve [Array<String>] 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.
|
1259
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1260
|
+
# @param object_id [String] Unique record identifier. (required)
|
1261
|
+
# @param attributes_to_retrieve [Array<String>] 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.
|
1262
1262
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1263
1263
|
# @return [Http::Response] the response
|
1264
1264
|
def get_object_with_http_info(index_name, object_id, attributes_to_retrieve = nil, request_options = {})
|
@@ -1292,13 +1292,13 @@ module Algolia
|
|
1292
1292
|
@api_client.call_api(:GET, path, new_options)
|
1293
1293
|
end
|
1294
1294
|
|
1295
|
-
# To
|
1295
|
+
# Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
|
1296
1296
|
#
|
1297
1297
|
# Required API Key ACLs:
|
1298
1298
|
# - search
|
1299
|
-
# @param index_name [String]
|
1300
|
-
# @param object_id [String] Unique record
|
1301
|
-
# @param attributes_to_retrieve [Array<String>] 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.
|
1299
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1300
|
+
# @param object_id [String] Unique record identifier. (required)
|
1301
|
+
# @param attributes_to_retrieve [Array<String>] 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.
|
1302
1302
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1303
1303
|
# @return [Hash<String, String>]
|
1304
1304
|
def get_object(index_name, object_id, attributes_to_retrieve = nil, request_options = {})
|
@@ -1306,7 +1306,7 @@ module Algolia
|
|
1306
1306
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::Hash<String, String>')
|
1307
1307
|
end
|
1308
1308
|
|
1309
|
-
#
|
1309
|
+
# Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
|
1310
1310
|
#
|
1311
1311
|
# Required API Key ACLs:
|
1312
1312
|
# - search
|
@@ -1338,7 +1338,7 @@ module Algolia
|
|
1338
1338
|
@api_client.call_api(:POST, path, new_options)
|
1339
1339
|
end
|
1340
1340
|
|
1341
|
-
#
|
1341
|
+
# Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
|
1342
1342
|
#
|
1343
1343
|
# Required API Key ACLs:
|
1344
1344
|
# - search
|
@@ -1350,11 +1350,11 @@ module Algolia
|
|
1350
1350
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::GetObjectsResponse')
|
1351
1351
|
end
|
1352
1352
|
|
1353
|
-
#
|
1353
|
+
# Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
1354
1354
|
#
|
1355
1355
|
# Required API Key ACLs:
|
1356
1356
|
# - settings
|
1357
|
-
# @param index_name [String]
|
1357
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1358
1358
|
# @param object_id [String] Unique identifier of a rule object. (required)
|
1359
1359
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1360
1360
|
# @return [Http::Response] the response
|
@@ -1388,11 +1388,11 @@ module Algolia
|
|
1388
1388
|
@api_client.call_api(:GET, path, new_options)
|
1389
1389
|
end
|
1390
1390
|
|
1391
|
-
#
|
1391
|
+
# Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
1392
1392
|
#
|
1393
1393
|
# Required API Key ACLs:
|
1394
1394
|
# - settings
|
1395
|
-
# @param index_name [String]
|
1395
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1396
1396
|
# @param object_id [String] Unique identifier of a rule object. (required)
|
1397
1397
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1398
1398
|
# @return [Rule]
|
@@ -1401,11 +1401,11 @@ module Algolia
|
|
1401
1401
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::Rule')
|
1402
1402
|
end
|
1403
1403
|
|
1404
|
-
#
|
1404
|
+
# Retrieves an object with non-null index settings.
|
1405
1405
|
#
|
1406
1406
|
# Required API Key ACLs:
|
1407
1407
|
# - search
|
1408
|
-
# @param index_name [String]
|
1408
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1409
1409
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1410
1410
|
# @return [Http::Response] the response
|
1411
1411
|
def get_settings_with_http_info(index_name, request_options = {})
|
@@ -1433,11 +1433,11 @@ module Algolia
|
|
1433
1433
|
@api_client.call_api(:GET, path, new_options)
|
1434
1434
|
end
|
1435
1435
|
|
1436
|
-
#
|
1436
|
+
# Retrieves an object with non-null index settings.
|
1437
1437
|
#
|
1438
1438
|
# Required API Key ACLs:
|
1439
1439
|
# - search
|
1440
|
-
# @param index_name [String]
|
1440
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1441
1441
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1442
1442
|
# @return [IndexSettings]
|
1443
1443
|
def get_settings(index_name, request_options = {})
|
@@ -1445,7 +1445,7 @@ module Algolia
|
|
1445
1445
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::IndexSettings')
|
1446
1446
|
end
|
1447
1447
|
|
1448
|
-
#
|
1448
|
+
# Retrieves all allowed IP addresses with access to your application.
|
1449
1449
|
#
|
1450
1450
|
# Required API Key ACLs:
|
1451
1451
|
# - admin
|
@@ -1471,7 +1471,7 @@ module Algolia
|
|
1471
1471
|
@api_client.call_api(:GET, path, new_options)
|
1472
1472
|
end
|
1473
1473
|
|
1474
|
-
#
|
1474
|
+
# Retrieves all allowed IP addresses with access to your application.
|
1475
1475
|
#
|
1476
1476
|
# Required API Key ACLs:
|
1477
1477
|
# - admin
|
@@ -1482,11 +1482,11 @@ module Algolia
|
|
1482
1482
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Search::Source>')
|
1483
1483
|
end
|
1484
1484
|
|
1485
|
-
#
|
1485
|
+
# Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
|
1486
1486
|
#
|
1487
1487
|
# Required API Key ACLs:
|
1488
1488
|
# - settings
|
1489
|
-
# @param index_name [String]
|
1489
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1490
1490
|
# @param object_id [String] Unique identifier of a synonym object. (required)
|
1491
1491
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1492
1492
|
# @return [Http::Response] the response
|
@@ -1520,11 +1520,11 @@ module Algolia
|
|
1520
1520
|
@api_client.call_api(:GET, path, new_options)
|
1521
1521
|
end
|
1522
1522
|
|
1523
|
-
#
|
1523
|
+
# Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
|
1524
1524
|
#
|
1525
1525
|
# Required API Key ACLs:
|
1526
1526
|
# - settings
|
1527
|
-
# @param index_name [String]
|
1527
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1528
1528
|
# @param object_id [String] Unique identifier of a synonym object. (required)
|
1529
1529
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1530
1530
|
# @return [SynonymHit]
|
@@ -1533,11 +1533,11 @@ module Algolia
|
|
1533
1533
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SynonymHit')
|
1534
1534
|
end
|
1535
1535
|
|
1536
|
-
#
|
1536
|
+
# 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.
|
1537
1537
|
#
|
1538
1538
|
# Required API Key ACLs:
|
1539
1539
|
# - addObject
|
1540
|
-
# @param index_name [String]
|
1540
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1541
1541
|
# @param task_id [Integer] Unique task identifier. (required)
|
1542
1542
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1543
1543
|
# @return [Http::Response] the response
|
@@ -1571,11 +1571,11 @@ module Algolia
|
|
1571
1571
|
@api_client.call_api(:GET, path, new_options)
|
1572
1572
|
end
|
1573
1573
|
|
1574
|
-
#
|
1574
|
+
# 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.
|
1575
1575
|
#
|
1576
1576
|
# Required API Key ACLs:
|
1577
1577
|
# - addObject
|
1578
|
-
# @param index_name [String]
|
1578
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1579
1579
|
# @param task_id [Integer] Unique task identifier. (required)
|
1580
1580
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1581
1581
|
# @return [GetTaskResponse]
|
@@ -1584,7 +1584,7 @@ module Algolia
|
|
1584
1584
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::GetTaskResponse')
|
1585
1585
|
end
|
1586
1586
|
|
1587
|
-
# Get the IDs of the 10 users with the highest number of records per cluster.
|
1587
|
+
# 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.
|
1588
1588
|
#
|
1589
1589
|
# Required API Key ACLs:
|
1590
1590
|
# - admin
|
@@ -1610,7 +1610,7 @@ module Algolia
|
|
1610
1610
|
@api_client.call_api(:GET, path, new_options)
|
1611
1611
|
end
|
1612
1612
|
|
1613
|
-
# Get the IDs of the 10 users with the highest number of records per cluster.
|
1613
|
+
# 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.
|
1614
1614
|
#
|
1615
1615
|
# Required API Key ACLs:
|
1616
1616
|
# - admin
|
@@ -1621,11 +1621,11 @@ module Algolia
|
|
1621
1621
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::GetTopUserIdsResponse')
|
1622
1622
|
end
|
1623
1623
|
|
1624
|
-
# Returns the
|
1624
|
+
# 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.
|
1625
1625
|
#
|
1626
1626
|
# Required API Key ACLs:
|
1627
1627
|
# - admin
|
1628
|
-
# @param user_id [String]
|
1628
|
+
# @param user_id [String] User ID to assign. (required)
|
1629
1629
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1630
1630
|
# @return [Http::Response] the response
|
1631
1631
|
def get_user_id_with_http_info(user_id, request_options = {})
|
@@ -1658,11 +1658,11 @@ module Algolia
|
|
1658
1658
|
@api_client.call_api(:GET, path, new_options)
|
1659
1659
|
end
|
1660
1660
|
|
1661
|
-
# Returns the
|
1661
|
+
# 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.
|
1662
1662
|
#
|
1663
1663
|
# Required API Key ACLs:
|
1664
1664
|
# - admin
|
1665
|
-
# @param user_id [String]
|
1665
|
+
# @param user_id [String] User ID to assign. (required)
|
1666
1666
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1667
1667
|
# @return [UserId]
|
1668
1668
|
def get_user_id(user_id, request_options = {})
|
@@ -1674,7 +1674,7 @@ module Algolia
|
|
1674
1674
|
#
|
1675
1675
|
# Required API Key ACLs:
|
1676
1676
|
# - admin
|
1677
|
-
# @param get_clusters [Boolean]
|
1677
|
+
# @param get_clusters [Boolean] Whether to include the cluster's pending mapping state in the response.
|
1678
1678
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1679
1679
|
# @return [Http::Response] the response
|
1680
1680
|
def has_pending_mappings_with_http_info(get_clusters = nil, request_options = {})
|
@@ -1702,7 +1702,7 @@ module Algolia
|
|
1702
1702
|
#
|
1703
1703
|
# Required API Key ACLs:
|
1704
1704
|
# - admin
|
1705
|
-
# @param get_clusters [Boolean]
|
1705
|
+
# @param get_clusters [Boolean] Whether to include the cluster's pending mapping state in the response.
|
1706
1706
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1707
1707
|
# @return [HasPendingMappingsResponse]
|
1708
1708
|
def has_pending_mappings(get_clusters = nil, request_options = {})
|
@@ -1710,7 +1710,7 @@ module Algolia
|
|
1710
1710
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::HasPendingMappingsResponse')
|
1711
1711
|
end
|
1712
1712
|
|
1713
|
-
#
|
1713
|
+
# Lists all API keys associated with your Algolia application, including their permissions and restrictions.
|
1714
1714
|
#
|
1715
1715
|
# Required API Key ACLs:
|
1716
1716
|
# - admin
|
@@ -1736,7 +1736,7 @@ module Algolia
|
|
1736
1736
|
@api_client.call_api(:GET, path, new_options)
|
1737
1737
|
end
|
1738
1738
|
|
1739
|
-
#
|
1739
|
+
# Lists all API keys associated with your Algolia application, including their permissions and restrictions.
|
1740
1740
|
#
|
1741
1741
|
# Required API Key ACLs:
|
1742
1742
|
# - admin
|
@@ -1747,7 +1747,7 @@ module Algolia
|
|
1747
1747
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::ListApiKeysResponse')
|
1748
1748
|
end
|
1749
1749
|
|
1750
|
-
#
|
1750
|
+
# Lists the available clusters in a multi-cluster setup.
|
1751
1751
|
#
|
1752
1752
|
# Required API Key ACLs:
|
1753
1753
|
# - admin
|
@@ -1773,7 +1773,7 @@ module Algolia
|
|
1773
1773
|
@api_client.call_api(:GET, path, new_options)
|
1774
1774
|
end
|
1775
1775
|
|
1776
|
-
#
|
1776
|
+
# Lists the available clusters in a multi-cluster setup.
|
1777
1777
|
#
|
1778
1778
|
# Required API Key ACLs:
|
1779
1779
|
# - admin
|
@@ -1784,12 +1784,12 @@ module Algolia
|
|
1784
1784
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::ListClustersResponse')
|
1785
1785
|
end
|
1786
1786
|
|
1787
|
-
#
|
1787
|
+
# Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
|
1788
1788
|
#
|
1789
1789
|
# Required API Key ACLs:
|
1790
1790
|
# - listIndexes
|
1791
|
-
# @param page [Integer]
|
1792
|
-
# @param hits_per_page [Integer]
|
1791
|
+
# @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated.
|
1792
|
+
# @param hits_per_page [Integer] Number of hits per page. (default to 100)
|
1793
1793
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1794
1794
|
# @return [Http::Response] the response
|
1795
1795
|
def list_indices_with_http_info(page = nil, hits_per_page = nil, request_options = {})
|
@@ -1818,12 +1818,12 @@ module Algolia
|
|
1818
1818
|
@api_client.call_api(:GET, path, new_options)
|
1819
1819
|
end
|
1820
1820
|
|
1821
|
-
#
|
1821
|
+
# Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
|
1822
1822
|
#
|
1823
1823
|
# Required API Key ACLs:
|
1824
1824
|
# - listIndexes
|
1825
|
-
# @param page [Integer]
|
1826
|
-
# @param hits_per_page [Integer]
|
1825
|
+
# @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated.
|
1826
|
+
# @param hits_per_page [Integer] Number of hits per page. (default to 100)
|
1827
1827
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1828
1828
|
# @return [ListIndicesResponse]
|
1829
1829
|
def list_indices(page = nil, hits_per_page = nil, request_options = {})
|
@@ -1831,12 +1831,12 @@ module Algolia
|
|
1831
1831
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::ListIndicesResponse')
|
1832
1832
|
end
|
1833
1833
|
|
1834
|
-
#
|
1834
|
+
# 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.
|
1835
1835
|
#
|
1836
1836
|
# Required API Key ACLs:
|
1837
1837
|
# - admin
|
1838
|
-
# @param page [Integer]
|
1839
|
-
# @param hits_per_page [Integer]
|
1838
|
+
# @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated.
|
1839
|
+
# @param hits_per_page [Integer] Number of hits per page. (default to 100)
|
1840
1840
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1841
1841
|
# @return [Http::Response] the response
|
1842
1842
|
def list_user_ids_with_http_info(page = nil, hits_per_page = nil, request_options = {})
|
@@ -1865,12 +1865,12 @@ module Algolia
|
|
1865
1865
|
@api_client.call_api(:GET, path, new_options)
|
1866
1866
|
end
|
1867
1867
|
|
1868
|
-
#
|
1868
|
+
# 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.
|
1869
1869
|
#
|
1870
1870
|
# Required API Key ACLs:
|
1871
1871
|
# - admin
|
1872
|
-
# @param page [Integer]
|
1873
|
-
# @param hits_per_page [Integer]
|
1872
|
+
# @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated.
|
1873
|
+
# @param hits_per_page [Integer] Number of hits per page. (default to 100)
|
1874
1874
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1875
1875
|
# @return [ListUserIdsResponse]
|
1876
1876
|
def list_user_ids(page = nil, hits_per_page = nil, request_options = {})
|
@@ -1878,7 +1878,7 @@ module Algolia
|
|
1878
1878
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::ListUserIdsResponse')
|
1879
1879
|
end
|
1880
1880
|
|
1881
|
-
#
|
1881
|
+
# 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.
|
1882
1882
|
|
1883
1883
|
# @param batch_params [BatchParams] (required)
|
1884
1884
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
@@ -1908,7 +1908,7 @@ module Algolia
|
|
1908
1908
|
@api_client.call_api(:POST, path, new_options)
|
1909
1909
|
end
|
1910
1910
|
|
1911
|
-
#
|
1911
|
+
# 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.
|
1912
1912
|
|
1913
1913
|
# @param batch_params [BatchParams] (required)
|
1914
1914
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
@@ -1918,11 +1918,11 @@ module Algolia
|
|
1918
1918
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::MultipleBatchResponse')
|
1919
1919
|
end
|
1920
1920
|
|
1921
|
-
#
|
1921
|
+
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of 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). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keep their 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. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
|
1922
1922
|
#
|
1923
1923
|
# Required API Key ACLs:
|
1924
1924
|
# - addObject
|
1925
|
-
# @param index_name [String]
|
1925
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1926
1926
|
# @param operation_index_params [OperationIndexParams] (required)
|
1927
1927
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1928
1928
|
# @return [Http::Response] the response
|
@@ -1955,11 +1955,11 @@ module Algolia
|
|
1955
1955
|
@api_client.call_api(:POST, path, new_options)
|
1956
1956
|
end
|
1957
1957
|
|
1958
|
-
#
|
1958
|
+
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of 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). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keep their 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. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
|
1959
1959
|
#
|
1960
1960
|
# Required API Key ACLs:
|
1961
1961
|
# - addObject
|
1962
|
-
# @param index_name [String]
|
1962
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1963
1963
|
# @param operation_index_params [OperationIndexParams] (required)
|
1964
1964
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1965
1965
|
# @return [UpdatedAtResponse]
|
@@ -1968,14 +1968,14 @@ module Algolia
|
|
1968
1968
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
1969
1969
|
end
|
1970
1970
|
|
1971
|
-
#
|
1971
|
+
# Adds new attributes to a record, or update 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. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.
|
1972
1972
|
#
|
1973
1973
|
# Required API Key ACLs:
|
1974
1974
|
# - addObject
|
1975
|
-
# @param index_name [String]
|
1976
|
-
# @param object_id [String] Unique record
|
1977
|
-
# @param attributes_to_update [Hash<String, AttributeToUpdate>]
|
1978
|
-
# @param create_if_not_exists [Boolean]
|
1975
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
1976
|
+
# @param object_id [String] Unique record identifier. (required)
|
1977
|
+
# @param attributes_to_update [Hash<String, AttributeToUpdate>] Attributes with their values. (required)
|
1978
|
+
# @param create_if_not_exists [Boolean] Whether to create a new record if it doesn't exist. (default to true)
|
1979
1979
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1980
1980
|
# @return [Http::Response] the response
|
1981
1981
|
def partial_update_object_with_http_info(index_name, object_id, attributes_to_update, create_if_not_exists = nil, request_options = {})
|
@@ -2013,14 +2013,14 @@ module Algolia
|
|
2013
2013
|
@api_client.call_api(:POST, path, new_options)
|
2014
2014
|
end
|
2015
2015
|
|
2016
|
-
#
|
2016
|
+
# Adds new attributes to a record, or update 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. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.
|
2017
2017
|
#
|
2018
2018
|
# Required API Key ACLs:
|
2019
2019
|
# - addObject
|
2020
|
-
# @param index_name [String]
|
2021
|
-
# @param object_id [String] Unique record
|
2022
|
-
# @param attributes_to_update [Hash<String, AttributeToUpdate>]
|
2023
|
-
# @param create_if_not_exists [Boolean]
|
2020
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2021
|
+
# @param object_id [String] Unique record identifier. (required)
|
2022
|
+
# @param attributes_to_update [Hash<String, AttributeToUpdate>] Attributes with their values. (required)
|
2023
|
+
# @param create_if_not_exists [Boolean] Whether to create a new record if it doesn't exist. (default to true)
|
2024
2024
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2025
2025
|
# @return [UpdatedAtWithObjectIdResponse]
|
2026
2026
|
def partial_update_object(index_name, object_id, attributes_to_update, create_if_not_exists = nil, request_options = {})
|
@@ -2028,11 +2028,11 @@ module Algolia
|
|
2028
2028
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtWithObjectIdResponse')
|
2029
2029
|
end
|
2030
2030
|
|
2031
|
-
#
|
2031
|
+
# Deletes a user ID and its associated data from the clusters.
|
2032
2032
|
#
|
2033
2033
|
# Required API Key ACLs:
|
2034
2034
|
# - admin
|
2035
|
-
# @param user_id [String]
|
2035
|
+
# @param user_id [String] User ID to assign. (required)
|
2036
2036
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2037
2037
|
# @return [Http::Response] the response
|
2038
2038
|
def remove_user_id_with_http_info(user_id, request_options = {})
|
@@ -2065,11 +2065,11 @@ module Algolia
|
|
2065
2065
|
@api_client.call_api(:DELETE, path, new_options)
|
2066
2066
|
end
|
2067
2067
|
|
2068
|
-
#
|
2068
|
+
# Deletes a user ID and its associated data from the clusters.
|
2069
2069
|
#
|
2070
2070
|
# Required API Key ACLs:
|
2071
2071
|
# - admin
|
2072
|
-
# @param user_id [String]
|
2072
|
+
# @param user_id [String] User ID to assign. (required)
|
2073
2073
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2074
2074
|
# @return [RemoveUserIdResponse]
|
2075
2075
|
def remove_user_id(user_id, request_options = {})
|
@@ -2077,7 +2077,7 @@ module Algolia
|
|
2077
2077
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::RemoveUserIdResponse')
|
2078
2078
|
end
|
2079
2079
|
|
2080
|
-
#
|
2080
|
+
# Replaces the list of allowed sources.
|
2081
2081
|
#
|
2082
2082
|
# Required API Key ACLs:
|
2083
2083
|
# - admin
|
@@ -2109,7 +2109,7 @@ module Algolia
|
|
2109
2109
|
@api_client.call_api(:PUT, path, new_options)
|
2110
2110
|
end
|
2111
2111
|
|
2112
|
-
#
|
2112
|
+
# Replaces the list of allowed sources.
|
2113
2113
|
#
|
2114
2114
|
# Required API Key ACLs:
|
2115
2115
|
# - admin
|
@@ -2121,7 +2121,7 @@ module Algolia
|
|
2121
2121
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::ReplaceSourceResponse')
|
2122
2122
|
end
|
2123
2123
|
|
2124
|
-
#
|
2124
|
+
# 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.
|
2125
2125
|
#
|
2126
2126
|
# Required API Key ACLs:
|
2127
2127
|
# - admin
|
@@ -2153,7 +2153,7 @@ module Algolia
|
|
2153
2153
|
@api_client.call_api(:POST, path, new_options)
|
2154
2154
|
end
|
2155
2155
|
|
2156
|
-
#
|
2156
|
+
# 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.
|
2157
2157
|
#
|
2158
2158
|
# Required API Key ACLs:
|
2159
2159
|
# - admin
|
@@ -2165,12 +2165,12 @@ module Algolia
|
|
2165
2165
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::AddApiKeyResponse')
|
2166
2166
|
end
|
2167
2167
|
|
2168
|
-
#
|
2168
|
+
# Adds a record to an index or replace 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](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
|
2169
2169
|
#
|
2170
2170
|
# Required API Key ACLs:
|
2171
2171
|
# - addObject
|
2172
|
-
# @param index_name [String]
|
2173
|
-
# @param body [Object] The
|
2172
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2173
|
+
# @param body [Object] The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)
|
2174
2174
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2175
2175
|
# @return [Http::Response] the response
|
2176
2176
|
def save_object_with_http_info(index_name, body, request_options = {})
|
@@ -2202,12 +2202,12 @@ module Algolia
|
|
2202
2202
|
@api_client.call_api(:POST, path, new_options)
|
2203
2203
|
end
|
2204
2204
|
|
2205
|
-
#
|
2205
|
+
# Adds a record to an index or replace 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](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
|
2206
2206
|
#
|
2207
2207
|
# Required API Key ACLs:
|
2208
2208
|
# - addObject
|
2209
|
-
# @param index_name [String]
|
2210
|
-
# @param body [Object] The
|
2209
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2210
|
+
# @param body [Object] The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)
|
2211
2211
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2212
2212
|
# @return [SaveObjectResponse]
|
2213
2213
|
def save_object(index_name, body, request_options = {})
|
@@ -2215,14 +2215,14 @@ module Algolia
|
|
2215
2215
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SaveObjectResponse')
|
2216
2216
|
end
|
2217
2217
|
|
2218
|
-
# To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
|
2218
|
+
# 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](#tag/Rules/operation/saveRules).
|
2219
2219
|
#
|
2220
2220
|
# Required API Key ACLs:
|
2221
2221
|
# - editSettings
|
2222
|
-
# @param index_name [String]
|
2222
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2223
2223
|
# @param object_id [String] Unique identifier of a rule object. (required)
|
2224
2224
|
# @param rule [Rule] (required)
|
2225
|
-
# @param forward_to_replicas [Boolean]
|
2225
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2226
2226
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2227
2227
|
# @return [Http::Response] the response
|
2228
2228
|
def save_rule_with_http_info(index_name, object_id, rule, forward_to_replicas = nil, request_options = {})
|
@@ -2260,14 +2260,14 @@ module Algolia
|
|
2260
2260
|
@api_client.call_api(:PUT, path, new_options)
|
2261
2261
|
end
|
2262
2262
|
|
2263
|
-
# To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
|
2263
|
+
# 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](#tag/Rules/operation/saveRules).
|
2264
2264
|
#
|
2265
2265
|
# Required API Key ACLs:
|
2266
2266
|
# - editSettings
|
2267
|
-
# @param index_name [String]
|
2267
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2268
2268
|
# @param object_id [String] Unique identifier of a rule object. (required)
|
2269
2269
|
# @param rule [Rule] (required)
|
2270
|
-
# @param forward_to_replicas [Boolean]
|
2270
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2271
2271
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2272
2272
|
# @return [UpdatedRuleResponse]
|
2273
2273
|
def save_rule(index_name, object_id, rule, forward_to_replicas = nil, request_options = {})
|
@@ -2275,14 +2275,14 @@ module Algolia
|
|
2275
2275
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedRuleResponse')
|
2276
2276
|
end
|
2277
2277
|
|
2278
|
-
# Create or update multiple rules.
|
2278
|
+
# 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.
|
2279
2279
|
#
|
2280
2280
|
# Required API Key ACLs:
|
2281
2281
|
# - editSettings
|
2282
|
-
# @param index_name [String]
|
2282
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2283
2283
|
# @param rules [Array<Rule>] (required)
|
2284
|
-
# @param forward_to_replicas [Boolean]
|
2285
|
-
# @param clear_existing_rules [Boolean]
|
2284
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2285
|
+
# @param clear_existing_rules [Boolean] Whether existing rules should be deleted before adding this batch.
|
2286
2286
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2287
2287
|
# @return [Http::Response] the response
|
2288
2288
|
def save_rules_with_http_info(index_name, rules, forward_to_replicas = nil, clear_existing_rules = nil, request_options = {})
|
@@ -2316,14 +2316,14 @@ module Algolia
|
|
2316
2316
|
@api_client.call_api(:POST, path, new_options)
|
2317
2317
|
end
|
2318
2318
|
|
2319
|
-
# Create or update multiple rules.
|
2319
|
+
# 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.
|
2320
2320
|
#
|
2321
2321
|
# Required API Key ACLs:
|
2322
2322
|
# - editSettings
|
2323
|
-
# @param index_name [String]
|
2323
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2324
2324
|
# @param rules [Array<Rule>] (required)
|
2325
|
-
# @param forward_to_replicas [Boolean]
|
2326
|
-
# @param clear_existing_rules [Boolean]
|
2325
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2326
|
+
# @param clear_existing_rules [Boolean] Whether existing rules should be deleted before adding this batch.
|
2327
2327
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2328
2328
|
# @return [UpdatedAtResponse]
|
2329
2329
|
def save_rules(index_name, rules, forward_to_replicas = nil, clear_existing_rules = nil, request_options = {})
|
@@ -2331,14 +2331,14 @@ module Algolia
|
|
2331
2331
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
2332
2332
|
end
|
2333
2333
|
|
2334
|
-
#
|
2334
|
+
# 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](#tag/Synonyms/operation/saveSynonyms).
|
2335
2335
|
#
|
2336
2336
|
# Required API Key ACLs:
|
2337
2337
|
# - editSettings
|
2338
|
-
# @param index_name [String]
|
2338
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2339
2339
|
# @param object_id [String] Unique identifier of a synonym object. (required)
|
2340
2340
|
# @param synonym_hit [SynonymHit] (required)
|
2341
|
-
# @param forward_to_replicas [Boolean]
|
2341
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2342
2342
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2343
2343
|
# @return [Http::Response] the response
|
2344
2344
|
def save_synonym_with_http_info(index_name, object_id, synonym_hit, forward_to_replicas = nil, request_options = {})
|
@@ -2376,14 +2376,14 @@ module Algolia
|
|
2376
2376
|
@api_client.call_api(:PUT, path, new_options)
|
2377
2377
|
end
|
2378
2378
|
|
2379
|
-
#
|
2379
|
+
# 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](#tag/Synonyms/operation/saveSynonyms).
|
2380
2380
|
#
|
2381
2381
|
# Required API Key ACLs:
|
2382
2382
|
# - editSettings
|
2383
|
-
# @param index_name [String]
|
2383
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2384
2384
|
# @param object_id [String] Unique identifier of a synonym object. (required)
|
2385
2385
|
# @param synonym_hit [SynonymHit] (required)
|
2386
|
-
# @param forward_to_replicas [Boolean]
|
2386
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2387
2387
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2388
2388
|
# @return [SaveSynonymResponse]
|
2389
2389
|
def save_synonym(index_name, object_id, synonym_hit, forward_to_replicas = nil, request_options = {})
|
@@ -2391,14 +2391,14 @@ module Algolia
|
|
2391
2391
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SaveSynonymResponse')
|
2392
2392
|
end
|
2393
2393
|
|
2394
|
-
#
|
2394
|
+
# If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.
|
2395
2395
|
#
|
2396
2396
|
# Required API Key ACLs:
|
2397
2397
|
# - editSettings
|
2398
|
-
# @param index_name [String]
|
2398
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2399
2399
|
# @param synonym_hit [Array<SynonymHit>] (required)
|
2400
|
-
# @param forward_to_replicas [Boolean]
|
2401
|
-
# @param replace_existing_synonyms [Boolean]
|
2400
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2401
|
+
# @param replace_existing_synonyms [Boolean] Whether to replace all synonyms in the index with the ones sent with this request.
|
2402
2402
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2403
2403
|
# @return [Http::Response] the response
|
2404
2404
|
def save_synonyms_with_http_info(index_name, synonym_hit, forward_to_replicas = nil, replace_existing_synonyms = nil, request_options = {})
|
@@ -2432,14 +2432,14 @@ module Algolia
|
|
2432
2432
|
@api_client.call_api(:POST, path, new_options)
|
2433
2433
|
end
|
2434
2434
|
|
2435
|
-
#
|
2435
|
+
# If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.
|
2436
2436
|
#
|
2437
2437
|
# Required API Key ACLs:
|
2438
2438
|
# - editSettings
|
2439
|
-
# @param index_name [String]
|
2439
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2440
2440
|
# @param synonym_hit [Array<SynonymHit>] (required)
|
2441
|
-
# @param forward_to_replicas [Boolean]
|
2442
|
-
# @param replace_existing_synonyms [Boolean]
|
2441
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2442
|
+
# @param replace_existing_synonyms [Boolean] Whether to replace all synonyms in the index with the ones sent with this request.
|
2443
2443
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2444
2444
|
# @return [UpdatedAtResponse]
|
2445
2445
|
def save_synonyms(index_name, synonym_hit, forward_to_replicas = nil, replace_existing_synonyms = nil, request_options = {})
|
@@ -2447,11 +2447,11 @@ module Algolia
|
|
2447
2447
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
2448
2448
|
end
|
2449
2449
|
|
2450
|
-
#
|
2450
|
+
# Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
|
2451
2451
|
#
|
2452
2452
|
# Required API Key ACLs:
|
2453
2453
|
# - search
|
2454
|
-
# @param search_method_params [SearchMethodParams]
|
2454
|
+
# @param search_method_params [SearchMethodParams] Muli-search request body. Results are returned in the same order as the requests. (required)
|
2455
2455
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2456
2456
|
# @return [Http::Response] the response
|
2457
2457
|
def search_with_http_info(search_method_params, request_options = {})
|
@@ -2479,11 +2479,11 @@ module Algolia
|
|
2479
2479
|
@api_client.call_api(:POST, path, new_options)
|
2480
2480
|
end
|
2481
2481
|
|
2482
|
-
#
|
2482
|
+
# Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
|
2483
2483
|
#
|
2484
2484
|
# Required API Key ACLs:
|
2485
2485
|
# - search
|
2486
|
-
# @param search_method_params [SearchMethodParams]
|
2486
|
+
# @param search_method_params [SearchMethodParams] Muli-search request body. Results are returned in the same order as the requests. (required)
|
2487
2487
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2488
2488
|
# @return [SearchResponses]
|
2489
2489
|
def search(search_method_params, request_options = {})
|
@@ -2491,11 +2491,11 @@ module Algolia
|
|
2491
2491
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SearchResponses')
|
2492
2492
|
end
|
2493
2493
|
|
2494
|
-
#
|
2494
|
+
# Searches for standard and custom dictionary entries.
|
2495
2495
|
#
|
2496
2496
|
# Required API Key ACLs:
|
2497
2497
|
# - settings
|
2498
|
-
# @param dictionary_name [DictionaryType] Dictionary to search
|
2498
|
+
# @param dictionary_name [DictionaryType] Dictionary type in which to search. (required)
|
2499
2499
|
# @param search_dictionary_entries_params [SearchDictionaryEntriesParams] (required)
|
2500
2500
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2501
2501
|
# @return [Http::Response] the response
|
@@ -2528,25 +2528,25 @@ module Algolia
|
|
2528
2528
|
@api_client.call_api(:POST, path, new_options)
|
2529
2529
|
end
|
2530
2530
|
|
2531
|
-
#
|
2531
|
+
# Searches for standard and custom dictionary entries.
|
2532
2532
|
#
|
2533
2533
|
# Required API Key ACLs:
|
2534
2534
|
# - settings
|
2535
|
-
# @param dictionary_name [DictionaryType] Dictionary to search
|
2535
|
+
# @param dictionary_name [DictionaryType] Dictionary type in which to search. (required)
|
2536
2536
|
# @param search_dictionary_entries_params [SearchDictionaryEntriesParams] (required)
|
2537
2537
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2538
|
-
# @return [
|
2538
|
+
# @return [SearchDictionaryEntriesResponse]
|
2539
2539
|
def search_dictionary_entries(dictionary_name, search_dictionary_entries_params, request_options = {})
|
2540
2540
|
response = search_dictionary_entries_with_http_info(dictionary_name, search_dictionary_entries_params, request_options)
|
2541
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::
|
2541
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SearchDictionaryEntriesResponse')
|
2542
2542
|
end
|
2543
2543
|
|
2544
|
-
#
|
2544
|
+
# 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**.
|
2545
2545
|
#
|
2546
2546
|
# Required API Key ACLs:
|
2547
2547
|
# - search
|
2548
|
-
# @param index_name [String]
|
2549
|
-
# @param facet_name [String] Facet
|
2548
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2549
|
+
# @param facet_name [String] Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)
|
2550
2550
|
# @param search_for_facet_values_request [SearchForFacetValuesRequest]
|
2551
2551
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2552
2552
|
# @return [Http::Response] the response
|
@@ -2580,12 +2580,12 @@ module Algolia
|
|
2580
2580
|
@api_client.call_api(:POST, path, new_options)
|
2581
2581
|
end
|
2582
2582
|
|
2583
|
-
#
|
2583
|
+
# 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**.
|
2584
2584
|
#
|
2585
2585
|
# Required API Key ACLs:
|
2586
2586
|
# - search
|
2587
|
-
# @param index_name [String]
|
2588
|
-
# @param facet_name [String] Facet
|
2587
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2588
|
+
# @param facet_name [String] Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)
|
2589
2589
|
# @param search_for_facet_values_request [SearchForFacetValuesRequest]
|
2590
2590
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2591
2591
|
# @return [SearchForFacetValuesResponse]
|
@@ -2594,11 +2594,11 @@ module Algolia
|
|
2594
2594
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SearchForFacetValuesResponse')
|
2595
2595
|
end
|
2596
2596
|
|
2597
|
-
#
|
2597
|
+
# Searches for rules in your index.
|
2598
2598
|
#
|
2599
2599
|
# Required API Key ACLs:
|
2600
2600
|
# - settings
|
2601
|
-
# @param index_name [String]
|
2601
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2602
2602
|
# @param search_rules_params [SearchRulesParams]
|
2603
2603
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2604
2604
|
# @return [Http::Response] the response
|
@@ -2627,11 +2627,11 @@ module Algolia
|
|
2627
2627
|
@api_client.call_api(:POST, path, new_options)
|
2628
2628
|
end
|
2629
2629
|
|
2630
|
-
#
|
2630
|
+
# Searches for rules in your index.
|
2631
2631
|
#
|
2632
2632
|
# Required API Key ACLs:
|
2633
2633
|
# - settings
|
2634
|
-
# @param index_name [String]
|
2634
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2635
2635
|
# @param search_rules_params [SearchRulesParams]
|
2636
2636
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2637
2637
|
# @return [SearchRulesResponse]
|
@@ -2640,11 +2640,11 @@ module Algolia
|
|
2640
2640
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SearchRulesResponse')
|
2641
2641
|
end
|
2642
2642
|
|
2643
|
-
#
|
2643
|
+
# Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
|
2644
2644
|
#
|
2645
2645
|
# Required API Key ACLs:
|
2646
2646
|
# - search
|
2647
|
-
# @param index_name [String]
|
2647
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2648
2648
|
# @param search_params [SearchParams]
|
2649
2649
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2650
2650
|
# @return [Http::Response] the response
|
@@ -2673,11 +2673,11 @@ module Algolia
|
|
2673
2673
|
@api_client.call_api(:POST, path, new_options)
|
2674
2674
|
end
|
2675
2675
|
|
2676
|
-
#
|
2676
|
+
# Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
|
2677
2677
|
#
|
2678
2678
|
# Required API Key ACLs:
|
2679
2679
|
# - search
|
2680
|
-
# @param index_name [String]
|
2680
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2681
2681
|
# @param search_params [SearchParams]
|
2682
2682
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2683
2683
|
# @return [SearchResponse]
|
@@ -2686,11 +2686,11 @@ module Algolia
|
|
2686
2686
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SearchResponse')
|
2687
2687
|
end
|
2688
2688
|
|
2689
|
-
#
|
2689
|
+
# Searches for synonyms in your index.
|
2690
2690
|
#
|
2691
2691
|
# Required API Key ACLs:
|
2692
2692
|
# - settings
|
2693
|
-
# @param index_name [String]
|
2693
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2694
2694
|
# @param search_synonyms_params [SearchSynonymsParams] Body of the `searchSynonyms` operation.
|
2695
2695
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2696
2696
|
# @return [Http::Response] the response
|
@@ -2719,11 +2719,11 @@ module Algolia
|
|
2719
2719
|
@api_client.call_api(:POST, path, new_options)
|
2720
2720
|
end
|
2721
2721
|
|
2722
|
-
#
|
2722
|
+
# Searches for synonyms in your index.
|
2723
2723
|
#
|
2724
2724
|
# Required API Key ACLs:
|
2725
2725
|
# - settings
|
2726
|
-
# @param index_name [String]
|
2726
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2727
2727
|
# @param search_synonyms_params [SearchSynonymsParams] Body of the `searchSynonyms` operation.
|
2728
2728
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2729
2729
|
# @return [SearchSynonymsResponse]
|
@@ -2732,7 +2732,7 @@ module Algolia
|
|
2732
2732
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SearchSynonymsResponse')
|
2733
2733
|
end
|
2734
2734
|
|
2735
|
-
# Since it can take
|
2735
|
+
# 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).
|
2736
2736
|
#
|
2737
2737
|
# Required API Key ACLs:
|
2738
2738
|
# - admin
|
@@ -2764,7 +2764,7 @@ module Algolia
|
|
2764
2764
|
@api_client.call_api(:POST, path, new_options)
|
2765
2765
|
end
|
2766
2766
|
|
2767
|
-
# Since it can take
|
2767
|
+
# 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).
|
2768
2768
|
#
|
2769
2769
|
# Required API Key ACLs:
|
2770
2770
|
# - admin
|
@@ -2776,7 +2776,7 @@ module Algolia
|
|
2776
2776
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::SearchUserIdsResponse')
|
2777
2777
|
end
|
2778
2778
|
|
2779
|
-
#
|
2779
|
+
# Turns standard stop word dictionary entries on or off for a given language.
|
2780
2780
|
#
|
2781
2781
|
# Required API Key ACLs:
|
2782
2782
|
# - editSettings
|
@@ -2808,7 +2808,7 @@ module Algolia
|
|
2808
2808
|
@api_client.call_api(:PUT, path, new_options)
|
2809
2809
|
end
|
2810
2810
|
|
2811
|
-
#
|
2811
|
+
# Turns standard stop word dictionary entries on or off for a given language.
|
2812
2812
|
#
|
2813
2813
|
# Required API Key ACLs:
|
2814
2814
|
# - editSettings
|
@@ -2820,13 +2820,13 @@ module Algolia
|
|
2820
2820
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
2821
2821
|
end
|
2822
2822
|
|
2823
|
-
# Update the specified
|
2823
|
+
# 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.
|
2824
2824
|
#
|
2825
2825
|
# Required API Key ACLs:
|
2826
2826
|
# - editSettings
|
2827
|
-
# @param index_name [String]
|
2827
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2828
2828
|
# @param index_settings [IndexSettings] (required)
|
2829
|
-
# @param forward_to_replicas [Boolean]
|
2829
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2830
2830
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2831
2831
|
# @return [Http::Response] the response
|
2832
2832
|
def set_settings_with_http_info(index_name, index_settings, forward_to_replicas = nil, request_options = {})
|
@@ -2859,13 +2859,13 @@ module Algolia
|
|
2859
2859
|
@api_client.call_api(:PUT, path, new_options)
|
2860
2860
|
end
|
2861
2861
|
|
2862
|
-
# Update the specified
|
2862
|
+
# 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.
|
2863
2863
|
#
|
2864
2864
|
# Required API Key ACLs:
|
2865
2865
|
# - editSettings
|
2866
|
-
# @param index_name [String]
|
2866
|
+
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
2867
2867
|
# @param index_settings [IndexSettings] (required)
|
2868
|
-
# @param forward_to_replicas [Boolean]
|
2868
|
+
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
2869
2869
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2870
2870
|
# @return [UpdatedAtResponse]
|
2871
2871
|
def set_settings(index_name, index_settings, forward_to_replicas = nil, request_options = {})
|
@@ -2873,7 +2873,7 @@ module Algolia
|
|
2873
2873
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Search::UpdatedAtResponse')
|
2874
2874
|
end
|
2875
2875
|
|
2876
|
-
#
|
2876
|
+
# Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
|
2877
2877
|
#
|
2878
2878
|
# Required API Key ACLs:
|
2879
2879
|
# - admin
|
@@ -2910,7 +2910,7 @@ module Algolia
|
|
2910
2910
|
@api_client.call_api(:PUT, path, new_options)
|
2911
2911
|
end
|
2912
2912
|
|
2913
|
-
#
|
2913
|
+
# Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
|
2914
2914
|
#
|
2915
2915
|
# Required API Key ACLs:
|
2916
2916
|
# - admin
|