algolia 3.0.0.alpha.14 → 3.0.0.alpha.16
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/Gemfile.lock +2 -2
- data/lib/algolia/api/abtesting_client.rb +4 -4
- data/lib/algolia/api/analytics_client.rb +268 -98
- data/lib/algolia/api/ingestion_client.rb +271 -200
- data/lib/algolia/api/insights_client.rb +4 -4
- data/lib/algolia/api/monitoring_client.rb +53 -53
- data/lib/algolia/api/personalization_client.rb +4 -4
- data/lib/algolia/api/query_suggestions_client.rb +18 -18
- data/lib/algolia/api/recommend_client.rb +4 -4
- data/lib/algolia/api/search_client.rb +4 -4
- data/lib/algolia/models/abtesting/{currencies_value.rb → currency.rb} +3 -3
- data/lib/algolia/models/abtesting/variant.rb +2 -5
- data/lib/algolia/models/analytics/{click_position.rb → click_positions_inner.rb} +38 -9
- data/lib/algolia/models/analytics/currencies_value.rb +208 -0
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +265 -0
- data/lib/algolia/models/analytics/daily_average_clicks.rb +249 -0
- data/lib/algolia/models/analytics/{click_through_rate_event.rb → daily_click_through_rates.rb} +24 -14
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +265 -0
- data/lib/algolia/models/analytics/{no_click_rate_event.rb → daily_no_click_rates.rb} +21 -7
- data/lib/algolia/models/analytics/{no_results_rate_event.rb → daily_no_results_rates.rb} +7 -7
- data/lib/algolia/models/analytics/{conversion_rate_event.rb → daily_purchase_rates.rb} +18 -22
- data/lib/algolia/models/analytics/{average_click_event.rb → daily_revenue.rb} +15 -25
- data/lib/algolia/models/analytics/{search_event.rb → daily_searches.rb} +4 -4
- data/lib/algolia/models/analytics/{search_no_result_event.rb → daily_searches_no_clicks.rb} +19 -5
- data/lib/algolia/models/analytics/{search_no_click_event.rb → daily_searches_no_results.rb} +19 -5
- data/lib/algolia/models/analytics/{user_with_date.rb → daily_users.rb} +5 -5
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +267 -0
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +31 -5
- data/lib/algolia/models/analytics/get_click_positions_response.rb +6 -6
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +22 -12
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +267 -0
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +19 -5
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +5 -5
- data/lib/algolia/models/analytics/{get_conversation_rate_response.rb → get_purchase_rate_response.rb} +19 -23
- data/lib/algolia/models/analytics/get_revenue.rb +215 -0
- data/lib/algolia/models/analytics/get_searches_count_response.rb +2 -2
- data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +2 -2
- data/lib/algolia/models/analytics/get_searches_no_results_response.rb +2 -2
- data/lib/algolia/models/analytics/get_status_response.rb +4 -2
- data/lib/algolia/models/analytics/get_top_countries_response.rb +1 -1
- data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +1 -1
- data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +23 -2
- data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +4 -2
- data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +23 -2
- data/lib/algolia/models/analytics/get_top_hits_response.rb +2 -1
- data/lib/algolia/models/analytics/get_top_searches_response.rb +2 -1
- data/lib/algolia/models/analytics/get_users_count_response.rb +3 -3
- data/lib/algolia/models/analytics/operator.rb +38 -0
- data/lib/algolia/models/analytics/top_country.rb +1 -1
- data/lib/algolia/models/analytics/top_hit.rb +1 -1
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +60 -21
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +437 -0
- data/lib/algolia/models/analytics/top_hits_response.rb +1 -1
- data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +1 -1
- data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +201 -0
- data/lib/algolia/models/analytics/top_search.rb +2 -2
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +99 -17
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +504 -0
- data/lib/algolia/models/analytics/top_searches_response.rb +1 -1
- data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +1 -1
- data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +201 -0
- data/lib/algolia/models/ingestion/auth_algolia.rb +3 -2
- data/lib/algolia/models/ingestion/auth_algolia_partial.rb +3 -2
- data/lib/algolia/models/ingestion/auth_api_key.rb +2 -1
- data/lib/algolia/models/ingestion/auth_api_key_partial.rb +2 -1
- data/lib/algolia/models/ingestion/auth_basic.rb +3 -1
- data/lib/algolia/models/ingestion/auth_basic_partial.rb +3 -1
- data/lib/algolia/models/ingestion/auth_google_service_account.rb +3 -3
- data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +3 -3
- data/lib/algolia/models/ingestion/auth_o_auth.rb +18 -8
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +18 -8
- data/lib/algolia/models/ingestion/authentication.rb +5 -5
- data/lib/algolia/models/ingestion/authentication_create.rb +2 -2
- data/lib/algolia/models/ingestion/authentication_create_response.rb +4 -4
- data/lib/algolia/models/ingestion/authentication_search.rb +1 -1
- data/lib/algolia/models/ingestion/authentication_update.rb +2 -2
- data/lib/algolia/models/ingestion/authentication_update_response.rb +4 -4
- data/lib/algolia/models/ingestion/big_commerce_channel.rb +2 -2
- data/lib/algolia/models/ingestion/big_commerce_metafield.rb +2 -2
- data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +1 -1
- data/lib/algolia/models/ingestion/delete_response.rb +1 -1
- data/lib/algolia/models/ingestion/destination.rb +6 -6
- data/lib/algolia/models/ingestion/destination_create.rb +3 -3
- data/lib/algolia/models/ingestion/destination_create_response.rb +4 -4
- data/lib/algolia/models/ingestion/destination_index_name.rb +2 -2
- data/lib/algolia/models/ingestion/destination_index_prefix.rb +1 -1
- data/lib/algolia/models/ingestion/destination_search.rb +1 -1
- data/lib/algolia/models/ingestion/destination_type.rb +1 -2
- data/lib/algolia/models/ingestion/destination_update.rb +3 -3
- data/lib/algolia/models/ingestion/destination_update_response.rb +4 -4
- data/lib/algolia/models/ingestion/docker_source_discover.rb +2 -2
- data/lib/algolia/models/ingestion/event.rb +3 -3
- data/lib/algolia/models/ingestion/list_tasks_response.rb +1 -1
- data/lib/algolia/models/ingestion/mapping_format_schema.rb +32 -0
- data/lib/algolia/models/ingestion/mapping_input.rb +24 -3
- data/lib/algolia/models/ingestion/on_demand_date_utils_input.rb +3 -3
- data/lib/algolia/models/ingestion/on_demand_trigger.rb +2 -2
- data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +1 -1
- data/lib/algolia/models/ingestion/pagination.rb +65 -0
- data/lib/algolia/models/ingestion/platform.rb +2 -1
- data/lib/algolia/models/ingestion/run.rb +7 -7
- data/lib/algolia/models/ingestion/run_response.rb +3 -3
- data/lib/algolia/models/ingestion/schedule_date_utils_input.rb +2 -2
- data/lib/algolia/models/ingestion/schedule_trigger.rb +4 -4
- data/lib/algolia/models/ingestion/schedule_trigger_input.rb +2 -2
- data/lib/algolia/models/ingestion/source.rb +4 -4
- data/lib/algolia/models/ingestion/source_big_commerce.rb +1 -1
- data/lib/algolia/models/ingestion/source_big_query.rb +5 -5
- data/lib/algolia/models/ingestion/source_commercetools.rb +2 -2
- data/lib/algolia/models/ingestion/source_create.rb +2 -1
- data/lib/algolia/models/ingestion/source_create_response.rb +3 -2
- data/lib/algolia/models/ingestion/source_csv.rb +3 -3
- data/lib/algolia/models/ingestion/source_docker.rb +3 -3
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +3 -3
- data/lib/algolia/models/ingestion/source_json.rb +2 -2
- data/lib/algolia/models/ingestion/source_type.rb +5 -3
- data/lib/algolia/models/ingestion/source_update.rb +2 -1
- data/lib/algolia/models/ingestion/source_update_commercetools.rb +2 -3
- data/lib/algolia/models/ingestion/source_update_docker.rb +3 -3
- data/lib/algolia/models/ingestion/source_update_response.rb +3 -2
- data/lib/algolia/models/ingestion/streaming_trigger.rb +1 -1
- data/lib/algolia/models/ingestion/streaming_utils_input.rb +1 -1
- data/lib/algolia/models/ingestion/subscription_trigger.rb +1 -1
- data/lib/algolia/models/ingestion/task.rb +7 -7
- data/lib/algolia/models/ingestion/task_create.rb +5 -5
- data/lib/algolia/models/ingestion/task_create_response.rb +3 -3
- data/lib/algolia/models/ingestion/task_input.rb +1 -0
- data/lib/algolia/models/ingestion/task_update.rb +4 -4
- data/lib/algolia/models/ingestion/task_update_response.rb +3 -3
- data/lib/algolia/models/ingestion/trigger.rb +1 -0
- data/lib/algolia/models/ingestion/trigger_update_input.rb +2 -2
- data/lib/algolia/models/ingestion/window.rb +3 -3
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/monitoring/{get_inventory403_response.rb → get_servers403_response.rb} +3 -3
- data/lib/algolia/models/monitoring/server.rb +2 -2
- data/lib/algolia/models/query-suggestions/app_id.rb +197 -0
- data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +2 -2
- data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +1 -1
- data/lib/algolia/models/query-suggestions/languages.rb +1 -1
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +2 -3
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +23 -34
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +18 -20
- data/lib/algolia/models/query-suggestions/source_index.rb +3 -5
- data/lib/algolia/version.rb +1 -1
- metadata +29 -15
@@ -45,7 +45,7 @@ module Algolia
|
|
45
45
|
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
46
46
|
end
|
47
47
|
|
48
|
-
path = '/
|
48
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
49
49
|
query_params = {}
|
50
50
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
51
51
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -88,7 +88,7 @@ module Algolia
|
|
88
88
|
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
89
89
|
end
|
90
90
|
|
91
|
-
path = '/
|
91
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
92
92
|
query_params = {}
|
93
93
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
94
94
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -132,7 +132,7 @@ module Algolia
|
|
132
132
|
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
133
133
|
end
|
134
134
|
|
135
|
-
path = '/
|
135
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
136
136
|
query_params = {}
|
137
137
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
138
138
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -177,7 +177,7 @@ module Algolia
|
|
177
177
|
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
178
178
|
end
|
179
179
|
|
180
|
-
path = '/
|
180
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
181
181
|
query_params = {}
|
182
182
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
183
183
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -36,7 +36,7 @@ module Algolia
|
|
36
36
|
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
37
37
|
end
|
38
38
|
|
39
|
-
path = '/
|
39
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
40
40
|
query_params = {}
|
41
41
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
42
42
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -79,7 +79,7 @@ module Algolia
|
|
79
79
|
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
80
80
|
end
|
81
81
|
|
82
|
-
path = '/
|
82
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
83
83
|
query_params = {}
|
84
84
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
85
85
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -123,7 +123,7 @@ module Algolia
|
|
123
123
|
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
124
124
|
end
|
125
125
|
|
126
|
-
path = '/
|
126
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
127
127
|
query_params = {}
|
128
128
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
129
129
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -168,7 +168,7 @@ module Algolia
|
|
168
168
|
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
169
169
|
end
|
170
170
|
|
171
|
-
path = '/
|
171
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
172
172
|
query_params = {}
|
173
173
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
174
174
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -200,7 +200,7 @@ module Algolia
|
|
200
200
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
201
201
|
end
|
202
202
|
|
203
|
-
#
|
203
|
+
# Retrieves known incidents for the selected clusters.
|
204
204
|
|
205
205
|
# @param clusters [String] Subset of clusters, separated by comma. (required)
|
206
206
|
# @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)
|
@@ -230,7 +230,7 @@ module Algolia
|
|
230
230
|
@api_client.call_api(:GET, path, new_options)
|
231
231
|
end
|
232
232
|
|
233
|
-
#
|
233
|
+
# Retrieves known incidents for the selected clusters.
|
234
234
|
|
235
235
|
# @param clusters [String] Subset of clusters, separated by comma. (required)
|
236
236
|
# @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)
|
@@ -240,7 +240,7 @@ module Algolia
|
|
240
240
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::IncidentsResponse')
|
241
241
|
end
|
242
242
|
|
243
|
-
#
|
243
|
+
# Retrieves the status of selected clusters.
|
244
244
|
|
245
245
|
# @param clusters [String] Subset of clusters, separated by comma. (required)
|
246
246
|
# @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)
|
@@ -270,7 +270,7 @@ module Algolia
|
|
270
270
|
@api_client.call_api(:GET, path, new_options)
|
271
271
|
end
|
272
272
|
|
273
|
-
#
|
273
|
+
# Retrieves the status of selected clusters.
|
274
274
|
|
275
275
|
# @param clusters [String] Subset of clusters, separated by comma. (required)
|
276
276
|
# @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)
|
@@ -280,7 +280,7 @@ module Algolia
|
|
280
280
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::StatusResponse')
|
281
281
|
end
|
282
282
|
|
283
|
-
#
|
283
|
+
# Retrieves known incidents for all clusters.
|
284
284
|
|
285
285
|
# @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)
|
286
286
|
# @return [Http::Response] the response
|
@@ -304,7 +304,7 @@ module Algolia
|
|
304
304
|
@api_client.call_api(:GET, path, new_options)
|
305
305
|
end
|
306
306
|
|
307
|
-
#
|
307
|
+
# Retrieves known incidents for all clusters.
|
308
308
|
|
309
309
|
# @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)
|
310
310
|
# @return [IncidentsResponse]
|
@@ -313,7 +313,7 @@ module Algolia
|
|
313
313
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::IncidentsResponse')
|
314
314
|
end
|
315
315
|
|
316
|
-
#
|
316
|
+
# Retrieves average times for indexing operations for selected clusters.
|
317
317
|
|
318
318
|
# @param clusters [String] Subset of clusters, separated by comma. (required)
|
319
319
|
# @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)
|
@@ -343,7 +343,7 @@ module Algolia
|
|
343
343
|
@api_client.call_api(:GET, path, new_options)
|
344
344
|
end
|
345
345
|
|
346
|
-
#
|
346
|
+
# Retrieves average times for indexing operations for selected clusters.
|
347
347
|
|
348
348
|
# @param clusters [String] Subset of clusters, separated by comma. (required)
|
349
349
|
# @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)
|
@@ -353,40 +353,7 @@ module Algolia
|
|
353
353
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::IndexingTimeResponse')
|
354
354
|
end
|
355
355
|
|
356
|
-
#
|
357
|
-
|
358
|
-
# @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)
|
359
|
-
# @return [Http::Response] the response
|
360
|
-
def get_inventory_with_http_info(request_options = {})
|
361
|
-
path = '/1/inventory/servers'
|
362
|
-
query_params = {}
|
363
|
-
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
364
|
-
header_params = {}
|
365
|
-
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
366
|
-
|
367
|
-
post_body = request_options[:debug_body]
|
368
|
-
|
369
|
-
new_options = request_options.merge(
|
370
|
-
:operation => :'MonitoringClient.get_inventory',
|
371
|
-
:header_params => header_params,
|
372
|
-
:query_params => query_params,
|
373
|
-
:body => post_body,
|
374
|
-
:use_read_transporter => false
|
375
|
-
)
|
376
|
-
|
377
|
-
@api_client.call_api(:GET, path, new_options)
|
378
|
-
end
|
379
|
-
|
380
|
-
# List the servers belonging to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.
|
381
|
-
|
382
|
-
# @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)
|
383
|
-
# @return [InventoryResponse]
|
384
|
-
def get_inventory(request_options = {})
|
385
|
-
response = get_inventory_with_http_info(request_options)
|
386
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::InventoryResponse')
|
387
|
-
end
|
388
|
-
|
389
|
-
# List the average latency for search requests for selected clusters.
|
356
|
+
# Retrieves the average latency for search requests for selected clusters.
|
390
357
|
|
391
358
|
# @param clusters [String] Subset of clusters, separated by comma. (required)
|
392
359
|
# @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)
|
@@ -416,7 +383,7 @@ module Algolia
|
|
416
383
|
@api_client.call_api(:GET, path, new_options)
|
417
384
|
end
|
418
385
|
|
419
|
-
#
|
386
|
+
# Retrieves the average latency for search requests for selected clusters.
|
420
387
|
|
421
388
|
# @param clusters [String] Subset of clusters, separated by comma. (required)
|
422
389
|
# @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)
|
@@ -426,9 +393,9 @@ module Algolia
|
|
426
393
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::LatencyResponse')
|
427
394
|
end
|
428
395
|
|
429
|
-
#
|
396
|
+
# Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
|
430
397
|
|
431
|
-
# @param metric [Metric] Metric to report. For more information about the individual metrics, see the response. To include all metrics, use `*`
|
398
|
+
# @param metric [Metric] Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required)
|
432
399
|
# @param period [Period] Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required)
|
433
400
|
# @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)
|
434
401
|
# @return [Http::Response] the response
|
@@ -461,9 +428,9 @@ module Algolia
|
|
461
428
|
@api_client.call_api(:GET, path, new_options)
|
462
429
|
end
|
463
430
|
|
464
|
-
#
|
431
|
+
# Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
|
465
432
|
|
466
|
-
# @param metric [Metric] Metric to report. For more information about the individual metrics, see the response. To include all metrics, use `*`
|
433
|
+
# @param metric [Metric] Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required)
|
467
434
|
# @param period [Period] Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required)
|
468
435
|
# @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)
|
469
436
|
# @return [InfrastructureResponse]
|
@@ -512,7 +479,40 @@ module Algolia
|
|
512
479
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::Hash<String, Hash>')
|
513
480
|
end
|
514
481
|
|
515
|
-
#
|
482
|
+
# Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.
|
483
|
+
|
484
|
+
# @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)
|
485
|
+
# @return [Http::Response] the response
|
486
|
+
def get_servers_with_http_info(request_options = {})
|
487
|
+
path = '/1/inventory/servers'
|
488
|
+
query_params = {}
|
489
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
490
|
+
header_params = {}
|
491
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
492
|
+
|
493
|
+
post_body = request_options[:debug_body]
|
494
|
+
|
495
|
+
new_options = request_options.merge(
|
496
|
+
:operation => :'MonitoringClient.get_servers',
|
497
|
+
:header_params => header_params,
|
498
|
+
:query_params => query_params,
|
499
|
+
:body => post_body,
|
500
|
+
:use_read_transporter => false
|
501
|
+
)
|
502
|
+
|
503
|
+
@api_client.call_api(:GET, path, new_options)
|
504
|
+
end
|
505
|
+
|
506
|
+
# Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.
|
507
|
+
|
508
|
+
# @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)
|
509
|
+
# @return [InventoryResponse]
|
510
|
+
def get_servers(request_options = {})
|
511
|
+
response = get_servers_with_http_info(request_options)
|
512
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::InventoryResponse')
|
513
|
+
end
|
514
|
+
|
515
|
+
# Retrieves the status of all Algolia clusters and instances.
|
516
516
|
|
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 [Http::Response] the response
|
@@ -536,7 +536,7 @@ module Algolia
|
|
536
536
|
@api_client.call_api(:GET, path, new_options)
|
537
537
|
end
|
538
538
|
|
539
|
-
#
|
539
|
+
# Retrieves the status of all Algolia clusters and instances.
|
540
540
|
|
541
541
|
# @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)
|
542
542
|
# @return [StatusResponse]
|
@@ -45,7 +45,7 @@ module Algolia
|
|
45
45
|
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
46
46
|
end
|
47
47
|
|
48
|
-
path = '/
|
48
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
49
49
|
query_params = {}
|
50
50
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
51
51
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -88,7 +88,7 @@ module Algolia
|
|
88
88
|
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
89
89
|
end
|
90
90
|
|
91
|
-
path = '/
|
91
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
92
92
|
query_params = {}
|
93
93
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
94
94
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -132,7 +132,7 @@ module Algolia
|
|
132
132
|
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
133
133
|
end
|
134
134
|
|
135
|
-
path = '/
|
135
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
136
136
|
query_params = {}
|
137
137
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
138
138
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -177,7 +177,7 @@ module Algolia
|
|
177
177
|
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
178
178
|
end
|
179
179
|
|
180
|
-
path = '/
|
180
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
181
181
|
query_params = {}
|
182
182
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
183
183
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -33,7 +33,7 @@ module Algolia
|
|
33
33
|
new(config)
|
34
34
|
end
|
35
35
|
|
36
|
-
#
|
36
|
+
# Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
|
37
37
|
#
|
38
38
|
# Required API Key ACLs:
|
39
39
|
# - editSettings
|
@@ -65,7 +65,7 @@ module Algolia
|
|
65
65
|
@api_client.call_api(:POST, path, new_options)
|
66
66
|
end
|
67
67
|
|
68
|
-
#
|
68
|
+
# Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
|
69
69
|
#
|
70
70
|
# Required API Key ACLs:
|
71
71
|
# - editSettings
|
@@ -89,7 +89,7 @@ module Algolia
|
|
89
89
|
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
90
90
|
end
|
91
91
|
|
92
|
-
path = '/
|
92
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
93
93
|
query_params = {}
|
94
94
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
95
95
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -132,7 +132,7 @@ module Algolia
|
|
132
132
|
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
133
133
|
end
|
134
134
|
|
135
|
-
path = '/
|
135
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
136
136
|
query_params = {}
|
137
137
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
138
138
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -176,7 +176,7 @@ module Algolia
|
|
176
176
|
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
177
177
|
end
|
178
178
|
|
179
|
-
path = '/
|
179
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
180
180
|
query_params = {}
|
181
181
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
182
182
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -221,7 +221,7 @@ module Algolia
|
|
221
221
|
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
222
222
|
end
|
223
223
|
|
224
|
-
path = '/
|
224
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
225
225
|
query_params = {}
|
226
226
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
227
227
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -253,7 +253,7 @@ module Algolia
|
|
253
253
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
254
254
|
end
|
255
255
|
|
256
|
-
#
|
256
|
+
# Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.
|
257
257
|
#
|
258
258
|
# Required API Key ACLs:
|
259
259
|
# - editSettings
|
@@ -285,7 +285,7 @@ module Algolia
|
|
285
285
|
@api_client.call_api(:DELETE, path, new_options)
|
286
286
|
end
|
287
287
|
|
288
|
-
#
|
288
|
+
# Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.
|
289
289
|
#
|
290
290
|
# Required API Key ACLs:
|
291
291
|
# - editSettings
|
@@ -297,7 +297,7 @@ module Algolia
|
|
297
297
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
|
298
298
|
end
|
299
299
|
|
300
|
-
#
|
300
|
+
# Retrieves all Query Suggestions configurations of your Algolia application.
|
301
301
|
#
|
302
302
|
# Required API Key ACLs:
|
303
303
|
# - settings
|
@@ -323,7 +323,7 @@ module Algolia
|
|
323
323
|
@api_client.call_api(:GET, path, new_options)
|
324
324
|
end
|
325
325
|
|
326
|
-
#
|
326
|
+
# Retrieves all Query Suggestions configurations of your Algolia application.
|
327
327
|
#
|
328
328
|
# Required API Key ACLs:
|
329
329
|
# - settings
|
@@ -334,7 +334,7 @@ module Algolia
|
|
334
334
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<QuerySuggestions::QuerySuggestionsConfigurationResponse>')
|
335
335
|
end
|
336
336
|
|
337
|
-
#
|
337
|
+
# Retrieves a single Query Suggestions configuration by its index name.
|
338
338
|
#
|
339
339
|
# Required API Key ACLs:
|
340
340
|
# - settings
|
@@ -366,7 +366,7 @@ module Algolia
|
|
366
366
|
@api_client.call_api(:GET, path, new_options)
|
367
367
|
end
|
368
368
|
|
369
|
-
#
|
369
|
+
# Retrieves a single Query Suggestions configuration by its index name.
|
370
370
|
#
|
371
371
|
# Required API Key ACLs:
|
372
372
|
# - settings
|
@@ -378,7 +378,7 @@ module Algolia
|
|
378
378
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::QuerySuggestionsConfigurationResponse')
|
379
379
|
end
|
380
380
|
|
381
|
-
#
|
381
|
+
# Reports the status of a Query Suggestions index.
|
382
382
|
#
|
383
383
|
# Required API Key ACLs:
|
384
384
|
# - settings
|
@@ -410,7 +410,7 @@ module Algolia
|
|
410
410
|
@api_client.call_api(:GET, path, new_options)
|
411
411
|
end
|
412
412
|
|
413
|
-
#
|
413
|
+
# Reports the status of a Query Suggestions index.
|
414
414
|
#
|
415
415
|
# Required API Key ACLs:
|
416
416
|
# - settings
|
@@ -422,7 +422,7 @@ module Algolia
|
|
422
422
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetConfigStatus200Response')
|
423
423
|
end
|
424
424
|
|
425
|
-
#
|
425
|
+
# Retrieves the logs for a single Query Suggestions index.
|
426
426
|
#
|
427
427
|
# Required API Key ACLs:
|
428
428
|
# - settings
|
@@ -454,7 +454,7 @@ module Algolia
|
|
454
454
|
@api_client.call_api(:GET, path, new_options)
|
455
455
|
end
|
456
456
|
|
457
|
-
#
|
457
|
+
# Retrieves the logs for a single Query Suggestions index.
|
458
458
|
#
|
459
459
|
# Required API Key ACLs:
|
460
460
|
# - settings
|
@@ -466,7 +466,7 @@ module Algolia
|
|
466
466
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetLogFile200Response')
|
467
467
|
end
|
468
468
|
|
469
|
-
#
|
469
|
+
# Updates a QuerySuggestions configuration.
|
470
470
|
#
|
471
471
|
# Required API Key ACLs:
|
472
472
|
# - editSettings
|
@@ -503,7 +503,7 @@ module Algolia
|
|
503
503
|
@api_client.call_api(:PUT, path, new_options)
|
504
504
|
end
|
505
505
|
|
506
|
-
#
|
506
|
+
# Updates a QuerySuggestions configuration.
|
507
507
|
#
|
508
508
|
# Required API Key ACLs:
|
509
509
|
# - editSettings
|
@@ -41,7 +41,7 @@ module Algolia
|
|
41
41
|
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
42
42
|
end
|
43
43
|
|
44
|
-
path = '/
|
44
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
45
45
|
query_params = {}
|
46
46
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
47
47
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -84,7 +84,7 @@ module Algolia
|
|
84
84
|
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
85
85
|
end
|
86
86
|
|
87
|
-
path = '/
|
87
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
88
88
|
query_params = {}
|
89
89
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
90
90
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -128,7 +128,7 @@ module Algolia
|
|
128
128
|
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
129
129
|
end
|
130
130
|
|
131
|
-
path = '/
|
131
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
132
132
|
query_params = {}
|
133
133
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
134
134
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -173,7 +173,7 @@ module Algolia
|
|
173
173
|
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
174
174
|
end
|
175
175
|
|
176
|
-
path = '/
|
176
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
177
177
|
query_params = {}
|
178
178
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
179
179
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -580,7 +580,7 @@ module Algolia
|
|
580
580
|
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
581
581
|
end
|
582
582
|
|
583
|
-
path = '/
|
583
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
584
584
|
query_params = {}
|
585
585
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
586
586
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -623,7 +623,7 @@ module Algolia
|
|
623
623
|
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
624
624
|
end
|
625
625
|
|
626
|
-
path = '/
|
626
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
627
627
|
query_params = {}
|
628
628
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
629
629
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -667,7 +667,7 @@ module Algolia
|
|
667
667
|
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
668
668
|
end
|
669
669
|
|
670
|
-
path = '/
|
670
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
671
671
|
query_params = {}
|
672
672
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
673
673
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -712,7 +712,7 @@ module Algolia
|
|
712
712
|
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
713
713
|
end
|
714
714
|
|
715
|
-
path = '/
|
715
|
+
path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
|
716
716
|
query_params = {}
|
717
717
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
718
718
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -5,7 +5,7 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Abtesting
|
8
|
-
class
|
8
|
+
class Currency
|
9
9
|
# Currency code.
|
10
10
|
attr_accessor :currency
|
11
11
|
|
@@ -52,14 +52,14 @@ module Algolia
|
|
52
52
|
# @param [Hash] attributes Model attributes in the form of hash
|
53
53
|
def initialize(attributes = {})
|
54
54
|
unless attributes.is_a?(Hash)
|
55
|
-
raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::
|
55
|
+
raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Currency` initialize method"
|
56
56
|
end
|
57
57
|
|
58
58
|
# check to see if the attribute exists and convert string to symbol for hash key
|
59
59
|
attributes = attributes.each_with_object({}) do |(k, v), h|
|
60
60
|
unless self.class.attribute_map.key?(k.to_sym)
|
61
61
|
raise ArgumentError,
|
62
|
-
"`#{k}` is not a valid attribute in `Algolia::
|
62
|
+
"`#{k}` is not a valid attribute in `Algolia::Currency`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
63
63
|
end
|
64
64
|
|
65
65
|
h[k.to_sym] = v
|
@@ -53,7 +53,7 @@ module Algolia
|
|
53
53
|
# Number of searches carried out during the A/B test.
|
54
54
|
attr_accessor :search_count
|
55
55
|
|
56
|
-
# Number of tracked searches.
|
56
|
+
# Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
|
57
57
|
attr_accessor :tracked_search_count
|
58
58
|
|
59
59
|
# A/B test traffic percentage.
|
@@ -106,7 +106,7 @@ module Algolia
|
|
106
106
|
:click_through_rate => :Float,
|
107
107
|
:conversion_count => :Integer,
|
108
108
|
:conversion_rate => :Float,
|
109
|
-
:currencies => :'Hash<String,
|
109
|
+
:currencies => :'Hash<String, Currency>',
|
110
110
|
:description => :String,
|
111
111
|
:estimated_sample_size => :Integer,
|
112
112
|
:filter_effects => :FilterEffects,
|
@@ -132,7 +132,6 @@ module Algolia
|
|
132
132
|
:no_result_count,
|
133
133
|
:purchase_rate,
|
134
134
|
:search_count,
|
135
|
-
:tracked_search_count,
|
136
135
|
:user_count,
|
137
136
|
:tracked_user_count
|
138
137
|
])
|
@@ -249,8 +248,6 @@ module Algolia
|
|
249
248
|
|
250
249
|
if attributes.key?(:tracked_search_count)
|
251
250
|
self.tracked_search_count = attributes[:tracked_search_count]
|
252
|
-
else
|
253
|
-
self.tracked_search_count = nil
|
254
251
|
end
|
255
252
|
|
256
253
|
if attributes.key?(:traffic_percentage)
|