algolia 3.0.0.alpha.6 → 3.0.0.alpha.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/VERSION +1 -1
  3. data/CHANGELOG.md +4 -0
  4. data/Gemfile.lock +2 -2
  5. data/lib/algolia/api/abtesting_client.rb +41 -21
  6. data/lib/algolia/api/analytics_client.rb +111 -43
  7. data/lib/algolia/api/ingestion_client.rb +334 -94
  8. data/lib/algolia/api/insights_client.rb +13 -13
  9. data/lib/algolia/api/monitoring_client.rb +32 -33
  10. data/lib/algolia/api/personalization_client.rb +34 -18
  11. data/lib/algolia/api/query_suggestions_client.rb +55 -27
  12. data/lib/algolia/api/recommend_client.rb +46 -26
  13. data/lib/algolia/api/search_client.rb +459 -171
  14. data/lib/algolia/api_client.rb +0 -4
  15. data/lib/algolia/models/abtesting/ab_test.rb +7 -1
  16. data/lib/algolia/models/abtesting/list_ab_tests_response.rb +3 -1
  17. data/lib/algolia/models/abtesting/variant.rb +24 -5
  18. data/lib/algolia/models/analytics/click_through_rate_event.rb +3 -1
  19. data/lib/algolia/models/analytics/conversion_rate_event.rb +3 -1
  20. data/lib/algolia/models/analytics/get_click_through_rate_response.rb +3 -1
  21. data/lib/algolia/models/analytics/get_conversation_rate_response.rb +3 -1
  22. data/lib/algolia/models/analytics/top_hit_with_analytics.rb +3 -1
  23. data/lib/algolia/models/analytics/top_search_with_analytics.rb +3 -1
  24. data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb +1 -11
  25. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +1 -11
  26. data/lib/algolia/models/recommend/highlight_result.rb +1 -0
  27. data/lib/algolia/models/recommend/snippet_result.rb +1 -0
  28. data/lib/algolia/models/search/highlight_result.rb +1 -0
  29. data/lib/algolia/models/search/snippet_result.rb +1 -0
  30. data/lib/algolia/transport/http/http_requester.rb +2 -2
  31. data/lib/algolia/transport/stateful_host.rb +2 -1
  32. data/lib/algolia/transport/transport.rb +7 -4
  33. data/lib/algolia/version.rb +1 -1
  34. metadata +2 -2
@@ -34,7 +34,11 @@ module Algolia
34
34
  end
35
35
 
36
36
  # Create a authentication.
37
- # Create a authentication.
37
+ #
38
+ # Required API Key ACLs:
39
+ # - addObject
40
+ # - deleteIndex
41
+ # - editSettings
38
42
  # @param authentication_create [AuthenticationCreate] (required)
39
43
  # @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)
40
44
  # @return [Http::Response] the response
@@ -64,7 +68,11 @@ module Algolia
64
68
  end
65
69
 
66
70
  # Create a authentication.
67
- # Create a authentication.
71
+ #
72
+ # Required API Key ACLs:
73
+ # - addObject
74
+ # - deleteIndex
75
+ # - editSettings
68
76
  # @param authentication_create [AuthenticationCreate] (required)
69
77
  # @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)
70
78
  # @return [AuthenticationCreateResponse]
@@ -74,7 +82,11 @@ module Algolia
74
82
  end
75
83
 
76
84
  # Create a destination.
77
- # Create a destination.
85
+ #
86
+ # Required API Key ACLs:
87
+ # - addObject
88
+ # - deleteIndex
89
+ # - editSettings
78
90
  # @param destination_create [DestinationCreate] (required)
79
91
  # @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)
80
92
  # @return [Http::Response] the response
@@ -104,7 +116,11 @@ module Algolia
104
116
  end
105
117
 
106
118
  # Create a destination.
107
- # Create a destination.
119
+ #
120
+ # Required API Key ACLs:
121
+ # - addObject
122
+ # - deleteIndex
123
+ # - editSettings
108
124
  # @param destination_create [DestinationCreate] (required)
109
125
  # @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)
110
126
  # @return [DestinationCreateResponse]
@@ -114,7 +130,11 @@ module Algolia
114
130
  end
115
131
 
116
132
  # Create a source.
117
- # Create a source.
133
+ #
134
+ # Required API Key ACLs:
135
+ # - addObject
136
+ # - deleteIndex
137
+ # - editSettings
118
138
  # @param source_create [SourceCreate] (required)
119
139
  # @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)
120
140
  # @return [Http::Response] the response
@@ -144,7 +164,11 @@ module Algolia
144
164
  end
145
165
 
146
166
  # Create a source.
147
- # Create a source.
167
+ #
168
+ # Required API Key ACLs:
169
+ # - addObject
170
+ # - deleteIndex
171
+ # - editSettings
148
172
  # @param source_create [SourceCreate] (required)
149
173
  # @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)
150
174
  # @return [SourceCreateResponse]
@@ -154,7 +178,7 @@ module Algolia
154
178
  end
155
179
 
156
180
  # Create a task.
157
- # Create a task.
181
+
158
182
  # @param task_create [TaskCreate] (required)
159
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)
160
184
  # @return [Http::Response] the response
@@ -184,7 +208,7 @@ module Algolia
184
208
  end
185
209
 
186
210
  # Create a task.
187
- # Create a task.
211
+
188
212
  # @param task_create [TaskCreate] (required)
189
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)
190
214
  # @return [TaskCreateResponse]
@@ -193,8 +217,8 @@ module Algolia
193
217
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskCreateResponse')
194
218
  end
195
219
 
196
- # Send requests to the Algolia REST API.
197
220
  # This method allow you to send requests to the Algolia REST API.
221
+
198
222
  # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
199
223
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
200
224
  # @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)
@@ -225,8 +249,8 @@ module Algolia
225
249
  @api_client.call_api(:DELETE, path, new_options)
