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.
Files changed (147) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/Gemfile.lock +2 -2
  4. data/lib/algolia/api/abtesting_client.rb +4 -4
  5. data/lib/algolia/api/analytics_client.rb +268 -98
  6. data/lib/algolia/api/ingestion_client.rb +271 -200
  7. data/lib/algolia/api/insights_client.rb +4 -4
  8. data/lib/algolia/api/monitoring_client.rb +53 -53
  9. data/lib/algolia/api/personalization_client.rb +4 -4
  10. data/lib/algolia/api/query_suggestions_client.rb +18 -18
  11. data/lib/algolia/api/recommend_client.rb +4 -4
  12. data/lib/algolia/api/search_client.rb +4 -4
  13. data/lib/algolia/models/abtesting/{currencies_value.rb → currency.rb} +3 -3
  14. data/lib/algolia/models/abtesting/variant.rb +2 -5
  15. data/lib/algolia/models/analytics/{click_position.rb → click_positions_inner.rb} +38 -9
  16. data/lib/algolia/models/analytics/currencies_value.rb +208 -0
  17. data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +265 -0
  18. data/lib/algolia/models/analytics/daily_average_clicks.rb +249 -0
  19. data/lib/algolia/models/analytics/{click_through_rate_event.rb → daily_click_through_rates.rb} +24 -14
  20. data/lib/algolia/models/analytics/daily_conversion_rates.rb +265 -0
  21. data/lib/algolia/models/analytics/{no_click_rate_event.rb → daily_no_click_rates.rb} +21 -7
  22. data/lib/algolia/models/analytics/{no_results_rate_event.rb → daily_no_results_rates.rb} +7 -7
  23. data/lib/algolia/models/analytics/{conversion_rate_event.rb → daily_purchase_rates.rb} +18 -22
  24. data/lib/algolia/models/analytics/{average_click_event.rb → daily_revenue.rb} +15 -25
  25. data/lib/algolia/models/analytics/{search_event.rb → daily_searches.rb} +4 -4
  26. data/lib/algolia/models/analytics/{search_no_result_event.rb → daily_searches_no_clicks.rb} +19 -5
  27. data/lib/algolia/models/analytics/{search_no_click_event.rb → daily_searches_no_results.rb} +19 -5
  28. data/lib/algolia/models/analytics/{user_with_date.rb → daily_users.rb} +5 -5
  29. data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +267 -0
  30. data/lib/algolia/models/analytics/get_average_click_position_response.rb +31 -5
  31. data/lib/algolia/models/analytics/get_click_positions_response.rb +6 -6
  32. data/lib/algolia/models/analytics/get_click_through_rate_response.rb +22 -12
  33. data/lib/algolia/models/analytics/get_conversion_rate_response.rb +267 -0
  34. data/lib/algolia/models/analytics/get_no_click_rate_response.rb +19 -5
  35. data/lib/algolia/models/analytics/get_no_results_rate_response.rb +5 -5
  36. data/lib/algolia/models/analytics/{get_conversation_rate_response.rb → get_purchase_rate_response.rb} +19 -23
  37. data/lib/algolia/models/analytics/get_revenue.rb +215 -0
  38. data/lib/algolia/models/analytics/get_searches_count_response.rb +2 -2
  39. data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +2 -2
  40. data/lib/algolia/models/analytics/get_searches_no_results_response.rb +2 -2
  41. data/lib/algolia/models/analytics/get_status_response.rb +4 -2
  42. data/lib/algolia/models/analytics/get_top_countries_response.rb +1 -1
  43. data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +1 -1
  44. data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +23 -2
  45. data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +4 -2
  46. data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +23 -2
  47. data/lib/algolia/models/analytics/get_top_hits_response.rb +2 -1
  48. data/lib/algolia/models/analytics/get_top_searches_response.rb +2 -1
  49. data/lib/algolia/models/analytics/get_users_count_response.rb +3 -3
  50. data/lib/algolia/models/analytics/operator.rb +38 -0
  51. data/lib/algolia/models/analytics/top_country.rb +1 -1
  52. data/lib/algolia/models/analytics/top_hit.rb +1 -1
  53. data/lib/algolia/models/analytics/top_hit_with_analytics.rb +60 -21
  54. data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +437 -0
  55. data/lib/algolia/models/analytics/top_hits_response.rb +1 -1
  56. data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +1 -1
  57. data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +201 -0
  58. data/lib/algolia/models/analytics/top_search.rb +2 -2
  59. data/lib/algolia/models/analytics/top_search_with_analytics.rb +99 -17
  60. data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +504 -0
  61. data/lib/algolia/models/analytics/top_searches_response.rb +1 -1
  62. data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +1 -1
  63. data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +201 -0
  64. data/lib/algolia/models/ingestion/auth_algolia.rb +3 -2
  65. data/lib/algolia/models/ingestion/auth_algolia_partial.rb +3 -2
  66. data/lib/algolia/models/ingestion/auth_api_key.rb +2 -1
  67. data/lib/algolia/models/ingestion/auth_api_key_partial.rb +2 -1
  68. data/lib/algolia/models/ingestion/auth_basic.rb +3 -1
  69. data/lib/algolia/models/ingestion/auth_basic_partial.rb +3 -1
  70. data/lib/algolia/models/ingestion/auth_google_service_account.rb +3 -3
  71. data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +3 -3
  72. data/lib/algolia/models/ingestion/auth_o_auth.rb +18 -8
  73. data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +18 -8
  74. data/lib/algolia/models/ingestion/authentication.rb +5 -5
  75. data/lib/algolia/models/ingestion/authentication_create.rb +2 -2
  76. data/lib/algolia/models/ingestion/authentication_create_response.rb +4 -4
  77. data/lib/algolia/models/ingestion/authentication_search.rb +1 -1
  78. data/lib/algolia/models/ingestion/authentication_update.rb +2 -2
  79. data/lib/algolia/models/ingestion/authentication_update_response.rb +4 -4
  80. data/lib/algolia/models/ingestion/big_commerce_channel.rb +2 -2
  81. data/lib/algolia/models/ingestion/big_commerce_metafield.rb +2 -2
  82. data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +1 -1
  83. data/lib/algolia/models/ingestion/delete_response.rb +1 -1
  84. data/lib/algolia/models/ingestion/destination.rb +6 -6
  85. data/lib/algolia/models/ingestion/destination_create.rb +3 -3
  86. data/lib/algolia/models/ingestion/destination_create_response.rb +4 -4
  87. data/lib/algolia/models/ingestion/destination_index_name.rb +2 -2
  88. data/lib/algolia/models/ingestion/destination_index_prefix.rb +1 -1
  89. data/lib/algolia/models/ingestion/destination_search.rb +1 -1
  90. data/lib/algolia/models/ingestion/destination_type.rb +1 -2
  91. data/lib/algolia/models/ingestion/destination_update.rb +3 -3
  92. data/lib/algolia/models/ingestion/destination_update_response.rb +4 -4
  93. data/lib/algolia/models/ingestion/docker_source_discover.rb +2 -2
  94. data/lib/algolia/models/ingestion/event.rb +3 -3
  95. data/lib/algolia/models/ingestion/list_tasks_response.rb +1 -1
  96. data/lib/algolia/models/ingestion/mapping_format_schema.rb +32 -0
  97. data/lib/algolia/models/ingestion/mapping_input.rb +24 -3
  98. data/lib/algolia/models/ingestion/on_demand_date_utils_input.rb +3 -3
  99. data/lib/algolia/models/ingestion/on_demand_trigger.rb +2 -2
  100. data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +1 -1
  101. data/lib/algolia/models/ingestion/pagination.rb +65 -0
  102. data/lib/algolia/models/ingestion/platform.rb +2 -1
  103. data/lib/algolia/models/ingestion/run.rb +7 -7
  104. data/lib/algolia/models/ingestion/run_response.rb +3 -3
  105. data/lib/algolia/models/ingestion/schedule_date_utils_input.rb +2 -2
  106. data/lib/algolia/models/ingestion/schedule_trigger.rb +4 -4
  107. data/lib/algolia/models/ingestion/schedule_trigger_input.rb +2 -2
  108. data/lib/algolia/models/ingestion/source.rb +4 -4
  109. data/lib/algolia/models/ingestion/source_big_commerce.rb +1 -1
  110. data/lib/algolia/models/ingestion/source_big_query.rb +5 -5
  111. data/lib/algolia/models/ingestion/source_commercetools.rb +2 -2
  112. data/lib/algolia/models/ingestion/source_create.rb +2 -1
  113. data/lib/algolia/models/ingestion/source_create_response.rb +3 -2
  114. data/lib/algolia/models/ingestion/source_csv.rb +3 -3
  115. data/lib/algolia/models/ingestion/source_docker.rb +3 -3
  116. data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +3 -3
  117. data/lib/algolia/models/ingestion/source_json.rb +2 -2
  118. data/lib/algolia/models/ingestion/source_type.rb +5 -3
  119. data/lib/algolia/models/ingestion/source_update.rb +2 -1
  120. data/lib/algolia/models/ingestion/source_update_commercetools.rb +2 -3
  121. data/lib/algolia/models/ingestion/source_update_docker.rb +3 -3
  122. data/lib/algolia/models/ingestion/source_update_response.rb +3 -2
  123. data/lib/algolia/models/ingestion/streaming_trigger.rb +1 -1
  124. data/lib/algolia/models/ingestion/streaming_utils_input.rb +1 -1
  125. data/lib/algolia/models/ingestion/subscription_trigger.rb +1 -1
  126. data/lib/algolia/models/ingestion/task.rb +7 -7
  127. data/lib/algolia/models/ingestion/task_create.rb +5 -5
  128. data/lib/algolia/models/ingestion/task_create_response.rb +3 -3
  129. data/lib/algolia/models/ingestion/task_input.rb +1 -0
  130. data/lib/algolia/models/ingestion/task_update.rb +4 -4
  131. data/lib/algolia/models/ingestion/task_update_response.rb +3 -3
  132. data/lib/algolia/models/ingestion/trigger.rb +1 -0
  133. data/lib/algolia/models/ingestion/trigger_update_input.rb +2 -2
  134. data/lib/algolia/models/ingestion/window.rb +3 -3
  135. data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -0
  136. data/lib/algolia/models/monitoring/{get_inventory403_response.rb → get_servers403_response.rb} +3 -3
  137. data/lib/algolia/models/monitoring/server.rb +2 -2
  138. data/lib/algolia/models/query-suggestions/app_id.rb +197 -0
  139. data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +2 -2
  140. data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +1 -1
  141. data/lib/algolia/models/query-suggestions/languages.rb +1 -1
  142. data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +2 -3
  143. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +23 -34
  144. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +18 -20
  145. data/lib/algolia/models/query-suggestions/source_index.rb +3 -5
  146. data/lib/algolia/version.rb +1 -1
  147. metadata +29 -15
