algolia 3.0.0.alpha.15 → 3.0.0.alpha.16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/Gemfile.lock +1 -1
  4. data/lib/algolia/api/ingestion_client.rb +267 -196
  5. data/lib/algolia/api/monitoring_client.rb +49 -49
  6. data/lib/algolia/api/query_suggestions_client.rb +14 -14
  7. data/lib/algolia/models/ingestion/auth_algolia.rb +3 -2
  8. data/lib/algolia/models/ingestion/auth_algolia_partial.rb +3 -2
  9. data/lib/algolia/models/ingestion/auth_api_key.rb +2 -1
  10. data/lib/algolia/models/ingestion/auth_api_key_partial.rb +2 -1
  11. data/lib/algolia/models/ingestion/auth_basic.rb +3 -1
  12. data/lib/algolia/models/ingestion/auth_basic_partial.rb +3 -1
  13. data/lib/algolia/models/ingestion/auth_google_service_account.rb +3 -3
  14. data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +3 -3
  15. data/lib/algolia/models/ingestion/auth_o_auth.rb +18 -8
  16. data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +18 -8
  17. data/lib/algolia/models/ingestion/authentication.rb +5 -5
  18. data/lib/algolia/models/ingestion/authentication_create.rb +2 -2
  19. data/lib/algolia/models/ingestion/authentication_create_response.rb +4 -4
  20. data/lib/algolia/models/ingestion/authentication_search.rb +1 -1
  21. data/lib/algolia/models/ingestion/authentication_update.rb +2 -2
  22. data/lib/algolia/models/ingestion/authentication_update_response.rb +4 -4
  23. data/lib/algolia/models/ingestion/big_commerce_channel.rb +2 -2
  24. data/lib/algolia/models/ingestion/big_commerce_metafield.rb +2 -2
  25. data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +1 -1
  26. data/lib/algolia/models/ingestion/delete_response.rb +1 -1
  27. data/lib/algolia/models/ingestion/destination.rb +6 -6
  28. data/lib/algolia/models/ingestion/destination_create.rb +3 -3
  29. data/lib/algolia/models/ingestion/destination_create_response.rb +4 -4
  30. data/lib/algolia/models/ingestion/destination_index_name.rb +2 -2
  31. data/lib/algolia/models/ingestion/destination_index_prefix.rb +1 -1
  32. data/lib/algolia/models/ingestion/destination_search.rb +1 -1
  33. data/lib/algolia/models/ingestion/destination_type.rb +1 -2
  34. data/lib/algolia/models/ingestion/destination_update.rb +3 -3
  35. data/lib/algolia/models/ingestion/destination_update_response.rb +4 -4
  36. data/lib/algolia/models/ingestion/docker_source_discover.rb +2 -2
  37. data/lib/algolia/models/ingestion/event.rb +3 -3
  38. data/lib/algolia/models/ingestion/list_tasks_response.rb +1 -1
  39. data/lib/algolia/models/ingestion/mapping_format_schema.rb +32 -0
  40. data/lib/algolia/models/ingestion/mapping_input.rb +24 -3
  41. data/lib/algolia/models/ingestion/on_demand_date_utils_input.rb +3 -3
  42. data/lib/algolia/models/ingestion/on_demand_trigger.rb +2 -2
  43. data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +1 -1
  44. data/lib/algolia/models/ingestion/pagination.rb +65 -0
  45. data/lib/algolia/models/ingestion/platform.rb +2 -1
  46. data/lib/algolia/models/ingestion/run.rb +7 -7
  47. data/lib/algolia/models/ingestion/run_response.rb +3 -3
  48. data/lib/algolia/models/ingestion/schedule_date_utils_input.rb +2 -2
  49. data/lib/algolia/models/ingestion/schedule_trigger.rb +4 -4
  50. data/lib/algolia/models/ingestion/schedule_trigger_input.rb +2 -2
  51. data/lib/algolia/models/ingestion/source.rb +4 -4
  52. data/lib/algolia/models/ingestion/source_big_commerce.rb +1 -1
  53. data/lib/algolia/models/ingestion/source_big_query.rb +5 -5
  54. data/lib/algolia/models/ingestion/source_commercetools.rb +2 -2
  55. data/lib/algolia/models/ingestion/source_create.rb +2 -1
  56. data/lib/algolia/models/ingestion/source_create_response.rb +3 -2
  57. data/lib/algolia/models/ingestion/source_csv.rb +3 -3
  58. data/lib/algolia/models/ingestion/source_docker.rb +3 -3
  59. data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +3 -3
  60. data/lib/algolia/models/ingestion/source_json.rb +2 -2
  61. data/lib/algolia/models/ingestion/source_type.rb +5 -3
  62. data/lib/algolia/models/ingestion/source_update.rb +2 -1
  63. data/lib/algolia/models/ingestion/source_update_commercetools.rb +2 -3
  64. data/lib/algolia/models/ingestion/source_update_docker.rb +3 -3
  65. data/lib/algolia/models/ingestion/source_update_response.rb +3 -2
  66. data/lib/algolia/models/ingestion/streaming_trigger.rb +1 -1
  67. data/lib/algolia/models/ingestion/streaming_utils_input.rb +1 -1
  68. data/lib/algolia/models/ingestion/subscription_trigger.rb +1 -1
  69. data/lib/algolia/models/ingestion/task.rb +7 -7
  70. data/lib/algolia/models/ingestion/task_create.rb +5 -5
  71. data/lib/algolia/models/ingestion/task_create_response.rb +3 -3
  72. data/lib/algolia/models/ingestion/task_input.rb +1 -0
  73. data/lib/algolia/models/ingestion/task_update.rb +4 -4
  74. data/lib/algolia/models/ingestion/task_update_response.rb +3 -3
  75. data/lib/algolia/models/ingestion/trigger.rb +1 -0
  76. data/lib/algolia/models/ingestion/trigger_update_input.rb +2 -2
  77. data/lib/algolia/models/ingestion/window.rb +3 -3
  78. data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -0
  79. data/lib/algolia/models/monitoring/{get_inventory403_response.rb → get_servers403_response.rb} +3 -3
  80. data/lib/algolia/models/monitoring/server.rb +2 -2
  81. data/lib/algolia/models/query-suggestions/app_id.rb +197 -0
  82. data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +2 -2
  83. data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +1 -1
  84. data/lib/algolia/models/query-suggestions/languages.rb +1 -1
  85. data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +2 -3
  86. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +23 -34
  87. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +18 -20
  88. data/lib/algolia/models/query-suggestions/source_index.rb +3 -5
  89. data/lib/algolia/version.rb +1 -1
  90. metadata +5 -3