226
250
  end
227
251
 
228
- # Send requests to the Algolia REST API.
229
252
  # This method allow you to send requests to the Algolia REST API.
253
+
230
254
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
231
255
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
232
256
  # @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)
@@ -236,8 +260,8 @@ module Algolia
236
260
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
237
261
  end
238
262
 
239
- # Send requests to the Algolia REST API.
240
263
  # This method allow you to send requests to the Algolia REST API.
264
+
241
265
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
242
266
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
243
267
  # @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)
@@ -268,8 +292,8 @@ module Algolia
268
292
  @api_client.call_api(:GET, path, new_options)
269
293
  end
270
294
 
271
- # Send requests to the Algolia REST API.
272
295
  # This method allow you to send requests to the Algolia REST API.
296
+
273
297
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
274
298
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
275
299
  # @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)
@@ -279,8 +303,8 @@ module Algolia
279
303
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
280
304
  end
281
305
 
282
- # Send requests to the Algolia REST API.
283
306
  # This method allow you to send requests to the Algolia REST API.
307
+
284
308
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
285
309
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
286
310
  # @param body [Object] Parameters to send with the custom request.
@@ -312,8 +336,8 @@ module Algolia
312
336
  @api_client.call_api(:POST, path, new_options)
313
337
  end
314
338
 
315
- # Send requests to the Algolia REST API.
316
339
  # This method allow you to send requests to the Algolia REST API.
340
+
317
341
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
318
342
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
319
343
  # @param body [Object] Parameters to send with the custom request.
@@ -324,8 +348,8 @@ module Algolia
324
348
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
325
349
  end
326
350
 
327
- # Send requests to the Algolia REST API.
328
351
  # This method allow you to send requests to the Algolia REST API.
352
+
329
353
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
330
354
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
331
355
  # @param body [Object] Parameters to send with the custom request.
@@ -357,8 +381,8 @@ module Algolia
357
381
  @api_client.call_api(:PUT, path, new_options)
358
382
  end
359
383
 
360
- # Send requests to the Algolia REST API.
361
384
  # This method allow you to send requests to the Algolia REST API.
385
+
362
386
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
363
387
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
364
388
  # @param body [Object] Parameters to send with the custom request.
@@ -369,8 +393,12 @@ module Algolia
369
393
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
370
394
  end
371
395
 
372
- # Delete a authentication.
373
396
  # Soft delete the authentication of the given authenticationID.
397
+ #
398
+ # Required API Key ACLs:
399
+ # - addObject
400
+ # - deleteIndex
401
+ # - editSettings
374
402
  # @param authentication_id [String] The authentication UUID. (required)
375
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)
376
404
  # @return [Http::Response] the response
@@ -380,7 +408,7 @@ module Algolia
380
408
  raise ArgumentError, "Parameter `authentication_id` is required when calling `delete_authentication`."
381
409
  end
382
410
 
383
- path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', @api_client.encode_uri(authentication_id.to_s))
411
+ path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', Transport.encode_uri(authentication_id.to_s))
384
412
  query_params = {}
385
413
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
386
414
  header_params = {}
@@ -399,8 +427,12 @@ module Algolia
399
427
  @api_client.call_api(:DELETE, path, new_options)
400
428
  end
401
429
 
402
- # Delete a authentication.
403
430
  # Soft delete the authentication of the given authenticationID.
431
+ #
432
+ # Required API Key ACLs:
433
+ # - addObject
434
+ # - deleteIndex
435
+ # - editSettings
404
436
  # @param authentication_id [String] The authentication UUID. (required)
405
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)
406
438
  # @return [DeleteResponse]
@@ -409,8 +441,12 @@ module Algolia
409
441
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
410
442
  end
411
443
 
412
- # Delete a destination.
413
444
  # Soft delete the destination of the given destinationID.
445
+ #
446
+ # Required API Key ACLs:
447
+ # - addObject
448
+ # - deleteIndex
449
+ # - editSettings
414
450
  # @param destination_id [String] The destination UUID. (required)
415
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)
416
452
  # @return [Http::Response] the response
@@ -420,7 +456,7 @@ module Algolia
420
456
  raise ArgumentError, "Parameter `destination_id` is required when calling `delete_destination`."
421
457
  end
422
458
 
423
- path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', @api_client.encode_uri(destination_id.to_s))
459
+ path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', Transport.encode_uri(destination_id.to_s))
424
460
  query_params = {}
425
461
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
426
462
  header_params = {}
@@ -439,8 +475,12 @@ module Algolia
439
475
  @api_client.call_api(:DELETE, path, new_options)
440
476
  end
441
477
 
442
- # Delete a destination.
443
478
  # Soft delete the destination of the given destinationID.
479
+ #
480
+ # Required API Key ACLs:
481
+ # - addObject
482
+ # - deleteIndex
483
+ # - editSettings
444
484
  # @param destination_id [String] The destination UUID. (required)
445
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)
446
486
  # @return [DeleteResponse]
@@ -449,8 +489,12 @@ module Algolia
449
489
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
450
490
  end
451
491
 
452
- # Delete a source.
453
492
  # Soft delete the source of the given sourceID.
493
+ #
494
+ # Required API Key ACLs:
495
+ # - addObject
496
+ # - deleteIndex
497
+ # - editSettings
454
498
  # @param source_id [String] The source UUID. (required)
455
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)
456
500
  # @return [Http::Response] the response
@@ -460,7 +504,7 @@ module Algolia
460
504
  raise ArgumentError, "Parameter `source_id` is required when calling `delete_source`."
461
505
  end
462
506
 
463
- path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
507
+ path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
464
508
  query_params = {}
465
509
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
466
510
  header_params = {}
@@ -479,8 +523,12 @@ module Algolia
479
523
  @api_client.call_api(:DELETE, path, new_options)
480
524
  end
481
525
 
