algolia 3.0.0.beta.4 → 3.0.0.beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/VERSION +1 -1
  3. data/CHANGELOG.md +11 -0
  4. data/Gemfile.lock +1 -1
  5. data/lib/algolia/api/ingestion_client.rb +424 -58
  6. data/lib/algolia/api/search_client.rb +100 -3
  7. data/lib/algolia/models/ingestion/authentication.rb +2 -2
  8. data/lib/algolia/models/ingestion/authentication_create_response.rb +1 -1
  9. data/lib/algolia/models/ingestion/authentication_update_response.rb +1 -1
  10. data/lib/algolia/models/ingestion/delete_response.rb +1 -1
  11. data/lib/algolia/models/ingestion/destination.rb +2 -2
  12. data/lib/algolia/models/ingestion/destination_create_response.rb +1 -1
  13. data/lib/algolia/models/ingestion/destination_update_response.rb +1 -1
  14. data/lib/algolia/models/ingestion/event.rb +1 -1
  15. data/lib/algolia/models/ingestion/list_transformations_response.rb +212 -0
  16. data/lib/algolia/models/ingestion/on_demand_date_utils_input.rb +2 -2
  17. data/lib/algolia/models/ingestion/on_demand_trigger.rb +1 -1
  18. data/lib/algolia/models/ingestion/run.rb +3 -3
  19. data/lib/algolia/models/ingestion/run_response.rb +1 -1
  20. data/lib/algolia/models/ingestion/schedule_trigger.rb +2 -2
  21. data/lib/algolia/models/ingestion/sort_keys.rb +35 -0
  22. data/lib/algolia/models/ingestion/source.rb +2 -2
  23. data/lib/algolia/models/ingestion/source_create_response.rb +1 -1
  24. data/lib/algolia/models/ingestion/source_update_response.rb +1 -1
  25. data/lib/algolia/models/ingestion/source_watch_response.rb +233 -0
  26. data/lib/algolia/models/ingestion/task.rb +13 -3
  27. data/lib/algolia/models/ingestion/task_create.rb +14 -4
  28. data/lib/algolia/models/ingestion/task_create_response.rb +1 -1
  29. data/lib/algolia/models/ingestion/task_update_response.rb +1 -1
  30. data/lib/algolia/models/ingestion/transformation.rb +257 -0
  31. data/lib/algolia/models/ingestion/transformation_create.rb +224 -0
  32. data/lib/algolia/models/ingestion/{docker_source_discover.rb → transformation_create_response.rb} +14 -13
  33. data/lib/algolia/models/ingestion/{docker_source_streams.rb → transformation_search.rb} +12 -12
  34. data/lib/algolia/models/ingestion/transformation_try.rb +211 -0
  35. data/lib/algolia/models/ingestion/transformation_try_response.rb +210 -0
  36. data/lib/algolia/models/ingestion/transformation_try_response_error.rb +208 -0
  37. data/lib/algolia/models/ingestion/transformation_update_response.rb +212 -0
  38. data/lib/algolia/models/ingestion/window.rb +2 -2
  39. data/lib/algolia/models/recommend/base_search_response.rb +2 -4
  40. data/lib/algolia/models/recommend/fallback_params.rb +3 -1
  41. data/lib/algolia/models/recommend/recommendations_results.rb +1 -1
  42. data/lib/algolia/models/recommend/search_params.rb +3 -1
  43. data/lib/algolia/models/recommend/search_params_object.rb +3 -1
  44. data/lib/algolia/models/recommend/trending_facets_query.rb +3 -1
  45. data/lib/algolia/models/search/base_index_settings.rb +2 -4
  46. data/lib/algolia/models/search/base_search_response.rb +2 -4
  47. data/lib/algolia/models/search/browse_params_object.rb +3 -1
  48. data/lib/algolia/models/search/browse_response.rb +1 -1
  49. data/lib/algolia/models/search/consequence_params.rb +3 -1
  50. data/lib/algolia/models/search/index_settings.rb +4 -2
  51. data/lib/algolia/models/search/search_for_facets.rb +3 -1
  52. data/lib/algolia/models/search/search_for_hits.rb +3 -1
  53. data/lib/algolia/models/search/search_params_object.rb +3 -1
  54. data/lib/algolia/models/search/search_response.rb +1 -1
  55. data/lib/algolia/models/search/secured_api_key_restrictions.rb +3 -3
  56. data/lib/algolia/version.rb +1 -1
  57. metadata +13 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d8a5616a1aa9d89d365371c04b20236bd153937bc86549a340c90f2f996c467b