@@ -33,7 +33,7 @@ module Algolia
33
33
  new(config)
34
34
  end
35
35
 
36
- # Create a authentication.
36
+ # Creates a new authentication resource.
37
37
  #
38
38
  # Required API Key ACLs:
39
39
  # - addObject
@@ -67,7 +67,7 @@ module Algolia
67
67
  @api_client.call_api(:POST, path, new_options)
68
68
  end
69
69
 
70
- # Create a authentication.
70
+ # Creates a new authentication resource.
71
71
  #
72
72
  # Required API Key ACLs:
73
73
  # - addObject
@@ -81,7 +81,7 @@ module Algolia
81
81
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::AuthenticationCreateResponse')
82
82
  end
83
83
 
84
- # Create a destination.
84
+ # Creates a new destination.
85
85
  #
86
86
  # Required API Key ACLs:
87
87
  # - addObject
@@ -115,7 +115,7 @@ module Algolia
115
115
  @api_client.call_api(:POST, path, new_options)
116
116
  end
117
117
 
118
- # Create a destination.
118
+ # Creates a new destination.
119
119
  #
120
120
  # Required API Key ACLs:
121
121
  # - addObject
@@ -129,7 +129,7 @@ module Algolia
129
129
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DestinationCreateResponse')
130
130
  end
131
131
 
132
- # Create a source.
132
+ # Creates a new source.
133
133
  #
134
134
  # Required API Key ACLs:
135
135
  # - addObject
@@ -163,7 +163,7 @@ module Algolia
163
163
  @api_client.call_api(:POST, path, new_options)
164
164
  end
165
165
 
166
- # Create a source.
166
+ # Creates a new source.
167
167
  #
168
168
  # Required API Key ACLs:
169
169
  # - addObject
@@ -177,9 +177,9 @@ module Algolia
177
177
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceCreateResponse')
178
178
  end
179
179
 
180
- # Create a task.
180
+ # Creates a new task.
181
181
 
182
- # @param task_create [TaskCreate] (required)
182
+ # @param task_create [TaskCreate] Request body for creating a task. (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
185
185
  def create_task_with_http_info(task_create, request_options = {})
@@ -207,9 +207,9 @@ module Algolia
207
207
  @api_client.call_api(:POST, path, new_options)
208
208
  end
209
209
 
210
- # Create a task.
210
+ # Creates a new task.
211
211
 
212
- # @param task_create [TaskCreate] (required)
212
+ # @param task_create [TaskCreate] Request body for creating a task. (required)
213
213
  # @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)
214
214
  # @return [TaskCreateResponse]
215
215
  def create_task(task_create, request_options = {})
@@ -229,7 +229,7 @@ module Algolia
229
229
  raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
230
230
  end
231
231
 
232
- path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
232
+ path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
233
233
  query_params = {}
234
234
  query_params = query_params.merge(parameters) unless parameters.nil?
235
235
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -272,7 +272,7 @@ module Algolia
272
272
  raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
273
273
  end
274
274
 
275
- path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
275
+ path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
276
276
  query_params = {}
277
277
  query_params = query_params.merge(parameters) unless parameters.nil?
278
278
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -316,7 +316,7 @@ module Algolia
316
316
  raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
317
317
  end
318
318
 
319
- path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
319
+ path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
320
320
  query_params = {}
321
321
  query_params = query_params.merge(parameters) unless parameters.nil?
322
322
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -361,7 +361,7 @@ module Algolia
361
361
  raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
362
362
  end
363
363
 
364
- path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
364
+ path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
365
365
  query_params = {}
366
366
  query_params = query_params.merge(parameters) unless parameters.nil?
367
367
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -393,13 +393,13 @@ module Algolia
393
393
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
394
394
  end
395
395
 
396
- # Soft delete the authentication of the given authenticationID.
396
+ # Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.
397
397
  #
398
398
  # Required API Key ACLs:
399
399
  # - addObject
400
400
  # - deleteIndex
401
401
  # - editSettings
402
- # @param authentication_id [String] The authentication UUID. (required)
402
+ # @param authentication_id [String] Unique identifier of an authentication resource. (required)
403
403
  # @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)
404
404
  # @return [Http::Response] the response
405
405
  def delete_authentication_with_http_info(authentication_id, request_options = {})
@@ -427,13 +427,13 @@ module Algolia
427
427
  @api_client.call_api(:DELETE, path, new_options)
428
428
  end
429
429
 
430
- # Soft delete the authentication of the given authenticationID.
430
+ # Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.
431
431
  #
432
432
  # Required API Key ACLs:
433
433
  # - addObject
434
434
  # - deleteIndex
435
435
  # - editSettings
436
- # @param authentication_id [String] The authentication UUID. (required)
436
+ # @param authentication_id [String] Unique identifier of an authentication resource. (required)
437
437
  # @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)
438
438
  # @return [DeleteResponse]
439
439
  def delete_authentication(authentication_id, request_options = {})
@@ -441,13 +441,13 @@ module Algolia
441
441
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
442
442
  end
443
443
 
444
- # Soft delete the destination of the given destinationID.
444
+ # Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.
445
445
  #
446
446
  # Required API Key ACLs:
447
447
  # - addObject
448
448
  # - deleteIndex
449
449
  # - editSettings
450
- # @param destination_id [String] The destination UUID. (required)
450
+ # @param destination_id [String] Unique identifier of a destination. (required)
451
451
  # @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)
452
452
  # @return [Http::Response] the response
453
453
  def delete_destination_with_http_info(destination_id, request_options = {})