482
- # Delete a source.
483
526
  # Soft delete the source of the given sourceID.
527
+ #
528
+ # Required API Key ACLs:
529
+ # - addObject
530
+ # - deleteIndex
531
+ # - editSettings
484
532
  # @param source_id [String] The source UUID. (required)
485
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)
486
534
  # @return [DeleteResponse]
@@ -489,8 +537,8 @@ module Algolia
489
537
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
490
538
  end
491
539
 
492
- # Delete a task.
493
540
  # Soft delete the task of the given taskID.
541
+
494
542
  # @param task_id [String] The task UUID. (required)
495
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)
496
544
  # @return [Http::Response] the response
@@ -500,7 +548,7 @@ module Algolia
500
548
  raise ArgumentError, "Parameter `task_id` is required when calling `delete_task`."
501
549
  end
502
550
 
503
- path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
551
+ path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
504
552
  query_params = {}
505
553
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
506
554
  header_params = {}
@@ -519,8 +567,8 @@ module Algolia
519
567
  @api_client.call_api(:DELETE, path, new_options)
520
568
  end
521
569
 
522
- # Delete a task.
523
570
  # Soft delete the task of the given taskID.
571
+
524
572
  # @param task_id [String] The task UUID. (required)
525
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)
526
574
  # @return [DeleteResponse]
@@ -529,8 +577,12 @@ module Algolia
529
577
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
530
578
  end
531
579
 
532
- # Disable a task.
533
580
  # Disable the task of the given taskID.
581
+ #
582
+ # Required API Key ACLs:
583
+ # - addObject
584
+ # - deleteIndex
585
+ # - editSettings
534
586
  # @param task_id [String] The task UUID. (required)
535
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)
536
588
  # @return [Http::Response] the response
@@ -540,7 +592,7 @@ module Algolia
540
592
  raise ArgumentError, "Parameter `task_id` is required when calling `disable_task`."
541
593
  end
542
594
 
543
- path = '/1/tasks/{taskID}/disable'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
595
+ path = '/1/tasks/{taskID}/disable'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
544
596
  query_params = {}
545
597
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
546
598
  header_params = {}
@@ -559,8 +611,12 @@ module Algolia
559
611
  @api_client.call_api(:PUT, path, new_options)
560
612
  end
561
613
 
562
- # Disable a task.
563
614
  # Disable the task of the given taskID.
615
+ #
616
+ # Required API Key ACLs:
617
+ # - addObject
618
+ # - deleteIndex
619
+ # - editSettings
564
620
  # @param task_id [String] The task UUID. (required)
565
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)
566
622
  # @return [TaskUpdateResponse]
@@ -569,8 +625,12 @@ module Algolia
569
625
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
570
626
  end
571
627
 
572
- # Enable a task.
573
628
  # Enable the task of the given taskID.
629
+ #
630
+ # Required API Key ACLs:
631
+ # - addObject
632
+ # - deleteIndex
633
+ # - editSettings
574
634
  # @param task_id [String] The task UUID. (required)
575
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)
576
636
  # @return [Http::Response] the response
@@ -580,7 +640,7 @@ module Algolia
580
640
  raise ArgumentError, "Parameter `task_id` is required when calling `enable_task`."
581
641
  end
582
642
 
583
- path = '/1/tasks/{taskID}/enable'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
643
+ path = '/1/tasks/{taskID}/enable'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
584
644
  query_params = {}
585
645
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
586
646
  header_params = {}
@@ -599,8 +659,12 @@ module Algolia
599
659
  @api_client.call_api(:PUT, path, new_options)
600
660
  end
601
661
 
602
- # Enable a task.
603
662
  # Enable the task of the given taskID.
663
+ #
664
+ # Required API Key ACLs:
665
+ # - addObject
666
+ # - deleteIndex
667
+ # - editSettings
604
668
  # @param task_id [String] The task UUID. (required)
605
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)
606
670
  # @return [TaskUpdateResponse]
@@ -609,8 +673,12 @@ module Algolia
609
673
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
610
674
  end
611
675
 
612
- # Get a authentication.
613
676
  # Get the authentication of the given authenticationID.
677
+ #
678
+ # Required API Key ACLs:
679
+ # - addObject
680
+ # - deleteIndex
681
+ # - editSettings
614
682
  # @param authentication_id [String] The authentication UUID. (required)
615
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)
616
684
  # @return [Http::Response] the response
@@ -620,7 +688,7 @@ module Algolia
620
688
  raise ArgumentError, "Parameter `authentication_id` is required when calling `get_authentication`."
621
689
  end
622
690
 
623
- path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', @api_client.encode_uri(authentication_id.to_s))
691
+ path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', Transport.encode_uri(authentication_id.to_s))
624
692
  query_params = {}
625
693
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
626
694
  header_params = {}
@@ -639,8 +707,12 @@ module Algolia
639
707
  @api_client.call_api(:GET, path, new_options)
640
708
  end
641
709
 
642
- # Get a authentication.
643
710
  # Get the authentication of the given authenticationID.
711
+ #
712
+ # Required API Key ACLs:
713
+ # - addObject
714
+ # - deleteIndex
715
+ # - editSettings
644
716
  # @param authentication_id [String] The authentication UUID. (required)
645
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)
646
718
  # @return [Authentication]
@@ -649,8 +721,12 @@ module Algolia
649
721
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Authentication')
650
722
  end
651
723
 
652
- # Get a list of authentications.
653
724
  # Get a list of authentications for the given query parameters, with pagination details.
725
+ #
726
+ # Required API Key ACLs:
727
+ # - addObject
728
+ # - deleteIndex
729
+ # - editSettings
654
730
  # @param items_per_page [Integer] The number of items per page to return.
655
731
  # @param page [Integer] The page number to fetch, starting at 1.
656
732
  # @param type [Array<AuthenticationType>] The type of the authentications to retrieve.