@@ -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
- # List known incidents for selected clusters.
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
- # List known incidents for selected clusters.
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
- # Report whether a cluster is operational.
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
- # Report whether a cluster is operational.
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
- # List known incidents for all clusters.
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
- # List known incidents for all clusters.
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
- # List the average times for indexing operations for selected clusters.
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
- # List the average times for indexing operations for selected clusters.
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
- # 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.
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
- # List the average latency for search requests for selected clusters.
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
- # Report the aggregate value of a metric for a selected period of time.
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 `*` as the parameter. (required)
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
- # Report the aggregate value of a metric for a selected period of time.
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 `*` as the parameter. (required)
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
- # Report whether clusters are operational. The response depends on whether you authenticate your API request. - With authentication, the response includes the status of the cluster assigned to your Algolia application. - Without authentication, the response lists the statuses of all public Algolia clusters.
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&#39;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
- # Report whether clusters are operational. The response depends on whether you authenticate your API request. - With authentication, the response includes the status of the cluster assigned to your Algolia application. - Without authentication, the response lists the statuses of all public Algolia clusters.
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]
@@ -33,7 +33,7 @@ module Algolia
33
33
  new(config)
34
34
  end
35
35
 
36
- # Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
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
- # Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
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
@@ -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
- # Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
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
- # Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
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
- # List all Query Suggestions configurations of your Algolia application.
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
- # List all Query Suggestions configurations of your Algolia application.
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
- # Get a single Query Suggestions configuration.
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
- # Get a single Query Suggestions configuration.
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
- # Report the status of a Query Suggestions index.
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
- # Report the status of a Query Suggestions index.
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
- # Get the logs for a single Query Suggestions index.
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
- # Get the logs for a single Query Suggestions index.
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
- # Update a QuerySuggestions configuration.
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
- # Update a QuerySuggestions configuration.
506
+ # Updates a QuerySuggestions configuration.
507
507
  #
508
508
  # Required API Key ACLs:
509
509
  # - editSettings
@@ -5,11 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
+ # Credentials for authenticating with Algolia.
8
9
  class AuthAlgolia
9
- # Algolia Application ID.
10
+ # Algolia application ID.
10
11
  attr_accessor :app_id
11
12
 
12
- # Algolia API Key, with the correct rights to push to an index and change settings.
13
+ # Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
13
14
  attr_accessor :api_key
14
15
 
15
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,11 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
+ # Credentials for authenticating with Algolia.
8
9
  class AuthAlgoliaPartial