@@ -475,13 +475,13 @@ module Algolia
475
475
  @api_client.call_api(:DELETE, path, new_options)
476
476
  end
477
477
 
478
- # Soft delete the destination of the given destinationID.
478
+ # Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.
479
479
  #
480
480
  # Required API Key ACLs:
481
481
  # - addObject
482
482
  # - deleteIndex
483
483
  # - editSettings
484
- # @param destination_id [String] The destination UUID. (required)
484
+ # @param destination_id [String] Unique identifier of a destination. (required)
485
485
  # @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)
486
486
  # @return [DeleteResponse]
487
487
  def delete_destination(destination_id, request_options = {})
@@ -489,13 +489,13 @@ module Algolia
489
489
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
490
490
  end
491
491
 
492
- # Soft delete the source of the given sourceID.
492
+ # Deletes a source by its ID. You can't delete sources that are referenced in tasks.
493
493
  #
494
494
  # Required API Key ACLs:
495
495
  # - addObject
496
496
  # - deleteIndex
497
497
  # - editSettings
498
- # @param source_id [String] The source UUID. (required)
498
+ # @param source_id [String] Unique identifier of a source. (required)
499
499
  # @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)
500
500
  # @return [Http::Response] the response
501
501
  def delete_source_with_http_info(source_id, request_options = {})
@@ -523,13 +523,13 @@ module Algolia
523
523
  @api_client.call_api(:DELETE, path, new_options)
524
524
  end
525
525
 
526
- # Soft delete the source of the given sourceID.
526
+ # Deletes a source by its ID. You can't delete sources that are referenced in tasks.
527
527
  #
528
528
  # Required API Key ACLs:
529
529
  # - addObject
530
530
  # - deleteIndex
531
531
  # - editSettings
532
- # @param source_id [String] The source UUID. (required)
532
+ # @param source_id [String] Unique identifier of a source. (required)
533
533
  # @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)
534
534
  # @return [DeleteResponse]
535
535
  def delete_source(source_id, request_options = {})
@@ -537,9 +537,9 @@ module Algolia
537
537
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
538
538
  end
539
539
 
540
- # Soft delete the task of the given taskID.
540
+ # Deletes a task by its ID.
541
541
 
542
- # @param task_id [String] The task UUID. (required)
542
+ # @param task_id [String] Unique identifier of a task. (required)
543
543
  # @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)
544
544
  # @return [Http::Response] the response
545
545
  def delete_task_with_http_info(task_id, request_options = {})
@@ -567,9 +567,9 @@ module Algolia
567
567
  @api_client.call_api(:DELETE, path, new_options)
568
568
  end
569
569
 
570
- # Soft delete the task of the given taskID.
570
+ # Deletes a task by its ID.
571
571
 
572
- # @param task_id [String] The task UUID. (required)
572
+ # @param task_id [String] Unique identifier of a task. (required)
573
573
  # @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)
574
574
  # @return [DeleteResponse]
575
575
  def delete_task(task_id, request_options = {})
@@ -577,13 +577,13 @@ module Algolia
577
577
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
578
578
  end
579
579
 
580
- # Disable the task of the given taskID.
580
+ # Disables a task.
581
581
  #
582
582
  # Required API Key ACLs:
583
583
  # - addObject
584
584
  # - deleteIndex
585
585
  # - editSettings
586
- # @param task_id [String] The task UUID. (required)
586
+ # @param task_id [String] Unique identifier of a task. (required)
587
587
  # @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)
588
588
  # @return [Http::Response] the response
589
589
  def disable_task_with_http_info(task_id, request_options = {})
@@ -611,13 +611,13 @@ module Algolia
611
611
  @api_client.call_api(:PUT, path, new_options)
612
612
  end
613
613
 
614
- # Disable the task of the given taskID.
614
+ # Disables a task.
615
615
  #
616
616
  # Required API Key ACLs:
617
617
  # - addObject
618
618
  # - deleteIndex
619
619
  # - editSettings
620
- # @param task_id [String] The task UUID. (required)
620
+ # @param task_id [String] Unique identifier of a task. (required)
621
621
  # @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)
622
622
  # @return [TaskUpdateResponse]
623
623
  def disable_task(task_id, request_options = {})
@@ -625,13 +625,13 @@ module Algolia
625
625
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
626
626
  end
627
627
 
628
- # Enable the task of the given taskID.
628
+ # Enables a task.
629
629
  #
630
630
  # Required API Key ACLs:
631
631
  # - addObject
632
632
  # - deleteIndex
633
633
  # - editSettings
634
- # @param task_id [String] The task UUID. (required)
634
+ # @param task_id [String] Unique identifier of a task. (required)
635
635
  # @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)
636
636
  # @return [Http::Response] the response
637
637
  def enable_task_with_http_info(task_id, request_options = {})
@@ -659,13 +659,13 @@ module Algolia
659
659
  @api_client.call_api(:PUT, path, new_options)
660
660
  end
661
661
 
662
- # Enable the task of the given taskID.
662
+ # Enables a task.
663
663
  #
664
664
  # Required API Key ACLs:
665
665
  # - addObject
666
666
  # - deleteIndex
667
667
  # - editSettings
668
- # @param task_id [String] The task UUID. (required)
668
+ # @param task_id [String] Unique identifier of a task. (required)
669
669
  # @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)
670
670
  # @return [TaskUpdateResponse]
671
671
  def enable_task(task_id, request_options = {})
@@ -673,13 +673,13 @@ module Algolia
673
673
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
674
674
  end
675
675
 
676
- # Get the authentication of the given authenticationID.
676
+ # Retrieves an authentication resource by its ID.
677
677
  #
678
678
  # Required API Key ACLs:
679
679
  # - addObject
680
680
  # - deleteIndex
681
681
  # - editSettings
682
- # @param authentication_id [String] The authentication UUID. (required)
682
+ # @param authentication_id [String] Unique identifier of an authentication resource. (required)
683
683
  # @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)
684
684
  # @return [Http::Response] the response
685
685
  def get_authentication_with_http_info(authentication_id, request_options = {})
@@ -707,13 +707,13 @@ module Algolia
707
707
  @api_client.call_api(:GET, path, new_options)
708
708
  end
709
709
 
710
- # Get the authentication of the given authenticationID.
710
+ # Retrieves an authentication resource by its ID.
711
711
  #
712
712
  # Required API Key ACLs:
713
713
  # - addObject
714
714
  # - deleteIndex
715
715
  # - editSettings
716
- # @param authentication_id [String] The authentication UUID. (required)
716
+ # @param authentication_id [String] Unique identifier of an authentication resource. (required)
717
717
  # @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)
718
718
  # @return [Authentication]
719
719
  def get_authentication(authentication_id, request_options = {})
@@ -721,21 +721,33 @@ module Algolia
721
721
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Authentication')
722
722
  end
723
723
 
724
- # Get a list of authentications for the given query parameters, with pagination details.
724
+ # Retrieves a list of all authentication resources.
725
725
  #
726
726
  # Required API Key ACLs:
727
727
  # - addObject
728
728
  # - deleteIndex
729
729
  # - editSettings
730
- # @param items_per_page [Integer] The number of items per page to return.
731
- # @param page [Integer] The page number to fetch, starting at 1.
732
- # @param type [Array<AuthenticationType>] The type of the authentications to retrieve.
733
- # @param platform [Array<PlatformWithNone>] The platform of the authentications to retrieve.
734
- # @param sort [AuthenticationSortKeys] The key by which the list should be sorted.
735
- # @param order [OrderKeys] The order of the returned list.
730
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
731
+ # @param page [Integer] Page number of the paginated API response.
732
+ # @param type [Array<AuthenticationType>] Type of authentication resource to retrieve.
733
+ # @param platform [Array<PlatformWithNone>] Ecommerce platform for which to retrieve authentication resources.
734
+ # @param sort [AuthenticationSortKeys] Property by which to sort the list of authentication resources. (default to 'createdAt')
735
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
736
736
  # @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)
737
737
  # @return [Http::Response] the response
738
738
  def get_authentications_with_http_info(items_per_page = nil, page = nil, type = nil, platform = nil, sort = nil, order = nil, request_options = {})