@@ -685,8 +761,12 @@ module Algolia
685
761
  @api_client.call_api(:GET, path, new_options)
686
762
  end
687
763
 
688
- # Get a list of authentications.
689
764
  # Get a list of authentications for the given query parameters, with pagination details.
765
+ #
766
+ # Required API Key ACLs:
767
+ # - addObject
768
+ # - deleteIndex
769
+ # - editSettings
690
770
  # @param items_per_page [Integer] The number of items per page to return.
691
771
  # @param page [Integer] The page number to fetch, starting at 1.
692
772
  # @param type [Array<AuthenticationType>] The type of the authentications to retrieve.
@@ -700,8 +780,12 @@ module Algolia
700
780
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListAuthenticationsResponse')
701
781
  end
702
782
 
703
- # Get a destination.
704
783
  # Get the destination of the given destinationID.
784
+ #
785
+ # Required API Key ACLs:
786
+ # - addObject
787
+ # - deleteIndex
788
+ # - editSettings
705
789
  # @param destination_id [String] The destination UUID. (required)
706
790
  # @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)
707
791
  # @return [Http::Response] the response
@@ -711,7 +795,7 @@ module Algolia
711
795
  raise ArgumentError, "Parameter `destination_id` is required when calling `get_destination`."
712
796
  end
713
797
 
714
- path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', @api_client.encode_uri(destination_id.to_s))
798
+ path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', Transport.encode_uri(destination_id.to_s))
715
799
  query_params = {}
716
800
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
717
801
  header_params = {}
@@ -730,8 +814,12 @@ module Algolia
730
814
  @api_client.call_api(:GET, path, new_options)
731
815
  end
732
816
 
733
- # Get a destination.
734
817
  # Get the destination of the given destinationID.
818
+ #
819
+ # Required API Key ACLs:
820
+ # - addObject
821
+ # - deleteIndex
822
+ # - editSettings
735
823
  # @param destination_id [String] The destination UUID. (required)
736
824
  # @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
825
  # @return [Destination]
@@ -740,8 +828,12 @@ module Algolia
740
828
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Destination')
741
829
  end
742
830
 
743
- # Get a list of destinations.
744
831
  # Get a list of destinations for the given query parameters, with pagination details.
832
+ #
833
+ # Required API Key ACLs:
834
+ # - addObject
835
+ # - deleteIndex
836
+ # - editSettings
745
837
  # @param items_per_page [Integer] The number of items per page to return.
746
838
  # @param page [Integer] The page number to fetch, starting at 1.
747
839
  # @param type [Array<DestinationType>] The type of the destinations to retrive.
@@ -776,8 +868,12 @@ module Algolia
776
868
  @api_client.call_api(:GET, path, new_options)
777
869
  end
778
870
 
779
- # Get a list of destinations.
780
871
  # Get a list of destinations for the given query parameters, with pagination details.
872
+ #
873
+ # Required API Key ACLs:
874
+ # - addObject
875
+ # - deleteIndex
876
+ # - editSettings
781
877
  # @param items_per_page [Integer] The number of items per page to return.
782
878
  # @param page [Integer] The page number to fetch, starting at 1.
783
879
  # @param type [Array<DestinationType>] The type of the destinations to retrive.
@@ -791,8 +887,12 @@ module Algolia
791
887
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListDestinationsResponse')
792
888
  end
793
889
 
794
- # Retrieve a stream listing.
795
890
  # Retrieve a stream listing for a given Singer specification compatible docker type source ID.
891
+ #
892
+ # Required API Key ACLs:
893
+ # - addObject
894
+ # - deleteIndex
895
+ # - editSettings
796
896
  # @param source_id [String] The source UUID. (required)
797
897
  # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
798
898
  # @return [Http::Response] the response
@@ -802,7 +902,7 @@ module Algolia
802
902
  raise ArgumentError, "Parameter `source_id` is required when calling `get_docker_source_streams`."
803
903
  end
804
904
 
805
- path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
905
+ path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
806
906
  query_params = {}
807
907
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
808
908
  header_params = {}
@@ -821,8 +921,12 @@ module Algolia
821
921
  @api_client.call_api(:GET, path, new_options)
822
922
  end
823
923
 
824
- # Retrieve a stream listing.
825
924
  # Retrieve a stream listing for a given Singer specification compatible docker type source ID.
925
+ #
926
+ # Required API Key ACLs:
927
+ # - addObject
928
+ # - deleteIndex
929
+ # - editSettings
826
930
  # @param source_id [String] The source UUID. (required)
827
931
  # @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)
828
932
  # @return [DockerSourceStreams]
@@ -831,8 +935,12 @@ module Algolia
831
935
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceStreams')
832
936
  end
833
937
 
834
- # Get an event.
835
938
  # Get a single event for a specific runID.
939
+ #
940
+ # Required API Key ACLs:
941
+ # - addObject
942
+ # - deleteIndex
943
+ # - editSettings
836
944
  # @param run_id [String] The run UUID. (required)
837
945
  # @param event_id [String] The event UUID. (required)
838
946
  # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -847,7 +955,7 @@ module Algolia
847
955
  raise ArgumentError, "Parameter `event_id` is required when calling `get_event`."
848
956
  end
849
957
 
850
- path = '/1/runs/{runID}/events/{eventID}'.sub('{' + 'runID' + '}', @api_client.encode_uri(run_id.to_s)).sub('{' + 'eventID' + '}', @api_client.encode_uri(event_id.to_s))
958
+ path = '/1/runs/{runID}/events/{eventID}'.sub('{' + 'runID' + '}', Transport.encode_uri(run_id.to_s)).sub('{' + 'eventID' + '}', Transport.encode_uri(event_id.to_s))
851
959
  query_params = {}
852
960
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
853
961
  header_params = {}
@@ -866,8 +974,12 @@ module Algolia
866
974
  @api_client.call_api(:GET, path, new_options)