4
- data.tar.gz: f07daa4f630934d9fee7a49d30ec1aaa48ad207799db4e754dad39b0fede65d2
3
+ metadata.gz: 7841f068eb004a49c57459769fc18f10f98714b3229b63f4223839e9d3e15ea6
4
+ data.tar.gz: 6f72cc44d5c858418ae7deed49ad2eaf86458fac3e08b2710e40207dd3f1b5ab
5
5
  SHA512:
6
- metadata.gz: 45af977700dd17bca72b31970899b2e790a6b51c599177fa254babced3e460ee0d67ca4e7cc6b6f1486a7856b0a275527fe30e44aaf3221c421f4a4b0042cd59
7
- data.tar.gz: e8e4fc306aea4b38a5b842061530e4c305900d1b64ba54f701e7f32cdd019a9187076520c640010a1bcf04c79b323ff6e122488e0244c3a63a2b92bd885c6c5f
6
+ metadata.gz: 91fe14b759af3f8d02e351294d97e447b98c71489820e819f9665fb25ce1d7a640c046ea4657fcc87435c5ed9f9c8688277774b5a6c5ace91804912b5a0d8d2d
7
+ data.tar.gz: fa78f348f10ae77b918a52b14768bfd52dedc504710fed6133908015724f27904739552e54403d571f3123f19b8f73722d094eea5e1fe48fd80af615e4931c4f
@@ -1 +1 @@
1
- 7.4.0
1
+ 7.6.0
data/CHANGELOG.md CHANGED
@@ -1,3 +1,14 @@
1
+ ## [3.0.0.beta.5](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.4...3.0.0.beta.5)
2
+
3
+ - [b7ae19f2b](https://github.com/algolia/api-clients-automation/commit/b7ae19f2b) feat(specs): add transformations endpoints to ingestion ([#3215](https://github.com/algolia/api-clients-automation/pull/3215)) by [@shortcuts](https://github.com/shortcuts/)
4
+ - [a99f796dd](https://github.com/algolia/api-clients-automation/commit/a99f796dd) fix(specs): update discover endpoint ([#3212](https://github.com/algolia/api-clients-automation/pull/3212)) by [@shortcuts](https://github.com/shortcuts/)
5
+ - [c91ca54f2](https://github.com/algolia/api-clients-automation/commit/c91ca54f2) feat(specs): add validate endpoint ([#3087](https://github.com/algolia/api-clients-automation/pull/3087)) by [@Fluf22](https://github.com/Fluf22/)
6
+ - [36aababfd](https://github.com/algolia/api-clients-automation/commit/36aababfd) chore(clients): use the ruff python formatter ([#3204](https://github.com/algolia/api-clients-automation/pull/3204)) by [@millotp](https://github.com/millotp/)
7
+ - [9ad5c8cae](https://github.com/algolia/api-clients-automation/commit/9ad5c8cae) fix(clients): reduce common tests flakyness ([#3205](https://github.com/algolia/api-clients-automation/pull/3205)) by [@millotp](https://github.com/millotp/)
8
+ - [3b4be7a3d](https://github.com/algolia/api-clients-automation/commit/3b4be7a3d) feat(ruby): add chunked_batch and replace_all_objects helpers ([#3208](https://github.com/algolia/api-clients-automation/pull/3208)) by [@millotp](https://github.com/millotp/)
9
+ - [fc1752b6e](https://github.com/algolia/api-clients-automation/commit/fc1752b6e) feat(clients): add chunkedBatch helper for Kotlin and Scala ([#3206](https://github.com/algolia/api-clients-automation/pull/3206)) by [@Fluf22](https://github.com/Fluf22/)
10
+ - [a58e88322](https://github.com/algolia/api-clients-automation/commit/a58e88322) feat(clients): add generateSecuredApiKey to java ([#3167](https://github.com/algolia/api-clients-automation/pull/3167)) by [@millotp](https://github.com/millotp/)
11
+
1
12
  ## [3.0.0.beta.4](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.3...3.0.0.beta.4)
2
13
 
3
14
  - [b2a464a2b](https://github.com/algolia/api-clients-automation/commit/b2a464a2b) feat(clients): add generate_secured_api_key to ruby ([#3166](https://github.com/algolia/api-clients-automation/pull/3166)) by [@millotp](https://github.com/millotp/)
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- algolia (3.0.0.beta.4)
4
+ algolia (3.0.0.beta.5)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-net_http_persistent (>= 0.15, < 3)
7
7
  net-http-persistent
@@ -217,6 +217,46 @@ module Algolia
217
217
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskCreateResponse')
218
218
  end
219
219
 
220
+ # Creates a new transformation.
221
+
222
+ # @param transformation_create [TransformationCreate] Request body for creating a transformation. (required)
223
+ # @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)
224
+ # @return [Http::Response] the response
225
+ def create_transformation_with_http_info(transformation_create, request_options = {})
226
+ # verify the required parameter 'transformation_create' is set
227
+ if @api_client.config.client_side_validation && transformation_create.nil?
228
+ raise ArgumentError, "Parameter `transformation_create` is required when calling `create_transformation`."
229
+ end
230
+
231
+ path = '/1/transformations'
232
+ query_params = {}
233
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
234
+ header_params = {}
235
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
236
+
237
+ post_body = request_options[:debug_body] || @api_client.object_to_http_body(transformation_create)
238
+
239
+ new_options = request_options.merge(
240
+ :operation => :'IngestionClient.create_transformation',
241
+ :header_params => header_params,
242
+ :query_params => query_params,
243
+ :body => post_body,
244
+ :use_read_transporter => false
245
+ )
246
+
247
+ @api_client.call_api(:POST, path, new_options)
248
+ end
249
+
250
+ # Creates a new transformation.
251
+
252
+ # @param transformation_create [TransformationCreate] Request body for creating a transformation. (required)
253
+ # @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)
254
+ # @return [TransformationCreateResponse]
255
+ def create_transformation(transformation_create, request_options = {})
256
+ response = create_transformation_with_http_info(transformation_create, request_options)
257
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TransformationCreateResponse')
258
+ end
259
+
220
260
  # This method allow you to send requests to the Algolia REST API.
221
261
 
222
262
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
@@ -577,6 +617,46 @@ module Algolia
577
617
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
578
618
  end
579
619
 
620
+ # Deletes a transformation by its ID.
621
+
622
+ # @param transformation_id [String] Unique identifier of a transformation. (required)
623
+ # @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)
624
+ # @return [Http::Response] the response
625
+ def delete_transformation_with_http_info(transformation_id, request_options = {})
626
+ # verify the required parameter 'transformation_id' is set
627
+ if @api_client.config.client_side_validation && transformation_id.nil?
628
+ raise ArgumentError, "Parameter `transformation_id` is required when calling `delete_transformation`."
629
+ end
630
+
631
+ path = '/1/transformations/{transformationID}'.sub('{' + 'transformationID' + '}', Transport.encode_uri(transformation_id.to_s))
632
+ query_params = {}
633
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
634
+ header_params = {}
635
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
636
+
637
+ post_body = request_options[:debug_body]
638
+
639
+ new_options = request_options.merge(
640
+ :operation => :'IngestionClient.delete_transformation',
641
+ :header_params => header_params,
642
+ :query_params => query_params,
643
+ :body => post_body,
644
+ :use_read_transporter => false
645
+ )
646
+
647
+ @api_client.call_api(:DELETE, path, new_options)
648
+ end
649
+
650
+ # Deletes a transformation by its ID.
651
+
652
+ # @param transformation_id [String] Unique identifier of a transformation. (required)
653
+ # @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)
654
+ # @return [DeleteResponse]
655
+ def delete_transformation(transformation_id, request_options = {})
656
+ response = delete_transformation_with_http_info(transformation_id, request_options)
657
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
658
+ end
659
+
580
660
  # Disables a task.
581
661
  #
582
662
  # Required API Key ACLs:
@@ -911,54 +991,6 @@ module Algolia
911
991
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListDestinationsResponse')
912
992
  end
913
993
 
914
- # Retrieves a stream listing for a source. Listing streams only works with sources with &#x60;type: docker&#x60; and &#x60;imageType: singer&#x60;.
915
- #
916
- # Required API Key ACLs:
917
- # - addObject
918
- # - deleteIndex
919
- # - editSettings
920
- # @param source_id [String] Unique identifier of a source. (required)
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)
922
- # @return [Http::Response] the response
923
- def get_docker_source_streams_with_http_info(source_id, request_options = {})
924
- # verify the required parameter 'source_id' is set
925
- if @api_client.config.client_side_validation && source_id.nil?
926
- raise ArgumentError, "Parameter `source_id` is required when calling `get_docker_source_streams`."
927
- end
928
-
929
- path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
930
- query_params = {}
931
- query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
932
- header_params = {}
933
- header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
934
-
935
- post_body = request_options[:debug_body]
936
-
937
- new_options = request_options.merge(
938
- :operation => :'IngestionClient.get_docker_source_streams',
939
- :header_params => header_params,
940
- :query_params => query_params,
941
- :body => post_body,
942
- :use_read_transporter => false
943
- )
944
-
945
- @api_client.call_api(:GET, path, new_options)
946
- end
947
-
948
- # Retrieves a stream listing for a source. Listing streams only works with sources with `type: docker` and `imageType: singer`.
949
- #
950
- # Required API Key ACLs:
951
- # - addObject
952
- # - deleteIndex
953
- # - editSettings
954
- # @param source_id [String] Unique identifier of a source. (required)
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)
956
- # @return [DockerSourceStreams]
957
- def get_docker_source_streams(source_id, request_options = {})
958
- response = get_docker_source_streams_with_http_info(source_id, request_options)
959
- @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceStreams')
960
- end
961
-
962
994
  # Retrieves a single task run event by its ID.
963
995
  #
964
996
  # Required API Key ACLs:
@@ -1026,8 +1058,8 @@ module Algolia
1026
1058
  # @param type [Array<EventType>] Event type for filtering the list of task runs.
1027
1059
  # @param sort [EventSortKeys] Property by which to sort the list of task run events.
1028
1060
  # @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.
1061
+ # @param start_date [String] Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
1062
+ # @param end_date [String] Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
1031
1063
  # @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)
1032
1064
  # @return [Http::Response] the response
1033
1065
  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,
@@ -1088,8 +1120,8 @@ module Algolia
1088
1120
  # @param type [Array<EventType>] Event type for filtering the list of task runs.
1089
1121
  # @param sort [EventSortKeys] Property by which to sort the list of task run events.
1090
1122
  # @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.
1123
+ # @param start_date [String] Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
1124
+ # @param end_date [String] Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
1093
1125
  # @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)
1094
1126
  # @return [ListEventsResponse]
1095
1127
  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 = {})
@@ -1157,8 +1189,8 @@ module Algolia
1157
1189
  # @param task_id [String] Task ID for filtering the list of task runs.
1158
1190
  # @param sort [RunSortKeys] Property by which to sort the list of task runs. (default to 'createdAt')
1159
1191
  # @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.
1192
+ # @param start_date [String] Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
1193
+ # @param end_date [String] Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
1162
1194
  # @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)
1163
1195
  # @return [Http::Response] the response
1164
1196
  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 = {})
@@ -1213,8 +1245,8 @@ module Algolia
1213
1245
  # @param task_id [String] Task ID for filtering the list of task runs.
1214
1246
  # @param sort [RunSortKeys] Property by which to sort the list of task runs. (default to 'createdAt')
1215
1247
  # @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.
1248
+ # @param start_date [String] Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
1249
+ # @param end_date [String] Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
1218
1250
  # @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)
1219
1251
  # @return [RunListResponse]
1220
1252
  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 = {})
@@ -1471,6 +1503,101 @@ module Algolia
1471
1503
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListTasksResponse')
1472
1504
  end
1473
1505
 
1506
+ # Retrieves a transformation by its ID.
1507
+ #
1508
+ # Required API Key ACLs:
1509
+ # - addObject
1510
+ # - deleteIndex
1511
+ # - editSettings
1512
+ # @param transformation_id [String] Unique identifier of a transformation. (required)
1513
+ # @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)
1514
+ # @return [Http::Response] the response
1515
+ def get_transformation_with_http_info(transformation_id, request_options = {})
1516
+ # verify the required parameter 'transformation_id' is set
1517
+ if @api_client.config.client_side_validation && transformation_id.nil?
1518
+ raise ArgumentError, "Parameter `transformation_id` is required when calling `get_transformation`."
1519
+ end
1520
+
1521
+ path = '/1/transformations/{transformationID}'.sub('{' + 'transformationID' + '}', Transport.encode_uri(transformation_id.to_s))
1522
+ query_params = {}
1523
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1524
+ header_params = {}
1525
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
1526
+
1527
+ post_body = request_options[:debug_body]
1528
+
1529
+ new_options = request_options.merge(
1530
+ :operation => :'IngestionClient.get_transformation',
1531
+ :header_params => header_params,
1532
+ :query_params => query_params,
1533
+ :body => post_body,
1534
+ :use_read_transporter => false
1535
+ )
1536
+
1537
+ @api_client.call_api(:GET, path, new_options)
1538
+ end
1539
+
1540
+ # Retrieves a transformation by its ID.
1541
+ #
1542
+ # Required API Key ACLs:
1543
+ # - addObject
1544
+ # - deleteIndex
1545
+ # - editSettings
1546
+ # @param transformation_id [String] Unique identifier of a transformation. (required)
1547
+ # @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)
1548
+ # @return [Transformation]
1549
+ def get_transformation(transformation_id, request_options = {})
1550
+ response = get_transformation_with_http_info(transformation_id, request_options)
1551
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Transformation')
1552
+ end
1553
+
1554
+ # Retrieves a list of transformations.
1555
+ #
1556
+ # Required API Key ACLs:
1557
+ # - addObject
1558
+ # - deleteIndex
1559
+ # - editSettings
1560
+ # @param sort [SortKeys] Property by which to sort the list. (default to 'desc')
1561
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1562
+ # @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)
1563
+ # @return [Http::Response] the response
1564
+ def get_transformations_with_http_info(sort = nil, order = nil, request_options = {})
1565
+ path = '/1/transformations'
1566
+ query_params = {}
1567
+ query_params[:sort] = sort unless sort.nil?
1568
+ query_params[:order] = order unless order.nil?
1569
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1570
+ header_params = {}
1571
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
1572
+
1573
+ post_body = request_options[:debug_body]
1574
+
1575
+ new_options = request_options.merge(
1576
+ :operation => :'IngestionClient.get_transformations',
1577
+ :header_params => header_params,
1578
+ :query_params => query_params,
1579
+ :body => post_body,
1580
+ :use_read_transporter => false
1581
+ )
1582
+
1583
+ @api_client.call_api(:GET, path, new_options)
1584
+ end
1585
+
1586
+ # Retrieves a list of transformations.
1587
+ #
1588
+ # Required API Key ACLs:
1589
+ # - addObject
1590
+ # - deleteIndex
1591
+ # - editSettings
1592
+ # @param sort [SortKeys] Property by which to sort the list. (default to 'desc')
1593
+ # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
1594
+ # @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)
1595
+ # @return [ListTransformationsResponse]
1596
+ def get_transformations(sort = nil, order = nil, request_options = {})
1597
+ response = get_transformations_with_http_info(sort, order, request_options)
1598
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListTransformationsResponse')
1599
+ end
1600
+
1474
1601
  # Runs a task. You can check the status of task runs with the observability endpoints.
1475
1602
  #
1476
1603
  # Required API Key ACLs:
@@ -1711,6 +1838,54 @@ module Algolia
1711
1838
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Task>')
1712
1839
  end
1713
1840
 
1841
+ # Searches for transformations.
1842
+ #
1843
+ # Required API Key ACLs:
1844
+ # - addObject
1845
+ # - deleteIndex
1846
+ # - editSettings
1847
+ # @param transformation_search [TransformationSearch] (required)
1848
+ # @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)
1849
+ # @return [Http::Response] the response
1850
+ def search_transformations_with_http_info(transformation_search, request_options = {})
1851
+ # verify the required parameter 'transformation_search' is set
1852
+ if @api_client.config.client_side_validation && transformation_search.nil?
1853
+ raise ArgumentError, "Parameter `transformation_search` is required when calling `search_transformations`."
1854
+ end
1855
+
1856
+ path = '/1/transformations/search'
1857
+ query_params = {}
1858
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1859
+ header_params = {}
1860
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
1861
+
1862
+ post_body = request_options[:debug_body] || @api_client.object_to_http_body(transformation_search)
1863
+
1864
+ new_options = request_options.merge(
1865
+ :operation => :'IngestionClient.search_transformations',
1866
+ :header_params => header_params,
1867
+ :query_params => query_params,
1868
+ :body => post_body,
1869
+ :use_read_transporter => false
1870
+ )
1871
+
1872
+ @api_client.call_api(:POST, path, new_options)
1873
+ end
1874
+
1875
+ # Searches for transformations.
1876
+ #
1877
+ # Required API Key ACLs:
1878
+ # - addObject
1879
+ # - deleteIndex
1880
+ # - editSettings
1881
+ # @param transformation_search [TransformationSearch] (required)
1882
+ # @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)
1883
+ # @return [Array<Transformation>]
1884
+ def search_transformations(transformation_search, request_options = {})
1885
+ response = search_transformations_with_http_info(transformation_search, request_options)
1886
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Transformation>')
1887
+ end
1888
+
1714
1889
  # 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;.
1715
1890
  #
1716
1891
  # Required API Key ACLs:
@@ -1753,10 +1928,58 @@ module Algolia
1753
1928
  # - editSettings
1754
1929
  # @param source_id [String] Unique identifier of a source. (required)
1755
1930
  # @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)
1756
- # @return [DockerSourceDiscover]
1931
+ # @return [SourceWatchResponse]
1757
1932
  def trigger_docker_source_discover(source_id, request_options = {})
1758
1933
  response = trigger_docker_source_discover_with_http_info(source_id, request_options)
1759
- @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceDiscover')
1934
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceWatchResponse')
1935
+ end
1936
+
1937
+ # Searches for transformations.
1938
+ #
1939
+ # Required API Key ACLs:
1940
+ # - addObject
1941
+ # - deleteIndex
1942
+ # - editSettings
1943
+ # @param transformation_try [TransformationTry] (required)
1944
+ # @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)
1945
+ # @return [Http::Response] the response
1946
+ def try_transformations_with_http_info(transformation_try, request_options = {})
1947
+ # verify the required parameter 'transformation_try' is set
1948
+ if @api_client.config.client_side_validation && transformation_try.nil?
1949
+ raise ArgumentError, "Parameter `transformation_try` is required when calling `try_transformations`."
1950
+ end
1951
+
1952
+ path = '/1/transformations/try'
1953
+ query_params = {}
1954
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
1955
+ header_params = {}
1956
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
1957
+
1958
+ post_body = request_options[:debug_body] || @api_client.object_to_http_body(transformation_try)
1959
+
1960
+ new_options = request_options.merge(
1961
+ :operation => :'IngestionClient.try_transformations',
1962
+ :header_params => header_params,
1963
+ :query_params => query_params,
1964
+ :body => post_body,
1965
+ :use_read_transporter => false
1966
+ )
1967
+
1968
+ @api_client.call_api(:POST, path, new_options)
1969
+ end
1970
+
1971
+ # Searches for transformations.
1972
+ #
1973
+ # Required API Key ACLs:
1974
+ # - addObject
1975
+ # - deleteIndex
1976
+ # - editSettings
1977
+ # @param transformation_try [TransformationTry] (required)
1978
+ # @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)
1979
+ # @return [TransformationTryResponse]
1980
+ def try_transformations(transformation_try, request_options = {})
1981
+ response = try_transformations_with_http_info(transformation_try, request_options)
1982
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TransformationTryResponse')
1760
1983
  end
1761
1984
 
1762
1985
  # Updates an authentication resource.
@@ -1966,5 +2189,148 @@ module Algolia
1966
2189
  response = update_task_with_http_info(task_id, task_update, request_options)
1967
2190
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
1968
2191
  end
2192
+
2193
+ # Updates a transformation by its ID.
2194
+
2195
+ # @param transformation_id [String] Unique identifier of a transformation. (required)
2196
+ # @param transformation_create [TransformationCreate] (required)
2197
+ # @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)
2198
+ # @return [Http::Response] the response
2199
+ def update_transformation_with_http_info(transformation_id, transformation_create, request_options = {})
2200
+ # verify the required parameter 'transformation_id' is set
2201
+ if @api_client.config.client_side_validation && transformation_id.nil?
2202
+ raise ArgumentError, "Parameter `transformation_id` is required when calling `update_transformation`."
2203
+ end
2204
+ # verify the required parameter 'transformation_create' is set
2205
+ if @api_client.config.client_side_validation && transformation_create.nil?
2206
+ raise ArgumentError, "Parameter `transformation_create` is required when calling `update_transformation`."
2207
+ end
2208
+
2209
+ path = '/1/transformations/{transformationID}'.sub('{' + 'transformationID' + '}', Transport.encode_uri(transformation_id.to_s))
2210
+ query_params = {}
2211
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
2212
+ header_params = {}
2213
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
2214
+
2215
+ post_body = request_options[:debug_body] || @api_client.object_to_http_body(transformation_create)
2216
+
2217
+ new_options = request_options.merge(
2218
+ :operation => :'IngestionClient.update_transformation',
2219
+ :header_params => header_params,
2220
+ :query_params => query_params,
2221
+ :body => post_body,
2222
+ :use_read_transporter => false
2223
+ )
2224
+
2225
+ @api_client.call_api(:PUT, path, new_options)
2226
+ end
2227
+
2228
+ # Updates a transformation by its ID.
2229
+
2230
+ # @param transformation_id [String] Unique identifier of a transformation. (required)
2231
+ # @param transformation_create [TransformationCreate] (required)
2232
+ # @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)
2233
+ # @return [TransformationUpdateResponse]
2234
+ def update_transformation(transformation_id, transformation_create, request_options = {})
2235
+ response = update_transformation_with_http_info(transformation_id, transformation_create, request_options)
2236
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TransformationUpdateResponse')
2237
+ end
2238
+
2239
+ # Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
2240
+ #
2241
+ # Required API Key ACLs:
2242
+ # - addObject
2243
+ # - deleteIndex
2244
+ # - editSettings
2245
+ # @param source_create [SourceCreate]
2246
+ # @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)
2247
+ # @return [Http::Response] the response
2248
+ def validate_source_with_http_info(source_create = nil, request_options = {})
2249
+ path = '/1/sources/validate'
2250
+ query_params = {}
2251
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
2252
+ header_params = {}
2253
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
2254
+
2255
+ post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_create)
2256
+
2257
+ new_options = request_options.merge(
2258
+ :operation => :'IngestionClient.validate_source',
2259
+ :header_params => header_params,
2260
+ :query_params => query_params,
2261
+ :body => post_body,
2262
+ :use_read_transporter => false
2263
+ )
2264
+
2265
+ @api_client.call_api(:POST, path, new_options)
2266
+ end
2267
+
2268
+ # Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
2269
+ #
2270
+ # Required API Key ACLs:
2271
+ # - addObject
2272
+ # - deleteIndex
2273
+ # - editSettings
2274
+ # @param source_create [SourceCreate]
2275
+ # @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)
2276
+ # @return [SourceWatchResponse]
2277
+ def validate_source(source_create = nil, request_options = {})
2278
+ response = validate_source_with_http_info(source_create, request_options)
2279
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceWatchResponse')
2280
+ end
2281
+
2282
+ # Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
2283
+ #
2284
+ # Required API Key ACLs:
2285
+ # - addObject
2286
+ # - deleteIndex
2287
+ # - editSettings
2288
+ # @param source_id [String] Unique identifier of a source. (required)
2289
+ # @param source_update [SourceUpdate] (required)
2290
+ # @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)
2291
+ # @return [Http::Response] the response
2292
+ def validate_source_before_update_with_http_info(source_id, source_update, request_options = {})
2293
+ # verify the required parameter 'source_id' is set
2294
+ if @api_client.config.client_side_validation && source_id.nil?
2295
+ raise ArgumentError, "Parameter `source_id` is required when calling `validate_source_before_update`."
2296
+ end
2297
+ # verify the required parameter 'source_update' is set
2298
+ if @api_client.config.client_side_validation && source_update.nil?
2299
+ raise ArgumentError, "Parameter `source_update` is required when calling `validate_source_before_update`."
2300
+ end
2301
+
2302
+ path = '/1/sources/{sourceID}/validate'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
2303
+ query_params = {}
2304
+ query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
2305
+ header_params = {}
2306
+ header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
2307
+
2308
+ post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_update)
2309
+
2310
+ new_options = request_options.merge(
2311
+ :operation => :'IngestionClient.validate_source_before_update',
2312
+ :header_params => header_params,
2313
+ :query_params => query_params,
2314
+ :body => post_body,
2315
+ :use_read_transporter => false
2316
+ )
2317
+
2318
+ @api_client.call_api(:POST, path, new_options)
2319
+ end
2320
+
2321
+ # Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
2322
+ #
2323
+ # Required API Key ACLs:
2324
+ # - addObject
2325
+ # - deleteIndex
2326
+ # - editSettings
2327
+ # @param source_id [String] Unique identifier of a source. (required)
2328
+ # @param source_update [SourceUpdate] (required)
2329
+ # @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)
2330
+ # @return [SourceWatchResponse]
2331
+ def validate_source_before_update(source_id, source_update, request_options = {})
2332
+ response = validate_source_before_update_with_http_info(source_id, source_update, request_options)
2333
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceWatchResponse')
2334
+ end
1969
2335
  end
1970
2336
  end