739
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
740
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_authentications, must be smaller than or equal to 100.'
741
+ end
742
+
743
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
744
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_authentications, must be greater than or equal to 1.'
745
+ end
746
+
747
+ if @api_client.config.client_side_validation && !page.nil? && page < 1
748
+ raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_authentications, must be greater than or equal to 1.'
749
+ end
750
+
739
751
  path = '/1/authentications'
740
752
  query_params = {}
741
753
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
@@ -761,18 +773,18 @@ module Algolia
761
773
  @api_client.call_api(:GET, path, new_options)
762
774
  end
763
775
 
764
- # Get a list of authentications for the given query parameters, with pagination details.
776
+ # Retrieves a list of all authentication resources.
765
777
  #
766
778
  # Required API Key ACLs:
767
779
  # - addObject
768
780
  # - deleteIndex
769
781
  # - editSettings
770
- # @param items_per_page [Integer] The number of items per page to return.
771
- # @param page [Integer] The page number to fetch, starting at 1.
772
- # @param type [Array<AuthenticationType>] The type of the authentications to retrieve.
773
- # @param platform [Array<PlatformWithNone>] The platform of the authentications to retrieve.
774
- # @param sort [AuthenticationSortKeys] The key by which the list should be sorted.
775
- # @param order [OrderKeys] The order of the returned list.
782
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
783
+ # @param page [Integer] Page number of the paginated API response.
784
+ # @param type [Array<AuthenticationType>] Type of authentication resource to retrieve.
785
+ # @param platform [Array<PlatformWithNone>] Ecommerce platform for which to retrieve authentication resources.
786
+ # @param sort [AuthenticationSortKeys] Property by which to sort the list of authentication resources. (default to 'createdAt')
787
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
776
788
  # @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)
777
789
  # @return [ListAuthenticationsResponse]
778
790
  def get_authentications(items_per_page = nil, page = nil, type = nil, platform = nil, sort = nil, order = nil, request_options = {})
@@ -780,13 +792,13 @@ module Algolia
780
792
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListAuthenticationsResponse')
781
793
  end
782
794
 
783
- # Get the destination of the given destinationID.
795
+ # Retrieves a destination by its ID.
784
796
  #
785
797
  # Required API Key ACLs:
786
798
  # - addObject
787
799
  # - deleteIndex
788
800
  # - editSettings
789
- # @param destination_id [String] The destination UUID. (required)
801
+ # @param destination_id [String] Unique identifier of a destination. (required)
790
802
  # @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)
791
803
  # @return [Http::Response] the response
792
804
  def get_destination_with_http_info(destination_id, request_options = {})
@@ -814,13 +826,13 @@ module Algolia
814
826
  @api_client.call_api(:GET, path, new_options)
815
827
  end
816
828
 
817
- # Get the destination of the given destinationID.
829
+ # Retrieves a destination by its ID.
818
830
  #
819
831
  # Required API Key ACLs:
820
832
  # - addObject
821
833
  # - deleteIndex
822
834
  # - editSettings
823
- # @param destination_id [String] The destination UUID. (required)
835
+ # @param destination_id [String] Unique identifier of a destination. (required)
824
836
  # @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)
825
837
  # @return [Destination]
826
838
  def get_destination(destination_id, request_options = {})
@@ -828,21 +840,33 @@ module Algolia
828
840
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Destination')
829
841
  end
830
842
 
831
- # Get a list of destinations for the given query parameters, with pagination details.
843
+ # Retrieves a list of destinations.
832
844
  #
833
845
  # Required API Key ACLs:
834
846
  # - addObject
835
847
  # - deleteIndex
836
848
  # - editSettings
837
- # @param items_per_page [Integer] The number of items per page to return.
838
- # @param page [Integer] The page number to fetch, starting at 1.
839
- # @param type [Array<DestinationType>] The type of the destinations to retrive.
840
- # @param authentication_id [Array<String>] The authenticationIDs of the destinations to retrive.
841
- # @param sort [DestinationSortKeys] The key by which the list should be sorted.
842
- # @param order [OrderKeys] The order of the returned list.
849
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
850
+ # @param page [Integer] Page number of the paginated API response.
851
+ # @param type [Array<DestinationType>] Destination type.
852
+ # @param authentication_id [Array<String>] Authentication ID used by destinations.
853
+ # @param sort [DestinationSortKeys] Property by which to sort the destinations. (default to 'createdAt')
854
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
843
855
  # @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)
844
856
  # @return [Http::Response] the response
845
857
  def get_destinations_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
858
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
859
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_destinations, must be smaller than or equal to 100.'
860
+ end
861
+
862
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
863
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_destinations, must be greater than or equal to 1.'
864
+ end
865
+
866
+ if @api_client.config.client_side_validation && !page.nil? && page < 1
867
+ raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_destinations, must be greater than or equal to 1.'
868
+ end
869
+
846
870
  path = '/1/destinations'
847
871
  query_params = {}
848
872
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
@@ -868,18 +892,18 @@ module Algolia
868
892
  @api_client.call_api(:GET, path, new_options)
869
893
  end
870
894
 
871
- # Get a list of destinations for the given query parameters, with pagination details.
895
+ # Retrieves a list of destinations.
872
896
  #
873
897
  # Required API Key ACLs:
874
898
  # - addObject
875
899
  # - deleteIndex
876
900
  # - editSettings
877
- # @param items_per_page [Integer] The number of items per page to return.
878
- # @param page [Integer] The page number to fetch, starting at 1.
879
- # @param type [Array<DestinationType>] The type of the destinations to retrive.
880
- # @param authentication_id [Array<String>] The authenticationIDs of the destinations to retrive.
881
- # @param sort [DestinationSortKeys] The key by which the list should be sorted.
882
- # @param order [OrderKeys] The order of the returned list.
901
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
902
+ # @param page [Integer] Page number of the paginated API response.
903
+ # @param type [Array<DestinationType>] Destination type.
904
+ # @param authentication_id [Array<String>] Authentication ID used by destinations.
905
+ # @param sort [DestinationSortKeys] Property by which to sort the destinations. (default to 'createdAt')
906
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
883
907
  # @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)
884
908
  # @return [ListDestinationsResponse]