9
- # Algolia Application ID.
10
+ # Algolia application ID.
10
11
  attr_accessor :app_id
11
12
 
12
- # Algolia API Key, with the correct rights to push to an index and change settings.
13
+ # Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
13
14
  attr_accessor :api_key
14
15
 
15
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,8 +5,9 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Authentication input used for token credentials.
8
+ # Credentials for authenticating with an API key.
9
9
  class AuthAPIKey
10
+ # API key. This field is `null` in the API response.
10
11
  attr_accessor :key
11
12
 
12
13
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,8 +5,9 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Authentication input used for token credentials.
8
+ # Credentials for authenticating with an API key.
9
9
  class AuthAPIKeyPartial
10
+ # API key. This field is `null` in the API response.
10
11
  attr_accessor :key
11
12
 
12
13
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,10 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Authentication input for Basic login with username and password.
8
+ # Credentials for authenticating with user name and password.
9
9
  class AuthBasic
10
+ # Username.
10
11
  attr_accessor :username
11
12
 
13
+ # Password. This field is `null` in the API response.
12
14
  attr_accessor :password
13
15
 
14
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,10 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Authentication input for Basic login with username and password.
8
+ # Credentials for authenticating with user name and password.
9
9
  class AuthBasicPartial
10
+ # Username.
10
11
  attr_accessor :username
11
12
 
13
+ # Password. This field is `null` in the API response.
12
14
  attr_accessor :password
13
15
 
14
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,12 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Authentication input to connect to a Google service (e.g. BigQuery).
8
+ # Credentials for authenticating with a Google service account, such as BigQuery.
9
9
  class AuthGoogleServiceAccount
10
- # Email address of the Service Account.
10
+ # Email address of the Google service account.
11
11
  attr_accessor :client_email
12
12
 
13
- # Private key of the Service Account.
13
+ # Private key of the Google service account. This field is `null` in the API response.
14
14
  attr_accessor :private_key
15
15
 
16
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,12 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Authentication input to connect to a Google service (e.g. BigQuery).
8
+ # Credentials for authenticating with a Google service account, such as BigQuery.
9
9
  class AuthGoogleServiceAccountPartial
10
- # Email address of the Service Account.
10
+ # Email address of the Google service account.
11
11
  attr_accessor :client_email
12
12
 
13
- # Private key of the Service Account.
13
+ # Private key of the Google service account. This field is `null` in the API response.
14
14
  attr_accessor :private_key
15
15
 
16
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,23 +5,27 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Authentication input for OAuth login.
8
+ # Credentials for authenticating with OAuth 2.0.
9
9
  class AuthOAuth
10
- # The OAuth endpoint URL.
10
+ # URL for the OAuth endpoint.
11
11
  attr_accessor :url
12
12
 
13
- # The clientID.
13
+ # Client ID.
14
14
  attr_accessor :client_id
15
15
 
16
- # The secret.
16
+ # Client secret. This field is `null` in the API response.
17
17
  attr_accessor :client_secret
18
18
 
19
+ # OAuth scope.
20
+ attr_accessor :scope
21
+
19
22
  # Attribute mapping from ruby-style variable name to JSON key.
20
23
  def self.attribute_map
21
24
  {
22
25
  :url => :url,
23
26
  :client_id => :client_id,
24
- :client_secret => :client_secret
27
+ :client_secret => :client_secret,
28
+ :scope => :scope
25
29
  }
26
30
  end
27
31
 
@@ -35,7 +39,8 @@ module Algolia
35
39
  {
36
40
  :url => :String,
37
41
  :client_id => :String,
38
- :client_secret => :String
42
+ :client_secret => :String,
43
+ :scope => :String
39
44
  }
40
45
  end
41
46
 
@@ -78,6 +83,10 @@ module Algolia
78
83
  else
79
84
  self.client_secret = nil
80
85
  end
86
+
87
+ if attributes.key?(:scope)
88
+ self.scope = attributes[:scope]
89
+ end
81
90
  end
82
91
 
83
92
  # Checks equality by comparing each attribute.
@@ -88,7 +97,8 @@ module Algolia
88
97
  self.class == other.class &&
89
98
  url == other.url &&
90
99
  client_id == other.client_id &&
91
- client_secret == other.client_secret
100
+ client_secret == other.client_secret &&
101
+ scope == other.scope
92
102
  end
93
103
 
94
104
  # @see the `==` method
@@ -100,7 +110,7 @@ module Algolia
100
110
  # Calculates hash code according to all attributes.
101
111
  # @return [Integer] Hash code
102
112
  def hash