867
975
  end
868
976
 
869
- # Get an event.
870
977
  # Get a single event for a specific runID.
978
+ #
979
+ # Required API Key ACLs:
980
+ # - addObject
981
+ # - deleteIndex
982
+ # - editSettings
871
983
  # @param run_id [String] The run UUID. (required)
872
984
  # @param event_id [String] The event UUID. (required)
873
985
  # @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)
@@ -877,8 +989,12 @@ module Algolia
877
989
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Event')
878
990
  end
879
991
 
880
- # Get a list of events.
881
992
  # Get a list of events associated to the given runID, for the given query parameters.
993
+ #
994
+ # Required API Key ACLs:
995
+ # - addObject
996
+ # - deleteIndex
997
+ # - editSettings
882
998
  # @param run_id [String] The run UUID. (required)
883
999
  # @param items_per_page [Integer] The number of items per page to return.
884
1000
  # @param page [Integer] The page number to fetch, starting at 1.
@@ -897,7 +1013,7 @@ module Algolia
897
1013
  raise ArgumentError, "Parameter `run_id` is required when calling `get_events`."
898
1014
  end
899
1015
 
900
- path = '/1/runs/{runID}/events'.sub('{' + 'runID' + '}', @api_client.encode_uri(run_id.to_s))
1016
+ path = '/1/runs/{runID}/events'.sub('{' + 'runID' + '}', Transport.encode_uri(run_id.to_s))
901
1017
  query_params = {}
902
1018
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
903
1019
  query_params[:page] = page unless page.nil?
@@ -924,8 +1040,12 @@ module Algolia
924
1040
  @api_client.call_api(:GET, path, new_options)
925
1041
  end
926
1042
 
927
- # Get a list of events.
928
1043
  # Get a list of events associated to the given runID, for the given query parameters.
1044
+ #
1045
+ # Required API Key ACLs:
1046
+ # - addObject
1047
+ # - deleteIndex
1048
+ # - editSettings
929
1049
  # @param run_id [String] The run UUID. (required)
930
1050
  # @param items_per_page [Integer] The number of items per page to return.
931
1051
  # @param page [Integer] The page number to fetch, starting at 1.
@@ -942,8 +1062,12 @@ module Algolia
942
1062
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListEventsResponse')
943
1063
  end
944
1064
 
945
- # Get a run.
946
1065
  # Get a single run for the given ID.
1066
+ #
1067
+ # Required API Key ACLs:
1068
+ # - addObject
1069
+ # - deleteIndex
1070
+ # - editSettings
947
1071
  # @param run_id [String] The run UUID. (required)
948
1072
  # @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)
949
1073
  # @return [Http::Response] the response
@@ -953,7 +1077,7 @@ module Algolia
953
1077
  raise ArgumentError, "Parameter `run_id` is required when calling `get_run`."
954
1078
  end
955
1079
 
956
- path = '/1/runs/{runID}'.sub('{' + 'runID' + '}', @api_client.encode_uri(run_id.to_s))
1080
+ path = '/1/runs/{runID}'.sub('{' + 'runID' + '}', Transport.encode_uri(run_id.to_s))
957
1081
  query_params = {}
958
1082
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
959
1083
  header_params = {}
@@ -972,8 +1096,12 @@ module Algolia
972
1096
  @api_client.call_api(:GET, path, new_options)
973
1097
  end
974
1098
 
975
- # Get a run.
976
1099
  # Get a single run for the given ID.
1100
+ #
1101
+ # Required API Key ACLs:
1102
+ # - addObject
1103
+ # - deleteIndex
1104
+ # - editSettings
977
1105
  # @param run_id [String] The run UUID. (required)
978
1106
  # @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)
979
1107
  # @return [Run]
@@ -982,8 +1110,12 @@ module Algolia
982
1110
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Run')
983
1111
  end
984
1112
 
985
- # Get a list of runs.
986
1113
  # Get a list of runs for the given query parameters, with pagination details.
1114
+ #
1115
+ # Required API Key ACLs:
1116
+ # - addObject
1117
+ # - deleteIndex
1118
+ # - editSettings
987
1119
  # @param items_per_page [Integer] The number of items per page to return.
988
1120
  # @param page [Integer] The page number to fetch, starting at 1.
989
1121
  # @param status [Array<RunStatus>] Filter the status of the runs.
@@ -1022,8 +1154,12 @@ module Algolia
1022
1154
  @api_client.call_api(:GET, path, new_options)
1023
1155
  end
1024
1156
 
1025
- # Get a list of runs.
1026
1157
  # Get a list of runs for the given query parameters, with pagination details.
1158
+ #
1159
+ # Required API Key ACLs:
1160
+ # - addObject
1161
+ # - deleteIndex
1162
+ # - editSettings
1027
1163
  # @param items_per_page [Integer] The number of items per page to return.
1028
1164
  # @param page [Integer] The page number to fetch, starting at 1.
1029
1165
  # @param status [Array<RunStatus>] Filter the status of the runs.
@@ -1039,8 +1175,12 @@ module Algolia
1039
1175
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::RunListResponse')
1040
1176
  end
1041
1177
 
1042
- # Get a source.
1043
1178
  # Get the source of the given sourceID.
1179
+ #
1180
+ # Required API Key ACLs:
1181
+ # - addObject
1182
+ # - deleteIndex
1183
+ # - editSettings
1044
1184
  # @param source_id [String] The source UUID. (required)
1045
1185
  # @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)
1046
1186
  # @return [Http::Response] the response
@@ -1050,7 +1190,7 @@ module Algolia
1050
1190
  raise ArgumentError, "Parameter `source_id` is required when calling `get_source`."
1051
1191
  end
1052
1192
 
1053
- path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
1193
+ path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
1054
1194
  query_params = {}
1055
1195
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1056
1196
  header_params = {}