885
909
  def get_destinations(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
@@ -887,13 +911,13 @@ module Algolia
887
911
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListDestinationsResponse')
888
912
  end
889
913
 
890
- # Retrieve a stream listing for a given Singer specification compatible docker type source ID.
914
+ # Retrieves a stream listing for a source. Listing streams only works with sources with &#x60;type: docker&#x60; and &#x60;imageType: singer&#x60;.
891
915
  #
892
916
  # Required API Key ACLs:
893
917
  # - addObject
894
918
  # - deleteIndex
895
919
  # - editSettings
896
- # @param source_id [String] The source UUID. (required)
920
+ # @param source_id [String] Unique identifier of a source. (required)
897
921
  # @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)
898
922
  # @return [Http::Response] the response
899
923
  def get_docker_source_streams_with_http_info(source_id, request_options = {})
@@ -921,13 +945,13 @@ module Algolia
921
945
  @api_client.call_api(:GET, path, new_options)
922
946
  end
923
947
 
924
- # Retrieve a stream listing for a given Singer specification compatible docker type source ID.
948
+ # Retrieves a stream listing for a source. Listing streams only works with sources with `type: docker` and `imageType: singer`.
925
949
  #
926
950
  # Required API Key ACLs:
927
951
  # - addObject
928
952
  # - deleteIndex
929
953
  # - editSettings
930
- # @param source_id [String] The source UUID. (required)
954
+ # @param source_id [String] Unique identifier of a source. (required)
931
955
  # @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)
932
956
  # @return [DockerSourceStreams]
933
957
  def get_docker_source_streams(source_id, request_options = {})
@@ -935,14 +959,14 @@ module Algolia
935
959
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceStreams')
936
960
  end
937
961
 
938
- # Get a single event for a specific runID.
962
+ # Retrieves a single task run event by its ID.
939
963
  #
940
964
  # Required API Key ACLs:
941
965
  # - addObject
942
966
  # - deleteIndex
943
967
  # - editSettings
944
- # @param run_id [String] The run UUID. (required)
945
- # @param event_id [String] The event UUID. (required)
968
+ # @param run_id [String] Unique identifier of a task run. (required)
969
+ # @param event_id [String] Unique identifier of an event. (required)
946
970
  # @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)
947
971
  # @return [Http::Response] the response
948
972
  def get_event_with_http_info(run_id, event_id, request_options = {})
@@ -974,14 +998,14 @@ module Algolia
974
998
  @api_client.call_api(:GET, path, new_options)
975
999
  end
976
1000
 
977
- # Get a single event for a specific runID.
1001
+ # Retrieves a single task run event by its ID.
978
1002
  #
979
1003
  # Required API Key ACLs:
980
1004
  # - addObject
981
1005
  # - deleteIndex
982
1006
  # - editSettings
983
- # @param run_id [String] The run UUID. (required)
984
- # @param event_id [String] The event UUID. (required)
1007
+ # @param run_id [String] Unique identifier of a task run. (required)
1008
+ # @param event_id [String] Unique identifier of an event. (required)
985
1009
  # @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)
986
1010
  # @return [Event]
987
1011
  def get_event(run_id, event_id, request_options = {})
@@ -989,21 +1013,21 @@ module Algolia
989
1013
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Event')
990
1014
  end
991
1015
 
992
- # Get a list of events associated to the given runID, for the given query parameters.
1016
+ # Retrieves a list of events for a task run, identified by it&#39;s ID.
993
1017
  #
994
1018
  # Required API Key ACLs:
995
1019
  # - addObject
996
1020
  # - deleteIndex
997
1021
  # - editSettings
998
- # @param run_id [String] The run UUID. (required)
999
- # @param items_per_page [Integer] The number of items per page to return.
1000
- # @param page [Integer] The page number to fetch, starting at 1.
1001
- # @param status [Array<EventStatus>] Filter the status of the events.
1002
- # @param type [Array<EventType>] Filter the type of the events.
1003
- # @param sort [EventSortKeys] The key by which the list should be sorted.
1004
- # @param order [OrderKeys] The order of the returned list.
1005
- # @param start_date [String] The start date (in RFC3339 format) of the events fetching window. Defaults to &#39;now&#39;-3 hours if omitted.
1006
- # @param end_date [String] The end date (in RFC3339 format) of the events fetching window. Defaults to &#39;now&#39; days if omitted.
1022
+ # @param run_id [String] Unique identifier of a task run. (required)
1023
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
1024
+ # @param page [Integer] Page number of the paginated API response.
1025
+ # @param status [Array<EventStatus>] Event status for filtering the list of task runs.
1026
+ # @param type [Array<EventType>] Event type for filtering the list of task runs.
1027
+ # @param sort [EventSortKeys] Property by which to sort the list of task run events.
1028
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1029
+ # @param start_date [String] Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
1030
+ # @param end_date [String] Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
1007
1031
  # @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)
1008
1032
  # @return [Http::Response] the response
1009
1033
  def get_events_with_http_info(run_id, items_per_page = nil, page = nil, status = nil, type = nil, sort = nil, order = nil, start_date = nil, end_date = nil,
@@ -1012,6 +1036,17 @@ module Algolia
1012
1036
  if @api_client.config.client_side_validation && run_id.nil?
1013
1037
  raise ArgumentError, "Parameter `run_id` is required when calling `get_events`."
1014
1038
  end
1039
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
1040
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_events, must be smaller than or equal to 100.'
1041
+ end
1042
+
1043
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
1044
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_events, must be greater than or equal to 1.'
1045
+ end
1046
+
1047
+ if @api_client.config.client_side_validation && !page.nil? && page < 1
1048
+ raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_events, must be greater than or equal to 1.'
1049
+ end
1015
1050
 
1016
1051
  path = '/1/runs/{runID}/events'.sub('{' + 'runID' + '}', Transport.encode_uri(run_id.to_s))
1017
1052
  query_params = {}
@@ -1040,21 +1075,21 @@ module Algolia
1040
1075
  @api_client.call_api(:GET, path, new_options)
1041
1076
  end
1042
1077
 
1043
- # Get a list of events associated to the given runID, for the given query parameters.
1078
+ # Retrieves a list of events for a task run, identified by it's ID.
1044
1079
  #
1045
1080
  # Required API Key ACLs:
1046
1081
  # - addObject
1047
1082
  # - deleteIndex
1048
1083
  # - editSettings
1049
- # @param run_id [String] The run UUID. (required)
1050
- # @param items_per_page [Integer] The number of items per page to return.
1051
- # @param page [Integer] The page number to fetch, starting at 1.
1052
- # @param status [Array<EventStatus>] Filter the status of the events.
1053
- # @param type [Array<EventType>] Filter the type of the events.
1054
- # @param sort [EventSortKeys] The key by which the list should be sorted.
1055
- # @param order [OrderKeys] The order of the returned list.
1056
- # @param start_date [String] The start date (in RFC3339 format) of the events fetching window. Defaults to &#39;now&#39;-3 hours if omitted.
1057
- # @param end_date [String] The end date (in RFC3339 format) of the events fetching window. Defaults to &#39;now&#39; days if omitted.
1084
+ # @param run_id [String] Unique identifier of a task run. (required)
1085
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
1086
+ # @param page [Integer] Page number of the paginated API response.
1087
+ # @param status [Array<EventStatus>] Event status for filtering the list of task runs.
1088
+ # @param type [Array<EventType>] Event type for filtering the list of task runs.
1089
+ # @param sort [EventSortKeys] Property by which to sort the list of task run events.
1090
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1091
+ # @param start_date [String] Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
1092
+ # @param end_date [String] Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
1058
1093
  # @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)
1059
1094
  # @return [ListEventsResponse]
1060
1095
  def get_events(run_id, items_per_page = nil, page = nil, status = nil, type = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {})
@@ -1062,13 +1097,13 @@ module Algolia
1062
1097
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListEventsResponse')
1063
1098
  end
1064
1099
 
1065
- # Get a single run for the given ID.
1100
+ # Retrieve a single task run by its ID.
1066
1101
  #
1067
1102
  # Required API Key ACLs:
1068
1103
  # - addObject
1069
1104
  # - deleteIndex
1070
1105
  # - editSettings
1071
- # @param run_id [String] The run UUID. (required)
1106
+ # @param run_id [String] Unique identifier of a task run. (required)
1072
1107
  # @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)
1073
1108
  # @return [Http::Response] the response
1074
1109
  def get_run_with_http_info(run_id, request_options = {})
@@ -1096,13 +1131,13 @@ module Algolia
1096
1131
  @api_client.call_api(:GET, path, new_options)
1097
1132
  end
1098
1133
 
1099
- # Get a single run for the given ID.
1134
+ # Retrieve a single task run by its ID.
1100
1135
  #
1101
1136
  # Required API Key ACLs:
1102
1137
  # - addObject
1103
1138
  # - deleteIndex
1104
1139
  # - editSettings
1105
- # @param run_id [String] The run UUID. (required)
1140
+ # @param run_id [String] Unique identifier of a task run. (required)
1106
1141
  # @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)
1107
1142
  # @return [Run]
1108
1143
  def get_run(run_id, request_options = {})
@@ -1110,23 +1145,35 @@ module Algolia
1110
1145
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Run')
1111
1146
  end
1112
1147
 
1113
- # Get a list of runs for the given query parameters, with pagination details.
1148
+ # Retrieve a list of task runs.
1114
1149
  #
1115
1150
  # Required API Key ACLs:
1116
1151
  # - addObject
1117
1152
  # - deleteIndex
1118
1153
  # - editSettings
1119
- # @param items_per_page [Integer] The number of items per page to return.
1120
- # @param page [Integer] The page number to fetch, starting at 1.
1121
- # @param status [Array<RunStatus>] Filter the status of the runs.
1122
- # @param task_id [String] Filter by taskID.
1123
- # @param sort [RunSortKeys] The key by which the list should be sorted.
1124
- # @param order [OrderKeys] The order of the returned list.
1125
- # @param start_date [String] The start date (in RFC3339 format) of the runs fetching window. Defaults to &#39;now&#39;-7 days if omitted.
1126
- # @param end_date [String] The end date (in RFC3339 format) of the runs fetching window. Defaults to &#39;now&#39; days if omitted.
1154
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
1155
+ # @param page [Integer] Page number of the paginated API response.
1156
+ # @param status [Array<RunStatus>] Run status for filtering the list of task runs.
1157
+ # @param task_id [String] Task ID for filtering the list of task runs.
1158
+ # @param sort [RunSortKeys] Property by which to sort the list of task runs. (default to 'createdAt')
1159
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1160
+ # @param start_date [String] Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
1161
+ # @param end_date [String] Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
1127
1162
  # @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)
1128
1163
  # @return [Http::Response] the response
1129
1164
  def get_runs_with_http_info(items_per_page = nil, page = nil, status = nil, task_id = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {})
1165
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
1166
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_runs, must be smaller than or equal to 100.'
1167
+ end
1168
+
1169
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
1170
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_runs, must be greater than or equal to 1.'
1171
+ end
1172
+
1173
+ if @api_client.config.client_side_validation && !page.nil? && page < 1
1174
+ raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_runs, must be greater than or equal to 1.'
1175
+ end
1176
+
1130
1177
  path = '/1/runs'
1131
1178
  query_params = {}
1132
1179
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
@@ -1154,20 +1201,20 @@ module Algolia
1154
1201
  @api_client.call_api(:GET, path, new_options)
1155
1202
  end
1156
1203
 
1157
- # Get a list of runs for the given query parameters, with pagination details.
1204
+ # Retrieve a list of task runs.
1158
1205
  #
1159
1206
  # Required API Key ACLs:
1160
1207
  # - addObject
1161
1208
  # - deleteIndex
1162
1209
  # - editSettings
1163
- # @param items_per_page [Integer] The number of items per page to return.
1164
- # @param page [Integer] The page number to fetch, starting at 1.
1165
- # @param status [Array<RunStatus>] Filter the status of the runs.
1166
- # @param task_id [String] Filter by taskID.
1167
- # @param sort [RunSortKeys] The key by which the list should be sorted.
1168
- # @param order [OrderKeys] The order of the returned list.
1169
- # @param start_date [String] The start date (in RFC3339 format) of the runs fetching window. Defaults to &#39;now&#39;-7 days if omitted.
1170
- # @param end_date [String] The end date (in RFC3339 format) of the runs fetching window. Defaults to &#39;now&#39; days if omitted.
1210
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
1211
+ # @param page [Integer] Page number of the paginated API response.
1212
+ # @param status [Array<RunStatus>] Run status for filtering the list of task runs.
1213
+ # @param task_id [String] Task ID for filtering the list of task runs.
1214
+ # @param sort [RunSortKeys] Property by which to sort the list of task runs. (default to 'createdAt')
1215
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1216
+ # @param start_date [String] Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
1217
+ # @param end_date [String] Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
1171
1218
  # @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)
1172
1219
  # @return [RunListResponse]
1173
1220
  def get_runs(items_per_page = nil, page = nil, status = nil, task_id = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {})
@@ -1175,13 +1222,13 @@ module Algolia
1175
1222
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::RunListResponse')
1176
1223
  end
1177
1224
 
1178
- # Get the source of the given sourceID.
1225
+ # Retrieve a source by its ID.
1179
1226
  #
1180
1227
  # Required API Key ACLs:
1181
1228
  # - addObject
1182
1229
  # - deleteIndex
1183
1230
  # - editSettings
1184
- # @param source_id [String] The source UUID. (required)
1231
+ # @param source_id [String] Unique identifier of a source. (required)
1185
1232
  # @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)
1186
1233
  # @return [Http::Response] the response
1187
1234
  def get_source_with_http_info(source_id, request_options = {})
@@ -1209,13 +1256,13 @@ module Algolia
1209
1256
  @api_client.call_api(:GET, path, new_options)
1210
1257
  end
1211
1258
 
1212
- # Get the source of the given sourceID.
1259
+ # Retrieve a source by its ID.
1213
1260
  #
1214
1261
  # Required API Key ACLs:
1215
1262
  # - addObject
1216
1263
  # - deleteIndex
1217
1264
  # - editSettings
1218
- # @param source_id [String] The source UUID. (required)
1265
+ # @param source_id [String] Unique identifier of a source. (required)
1219
1266
  # @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)
1220
1267
  # @return [Source]
1221
1268
  def get_source(source_id, request_options = {})
@@ -1223,21 +1270,33 @@ module Algolia
1223
1270
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Source')
1224
1271
  end
1225
1272
 
1226
- # Get a list of sources for the given query parameters, with pagination details.
1273
+ # Retrieves a list of sources.
1227
1274
  #
1228
1275
  # Required API Key ACLs:
1229
1276
  # - addObject
1230
1277
  # - deleteIndex
1231
1278
  # - editSettings
1232
- # @param items_per_page [Integer] The number of items per page to return.
1233
- # @param page [Integer] The page number to fetch, starting at 1.
1234
- # @param type [Array<SourceType>] The type of the sources to retrieve.
1235
- # @param authentication_id [Array<String>] The authenticationIDs of the sources to retrieve. &#39;none&#39; returns sources that doesn&#39;t have an authentication.
1236
- # @param sort [SourceSortKeys] The key by which the list should be sorted.
1237
- # @param order [OrderKeys] The order of the returned list.
1279
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
1280
+ # @param page [Integer] Page number of the paginated API response.
1281
+ # @param type [Array<SourceType>] Source type. Some sources require authentication.
1282
+ # @param authentication_id [Array<String>] Authentication IDs of the sources to retrieve. &#39;none&#39; returns sources that doesn&#39;t have an authentication resource.
1283
+ # @param sort [SourceSortKeys] Property by which to sort the list of sources. (default to 'createdAt')
1284
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1238
1285
  # @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)
1239
1286
  # @return [Http::Response] the response
1240
1287
  def get_sources_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
1288
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
1289
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_sources, must be smaller than or equal to 100.'
1290
+ end
1291
+
1292
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
1293
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_sources, must be greater than or equal to 1.'
1294
+ end
1295
+
1296
+ if @api_client.config.client_side_validation && !page.nil? && page < 1
1297
+ raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_sources, must be greater than or equal to 1.'
1298
+ end
1299
+
1241
1300
  path = '/1/sources'
1242
1301
  query_params = {}
1243
1302
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
@@ -1263,18 +1322,18 @@ module Algolia
1263
1322
  @api_client.call_api(:GET, path, new_options)
1264
1323
  end
1265
1324
 
1266
- # Get a list of sources for the given query parameters, with pagination details.
1325
+ # Retrieves a list of sources.
1267
1326
  #
1268
1327
  # Required API Key ACLs:
1269
1328
  # - addObject
1270
1329
  # - deleteIndex
1271
1330
  # - editSettings
1272
- # @param items_per_page [Integer] The number of items per page to return.
1273
- # @param page [Integer] The page number to fetch, starting at 1.
1274
- # @param type [Array<SourceType>] The type of the sources to retrieve.
1275
- # @param authentication_id [Array<String>] The authenticationIDs of the sources to retrieve. &#39;none&#39; returns sources that doesn&#39;t have an authentication.
1276
- # @param sort [SourceSortKeys] The key by which the list should be sorted.
1277
- # @param order [OrderKeys] The order of the returned list.
1331
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
1332
+ # @param page [Integer] Page number of the paginated API response.
1333
+ # @param type [Array<SourceType>] Source type. Some sources require authentication.
1334
+ # @param authentication_id [Array<String>] Authentication IDs of the sources to retrieve. &#39;none&#39; returns sources that doesn&#39;t have an authentication resource.
1335
+ # @param sort [SourceSortKeys] Property by which to sort the list of sources. (default to 'createdAt')
1336
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1278
1337
  # @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)
1279
1338
  # @return [ListSourcesResponse]
1280
1339
  def get_sources(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
@@ -1282,13 +1341,13 @@ module Algolia
1282
1341
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListSourcesResponse')
1283
1342
  end
1284
1343
 
1285
- # Get the task of the given taskID.
1344
+ # Retrieves a task by its ID.
1286
1345
  #
1287
1346
  # Required API Key ACLs:
1288
1347
  # - addObject
1289
1348
  # - deleteIndex
1290
1349
  # - editSettings
1291
- # @param task_id [String] The task UUID. (required)
1350
+ # @param task_id [String] Unique identifier of a task. (required)
1292
1351
  # @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)
1293
1352
  # @return [Http::Response] the response
1294
1353
  def get_task_with_http_info(task_id, request_options = {})
@@ -1316,13 +1375,13 @@ module Algolia
1316
1375
  @api_client.call_api(:GET, path, new_options)
1317
1376
  end
1318
1377
 
1319
- # Get the task of the given taskID.
1378
+ # Retrieves a task by its ID.
1320
1379
  #
1321
1380
  # Required API Key ACLs:
1322
1381
  # - addObject
1323
1382
  # - deleteIndex
1324
1383
  # - editSettings
1325
- # @param task_id [String] The task UUID. (required)
1384
+ # @param task_id [String] Unique identifier of a task. (required)
1326
1385
  # @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)
1327
1386
  # @return [Task]
1328
1387
  def get_task(task_id, request_options = {})
@@ -1330,25 +1389,37 @@ module Algolia
1330
1389
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Task')
1331
1390
  end
1332
1391
 
1333
- # Get a list of tasks for the given query parameters, with pagination details.
1392
+ # Retrieves a list of tasks.
1334
1393
  #
1335
1394
  # Required API Key ACLs:
1336
1395
  # - addObject
1337
1396
  # - deleteIndex
1338
1397
  # - editSettings
1339
- # @param items_per_page [Integer] The number of items per page to return.
1340
- # @param page [Integer] The page number to fetch, starting at 1.
1341
- # @param action [Array<ActionType>] The action of the tasks to retrieve.
1342
- # @param enabled [Boolean] Whether the task is enabled or not.
1343
- # @param source_id [Array<String>] The sourceIDs of the tasks to retrieve.
1344
- # @param destination_id [Array<String>] The destinationIDs of the tasks to retrieve.
1345
- # @param trigger_type [Array<TriggerType>] The trigger type of the task.
1346
- # @param sort [TaskSortKeys] The key by which the list should be sorted.
1347
- # @param order [OrderKeys] The order of the returned list.
1398
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
1399
+ # @param page [Integer] Page number of the paginated API response.
1400
+ # @param action [Array<ActionType>] Actions for filtering the list of tasks.
1401
+ # @param enabled [Boolean] Whether to filter the list of tasks by the &#x60;enabled&#x60; status.
1402
+ # @param source_id [Array<String>] Source IDs for filtering the list of tasks.
1403
+ # @param destination_id [Array<String>] Destination IDs for filtering the list of tasks.
1404
+ # @param trigger_type [Array<TriggerType>] Type of task trigger for filtering the list of tasks.
1405
+ # @param sort [TaskSortKeys] Property by which to sort the list of tasks. (default to 'createdAt')
1406
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1348
1407
  # @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)
1349
1408
  # @return [Http::Response] the response
1350
1409
  def get_tasks_with_http_info(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, destination_id = nil, trigger_type = nil, sort = nil, order = nil,
1351
1410
  request_options = {})
1411
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
1412
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_tasks, must be smaller than or equal to 100.'
1413
+ end
1414
+
1415
+ if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
1416
+ raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_tasks, must be greater than or equal to 1.'
1417
+ end
1418
+
1419
+ if @api_client.config.client_side_validation && !page.nil? && page < 1
1420
+ raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_tasks, must be greater than or equal to 1.'
1421
+ end
1422
+
1352
1423
  path = '/1/tasks'
1353
1424
  query_params = {}
1354
1425
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
@@ -1377,21 +1448,21 @@ module Algolia
1377
1448
  @api_client.call_api(:GET, path, new_options)
1378
1449
  end
1379
1450
 
1380
- # Get a list of tasks for the given query parameters, with pagination details.
1451
+ # Retrieves a list of tasks.
1381
1452
  #
1382
1453
  # Required API Key ACLs:
1383
1454
  # - addObject
1384
1455
  # - deleteIndex
1385
1456
  # - editSettings
1386
- # @param items_per_page [Integer] The number of items per page to return.
1387
- # @param page [Integer] The page number to fetch, starting at 1.
1388
- # @param action [Array<ActionType>] The action of the tasks to retrieve.
1389
- # @param enabled [Boolean] Whether the task is enabled or not.
1390
- # @param source_id [Array<String>] The sourceIDs of the tasks to retrieve.
1391
- # @param destination_id [Array<String>] The destinationIDs of the tasks to retrieve.
1392
- # @param trigger_type [Array<TriggerType>] The trigger type of the task.
1393
- # @param sort [TaskSortKeys] The key by which the list should be sorted.
1394
- # @param order [OrderKeys] The order of the returned list.
1457
+ # @param items_per_page [Integer] Number of items per page. (default to 10)
1458
+ # @param page [Integer] Page number of the paginated API response.
1459
+ # @param action [Array<ActionType>] Actions for filtering the list of tasks.
1460
+ # @param enabled [Boolean] Whether to filter the list of tasks by the &#x60;enabled&#x60; status.
1461
+ # @param source_id [Array<String>] Source IDs for filtering the list of tasks.
1462
+ # @param destination_id [Array<String>] Destination IDs for filtering the list of tasks.
1463
+ # @param trigger_type [Array<TriggerType>] Type of task trigger for filtering the list of tasks.
1464
+ # @param sort [TaskSortKeys] Property by which to sort the list of tasks. (default to 'createdAt')
1465
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1395
1466
  # @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)
1396
1467
  # @return [ListTasksResponse]
1397
1468
  def get_tasks(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, destination_id = nil, trigger_type = nil, sort = nil, order = nil,
@@ -1400,13 +1471,13 @@ module Algolia
1400
1471
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListTasksResponse')
1401
1472
  end
1402
1473
 
1403
- # Run the task of the given taskID.
1474
+ # Runs a task. You can check the status of task runs with the observability endpoints.
1404
1475
  #
1405
1476
  # Required API Key ACLs:
1406
1477
  # - addObject
1407
1478
  # - deleteIndex
1408
1479
  # - editSettings
1409
- # @param task_id [String] The task UUID. (required)
1480
+ # @param task_id [String] Unique identifier of a task. (required)
1410
1481
  # @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)
1411
1482
  # @return [Http::Response] the response
1412
1483
  def run_task_with_http_info(task_id, request_options = {})
@@ -1434,13 +1505,13 @@ module Algolia
1434
1505
  @api_client.call_api(:POST, path, new_options)
1435
1506
  end
1436
1507
 
1437
- # Run the task of the given taskID.
1508
+ # Runs a task. You can check the status of task runs with the observability endpoints.
1438
1509
  #
1439
1510
  # Required API Key ACLs:
1440
1511
  # - addObject
1441
1512
  # - deleteIndex
1442
1513
  # - editSettings
1443
- # @param task_id [String] The task UUID. (required)
1514
+ # @param task_id [String] Unique identifier of a task. (required)
1444
1515
  # @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)
1445
1516
  # @return [RunResponse]
1446
1517
  def run_task(task_id, request_options = {})
@@ -1448,7 +1519,7 @@ module Algolia
1448
1519
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::RunResponse')
1449
1520
  end
1450
1521
 
1451
- # Search among authentications with a defined set of parameters.
1522
+ # Searches for authentication resources.
1452
1523
  #
1453
1524
  # Required API Key ACLs:
1454
1525
  # - addObject
@@ -1482,7 +1553,7 @@ module Algolia
1482
1553
  @api_client.call_api(:POST, path, new_options)
1483
1554
  end
1484
1555
 
1485
- # Search among authentications with a defined set of parameters.
1556
+ # Searches for authentication resources.
1486
1557
  #
1487
1558
  # Required API Key ACLs:
1488
1559
  # - addObject
@@ -1496,7 +1567,7 @@ module Algolia
1496
1567
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Authentication>')
1497
1568
  end
1498
1569
 
1499
- # Search among destinations with a defined set of parameters.
1570
+ # Searches for destinations.
1500
1571
  #
1501
1572
  # Required API Key ACLs:
1502
1573
  # - addObject
@@ -1530,7 +1601,7 @@ module Algolia
1530
1601
  @api_client.call_api(:POST, path, new_options)
1531
1602
  end
1532
1603
 
1533
- # Search among destinations with a defined set of parameters.
1604
+ # Searches for destinations.
1534
1605
  #
1535
1606
  # Required API Key ACLs:
1536
1607
  # - addObject
@@ -1544,7 +1615,7 @@ module Algolia
1544
1615
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Destination>')
1545
1616
  end
1546
1617
 
1547
- # Search among sources with a defined set of parameters.
1618
+ # Searches for sources.
1548
1619
  #
1549
1620
  # Required API Key ACLs:
1550
1621
  # - addObject
@@ -1578,7 +1649,7 @@ module Algolia
1578
1649
  @api_client.call_api(:POST, path, new_options)
1579
1650
  end
1580
1651
 
1581
- # Search among sources with a defined set of parameters.
1652
+ # Searches for sources.
1582
1653
  #
1583
1654
  # Required API Key ACLs:
1584
1655
  # - addObject
@@ -1592,7 +1663,7 @@ module Algolia
1592
1663
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Source>')
1593
1664
  end
1594
1665
 
1595
- # Search among tasks with a defined set of parameters.
1666
+ # Searches for tasks.
1596
1667
  #
1597
1668
  # Required API Key ACLs:
1598
1669
  # - addObject
@@ -1626,7 +1697,7 @@ module Algolia
1626
1697
  @api_client.call_api(:POST, path, new_options)
1627
1698
  end
1628
1699
 
1629
- # Search among tasks with a defined set of parameters.
1700
+ # Searches for tasks.
1630
1701
  #
1631
1702
  # Required API Key ACLs:
1632
1703
  # - addObject
@@ -1640,13 +1711,13 @@ module Algolia
1640
1711
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Task>')
1641
1712
  end
1642
1713
 
1643
- # Trigger a stream listing request for a Singer specification compatible docker type source.
1714
+ # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with &#x60;type: docker&#x60; and &#x60;imageType: singer&#x60;.
1644
1715
  #
1645
1716
  # Required API Key ACLs:
1646
1717
  # - addObject
1647
1718
  # - deleteIndex
1648
1719
  # - editSettings
1649
- # @param source_id [String] The source UUID. (required)
1720
+ # @param source_id [String] Unique identifier of a source. (required)
1650
1721
  # @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)
1651
1722
  # @return [Http::Response] the response
1652
1723
  def trigger_docker_source_discover_with_http_info(source_id, request_options = {})
@@ -1674,13 +1745,13 @@ module Algolia
1674
1745
  @api_client.call_api(:POST, path, new_options)
1675
1746
  end
1676
1747
 
1677
- # Trigger a stream listing request for a Singer specification compatible docker type source.
1748
+ # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
1678
1749
  #
1679
1750
  # Required API Key ACLs:
1680
1751
  # - addObject
1681
1752
  # - deleteIndex
1682
1753
  # - editSettings
1683
- # @param source_id [String] The source UUID. (required)
1754
+ # @param source_id [String] Unique identifier of a source. (required)
1684
1755
  # @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)
1685
1756
  # @return [DockerSourceDiscover]
1686
1757
  def trigger_docker_source_discover(source_id, request_options = {})
@@ -1688,13 +1759,13 @@ module Algolia
1688
1759
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceDiscover')
1689
1760
  end
1690
1761
 
1691
- # Update the authentication of the given authenticationID.
1762
+ # Updates an authentication resource.
1692
1763
  #
1693
1764
  # Required API Key ACLs:
1694
1765
  # - addObject
1695
1766
  # - deleteIndex
1696
1767
  # - editSettings
1697
- # @param authentication_id [String] The authentication UUID. (required)
1768
+ # @param authentication_id [String] Unique identifier of an authentication resource. (required)
1698
1769
  # @param authentication_update [AuthenticationUpdate] (required)
1699
1770
  # @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)
1700
1771
  # @return [Http::Response] the response
@@ -1727,13 +1798,13 @@ module Algolia
1727
1798
  @api_client.call_api(:PATCH, path, new_options)
1728
1799
  end
1729
1800
 
1730
- # Update the authentication of the given authenticationID.
1801
+ # Updates an authentication resource.
1731
1802
  #
1732
1803
  # Required API Key ACLs:
1733
1804
  # - addObject
1734
1805
  # - deleteIndex
1735
1806
  # - editSettings
1736
- # @param authentication_id [String] The authentication UUID. (required)
1807
+ # @param authentication_id [String] Unique identifier of an authentication resource. (required)
1737
1808
  # @param authentication_update [AuthenticationUpdate] (required)
1738
1809
  # @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)
1739
1810
  # @return [AuthenticationUpdateResponse]
@@ -1742,13 +1813,13 @@ module Algolia
1742
1813
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::AuthenticationUpdateResponse')
1743
1814
  end
1744
1815
 
1745
- # Update the destination of the given destinationID.
1816
+ # Updates the destination by its ID.
1746
1817
  #
1747
1818
  # Required API Key ACLs:
1748
1819
  # - addObject
1749
1820
  # - deleteIndex
1750
1821
  # - editSettings
1751
- # @param destination_id [String] The destination UUID. (required)
1822
+ # @param destination_id [String] Unique identifier of a destination. (required)
1752
1823
  # @param destination_update [DestinationUpdate] (required)
1753
1824
  # @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)
1754
1825
  # @return [Http::Response] the response
@@ -1781,13 +1852,13 @@ module Algolia
1781
1852
  @api_client.call_api(:PATCH, path, new_options)
1782
1853
  end
1783
1854
 
1784
- # Update the destination of the given destinationID.
1855
+ # Updates the destination by its ID.
1785
1856
  #
1786
1857
  # Required API Key ACLs:
1787
1858
  # - addObject
1788
1859
  # - deleteIndex
1789
1860
  # - editSettings
1790
- # @param destination_id [String] The destination UUID. (required)
1861
+ # @param destination_id [String] Unique identifier of a destination. (required)
1791
1862
  # @param destination_update [DestinationUpdate] (required)
1792
1863
  # @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)
1793
1864
  # @return [DestinationUpdateResponse]
@@ -1796,13 +1867,13 @@ module Algolia
1796
1867
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DestinationUpdateResponse')
1797
1868
  end
1798
1869
 
1799
- # Update the source of the given sourceID.
1870
+ # Updates a source by its ID.
1800
1871
  #
1801
1872
  # Required API Key ACLs:
1802
1873
  # - addObject
1803
1874
  # - deleteIndex
1804
1875
  # - editSettings
1805
- # @param source_id [String] The source UUID. (required)
1876
+ # @param source_id [String] Unique identifier of a source. (required)
1806
1877
  # @param source_update [SourceUpdate] (required)
1807
1878
  # @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)
1808
1879
  # @return [Http::Response] the response
@@ -1835,13 +1906,13 @@ module Algolia
1835
1906
  @api_client.call_api(:PATCH, path, new_options)
1836
1907
  end
1837
1908
 
1838
- # Update the source of the given sourceID.
1909
+ # Updates a source by its ID.
1839
1910
  #
1840
1911
  # Required API Key ACLs:
1841
1912
  # - addObject
1842
1913
  # - deleteIndex
1843
1914
  # - editSettings
1844
- # @param source_id [String] The source UUID. (required)
1915
+ # @param source_id [String] Unique identifier of a source. (required)
1845
1916
  # @param source_update [SourceUpdate] (required)
1846
1917
  # @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)
1847
1918
  # @return [SourceUpdateResponse]
@@ -1850,9 +1921,9 @@ module Algolia
1850
1921
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceUpdateResponse')
1851
1922
  end
1852
1923
 
1853
- # Update the task of the given taskID.
1924
+ # Updates a task by its ID.
1854
1925
 
1855
- # @param task_id [String] The task UUID. (required)
1926
+ # @param task_id [String] Unique identifier of a task. (required)
1856
1927
  # @param task_update [TaskUpdate] (required)
1857
1928
  # @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)
1858
1929
  # @return [Http::Response] the response
@@ -1885,9 +1956,9 @@ module Algolia
1885
1956
  @api_client.call_api(:PATCH, path, new_options)
1886
1957
  end
1887
1958
 
1888
- # Update the task of the given taskID.
1959
+ # Updates a task by its ID.
1889
1960
 
1890
- # @param task_id [String] The task UUID. (required)
1961
+ # @param task_id [String] Unique identifier of a task. (required)
1891
1962
  # @param task_update [TaskUpdate] (required)
1892
1963
  # @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)
1893
1964
  # @return [TaskUpdateResponse]