103
- [url, client_id, client_secret].hash
113
+ [url, client_id, client_secret, scope].hash
104
114
  end
105
115
 
106
116
  # Builds the object from hash
@@ -5,23 +5,27 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Authentication input for OAuth login.
8
+ # Credentials for authenticating with OAuth 2.0.
9
9
  class AuthOAuthPartial
10
- # The OAuth endpoint URL.
10
+ # URL for the OAuth endpoint.
11
11
  attr_accessor :url
12
12
 
13
- # The clientID.
13
+ # Client ID.
14
14
  attr_accessor :client_id
15
15
 
16
- # The secret.
16
+ # Client secret. This field is `null` in the API response.
17
17
  attr_accessor :client_secret
18
18
 
19
+ # OAuth scope.
20
+ attr_accessor :scope
21
+
19
22
  # Attribute mapping from ruby-style variable name to JSON key.
20
23
  def self.attribute_map
21
24
  {
22
25
  :url => :url,
23
26
  :client_id => :client_id,
24
- :client_secret => :client_secret
27
+ :client_secret => :client_secret,
28
+ :scope => :scope
25
29
  }
26
30
  end
27
31
 
@@ -35,7 +39,8 @@ module Algolia
35
39
  {
36
40
  :url => :String,
37
41
  :client_id => :String,
38
- :client_secret => :String
42
+ :client_secret => :String,
43
+ :scope => :String
39
44
  }
40
45
  end
41
46
 
@@ -72,6 +77,10 @@ module Algolia
72
77
  if attributes.key?(:client_secret)
73
78
  self.client_secret = attributes[:client_secret]
74
79
  end
80
+
81
+ if attributes.key?(:scope)
82
+ self.scope = attributes[:scope]
83
+ end
75
84
  end
76
85
 
77
86
  # Checks equality by comparing each attribute.
@@ -82,7 +91,8 @@ module Algolia
82
91
  self.class == other.class &&
83
92
  url == other.url &&
84
93
  client_id == other.client_id &&
85
- client_secret == other.client_secret
94
+ client_secret == other.client_secret &&
95
+ scope == other.scope
86
96
  end
87
97
 
88
98
  # @see the `==` method
@@ -94,7 +104,7 @@ module Algolia
94
104
  # Calculates hash code according to all attributes.
95
105
  # @return [Integer] Hash code
96
106
  def hash
97
- [url, client_id, client_secret].hash
107
+ [url, client_id, client_secret, scope].hash
98
108
  end
99
109
 
100
110
  # Builds the object from hash
@@ -5,24 +5,24 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # An authentication is used to login into a Source or a Destination, with obfuscated input.
8
+ # Resource representing the information required to authenticate with a source or a destination.
9
9
  class Authentication
10
- # The authentication UUID.
10
+ # Universally unique identifier (UUID) of an authentication resource.
11
11
  attr_accessor :authentication_id
12
12
 
13
13
  attr_accessor :type
14
14
 
15
- # An human readable name describing the object.
15
+ # Descriptive name for the resource.
16
16
  attr_accessor :name
17
17
 
18
18
  attr_accessor :platform
19
19
 
20
20
  attr_accessor :input
21
21
 
22
- # Date of creation (RFC3339 format).
22
+ # Date of creation in RFC3339 format.
23
23
  attr_accessor :created_at
24
24
 
25
- # Date of last update (RFC3339 format).
25
+ # Date of last update in RFC3339 format.
26
26
  attr_accessor :updated_at
27
27
 
28
28
  class EnumAttributeValidator
@@ -5,11 +5,11 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The payload when creating an authentication.
8
+ # Request body for creating a new authentication resource.
9
9
  class AuthenticationCreate
10
10
  attr_accessor :type
11
11
 
12
- # An human readable name describing the object.
12
+ # Descriptive name for the resource.
13
13
  attr_accessor :name
14
14
 
15
15
  attr_accessor :platform
@@ -5,15 +5,15 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # Response from the API when the Authentication is successfully created.
8
+ # API response for the successful creation of an authentication resource.
9
9
  class AuthenticationCreateResponse
10
- # The authentication UUID.
10
+ # Universally unique identifier (UUID) of an authentication resource.
11
11
  attr_accessor :authentication_id
12
12
 
13
- # An human readable name describing the object.
13
+ # Descriptive name for the resource.
14
14
  attr_accessor :name
15
15
 
16
- # Date of creation (RFC3339 format).
16
+ # Date of creation in RFC3339 format.
17
17
  attr_accessor :created_at
18
18
 
19
19
  # Attribute mapping from ruby-style variable name to JSON key.