@@ -1069,8 +1209,12 @@ module Algolia
1069
1209
  @api_client.call_api(:GET, path, new_options)
1070
1210
  end
1071
1211
 
1072
- # Get a source.
1073
1212
  # Get the source of the given sourceID.
1213
+ #
1214
+ # Required API Key ACLs:
1215
+ # - addObject
1216
+ # - deleteIndex
1217
+ # - editSettings
1074
1218
  # @param source_id [String] The source UUID. (required)
1075
1219
  # @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)
1076
1220
  # @return [Source]
@@ -1079,8 +1223,12 @@ module Algolia
1079
1223
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Source')
1080
1224
  end
1081
1225
 
1082
- # Get a list of sources.
1083
1226
  # Get a list of sources for the given query parameters, with pagination details.
1227
+ #
1228
+ # Required API Key ACLs:
1229
+ # - addObject
1230
+ # - deleteIndex
1231
+ # - editSettings
1084
1232
  # @param items_per_page [Integer] The number of items per page to return.
1085
1233
  # @param page [Integer] The page number to fetch, starting at 1.
1086
1234
  # @param type [Array<SourceType>] The type of the sources to retrieve.
@@ -1115,8 +1263,12 @@ module Algolia
1115
1263
  @api_client.call_api(:GET, path, new_options)
1116
1264
  end
1117
1265
 
1118
- # Get a list of sources.
1119
1266
  # Get a list of sources for the given query parameters, with pagination details.
1267
+ #
1268
+ # Required API Key ACLs:
1269
+ # - addObject
1270
+ # - deleteIndex
1271
+ # - editSettings
1120
1272
  # @param items_per_page [Integer] The number of items per page to return.
1121
1273
  # @param page [Integer] The page number to fetch, starting at 1.
1122
1274
  # @param type [Array<SourceType>] The type of the sources to retrieve.
@@ -1130,8 +1282,12 @@ module Algolia
1130
1282
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListSourcesResponse')
1131
1283
  end
1132
1284
 
1133
- # Get a task.
1134
1285
  # Get the task of the given taskID.
1286
+ #
1287
+ # Required API Key ACLs:
1288
+ # - addObject
1289
+ # - deleteIndex
1290
+ # - editSettings
1135
1291
  # @param task_id [String] The task UUID. (required)
1136
1292
  # @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)
1137
1293
  # @return [Http::Response] the response
@@ -1141,7 +1297,7 @@ module Algolia
1141
1297
  raise ArgumentError, "Parameter `task_id` is required when calling `get_task`."
1142
1298
  end
1143
1299
 
1144
- path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
1300
+ path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
1145
1301
  query_params = {}
1146
1302
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1147
1303
  header_params = {}
@@ -1160,8 +1316,12 @@ module Algolia
1160
1316
  @api_client.call_api(:GET, path, new_options)
1161
1317
  end
1162
1318
 
1163
- # Get a task.
1164
1319
  # Get the task of the given taskID.
1320
+ #
1321
+ # Required API Key ACLs:
1322
+ # - addObject
1323
+ # - deleteIndex
1324
+ # - editSettings
1165
1325
  # @param task_id [String] The task UUID. (required)
1166
1326
  # @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)
1167
1327
  # @return [Task]
@@ -1170,8 +1330,12 @@ module Algolia
1170
1330
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Task')
1171
1331
  end
1172
1332
 
1173
- # Get a list of tasks.
1174
1333
  # Get a list of tasks for the given query parameters, with pagination details.
1334
+ #
1335
+ # Required API Key ACLs:
1336
+ # - addObject
1337
+ # - deleteIndex
1338
+ # - editSettings
1175
1339
  # @param items_per_page [Integer] The number of items per page to return.
1176
1340
  # @param page [Integer] The page number to fetch, starting at 1.
1177
1341
  # @param action [Array<ActionType>] The action of the tasks to retrieve.
@@ -1213,8 +1377,12 @@ module Algolia
1213
1377
  @api_client.call_api(:GET, path, new_options)
1214
1378
  end
1215
1379
 
1216
- # Get a list of tasks.
1217
1380
  # Get a list of tasks for the given query parameters, with pagination details.
1381
+ #
1382
+ # Required API Key ACLs:
1383
+ # - addObject
1384
+ # - deleteIndex
1385
+ # - editSettings
1218
1386
  # @param items_per_page [Integer] The number of items per page to return.
1219
1387
  # @param page [Integer] The page number to fetch, starting at 1.
1220
1388
  # @param action [Array<ActionType>] The action of the tasks to retrieve.
@@ -1232,8 +1400,12 @@ module Algolia
1232
1400
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListTasksResponse')
1233
1401
  end
1234
1402
 
1235
- # Run a task.
1236
1403
  # Run the task of the given taskID.
1404
+ #
1405
+ # Required API Key ACLs:
1406
+ # - addObject
1407
+ # - deleteIndex
1408
+ # - editSettings
1237
1409
  # @param task_id [String] The task UUID. (required)
1238
1410
  # @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
1411
  # @return [Http::Response] the response
@@ -1243,7 +1415,7 @@ module Algolia
1243
1415
  raise ArgumentError, "Parameter `task_id` is required when calling `run_task`."
1244
1416
  end
1245
1417
 
1246
- path = '/1/tasks/{taskID}/run'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
1418
+ path = '/1/tasks/{taskID}/run'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
1247
1419
  query_params = {}
1248
1420
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1249
1421
  header_params = {}
@@ -1262,8 +1434,12 @@ module Algolia
1262
1434
  @api_client.call_api(:POST, path, new_options)
1263
1435
  end
1264
1436
 
1265
- # Run a task.
1266
1437
  # Run the task of the given taskID.
1438
+ #
1439
+ # Required API Key ACLs:
1440
+ # - addObject
1441
+ # - deleteIndex
1442
+ # - editSettings
1267
1443
  # @param task_id [String] The task UUID. (required)
1268
1444
  # @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)
1269
1445
  # @return [RunResponse]
@@ -1272,8 +1448,12 @@ module Algolia
1272
1448
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::RunResponse')
1273
1449
  end
1274
1450
 
1275
- # Search among authentications.
1276
1451
  # Search among authentications with a defined set of parameters.
1452
+ #
1453
+ # Required API Key ACLs:
1454
+ # - addObject
1455
+ # - deleteIndex
1456
+ # - editSettings
1277
1457
  # @param authentication_search [AuthenticationSearch] (required)
1278
1458
  # @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
1459
  # @return [Http::Response] the response
@@ -1302,8 +1482,12 @@ module Algolia
1302
1482
  @api_client.call_api(:POST, path, new_options)
1303
1483
  end
1304
1484
 
1305
- # Search among authentications.
1306
1485
  # Search among authentications with a defined set of parameters.
1486
+ #
1487
+ # Required API Key ACLs:
1488
+ # - addObject
1489
+ # - deleteIndex
1490
+ # - editSettings
1307
1491
  # @param authentication_search [AuthenticationSearch] (required)
1308
1492
  # @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)
1309
1493
  # @return [Array<Authentication>]
@@ -1312,8 +1496,12 @@ module Algolia
1312
1496
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Authentication>')
1313
1497
  end
1314
1498
 
1315
- # Search among destinations.
1316
1499
  # Search among destinations with a defined set of parameters.
1500
+ #
1501
+ # Required API Key ACLs:
1502
+ # - addObject
1503
+ # - deleteIndex
1504
+ # - editSettings
1317
1505
  # @param destination_search [DestinationSearch] (required)
1318
1506
  # @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)
1319
1507
  # @return [Http::Response] the response
@@ -1342,8 +1530,12 @@ module Algolia
1342
1530
  @api_client.call_api(:POST, path, new_options)
1343
1531
  end
1344
1532
 
1345
- # Search among destinations.
1346
1533
  # Search among destinations with a defined set of parameters.
1534
+ #
1535
+ # Required API Key ACLs:
1536
+ # - addObject
1537
+ # - deleteIndex
1538
+ # - editSettings
1347
1539
  # @param destination_search [DestinationSearch] (required)
1348
1540
  # @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
1541
  # @return [Array<Destination>]
@@ -1352,8 +1544,12 @@ module Algolia
1352
1544
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Destination>')
1353
1545
  end
1354
1546
 
1355
- # Search among sources.
1356
1547
  # Search among sources with a defined set of parameters.
1548
+ #
1549
+ # Required API Key ACLs:
1550
+ # - addObject
1551
+ # - deleteIndex
1552
+ # - editSettings
1357
1553
  # @param source_search [SourceSearch] (required)
1358
1554
  # @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)
1359
1555
  # @return [Http::Response] the response
@@ -1382,8 +1578,12 @@ module Algolia
1382
1578
  @api_client.call_api(:POST, path, new_options)
1383
1579
  end
1384
1580
 
1385
- # Search among sources.
1386
1581
  # Search among sources with a defined set of parameters.
1582
+ #
1583
+ # Required API Key ACLs:
1584
+ # - addObject
1585
+ # - deleteIndex
1586
+ # - editSettings
1387
1587
  # @param source_search [SourceSearch] (required)
1388
1588
  # @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)
1389
1589
  # @return [Array<Source>]
@@ -1392,8 +1592,12 @@ module Algolia
1392
1592
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Source>')
1393
1593
  end
1394
1594
 
1395
- # Search among tasks.
1396
1595
  # Search among tasks with a defined set of parameters.
1596
+ #
1597
+ # Required API Key ACLs:
1598
+ # - addObject
1599
+ # - deleteIndex
1600
+ # - editSettings
1397
1601
  # @param task_search [TaskSearch] (required)
1398
1602
  # @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)
1399
1603
  # @return [Http::Response] the response
@@ -1422,8 +1626,12 @@ module Algolia
1422
1626
  @api_client.call_api(:POST, path, new_options)
1423
1627
  end
1424
1628
 
1425
- # Search among tasks.
1426
1629
  # Search among tasks with a defined set of parameters.
1630
+ #
1631
+ # Required API Key ACLs:
1632
+ # - addObject
1633
+ # - deleteIndex
1634
+ # - editSettings
1427
1635
  # @param task_search [TaskSearch] (required)
1428
1636
  # @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)
1429
1637
  # @return [Array<Task>]
@@ -1432,8 +1640,12 @@ module Algolia
1432
1640
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Task>')
1433
1641
  end
1434
1642
 
1435
- # Trigger a stream listing request.
1436
1643
  # Trigger a stream listing request for a Singer specification compatible docker type source.
1644
+ #
1645
+ # Required API Key ACLs:
1646
+ # - addObject
1647
+ # - deleteIndex
1648
+ # - editSettings
1437
1649
  # @param source_id [String] The source UUID. (required)
1438
1650
  # @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)
1439
1651
  # @return [Http::Response] the response
@@ -1443,7 +1655,7 @@ module Algolia
1443
1655
  raise ArgumentError, "Parameter `source_id` is required when calling `trigger_docker_source_discover`."
1444
1656
  end
1445
1657
 
1446
- path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
1658
+ path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
1447
1659
  query_params = {}
1448
1660
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1449
1661
  header_params = {}
@@ -1462,8 +1674,12 @@ module Algolia
1462
1674
  @api_client.call_api(:POST, path, new_options)
1463
1675
  end
1464
1676
 
1465
- # Trigger a stream listing request.
1466
1677
  # Trigger a stream listing request for a Singer specification compatible docker type source.
1678
+ #
1679
+ # Required API Key ACLs:
1680
+ # - addObject
1681
+ # - deleteIndex
1682
+ # - editSettings
1467
1683
  # @param source_id [String] The source UUID. (required)
1468
1684
  # @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)
1469
1685
  # @return [DockerSourceDiscover]
@@ -1472,8 +1688,12 @@ module Algolia
1472
1688
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceDiscover')
1473
1689
  end
1474
1690
 
1475
- # Update a authentication.
1476
1691
  # Update the authentication of the given authenticationID.
1692
+ #
1693
+ # Required API Key ACLs:
1694
+ # - addObject
1695
+ # - deleteIndex
1696
+ # - editSettings
1477
1697
  # @param authentication_id [String] The authentication UUID. (required)
1478
1698
  # @param authentication_update [AuthenticationUpdate] (required)
1479
1699
  # @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)
@@ -1488,7 +1708,7 @@ module Algolia
1488
1708
  raise ArgumentError, "Parameter `authentication_update` is required when calling `update_authentication`."
1489
1709
  end
1490
1710
 
1491
- path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', @api_client.encode_uri(authentication_id.to_s))
1711
+ path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', Transport.encode_uri(authentication_id.to_s))
1492
1712
  query_params = {}
1493
1713
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1494
1714
  header_params = {}
@@ -1507,8 +1727,12 @@ module Algolia
1507
1727
  @api_client.call_api(:PATCH, path, new_options)
1508
1728
  end
1509
1729
 
1510
- # Update a authentication.
1511
1730
  # Update the authentication of the given authenticationID.
1731
+ #
1732
+ # Required API Key ACLs:
1733
+ # - addObject
1734
+ # - deleteIndex
1735
+ # - editSettings
1512
1736
  # @param authentication_id [String] The authentication UUID. (required)
1513
1737
  # @param authentication_update [AuthenticationUpdate] (required)
1514
1738
  # @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)
@@ -1518,8 +1742,12 @@ module Algolia
1518
1742
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::AuthenticationUpdateResponse')
1519
1743
  end
1520
1744
 
1521
- # Update a destination.
1522
1745
  # Update the destination of the given destinationID.
1746
+ #
1747
+ # Required API Key ACLs:
1748
+ # - addObject
1749
+ # - deleteIndex
1750
+ # - editSettings
1523
1751
  # @param destination_id [String] The destination UUID. (required)
1524
1752
  # @param destination_update [DestinationUpdate] (required)
1525
1753
  # @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)
@@ -1534,7 +1762,7 @@ module Algolia
1534
1762
  raise ArgumentError, "Parameter `destination_update` is required when calling `update_destination`."
1535
1763
  end
1536
1764
 
1537
- path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', @api_client.encode_uri(destination_id.to_s))
1765
+ path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', Transport.encode_uri(destination_id.to_s))
1538
1766
  query_params = {}
1539
1767
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1540
1768
  header_params = {}
@@ -1553,8 +1781,12 @@ module Algolia
1553
1781
  @api_client.call_api(:PATCH, path, new_options)
1554
1782
  end
1555
1783
 
1556
- # Update a destination.
1557
1784
  # Update the destination of the given destinationID.
1785
+ #
1786
+ # Required API Key ACLs:
1787
+ # - addObject
1788
+ # - deleteIndex
1789
+ # - editSettings
1558
1790
  # @param destination_id [String] The destination UUID. (required)
1559
1791
  # @param destination_update [DestinationUpdate] (required)
1560
1792
  # @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)
@@ -1564,8 +1796,12 @@ module Algolia
1564
1796
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DestinationUpdateResponse')
1565
1797
  end
1566
1798
 
1567
- # Update a source.
1568
1799
  # Update the source of the given sourceID.
1800
+ #
1801
+ # Required API Key ACLs:
1802
+ # - addObject
1803
+ # - deleteIndex
1804
+ # - editSettings
1569
1805
  # @param source_id [String] The source UUID. (required)
1570
1806
  # @param source_update [SourceUpdate] (required)
1571
1807
  # @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)
@@ -1580,7 +1816,7 @@ module Algolia
1580
1816
  raise ArgumentError, "Parameter `source_update` is required when calling `update_source`."
1581
1817
  end
1582
1818
 
1583
- path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
1819
+ path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
1584
1820
  query_params = {}
1585
1821
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1586
1822
  header_params = {}
@@ -1599,8 +1835,12 @@ module Algolia
1599
1835
  @api_client.call_api(:PATCH, path, new_options)
1600
1836
  end
1601
1837
 
1602
- # Update a source.
1603
1838
  # Update the source of the given sourceID.
1839
+ #
1840
+ # Required API Key ACLs:
1841
+ # - addObject
1842
+ # - deleteIndex
1843
+ # - editSettings
1604
1844
  # @param source_id [String] The source UUID. (required)
1605
1845
  # @param source_update [SourceUpdate] (required)
1606
1846
  # @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)
@@ -1610,8 +1850,8 @@ module Algolia
1610
1850
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceUpdateResponse')
1611
1851
  end
1612
1852
 
1613
- # Update a task.
1614
1853
  # Update the task of the given taskID.
1854
+
1615
1855
  # @param task_id [String] The task UUID. (required)
1616
1856
  # @param task_update [TaskUpdate] (required)
1617
1857
  # @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)
@@ -1626,7 +1866,7 @@ module Algolia
1626
1866
  raise ArgumentError, "Parameter `task_update` is required when calling `update_task`."
1627
1867
  end
1628
1868
 
1629
- path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
1869
+ path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
1630
1870
  query_params = {}
1631
1871
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1632
1872
  header_params = {}
@@ -1645,8 +1885,8 @@ module Algolia
1645
1885
  @api_client.call_api(:PATCH, path, new_options)
1646
1886
  end
1647
1887
 
1648
- # Update a task.
1649
1888
  # Update the task of the given taskID.
1889
+
1650
1890
  # @param task_id [String] The task UUID. (required)
1651
1891
  # @param task_update [TaskUpdate] (required)
1652
1892
  # @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)