algolia 2.3.3 → 3.0.0.alpha.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +21 -89
- data/Gemfile +1 -14
- data/Gemfile.lock +64 -0
- data/README.md +4 -6
- data/Rakefile +0 -39
- data/algolia.gemspec +24 -39
- data/lib/algolia/api/abtesting_client.rb +418 -0
- data/lib/algolia/api/analytics_client.rb +1294 -0
- data/lib/algolia/api/ingestion_client.rb +1659 -0
- data/lib/algolia/api/insights_client.rb +252 -0
- data/lib/algolia/api/monitoring_client.rb +555 -0
- data/lib/algolia/api/personalization_client.rb +365 -0
- data/lib/algolia/api/query_suggestions_client.rb +491 -0
- data/lib/algolia/api/recommend_client.rb +460 -0
- data/lib/algolia/api/search_client.rb +2723 -0
- data/lib/algolia/api_client.rb +153 -0
- data/lib/algolia/api_error.rb +48 -0
- data/lib/algolia/configuration.rb +41 -0
- data/lib/algolia/logger_helper.rb +1 -1
- data/lib/algolia/models/abtesting/ab_test.rb +332 -0
- data/lib/algolia/models/abtesting/ab_test_response.rb +219 -0
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +217 -0
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +236 -0
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +239 -0
- data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +96 -0
- data/lib/algolia/models/abtesting/currencies_value.rb +223 -0
- data/lib/algolia/models/abtesting/custom_search_params.rb +195 -0
- data/lib/algolia/models/abtesting/error_base.rb +196 -0
- data/lib/algolia/models/abtesting/filter_effects.rb +202 -0
- data/lib/algolia/models/abtesting/filter_effects_empty_search.rb +204 -0
- data/lib/algolia/models/abtesting/filter_effects_outliers.rb +204 -0
- data/lib/algolia/models/abtesting/list_ab_tests_response.rb +221 -0
- data/lib/algolia/models/abtesting/variant.rb +399 -0
- data/lib/algolia/models/analytics/average_click_event.rb +219 -0
- data/lib/algolia/models/analytics/click_position.rb +209 -0
- data/lib/algolia/models/analytics/click_through_rate_event.rb +249 -0
- data/lib/algolia/models/analytics/conversion_rate_event.rb +249 -0
- data/lib/algolia/models/analytics/direction.rb +33 -0
- data/lib/algolia/models/analytics/error_base.rb +196 -0
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +221 -0
- data/lib/algolia/models/analytics/get_click_positions_response.rb +215 -0
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +251 -0
- data/lib/algolia/models/analytics/get_conversation_rate_response.rb +251 -0
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +251 -0
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +251 -0
- data/lib/algolia/models/analytics/get_searches_count_response.rb +209 -0
- data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +197 -0
- data/lib/algolia/models/analytics/get_searches_no_results_response.rb +197 -0
- data/lib/algolia/models/analytics/get_status_response.rb +195 -0
- data/lib/algolia/models/analytics/get_top_countries_response.rb +197 -0
- data/lib/algolia/models/analytics/get_top_filter_attribute.rb +207 -0
- data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +197 -0
- data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +231 -0
- data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +197 -0
- data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +197 -0
- data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +219 -0
- data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +209 -0
- data/lib/algolia/models/analytics/get_top_hits_response.rb +96 -0
- data/lib/algolia/models/analytics/get_top_searches_response.rb +96 -0
- data/lib/algolia/models/analytics/get_users_count_response.rb +209 -0
- data/lib/algolia/models/analytics/no_click_rate_event.rb +249 -0
- data/lib/algolia/models/analytics/no_results_rate_event.rb +249 -0
- data/lib/algolia/models/analytics/order_by.rb +35 -0
- data/lib/algolia/models/analytics/search_event.rb +207 -0
- data/lib/algolia/models/analytics/search_no_click_event.rb +219 -0
- data/lib/algolia/models/analytics/search_no_result_event.rb +219 -0
- data/lib/algolia/models/analytics/top_country.rb +207 -0
- data/lib/algolia/models/analytics/top_hit.rb +207 -0
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +285 -0
- data/lib/algolia/models/analytics/top_hits_response.rb +197 -0
- data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +197 -0
- data/lib/algolia/models/analytics/top_search.rb +219 -0
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +309 -0
- data/lib/algolia/models/analytics/top_searches_response.rb +197 -0
- data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +197 -0
- data/lib/algolia/models/analytics/user_with_date.rb +207 -0
- data/lib/algolia/models/ingestion/action_type.rb +34 -0
- data/lib/algolia/models/ingestion/auth_algolia.rb +207 -0
- data/lib/algolia/models/ingestion/auth_algolia_partial.rb +203 -0
- data/lib/algolia/models/ingestion/auth_api_key.rb +195 -0
- data/lib/algolia/models/ingestion/auth_api_key_partial.rb +193 -0
- data/lib/algolia/models/ingestion/auth_basic.rb +206 -0
- data/lib/algolia/models/ingestion/auth_basic_partial.rb +202 -0
- data/lib/algolia/models/ingestion/auth_google_service_account.rb +208 -0
- data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +204 -0
- data/lib/algolia/models/ingestion/auth_input.rb +99 -0
- data/lib/algolia/models/ingestion/auth_input_partial.rb +99 -0
- data/lib/algolia/models/ingestion/auth_o_auth.rb +220 -0
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +214 -0
- data/lib/algolia/models/ingestion/authentication.rb +283 -0
- data/lib/algolia/models/ingestion/authentication_create.rb +249 -0
- data/lib/algolia/models/ingestion/authentication_create_response.rb +220 -0
- data/lib/algolia/models/ingestion/authentication_search.rb +197 -0
- data/lib/algolia/models/ingestion/authentication_sort_keys.rb +36 -0
- data/lib/algolia/models/ingestion/authentication_type.rb +36 -0
- data/lib/algolia/models/ingestion/authentication_update.rb +243 -0
- data/lib/algolia/models/ingestion/authentication_update_response.rb +220 -0
- data/lib/algolia/models/ingestion/big_commerce_channel.rb +207 -0
- data/lib/algolia/models/ingestion/big_commerce_metafield.rb +207 -0
- data/lib/algolia/models/ingestion/big_query_data_type.rb +33 -0
- data/lib/algolia/models/ingestion/delete_response.rb +195 -0
- data/lib/algolia/models/ingestion/destination.rb +283 -0
- data/lib/algolia/models/ingestion/destination_create.rb +250 -0
- data/lib/algolia/models/ingestion/destination_create_response.rb +220 -0
- data/lib/algolia/models/ingestion/destination_index_name.rb +238 -0
- data/lib/algolia/models/ingestion/destination_index_prefix.rb +195 -0
- data/lib/algolia/models/ingestion/destination_input.rb +96 -0
- data/lib/algolia/models/ingestion/destination_search.rb +197 -0
- data/lib/algolia/models/ingestion/destination_sort_keys.rb +35 -0
- data/lib/algolia/models/ingestion/destination_type.rb +34 -0
- data/lib/algolia/models/ingestion/destination_update.rb +243 -0
- data/lib/algolia/models/ingestion/destination_update_response.rb +220 -0
- data/lib/algolia/models/ingestion/docker_image_type.rb +34 -0
- data/lib/algolia/models/ingestion/docker_registry.rb +33 -0
- data/lib/algolia/models/ingestion/docker_source_discover.rb +207 -0
- data/lib/algolia/models/ingestion/docker_source_streams.rb +196 -0
- data/lib/algolia/models/ingestion/error_base.rb +196 -0
- data/lib/algolia/models/ingestion/event.rb +311 -0
- data/lib/algolia/models/ingestion/event_sort_keys.rb +34 -0
- data/lib/algolia/models/ingestion/event_status.rb +37 -0
- data/lib/algolia/models/ingestion/event_type.rb +35 -0
- data/lib/algolia/models/ingestion/list_authentications_response.rb +207 -0
- data/lib/algolia/models/ingestion/list_destinations_response.rb +207 -0
- data/lib/algolia/models/ingestion/list_events_response.rb +218 -0
- data/lib/algolia/models/ingestion/list_sources_response.rb +207 -0
- data/lib/algolia/models/ingestion/list_tasks_response.rb +208 -0
- data/lib/algolia/models/ingestion/mapping_type_csv.rb +36 -0
- data/lib/algolia/models/ingestion/method_type.rb +33 -0
- data/lib/algolia/models/ingestion/on_demand_date_utils_input.rb +208 -0
- data/lib/algolia/models/ingestion/on_demand_trigger.rb +227 -0
- data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +217 -0
- data/lib/algolia/models/ingestion/on_demand_trigger_type.rb +32 -0
- data/lib/algolia/models/ingestion/order_keys.rb +33 -0
- data/lib/algolia/models/ingestion/pagination.rb +227 -0
- data/lib/algolia/models/ingestion/platform.rb +33 -0
- data/lib/algolia/models/ingestion/platform_none.rb +32 -0
- data/lib/algolia/models/ingestion/platform_with_none.rb +96 -0
- data/lib/algolia/models/ingestion/record_type.rb +33 -0
- data/lib/algolia/models/ingestion/run.rb +359 -0
- data/lib/algolia/models/ingestion/run_list_response.rb +218 -0
- data/lib/algolia/models/ingestion/run_outcome.rb +34 -0
- data/lib/algolia/models/ingestion/run_progress.rb +201 -0
- data/lib/algolia/models/ingestion/run_reason_code.rb +38 -0
- data/lib/algolia/models/ingestion/run_response.rb +208 -0
- data/lib/algolia/models/ingestion/run_sort_keys.rb +34 -0
- data/lib/algolia/models/ingestion/run_status.rb +36 -0
- data/lib/algolia/models/ingestion/run_type.rb +34 -0
- data/lib/algolia/models/ingestion/schedule_date_utils_input.rb +214 -0
- data/lib/algolia/models/ingestion/schedule_trigger.rb +251 -0
- data/lib/algolia/models/ingestion/schedule_trigger_input.rb +229 -0
- data/lib/algolia/models/ingestion/schedule_trigger_type.rb +32 -0
- data/lib/algolia/models/ingestion/source.rb +282 -0
- data/lib/algolia/models/ingestion/source_big_commerce.rb +235 -0
- data/lib/algolia/models/ingestion/source_big_query.rb +278 -0
- data/lib/algolia/models/ingestion/source_commercetools.rb +238 -0
- data/lib/algolia/models/ingestion/source_create.rb +248 -0
- data/lib/algolia/models/ingestion/source_create_response.rb +218 -0
- data/lib/algolia/models/ingestion/source_csv.rb +276 -0
- data/lib/algolia/models/ingestion/source_docker.rb +261 -0
- data/lib/algolia/models/ingestion/source_input.rb +100 -0
- data/lib/algolia/models/ingestion/source_json.rb +236 -0
- data/lib/algolia/models/ingestion/source_search.rb +196 -0
- data/lib/algolia/models/ingestion/source_sort_keys.rb +35 -0
- data/lib/algolia/models/ingestion/source_type.rb +37 -0
- data/lib/algolia/models/ingestion/source_update.rb +211 -0
- data/lib/algolia/models/ingestion/source_update_commercetools.rb +207 -0
- data/lib/algolia/models/ingestion/source_update_docker.rb +246 -0
- data/lib/algolia/models/ingestion/source_update_input.rb +99 -0
- data/lib/algolia/models/ingestion/source_update_response.rb +218 -0
- data/lib/algolia/models/ingestion/subscription_trigger.rb +217 -0
- data/lib/algolia/models/ingestion/subscription_trigger_type.rb +32 -0
- data/lib/algolia/models/ingestion/task.rb +334 -0
- data/lib/algolia/models/ingestion/task_create.rb +299 -0
- data/lib/algolia/models/ingestion/task_create_response.rb +208 -0
- data/lib/algolia/models/ingestion/task_create_trigger.rb +97 -0
- data/lib/algolia/models/ingestion/task_input.rb +96 -0
- data/lib/algolia/models/ingestion/task_search.rb +196 -0
- data/lib/algolia/models/ingestion/task_sort_keys.rb +36 -0
- data/lib/algolia/models/ingestion/task_update.rb +250 -0
- data/lib/algolia/models/ingestion/task_update_response.rb +208 -0
- data/lib/algolia/models/ingestion/trigger.rb +97 -0
- data/lib/algolia/models/ingestion/trigger_type.rb +34 -0
- data/lib/algolia/models/ingestion/trigger_update_input.rb +196 -0
- data/lib/algolia/models/ingestion/window.rb +208 -0
- data/lib/algolia/models/insights/add_to_cart_event.rb +32 -0
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +384 -0
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +419 -0
- data/lib/algolia/models/insights/click_event.rb +32 -0
- data/lib/algolia/models/insights/clicked_filters.rb +351 -0
- data/lib/algolia/models/insights/clicked_object_ids.rb +341 -0
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +418 -0
- data/lib/algolia/models/insights/conversion_event.rb +32 -0
- data/lib/algolia/models/insights/converted_filters.rb +350 -0
- data/lib/algolia/models/insights/converted_object_ids.rb +351 -0
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +386 -0
- data/lib/algolia/models/insights/discount.rb +97 -0
- data/lib/algolia/models/insights/error_base.rb +196 -0
- data/lib/algolia/models/insights/events_items.rb +106 -0
- data/lib/algolia/models/insights/events_response.rb +204 -0
- data/lib/algolia/models/insights/insights_events.rb +215 -0
- data/lib/algolia/models/insights/object_data.rb +211 -0
- data/lib/algolia/models/insights/object_data_after_search.rb +221 -0
- data/lib/algolia/models/insights/price.rb +97 -0
- data/lib/algolia/models/insights/purchase_event.rb +32 -0
- data/lib/algolia/models/insights/purchased_object_ids.rb +384 -0
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +419 -0
- data/lib/algolia/models/insights/view_event.rb +32 -0
- data/lib/algolia/models/insights/viewed_filters.rb +351 -0
- data/lib/algolia/models/insights/viewed_object_ids.rb +351 -0
- data/lib/algolia/models/monitoring/error_base.rb +196 -0
- data/lib/algolia/models/monitoring/get_inventory403_response.rb +192 -0
- data/lib/algolia/models/monitoring/incident.rb +225 -0
- data/lib/algolia/models/monitoring/incidents_inner.rb +202 -0
- data/lib/algolia/models/monitoring/incidents_response.rb +194 -0
- data/lib/algolia/models/monitoring/indexing_time_response.rb +192 -0
- data/lib/algolia/models/monitoring/indexing_time_response_metrics.rb +194 -0
- data/lib/algolia/models/monitoring/infrastructure_response.rb +192 -0
- data/lib/algolia/models/monitoring/infrastructure_response_metrics.rb +243 -0
- data/lib/algolia/models/monitoring/inventory_response.rb +194 -0
- data/lib/algolia/models/monitoring/latency_response.rb +192 -0
- data/lib/algolia/models/monitoring/latency_response_metrics.rb +194 -0
- data/lib/algolia/models/monitoring/metric.rb +37 -0
- data/lib/algolia/models/monitoring/period.rb +36 -0
- data/lib/algolia/models/monitoring/probes_metric.rb +203 -0
- data/lib/algolia/models/monitoring/region.rb +46 -0
- data/lib/algolia/models/monitoring/server.rb +272 -0
- data/lib/algolia/models/monitoring/server_status.rb +32 -0
- data/lib/algolia/models/monitoring/status.rb +35 -0
- data/lib/algolia/models/monitoring/status_response.rb +194 -0
- data/lib/algolia/models/monitoring/time_inner.rb +203 -0
- data/lib/algolia/models/monitoring/type.rb +32 -0
- data/lib/algolia/models/personalization/delete_user_profile_response.rb +207 -0
- data/lib/algolia/models/personalization/error_base.rb +196 -0
- data/lib/algolia/models/personalization/event_scoring.rb +219 -0
- data/lib/algolia/models/personalization/facet_scoring.rb +207 -0
- data/lib/algolia/models/personalization/get_user_token_response.rb +219 -0
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +223 -0
- data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +195 -0
- data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb +223 -0
- data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_with_index.rb +195 -0
- data/lib/algolia/models/query-suggestions/base_response.rb +203 -0
- data/lib/algolia/models/query-suggestions/error_base.rb +196 -0
- data/lib/algolia/models/query-suggestions/facet.rb +204 -0
- data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +233 -0
- data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +244 -0
- data/lib/algolia/models/query-suggestions/languages.rb +97 -0
- data/lib/algolia/models/query-suggestions/log_level.rb +34 -0
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +255 -0
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +315 -0
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +275 -0
- data/lib/algolia/models/query-suggestions/source_index.rb +305 -0
- data/lib/algolia/models/recommend/advanced_syntax_features.rb +33 -0
- data/lib/algolia/models/recommend/alternatives_as_exact.rb +34 -0
- data/lib/algolia/models/recommend/anchoring.rb +35 -0
- data/lib/algolia/models/recommend/around_precision.rb +97 -0
- data/lib/algolia/models/recommend/around_precision_from_value_inner.rb +201 -0
- data/lib/algolia/models/recommend/around_radius.rb +97 -0
- data/lib/algolia/models/recommend/around_radius_all.rb +32 -0
- data/lib/algolia/models/recommend/automatic_facet_filter.rb +216 -0
- data/lib/algolia/models/recommend/automatic_facet_filters.rb +97 -0
- data/lib/algolia/models/recommend/base_recommend_request.rb +233 -0
- data/lib/algolia/models/recommend/base_recommendations_query.rb +246 -0
- data/lib/algolia/models/recommend/base_recommended_for_you_query.rb +234 -0
- data/lib/algolia/models/recommend/base_recommended_for_you_query_parameters.rb +195 -0
- data/lib/algolia/models/recommend/base_search_params.rb +564 -0
- data/lib/algolia/models/recommend/base_search_params_without_query.rb +546 -0
- data/lib/algolia/models/recommend/base_search_response.rb +517 -0
- data/lib/algolia/models/recommend/base_trending_facets_query.rb +226 -0
- data/lib/algolia/models/recommend/base_trending_items_query.rb +252 -0
- data/lib/algolia/models/recommend/condition.rb +244 -0
- data/lib/algolia/models/recommend/consequence.rb +239 -0
- data/lib/algolia/models/recommend/consequence_hide.rb +196 -0
- data/lib/algolia/models/recommend/consequence_params.rb +1121 -0
- data/lib/algolia/models/recommend/consequence_query.rb +97 -0
- data/lib/algolia/models/recommend/consequence_query_object.rb +207 -0
- data/lib/algolia/models/recommend/deleted_at_response.rb +208 -0
- data/lib/algolia/models/recommend/distinct.rb +97 -0
- data/lib/algolia/models/recommend/edit.rb +234 -0
- data/lib/algolia/models/recommend/edit_type.rb +33 -0
- data/lib/algolia/models/recommend/error_base.rb +196 -0
- data/lib/algolia/models/recommend/exact_on_single_word_query.rb +34 -0
- data/lib/algolia/models/recommend/exhaustive.rb +234 -0
- data/lib/algolia/models/recommend/facet_filters.rb +97 -0
- data/lib/algolia/models/recommend/facet_ordering.rb +205 -0
- data/lib/algolia/models/recommend/facets.rb +196 -0
- data/lib/algolia/models/recommend/facets_stats.rb +223 -0
- data/lib/algolia/models/recommend/get_recommend_task_response.rb +216 -0
- data/lib/algolia/models/recommend/get_recommendations_params.rb +198 -0
- data/lib/algolia/models/recommend/get_recommendations_response.rb +194 -0
- data/lib/algolia/models/recommend/highlight_result.rb +96 -0
- data/lib/algolia/models/recommend/highlight_result_option.rb +253 -0
- data/lib/algolia/models/recommend/ignore_plurals.rb +97 -0
- data/lib/algolia/models/recommend/index_settings_as_search_params.rb +723 -0
- data/lib/algolia/models/recommend/match_level.rb +34 -0
- data/lib/algolia/models/recommend/matched_geo_location.rb +213 -0
- data/lib/algolia/models/recommend/mixed_search_filters.rb +96 -0
- data/lib/algolia/models/recommend/mode.rb +33 -0
- data/lib/algolia/models/recommend/numeric_filters.rb +97 -0
- data/lib/algolia/models/recommend/optional_filters.rb +97 -0
- data/lib/algolia/models/recommend/params.rb +220 -0
- data/lib/algolia/models/recommend/personalization.rb +213 -0
- data/lib/algolia/models/recommend/promote.rb +96 -0
- data/lib/algolia/models/recommend/promote_object_id.rb +208 -0
- data/lib/algolia/models/recommend/promote_object_ids.rb +210 -0
- data/lib/algolia/models/recommend/query_type.rb +34 -0
- data/lib/algolia/models/recommend/ranking_info.rb +328 -0
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +97 -0
- data/lib/algolia/models/recommend/recommend_hit.rb +271 -0
- data/lib/algolia/models/recommend/recommend_models.rb +35 -0
- data/lib/algolia/models/recommend/recommendation_models.rb +33 -0
- data/lib/algolia/models/recommend/recommendations_hit.rb +96 -0
- data/lib/algolia/models/recommend/recommendations_hits.rb +216 -0
- data/lib/algolia/models/recommend/recommendations_query.rb +304 -0
- data/lib/algolia/models/recommend/recommendations_request.rb +98 -0
- data/lib/algolia/models/recommend/recommendations_results.rb +553 -0
- data/lib/algolia/models/recommend/recommended_for_you_model.rb +32 -0
- data/lib/algolia/models/recommend/recommended_for_you_query.rb +292 -0
- data/lib/algolia/models/recommend/recommended_for_you_query_parameters.rb +1105 -0
- data/lib/algolia/models/recommend/redirect.rb +195 -0
- data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +242 -0
- data/lib/algolia/models/recommend/redirect_rule_index_metadata_data.rb +195 -0
- data/lib/algolia/models/recommend/remove_stop_words.rb +97 -0
- data/lib/algolia/models/recommend/remove_words_if_no_results.rb +35 -0
- data/lib/algolia/models/recommend/rendering_content.rb +193 -0
- data/lib/algolia/models/recommend/rule_response.rb +246 -0
- data/lib/algolia/models/recommend/rule_response_metadata.rb +193 -0
- data/lib/algolia/models/recommend/search_params_object.rb +1103 -0
- data/lib/algolia/models/recommend/search_params_query.rb +193 -0
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +268 -0
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +233 -0
- data/lib/algolia/models/recommend/semantic_search.rb +198 -0
- data/lib/algolia/models/recommend/snippet_result.rb +96 -0
- data/lib/algolia/models/recommend/snippet_result_option.rb +229 -0
- data/lib/algolia/models/recommend/sort_remaining_by.rb +34 -0
- data/lib/algolia/models/recommend/tag_filters.rb +97 -0
- data/lib/algolia/models/recommend/task_status.rb +33 -0
- data/lib/algolia/models/recommend/trending_facet_hit.rb +238 -0
- data/lib/algolia/models/recommend/trending_facets_model.rb +32 -0
- data/lib/algolia/models/recommend/trending_facets_query.rb +284 -0
- data/lib/algolia/models/recommend/trending_items_model.rb +32 -0
- data/lib/algolia/models/recommend/trending_items_query.rb +310 -0
- data/lib/algolia/models/recommend/typo_tolerance.rb +97 -0
- data/lib/algolia/models/recommend/typo_tolerance_enum.rb +33 -0
- data/lib/algolia/models/recommend/value.rb +226 -0
- data/lib/algolia/models/search/acl.rb +47 -0
- data/lib/algolia/models/search/action.rb +38 -0
- data/lib/algolia/models/search/add_api_key_response.rb +207 -0
- data/lib/algolia/models/search/advanced_syntax_features.rb +33 -0
- data/lib/algolia/models/search/alternatives_as_exact.rb +34 -0
- data/lib/algolia/models/search/anchoring.rb +35 -0
- data/lib/algolia/models/search/api_key.rb +272 -0
- data/lib/algolia/models/search/around_precision.rb +97 -0
- data/lib/algolia/models/search/around_precision_from_value_inner.rb +201 -0
- data/lib/algolia/models/search/around_radius.rb +97 -0
- data/lib/algolia/models/search/around_radius_all.rb +32 -0
- data/lib/algolia/models/search/assign_user_id_params.rb +196 -0
- data/lib/algolia/models/search/attribute_to_update.rb +96 -0
- data/lib/algolia/models/search/automatic_facet_filter.rb +216 -0
- data/lib/algolia/models/search/automatic_facet_filters.rb +97 -0
- data/lib/algolia/models/search/base_get_api_key_response.rb +205 -0
- data/lib/algolia/models/search/base_index_settings.rb +366 -0
- data/lib/algolia/models/search/base_search_params.rb +564 -0
- data/lib/algolia/models/search/base_search_params_without_query.rb +546 -0
- data/lib/algolia/models/search/base_search_response.rb +517 -0
- data/lib/algolia/models/search/batch_assign_user_ids_params.rb +210 -0
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +208 -0
- data/lib/algolia/models/search/batch_dictionary_entries_request.rb +227 -0
- data/lib/algolia/models/search/batch_params.rb +197 -0
- data/lib/algolia/models/search/batch_request.rb +228 -0
- data/lib/algolia/models/search/batch_response.rb +209 -0
- data/lib/algolia/models/search/batch_write_params.rb +197 -0
- data/lib/algolia/models/search/browse_params.rb +96 -0
- data/lib/algolia/models/search/browse_params_object.rb +1113 -0
- data/lib/algolia/models/search/browse_response.rb +568 -0
- data/lib/algolia/models/search/built_in_operation.rb +229 -0
- data/lib/algolia/models/search/built_in_operation_type.rb +38 -0
- data/lib/algolia/models/search/condition.rb +244 -0
- data/lib/algolia/models/search/consequence.rb +239 -0
- data/lib/algolia/models/search/consequence_hide.rb +196 -0
- data/lib/algolia/models/search/consequence_params.rb +1121 -0
- data/lib/algolia/models/search/consequence_query.rb +97 -0
- data/lib/algolia/models/search/consequence_query_object.rb +207 -0
- data/lib/algolia/models/search/created_at_response.rb +196 -0
- data/lib/algolia/models/search/cursor.rb +193 -0
- data/lib/algolia/models/search/delete_api_key_response.rb +195 -0
- data/lib/algolia/models/search/delete_by_params.rb +263 -0
- data/lib/algolia/models/search/delete_source_response.rb +195 -0
- data/lib/algolia/models/search/deleted_at_response.rb +208 -0
- data/lib/algolia/models/search/dictionary_action.rb +33 -0
- data/lib/algolia/models/search/dictionary_entry.rb +276 -0
- data/lib/algolia/models/search/dictionary_entry_state.rb +33 -0
- data/lib/algolia/models/search/dictionary_language.rb +194 -0
- data/lib/algolia/models/search/dictionary_settings_params.rb +195 -0
- data/lib/algolia/models/search/dictionary_type.rb +34 -0
- data/lib/algolia/models/search/distinct.rb +97 -0
- data/lib/algolia/models/search/edit.rb +234 -0
- data/lib/algolia/models/search/edit_type.rb +33 -0
- data/lib/algolia/models/search/error_base.rb +196 -0
- data/lib/algolia/models/search/exact_on_single_word_query.rb +34 -0
- data/lib/algolia/models/search/exhaustive.rb +234 -0
- data/lib/algolia/models/search/facet_filters.rb +97 -0
- data/lib/algolia/models/search/facet_hits.rb +219 -0
- data/lib/algolia/models/search/facet_ordering.rb +205 -0
- data/lib/algolia/models/search/facets.rb +196 -0
- data/lib/algolia/models/search/facets_stats.rb +223 -0
- data/lib/algolia/models/search/fetched_index.rb +313 -0
- data/lib/algolia/models/search/get_api_key_response.rb +301 -0
- data/lib/algolia/models/search/get_dictionary_settings_response.rb +194 -0
- data/lib/algolia/models/search/get_logs_response.rb +196 -0
- data/lib/algolia/models/search/get_objects_params.rb +197 -0
- data/lib/algolia/models/search/get_objects_request.rb +220 -0
- data/lib/algolia/models/search/get_objects_response.rb +197 -0
- data/lib/algolia/models/search/get_task_response.rb +216 -0
- data/lib/algolia/models/search/get_top_user_ids_response.rb +198 -0
- data/lib/algolia/models/search/has_pending_mappings_response.rb +207 -0
- data/lib/algolia/models/search/highlight_result.rb +96 -0
- data/lib/algolia/models/search/highlight_result_option.rb +253 -0
- data/lib/algolia/models/search/hit.rb +241 -0
- data/lib/algolia/models/search/ignore_plurals.rb +97 -0
- data/lib/algolia/models/search/index_settings.rb +912 -0
- data/lib/algolia/models/search/index_settings_as_search_params.rb +723 -0
- data/lib/algolia/models/search/languages.rb +221 -0
- data/lib/algolia/models/search/list_api_keys_response.rb +197 -0
- data/lib/algolia/models/search/list_clusters_response.rb +198 -0
- data/lib/algolia/models/search/list_indices_response.rb +207 -0
- data/lib/algolia/models/search/list_user_ids_response.rb +198 -0
- data/lib/algolia/models/search/log.rb +358 -0
- data/lib/algolia/models/search/log_query.rb +213 -0
- data/lib/algolia/models/search/log_type.rb +35 -0
- data/lib/algolia/models/search/match_level.rb +34 -0
- data/lib/algolia/models/search/matched_geo_location.rb +213 -0
- data/lib/algolia/models/search/mixed_search_filters.rb +96 -0
- data/lib/algolia/models/search/mode.rb +33 -0
- data/lib/algolia/models/search/multiple_batch_request.rb +240 -0
- data/lib/algolia/models/search/multiple_batch_response.rb +211 -0
- data/lib/algolia/models/search/numeric_filters.rb +97 -0
- data/lib/algolia/models/search/operation_index_params.rb +240 -0
- data/lib/algolia/models/search/operation_type.rb +33 -0
- data/lib/algolia/models/search/optional_filters.rb +97 -0
- data/lib/algolia/models/search/params.rb +220 -0
- data/lib/algolia/models/search/personalization.rb +213 -0
- data/lib/algolia/models/search/promote.rb +96 -0
- data/lib/algolia/models/search/promote_object_id.rb +208 -0
- data/lib/algolia/models/search/promote_object_ids.rb +210 -0
- data/lib/algolia/models/search/query_type.rb +34 -0
- data/lib/algolia/models/search/ranking_info.rb +328 -0
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +97 -0
- data/lib/algolia/models/search/redirect.rb +195 -0
- data/lib/algolia/models/search/redirect_rule_index_metadata.rb +242 -0
- data/lib/algolia/models/search/redirect_rule_index_metadata_data.rb +195 -0
- data/lib/algolia/models/search/remove_stop_words.rb +97 -0
- data/lib/algolia/models/search/remove_user_id_response.rb +195 -0
- data/lib/algolia/models/search/remove_words_if_no_results.rb +35 -0
- data/lib/algolia/models/search/rendering_content.rb +193 -0
- data/lib/algolia/models/search/replace_source_response.rb +195 -0
- data/lib/algolia/models/search/rule.rb +249 -0
- data/lib/algolia/models/search/save_object_response.rb +217 -0
- data/lib/algolia/models/search/save_synonym_response.rb +219 -0
- data/lib/algolia/models/search/scope_type.rb +34 -0
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +244 -0
- data/lib/algolia/models/search/search_for_facet_values_request.rb +227 -0
- data/lib/algolia/models/search/search_for_facet_values_response.rb +218 -0
- data/lib/algolia/models/search/search_for_facets.rb +1158 -0
- data/lib/algolia/models/search/search_for_facets_options.rb +274 -0
- data/lib/algolia/models/search/search_for_hits.rb +1134 -0
- data/lib/algolia/models/search/search_for_hits_options.rb +226 -0
- data/lib/algolia/models/search/search_hits.rb +223 -0
- data/lib/algolia/models/search/search_method_params.rb +227 -0
- data/lib/algolia/models/search/search_params.rb +96 -0
- data/lib/algolia/models/search/search_params_object.rb +1103 -0
- data/lib/algolia/models/search/search_params_query.rb +193 -0
- data/lib/algolia/models/search/search_params_string.rb +193 -0
- data/lib/algolia/models/search/search_query.rb +96 -0
- data/lib/algolia/models/search/search_response.rb +560 -0
- data/lib/algolia/models/search/search_responses.rb +196 -0
- data/lib/algolia/models/search/search_result.rb +96 -0
- data/lib/algolia/models/search/search_rules_params.rb +311 -0
- data/lib/algolia/models/search/search_rules_response.rb +233 -0
- data/lib/algolia/models/search/search_strategy.rb +33 -0
- data/lib/algolia/models/search/search_synonyms_params.rb +193 -0
- data/lib/algolia/models/search/search_synonyms_response.rb +212 -0
- data/lib/algolia/models/search/search_type_default.rb +32 -0
- data/lib/algolia/models/search/search_type_facet.rb +32 -0
- data/lib/algolia/models/search/search_user_ids_params.rb +244 -0
- data/lib/algolia/models/search/search_user_ids_response.rb +264 -0
- data/lib/algolia/models/search/semantic_search.rb +198 -0
- data/lib/algolia/models/search/snippet_result.rb +96 -0
- data/lib/algolia/models/search/snippet_result_option.rb +229 -0
- data/lib/algolia/models/search/sort_remaining_by.rb +34 -0
- data/lib/algolia/models/search/source.rb +206 -0
- data/lib/algolia/models/search/standard_entries.rb +224 -0
- data/lib/algolia/models/search/synonym_hit.rb +295 -0
- data/lib/algolia/models/search/synonym_type.rb +36 -0
- data/lib/algolia/models/search/tag_filters.rb +97 -0
- data/lib/algolia/models/search/task_status.rb +33 -0
- data/lib/algolia/models/search/time_range.rb +207 -0
- data/lib/algolia/models/search/typo_tolerance.rb +97 -0
- data/lib/algolia/models/search/typo_tolerance_enum.rb +33 -0
- data/lib/algolia/models/search/update_api_key_response.rb +207 -0
- data/lib/algolia/models/search/updated_at_response.rb +208 -0
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +214 -0
- data/lib/algolia/models/search/updated_rule_response.rb +219 -0
- data/lib/algolia/models/search/user_highlight_result.rb +205 -0
- data/lib/algolia/models/search/user_hit.rb +269 -0
- data/lib/algolia/models/search/user_id.rb +247 -0
- data/lib/algolia/models/search/value.rb +226 -0
- data/lib/algolia/transport/echo_requester.rb +10 -0
- data/lib/algolia/{http → transport/http}/http_requester.rb +24 -19
- data/lib/algolia/{http → transport/http}/response.rb +11 -1
- data/lib/algolia/transport/request_options.rb +19 -31
- data/lib/algolia/transport/retry_strategy.rb +5 -8
- data/lib/algolia/transport/stateful_host.rb +1 -2
- data/lib/algolia/transport/transport.rb +33 -73
- data/lib/algolia/user_agent.rb +4 -14
- data/lib/algolia/version.rb +3 -1
- data/lib/algolia.rb +23 -40
- metadata +523 -218
- data/.circleci/config.yml +0 -155
- data/.dockerignore +0 -38
- data/.github/ISSUE_TEMPLATE.md +0 -20
- data/.github/PULL_REQUEST_TEMPLATE.md +0 -22
- data/.gitignore +0 -40
- data/.rubocop.yml +0 -189
- data/.rubocop_todo.yml +0 -14
- data/CODE_OF_CONDUCT.md +0 -74
- data/CONTRIBUTING.MD +0 -184
- data/DOCKER_README.MD +0 -89
- data/Dockerfile +0 -7
- data/LICENSE +0 -21
- data/SECURITY.md +0 -3
- data/Steepfile +0 -6
- data/bin/console +0 -21
- data/bin/setup +0 -8
- data/lib/algolia/account_client.rb +0 -65
- data/lib/algolia/analytics_client.rb +0 -105
- data/lib/algolia/config/analytics_config.rb +0 -20
- data/lib/algolia/config/base_config.rb +0 -43
- data/lib/algolia/config/insights_config.rb +0 -20
- data/lib/algolia/config/personalization_config.rb +0 -20
- data/lib/algolia/config/recommend_config.rb +0 -6
- data/lib/algolia/config/recommendation_config.rb +0 -7
- data/lib/algolia/config/search_config.rb +0 -40
- data/lib/algolia/defaults.rb +0 -35
- data/lib/algolia/helpers.rb +0 -134
- data/lib/algolia/insights_client.rb +0 -238
- data/lib/algolia/iterators/base_iterator.rb +0 -19
- data/lib/algolia/iterators/object_iterator.rb +0 -28
- data/lib/algolia/iterators/paginator_iterator.rb +0 -46
- data/lib/algolia/iterators/rule_iterator.rb +0 -9
- data/lib/algolia/iterators/synonym_iterator.rb +0 -9
- data/lib/algolia/personalization_client.rb +0 -60
- data/lib/algolia/recommend_client.rb +0 -134
- data/lib/algolia/recommendation_client.rb +0 -7
- data/lib/algolia/responses/add_api_key_response.rb +0 -38
- data/lib/algolia/responses/base_response.rb +0 -9
- data/lib/algolia/responses/delete_api_key_response.rb +0 -40
- data/lib/algolia/responses/dictionary_response.rb +0 -33
- data/lib/algolia/responses/indexing_response.rb +0 -28
- data/lib/algolia/responses/multiple_batch_indexing_response.rb +0 -29
- data/lib/algolia/responses/multiple_response.rb +0 -45
- data/lib/algolia/responses/restore_api_key_response.rb +0 -36
- data/lib/algolia/responses/update_api_key_response.rb +0 -39
- data/lib/algolia/search_client.rb +0 -791
- data/lib/algolia/search_index.rb +0 -1059
- data/renovate.json +0 -5
- data/sig/config/algolia_config.rbs +0 -24
- data/sig/config/analytics_config.rbs +0 -11
- data/sig/config/insights_config.rbs +0 -11
- data/sig/config/recommendation_config.rbs +0 -11
- data/sig/config/search_config.rbs +0 -11
- data/sig/enums/call_type.rbs +0 -5
- data/sig/helpers.rbs +0 -12
- data/sig/http/http_requester.rbs +0 -17
- data/sig/http/response.rbs +0 -14
- data/sig/interfaces/_connection.rbs +0 -16
- data/sig/iterators/base_iterator.rbs +0 -15
- data/sig/iterators/object_iterator.rbs +0 -6
- data/sig/iterators/paginator_iterator.rbs +0 -8
- data/sig/iterators/rule_iterator.rbs +0 -5
- data/sig/iterators/synonym_iterator.rbs +0 -5
- data/sig/transport/request_options.rbs +0 -33
- data/sig/transport/stateful_host.rbs +0 -21
- data/test/algolia/integration/account_client_test.rb +0 -47
- data/test/algolia/integration/analytics_client_test.rb +0 -117
- data/test/algolia/integration/base_test.rb +0 -9
- data/test/algolia/integration/insights_client_test.rb +0 -80
- data/test/algolia/integration/mocks/mock_requester.rb +0 -47
- data/test/algolia/integration/personalization_client_test.rb +0 -30
- data/test/algolia/integration/recommend_client_test.rb +0 -70
- data/test/algolia/integration/recommendation_client_test.rb +0 -30
- data/test/algolia/integration/search_client_test.rb +0 -465
- data/test/algolia/integration/search_index_test.rb +0 -729
- data/test/algolia/unit/algolia_config_test.rb +0 -16
- data/test/algolia/unit/helpers_test.rb +0 -88
- data/test/algolia/unit/http_requester_test.rb +0 -27
- data/test/algolia/unit/retry_strategy_test.rb +0 -139
- data/test/algolia/unit/user_agent_test.rb +0 -16
- data/test/test_helper.rb +0 -121
- data/upgrade_guide.md +0 -603
- /data/lib/algolia/{enums → transport}/call_type.rb +0 -0
- /data/lib/algolia/{enums → transport}/retry_outcome_type.rb +0 -0
@@ -0,0 +1,1659 @@
|
|
1
|
+
# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
2
|
+
|
3
|
+
module Algolia
|
4
|
+
class IngestionClient
|
5
|
+
attr_accessor :api_client
|
6
|
+
|
7
|
+
def initialize(config = nil)
|
8
|
+
raise '`config` is missing.' if config.nil?
|
9
|
+
raise '`app_id` is missing.' if config.app_id.nil? || config.app_id == ''
|
10
|
+
raise '`api_key` is missing.' if config.api_key.nil? || config.api_key == ''
|
11
|
+
|
12
|
+
@api_client = Algolia::ApiClient.new(config)
|
13
|
+
end
|
14
|
+
|
15
|
+
def self.create(app_id, api_key, region = nil, opts = {})
|
16
|
+
hosts = []
|
17
|
+
regions = ['eu', 'us']
|
18
|
+
|
19
|
+
if region.is_a?(Hash) && (opts.nil? || opts.empty?)
|
20
|
+
opts = region
|
21
|
+
region = nil
|
22
|
+
end
|
23
|
+
|
24
|
+
raise "`region` is required and must be one of the following: #{regions.join(', ')}" if region.nil? || !region.is_a?(String) || !regions.include?(region)
|
25
|
+
|
26
|
+
hosts << Transport::StatefulHost.new('data.{region}.algolia.com'.sub!('{region}', region), accept: CallType::READ | CallType::WRITE)
|
27
|
+
|
28
|
+
config = Algolia::Configuration.new(app_id, api_key, hosts, 'Ingestion', opts)
|
29
|
+
create_with_config(config)
|
30
|
+
end
|
31
|
+
|
32
|
+
def self.create_with_config(config)
|
33
|
+
new(config)
|
34
|
+
end
|
35
|
+
|
36
|
+
# Create a authentication.
|
37
|
+
# Create a authentication.
|
38
|
+
# @param authentication_create [AuthenticationCreate] (required)
|
39
|
+
# @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
|
+
# @return [Http::Response] the response
|
41
|
+
def create_authentication_with_http_info(authentication_create, request_options = {})
|
42
|
+
# verify the required parameter 'authentication_create' is set
|
43
|
+
if @api_client.config.client_side_validation && authentication_create.nil?
|
44
|
+
raise ArgumentError, "Parameter `authentication_create` is required when calling `create_authentication`."
|
45
|
+
end
|
46
|
+
|
47
|
+
path = '/1/authentications'
|
48
|
+
query_params = {}
|
49
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
50
|
+
header_params = {}
|
51
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
52
|
+
|
53
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(authentication_create)
|
54
|
+
|
55
|
+
new_options = request_options.merge(
|
56
|
+
:operation => :'IngestionClient.create_authentication',
|
57
|
+
:header_params => header_params,
|
58
|
+
:query_params => query_params,
|
59
|
+
:body => post_body,
|
60
|
+
:use_read_transporter => false
|
61
|
+
)
|
62
|
+
|
63
|
+
@api_client.call_api(:POST, path, new_options)
|
64
|
+
end
|
65
|
+
|
66
|
+
# Create a authentication.
|
67
|
+
# Create a authentication.
|
68
|
+
# @param authentication_create [AuthenticationCreate] (required)
|
69
|
+
# @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
|
+
# @return [AuthenticationCreateResponse]
|
71
|
+
def create_authentication(authentication_create, request_options = {})
|
72
|
+
response = create_authentication_with_http_info(authentication_create, request_options)
|
73
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::AuthenticationCreateResponse')
|
74
|
+
end
|
75
|
+
|
76
|
+
# Create a destination.
|
77
|
+
# Create a destination.
|
78
|
+
# @param destination_create [DestinationCreate] (required)
|
79
|
+
# @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
|
+
# @return [Http::Response] the response
|
81
|
+
def create_destination_with_http_info(destination_create, request_options = {})
|
82
|
+
# verify the required parameter 'destination_create' is set
|
83
|
+
if @api_client.config.client_side_validation && destination_create.nil?
|
84
|
+
raise ArgumentError, "Parameter `destination_create` is required when calling `create_destination`."
|
85
|
+
end
|
86
|
+
|
87
|
+
path = '/1/destinations'
|
88
|
+
query_params = {}
|
89
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
90
|
+
header_params = {}
|
91
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
92
|
+
|
93
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(destination_create)
|
94
|
+
|
95
|
+
new_options = request_options.merge(
|
96
|
+
:operation => :'IngestionClient.create_destination',
|
97
|
+
:header_params => header_params,
|
98
|
+
:query_params => query_params,
|
99
|
+
:body => post_body,
|
100
|
+
:use_read_transporter => false
|
101
|
+
)
|
102
|
+
|
103
|
+
@api_client.call_api(:POST, path, new_options)
|
104
|
+
end
|
105
|
+
|
106
|
+
# Create a destination.
|
107
|
+
# Create a destination.
|
108
|
+
# @param destination_create [DestinationCreate] (required)
|
109
|
+
# @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
|
+
# @return [DestinationCreateResponse]
|
111
|
+
def create_destination(destination_create, request_options = {})
|
112
|
+
response = create_destination_with_http_info(destination_create, request_options)
|
113
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DestinationCreateResponse')
|
114
|
+
end
|
115
|
+
|
116
|
+
# Create a source.
|
117
|
+
# Create a source.
|
118
|
+
# @param source_create [SourceCreate] (required)
|
119
|
+
# @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
|
+
# @return [Http::Response] the response
|
121
|
+
def create_source_with_http_info(source_create, request_options = {})
|
122
|
+
# verify the required parameter 'source_create' is set
|
123
|
+
if @api_client.config.client_side_validation && source_create.nil?
|
124
|
+
raise ArgumentError, "Parameter `source_create` is required when calling `create_source`."
|
125
|
+
end
|
126
|
+
|
127
|
+
path = '/1/sources'
|
128
|
+
query_params = {}
|
129
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
130
|
+
header_params = {}
|
131
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
132
|
+
|
133
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_create)
|
134
|
+
|
135
|
+
new_options = request_options.merge(
|
136
|
+
:operation => :'IngestionClient.create_source',
|
137
|
+
:header_params => header_params,
|
138
|
+
:query_params => query_params,
|
139
|
+
:body => post_body,
|
140
|
+
:use_read_transporter => false
|
141
|
+
)
|
142
|
+
|
143
|
+
@api_client.call_api(:POST, path, new_options)
|
144
|
+
end
|
145
|
+
|
146
|
+
# Create a source.
|
147
|
+
# Create a source.
|
148
|
+
# @param source_create [SourceCreate] (required)
|
149
|
+
# @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
|
+
# @return [SourceCreateResponse]
|
151
|
+
def create_source(source_create, request_options = {})
|
152
|
+
response = create_source_with_http_info(source_create, request_options)
|
153
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceCreateResponse')
|
154
|
+
end
|
155
|
+
|
156
|
+
# Create a task.
|
157
|
+
# Create a task.
|
158
|
+
# @param task_create [TaskCreate] (required)
|
159
|
+
# @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
|
+
# @return [Http::Response] the response
|
161
|
+
def create_task_with_http_info(task_create, request_options = {})
|
162
|
+
# verify the required parameter 'task_create' is set
|
163
|
+
if @api_client.config.client_side_validation && task_create.nil?
|
164
|
+
raise ArgumentError, "Parameter `task_create` is required when calling `create_task`."
|
165
|
+
end
|
166
|
+
|
167
|
+
path = '/1/tasks'
|
168
|
+
query_params = {}
|
169
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
170
|
+
header_params = {}
|
171
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
172
|
+
|
173
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(task_create)
|
174
|
+
|
175
|
+
new_options = request_options.merge(
|
176
|
+
:operation => :'IngestionClient.create_task',
|
177
|
+
:header_params => header_params,
|
178
|
+
:query_params => query_params,
|
179
|
+
:body => post_body,
|
180
|
+
:use_read_transporter => false
|
181
|
+
)
|
182
|
+
|
183
|
+
@api_client.call_api(:POST, path, new_options)
|
184
|
+
end
|
185
|
+
|
186
|
+
# Create a task.
|
187
|
+
# Create a task.
|
188
|
+
# @param task_create [TaskCreate] (required)
|
189
|
+
# @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
|
+
# @return [TaskCreateResponse]
|
191
|
+
def create_task(task_create, request_options = {})
|
192
|
+
response = create_task_with_http_info(task_create, request_options)
|
193
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskCreateResponse')
|
194
|
+
end
|
195
|
+
|
196
|
+
# Send requests to the Algolia REST API.
|
197
|
+
# This method allow you to send requests to the Algolia REST API.
|
198
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
199
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
200
|
+
# @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)
|
201
|
+
# @return [Http::Response] the response
|
202
|
+
def custom_delete_with_http_info(path, parameters = nil, request_options = {})
|
203
|
+
# verify the required parameter 'path' is set
|
204
|
+
if @api_client.config.client_side_validation && path.nil?
|
205
|
+
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
206
|
+
end
|
207
|
+
|
208
|
+
path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
|
209
|
+
query_params = {}
|
210
|
+
query_params = query_params.merge(parameters) unless parameters.nil?
|
211
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
212
|
+
header_params = {}
|
213
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
214
|
+
|
215
|
+
post_body = request_options[:debug_body]
|
216
|
+
|
217
|
+
new_options = request_options.merge(
|
218
|
+
:operation => :'IngestionClient.custom_delete',
|
219
|
+
:header_params => header_params,
|
220
|
+
:query_params => query_params,
|
221
|
+
:body => post_body,
|
222
|
+
:use_read_transporter => false
|
223
|
+
)
|
224
|
+
|
225
|
+
@api_client.call_api(:DELETE, path, new_options)
|
226
|
+
end
|
227
|
+
|
228
|
+
# Send requests to the Algolia REST API.
|
229
|
+
# This method allow you to send requests to the Algolia REST API.
|
230
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
231
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
232
|
+
# @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)
|
233
|
+
# @return [Object]
|
234
|
+
def custom_delete(path, parameters = nil, request_options = {})
|
235
|
+
response = custom_delete_with_http_info(path, parameters, request_options)
|
236
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
237
|
+
end
|
238
|
+
|
239
|
+
# Send requests to the Algolia REST API.
|
240
|
+
# This method allow you to send requests to the Algolia REST API.
|
241
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
242
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
243
|
+
# @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)
|
244
|
+
# @return [Http::Response] the response
|
245
|
+
def custom_get_with_http_info(path, parameters = nil, request_options = {})
|
246
|
+
# verify the required parameter 'path' is set
|
247
|
+
if @api_client.config.client_side_validation && path.nil?
|
248
|
+
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
249
|
+
end
|
250
|
+
|
251
|
+
path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
|
252
|
+
query_params = {}
|
253
|
+
query_params = query_params.merge(parameters) unless parameters.nil?
|
254
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
255
|
+
header_params = {}
|
256
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
257
|
+
|
258
|
+
post_body = request_options[:debug_body]
|
259
|
+
|
260
|
+
new_options = request_options.merge(
|
261
|
+
:operation => :'IngestionClient.custom_get',
|
262
|
+
:header_params => header_params,
|
263
|
+
:query_params => query_params,
|
264
|
+
:body => post_body,
|
265
|
+
:use_read_transporter => false
|
266
|
+
)
|
267
|
+
|
268
|
+
@api_client.call_api(:GET, path, new_options)
|
269
|
+
end
|
270
|
+
|
271
|
+
# Send requests to the Algolia REST API.
|
272
|
+
# This method allow you to send requests to the Algolia REST API.
|
273
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
274
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
275
|
+
# @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)
|
276
|
+
# @return [Object]
|
277
|
+
def custom_get(path, parameters = nil, request_options = {})
|
278
|
+
response = custom_get_with_http_info(path, parameters, request_options)
|
279
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
280
|
+
end
|
281
|
+
|
282
|
+
# Send requests to the Algolia REST API.
|
283
|
+
# This method allow you to send requests to the Algolia REST API.
|
284
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
285
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
286
|
+
# @param body [Object] Parameters to send with the custom request.
|
287
|
+
# @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)
|
288
|
+
# @return [Http::Response] the response
|
289
|
+
def custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {})
|
290
|
+
# verify the required parameter 'path' is set
|
291
|
+
if @api_client.config.client_side_validation && path.nil?
|
292
|
+
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
293
|
+
end
|
294
|
+
|
295
|
+
path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
|
296
|
+
query_params = {}
|
297
|
+
query_params = query_params.merge(parameters) unless parameters.nil?
|
298
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
299
|
+
header_params = {}
|
300
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
301
|
+
|
302
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
|
303
|
+
|
304
|
+
new_options = request_options.merge(
|
305
|
+
:operation => :'IngestionClient.custom_post',
|
306
|
+
:header_params => header_params,
|
307
|
+
:query_params => query_params,
|
308
|
+
:body => post_body,
|
309
|
+
:use_read_transporter => false
|
310
|
+
)
|
311
|
+
|
312
|
+
@api_client.call_api(:POST, path, new_options)
|
313
|
+
end
|
314
|
+
|
315
|
+
# Send requests to the Algolia REST API.
|
316
|
+
# This method allow you to send requests to the Algolia REST API.
|
317
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
318
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
319
|
+
# @param body [Object] Parameters to send with the custom request.
|
320
|
+
# @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)
|
321
|
+
# @return [Object]
|
322
|
+
def custom_post(path, parameters = nil, body = nil, request_options = {})
|
323
|
+
response = custom_post_with_http_info(path, parameters, body, request_options)
|
324
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
325
|
+
end
|
326
|
+
|
327
|
+
# Send requests to the Algolia REST API.
|
328
|
+
# This method allow you to send requests to the Algolia REST API.
|
329
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
330
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
331
|
+
# @param body [Object] Parameters to send with the custom request.
|
332
|
+
# @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)
|
333
|
+
# @return [Http::Response] the response
|
334
|
+
def custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {})
|
335
|
+
# verify the required parameter 'path' is set
|
336
|
+
if @api_client.config.client_side_validation && path.nil?
|
337
|
+
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
338
|
+
end
|
339
|
+
|
340
|
+
path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
|
341
|
+
query_params = {}
|
342
|
+
query_params = query_params.merge(parameters) unless parameters.nil?
|
343
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
344
|
+
header_params = {}
|
345
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
346
|
+
|
347
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
|
348
|
+
|
349
|
+
new_options = request_options.merge(
|
350
|
+
:operation => :'IngestionClient.custom_put',
|
351
|
+
:header_params => header_params,
|
352
|
+
:query_params => query_params,
|
353
|
+
:body => post_body,
|
354
|
+
:use_read_transporter => false
|
355
|
+
)
|
356
|
+
|
357
|
+
@api_client.call_api(:PUT, path, new_options)
|
358
|
+
end
|
359
|
+
|
360
|
+
# Send requests to the Algolia REST API.
|
361
|
+
# This method allow you to send requests to the Algolia REST API.
|
362
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
363
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
364
|
+
# @param body [Object] Parameters to send with the custom request.
|
365
|
+
# @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)
|
366
|
+
# @return [Object]
|
367
|
+
def custom_put(path, parameters = nil, body = nil, request_options = {})
|
368
|
+
response = custom_put_with_http_info(path, parameters, body, request_options)
|
369
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
370
|
+
end
|
371
|
+
|
372
|
+
# Delete a authentication.
|
373
|
+
# Soft delete the authentication of the given authenticationID.
|
374
|
+
# @param authentication_id [String] The authentication UUID. (required)
|
375
|
+
# @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
|
+
# @return [Http::Response] the response
|
377
|
+
def delete_authentication_with_http_info(authentication_id, request_options = {})
|
378
|
+
# verify the required parameter 'authentication_id' is set
|
379
|
+
if @api_client.config.client_side_validation && authentication_id.nil?
|
380
|
+
raise ArgumentError, "Parameter `authentication_id` is required when calling `delete_authentication`."
|
381
|
+
end
|
382
|
+
|
383
|
+
path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', @api_client.encode_uri(authentication_id.to_s))
|
384
|
+
query_params = {}
|
385
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
386
|
+
header_params = {}
|
387
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
388
|
+
|
389
|
+
post_body = request_options[:debug_body]
|
390
|
+
|
391
|
+
new_options = request_options.merge(
|
392
|
+
:operation => :'IngestionClient.delete_authentication',
|
393
|
+
:header_params => header_params,
|
394
|
+
:query_params => query_params,
|
395
|
+
:body => post_body,
|
396
|
+
:use_read_transporter => false
|
397
|
+
)
|
398
|
+
|
399
|
+
@api_client.call_api(:DELETE, path, new_options)
|
400
|
+
end
|
401
|
+
|
402
|
+
# Delete a authentication.
|
403
|
+
# Soft delete the authentication of the given authenticationID.
|
404
|
+
# @param authentication_id [String] The authentication UUID. (required)
|
405
|
+
# @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
|
+
# @return [DeleteResponse]
|
407
|
+
def delete_authentication(authentication_id, request_options = {})
|
408
|
+
response = delete_authentication_with_http_info(authentication_id, request_options)
|
409
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
|
410
|
+
end
|
411
|
+
|
412
|
+
# Delete a destination.
|
413
|
+
# Soft delete the destination of the given destinationID.
|
414
|
+
# @param destination_id [String] The destination UUID. (required)
|
415
|
+
# @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
|
+
# @return [Http::Response] the response
|
417
|
+
def delete_destination_with_http_info(destination_id, request_options = {})
|
418
|
+
# verify the required parameter 'destination_id' is set
|
419
|
+
if @api_client.config.client_side_validation && destination_id.nil?
|
420
|
+
raise ArgumentError, "Parameter `destination_id` is required when calling `delete_destination`."
|
421
|
+
end
|
422
|
+
|
423
|
+
path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', @api_client.encode_uri(destination_id.to_s))
|
424
|
+
query_params = {}
|
425
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
426
|
+
header_params = {}
|
427
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
428
|
+
|
429
|
+
post_body = request_options[:debug_body]
|
430
|
+
|
431
|
+
new_options = request_options.merge(
|
432
|
+
:operation => :'IngestionClient.delete_destination',
|
433
|
+
:header_params => header_params,
|
434
|
+
:query_params => query_params,
|
435
|
+
:body => post_body,
|
436
|
+
:use_read_transporter => false
|
437
|
+
)
|
438
|
+
|
439
|
+
@api_client.call_api(:DELETE, path, new_options)
|
440
|
+
end
|
441
|
+
|
442
|
+
# Delete a destination.
|
443
|
+
# Soft delete the destination of the given destinationID.
|
444
|
+
# @param destination_id [String] The destination UUID. (required)
|
445
|
+
# @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
|
+
# @return [DeleteResponse]
|
447
|
+
def delete_destination(destination_id, request_options = {})
|
448
|
+
response = delete_destination_with_http_info(destination_id, request_options)
|
449
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
|
450
|
+
end
|
451
|
+
|
452
|
+
# Delete a source.
|
453
|
+
# Soft delete the source of the given sourceID.
|
454
|
+
# @param source_id [String] The source UUID. (required)
|
455
|
+
# @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
|
+
# @return [Http::Response] the response
|
457
|
+
def delete_source_with_http_info(source_id, request_options = {})
|
458
|
+
# verify the required parameter 'source_id' is set
|
459
|
+
if @api_client.config.client_side_validation && source_id.nil?
|
460
|
+
raise ArgumentError, "Parameter `source_id` is required when calling `delete_source`."
|
461
|
+
end
|
462
|
+
|
463
|
+
path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
|
464
|
+
query_params = {}
|
465
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
466
|
+
header_params = {}
|
467
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
468
|
+
|
469
|
+
post_body = request_options[:debug_body]
|
470
|
+
|
471
|
+
new_options = request_options.merge(
|
472
|
+
:operation => :'IngestionClient.delete_source',
|
473
|
+
:header_params => header_params,
|
474
|
+
:query_params => query_params,
|
475
|
+
:body => post_body,
|
476
|
+
:use_read_transporter => false
|
477
|
+
)
|
478
|
+
|
479
|
+
@api_client.call_api(:DELETE, path, new_options)
|
480
|
+
end
|
481
|
+
|
482
|
+
# Delete a source.
|
483
|
+
# Soft delete the source of the given sourceID.
|
484
|
+
# @param source_id [String] The source UUID. (required)
|
485
|
+
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
486
|
+
# @return [DeleteResponse]
|
487
|
+
def delete_source(source_id, request_options = {})
|
488
|
+
response = delete_source_with_http_info(source_id, request_options)
|
489
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
|
490
|
+
end
|
491
|
+
|
492
|
+
# Delete a task.
|
493
|
+
# Soft delete the task of the given taskID.
|
494
|
+
# @param task_id [String] The task UUID. (required)
|
495
|
+
# @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
|
+
# @return [Http::Response] the response
|
497
|
+
def delete_task_with_http_info(task_id, request_options = {})
|
498
|
+
# verify the required parameter 'task_id' is set
|
499
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
500
|
+
raise ArgumentError, "Parameter `task_id` is required when calling `delete_task`."
|
501
|
+
end
|
502
|
+
|
503
|
+
path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
|
504
|
+
query_params = {}
|
505
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
506
|
+
header_params = {}
|
507
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
508
|
+
|
509
|
+
post_body = request_options[:debug_body]
|
510
|
+
|
511
|
+
new_options = request_options.merge(
|
512
|
+
:operation => :'IngestionClient.delete_task',
|
513
|
+
:header_params => header_params,
|
514
|
+
:query_params => query_params,
|
515
|
+
:body => post_body,
|
516
|
+
:use_read_transporter => false
|
517
|
+
)
|
518
|
+
|
519
|
+
@api_client.call_api(:DELETE, path, new_options)
|
520
|
+
end
|
521
|
+
|
522
|
+
# Delete a task.
|
523
|
+
# Soft delete the task of the given taskID.
|
524
|
+
# @param task_id [String] The task UUID. (required)
|
525
|
+
# @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
|
+
# @return [DeleteResponse]
|
527
|
+
def delete_task(task_id, request_options = {})
|
528
|
+
response = delete_task_with_http_info(task_id, request_options)
|
529
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
|
530
|
+
end
|
531
|
+
|
532
|
+
# Disable a task.
|
533
|
+
# Disable the task of the given taskID.
|
534
|
+
# @param task_id [String] The task UUID. (required)
|
535
|
+
# @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
|
+
# @return [Http::Response] the response
|
537
|
+
def disable_task_with_http_info(task_id, request_options = {})
|
538
|
+
# verify the required parameter 'task_id' is set
|
539
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
540
|
+
raise ArgumentError, "Parameter `task_id` is required when calling `disable_task`."
|
541
|
+
end
|
542
|
+
|
543
|
+
path = '/1/tasks/{taskID}/disable'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
|
544
|
+
query_params = {}
|
545
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
546
|
+
header_params = {}
|
547
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
548
|
+
|
549
|
+
post_body = request_options[:debug_body]
|
550
|
+
|
551
|
+
new_options = request_options.merge(
|
552
|
+
:operation => :'IngestionClient.disable_task',
|
553
|
+
:header_params => header_params,
|
554
|
+
:query_params => query_params,
|
555
|
+
:body => post_body,
|
556
|
+
:use_read_transporter => false
|
557
|
+
)
|
558
|
+
|
559
|
+
@api_client.call_api(:PUT, path, new_options)
|
560
|
+
end
|
561
|
+
|
562
|
+
# Disable a task.
|
563
|
+
# Disable the task of the given taskID.
|
564
|
+
# @param task_id [String] The task UUID. (required)
|
565
|
+
# @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
|
+
# @return [TaskUpdateResponse]
|
567
|
+
def disable_task(task_id, request_options = {})
|
568
|
+
response = disable_task_with_http_info(task_id, request_options)
|
569
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
|
570
|
+
end
|
571
|
+
|
572
|
+
# Enable a task.
|
573
|
+
# Enable the task of the given taskID.
|
574
|
+
# @param task_id [String] The task UUID. (required)
|
575
|
+
# @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
|
+
# @return [Http::Response] the response
|
577
|
+
def enable_task_with_http_info(task_id, request_options = {})
|
578
|
+
# verify the required parameter 'task_id' is set
|
579
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
580
|
+
raise ArgumentError, "Parameter `task_id` is required when calling `enable_task`."
|
581
|
+
end
|
582
|
+
|
583
|
+
path = '/1/tasks/{taskID}/enable'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
|
584
|
+
query_params = {}
|
585
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
586
|
+
header_params = {}
|
587
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
588
|
+
|
589
|
+
post_body = request_options[:debug_body]
|
590
|
+
|
591
|
+
new_options = request_options.merge(
|
592
|
+
:operation => :'IngestionClient.enable_task',
|
593
|
+
:header_params => header_params,
|
594
|
+
:query_params => query_params,
|
595
|
+
:body => post_body,
|
596
|
+
:use_read_transporter => false
|
597
|
+
)
|
598
|
+
|
599
|
+
@api_client.call_api(:PUT, path, new_options)
|
600
|
+
end
|
601
|
+
|
602
|
+
# Enable a task.
|
603
|
+
# Enable the task of the given taskID.
|
604
|
+
# @param task_id [String] The task UUID. (required)
|
605
|
+
# @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
|
+
# @return [TaskUpdateResponse]
|
607
|
+
def enable_task(task_id, request_options = {})
|
608
|
+
response = enable_task_with_http_info(task_id, request_options)
|
609
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
|
610
|
+
end
|
611
|
+
|
612
|
+
# Get a authentication.
|
613
|
+
# Get the authentication of the given authenticationID.
|
614
|
+
# @param authentication_id [String] The authentication UUID. (required)
|
615
|
+
# @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
|
+
# @return [Http::Response] the response
|
617
|
+
def get_authentication_with_http_info(authentication_id, request_options = {})
|
618
|
+
# verify the required parameter 'authentication_id' is set
|
619
|
+
if @api_client.config.client_side_validation && authentication_id.nil?
|
620
|
+
raise ArgumentError, "Parameter `authentication_id` is required when calling `get_authentication`."
|
621
|
+
end
|
622
|
+
|
623
|
+
path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', @api_client.encode_uri(authentication_id.to_s))
|
624
|
+
query_params = {}
|
625
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
626
|
+
header_params = {}
|
627
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
628
|
+
|
629
|
+
post_body = request_options[:debug_body]
|
630
|
+
|
631
|
+
new_options = request_options.merge(
|
632
|
+
:operation => :'IngestionClient.get_authentication',
|
633
|
+
:header_params => header_params,
|
634
|
+
:query_params => query_params,
|
635
|
+
:body => post_body,
|
636
|
+
:use_read_transporter => false
|
637
|
+
)
|
638
|
+
|
639
|
+
@api_client.call_api(:GET, path, new_options)
|
640
|
+
end
|
641
|
+
|
642
|
+
# Get a authentication.
|
643
|
+
# Get the authentication of the given authenticationID.
|
644
|
+
# @param authentication_id [String] The authentication UUID. (required)
|
645
|
+
# @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
|
+
# @return [Authentication]
|
647
|
+
def get_authentication(authentication_id, request_options = {})
|
648
|
+
response = get_authentication_with_http_info(authentication_id, request_options)
|
649
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Authentication')
|
650
|
+
end
|
651
|
+
|
652
|
+
# Get a list of authentications.
|
653
|
+
# Get a list of authentications for the given query parameters, with pagination details.
|
654
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
655
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
656
|
+
# @param type [Array<AuthenticationType>] The type of the authentications to retrieve.
|
657
|
+
# @param platform [Array<PlatformWithNone>] The platform of the authentications to retrieve.
|
658
|
+
# @param sort [AuthenticationSortKeys] The key by which the list should be sorted.
|
659
|
+
# @param order [OrderKeys] The order of the returned list.
|
660
|
+
# @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)
|
661
|
+
# @return [Http::Response] the response
|
662
|
+
def get_authentications_with_http_info(items_per_page = nil, page = nil, type = nil, platform = nil, sort = nil, order = nil, request_options = {})
|
663
|
+
path = '/1/authentications'
|
664
|
+
query_params = {}
|
665
|
+
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
666
|
+
query_params[:page] = page unless page.nil?
|
667
|
+
query_params[:type] = @api_client.build_collection_param(type, :csv) unless type.nil?
|
668
|
+
query_params[:platform] = @api_client.build_collection_param(platform, :csv) unless platform.nil?
|
669
|
+
query_params[:sort] = sort unless sort.nil?
|
670
|
+
query_params[:order] = order unless order.nil?
|
671
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
672
|
+
header_params = {}
|
673
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
674
|
+
|
675
|
+
post_body = request_options[:debug_body]
|
676
|
+
|
677
|
+
new_options = request_options.merge(
|
678
|
+
:operation => :'IngestionClient.get_authentications',
|
679
|
+
:header_params => header_params,
|
680
|
+
:query_params => query_params,
|
681
|
+
:body => post_body,
|
682
|
+
:use_read_transporter => false
|
683
|
+
)
|
684
|
+
|
685
|
+
@api_client.call_api(:GET, path, new_options)
|
686
|
+
end
|
687
|
+
|
688
|
+
# Get a list of authentications.
|
689
|
+
# Get a list of authentications for the given query parameters, with pagination details.
|
690
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
691
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
692
|
+
# @param type [Array<AuthenticationType>] The type of the authentications to retrieve.
|
693
|
+
# @param platform [Array<PlatformWithNone>] The platform of the authentications to retrieve.
|
694
|
+
# @param sort [AuthenticationSortKeys] The key by which the list should be sorted.
|
695
|
+
# @param order [OrderKeys] The order of the returned list.
|
696
|
+
# @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)
|
697
|
+
# @return [ListAuthenticationsResponse]
|
698
|
+
def get_authentications(items_per_page = nil, page = nil, type = nil, platform = nil, sort = nil, order = nil, request_options = {})
|
699
|
+
response = get_authentications_with_http_info(items_per_page, page, type, platform, sort, order, request_options)
|
700
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListAuthenticationsResponse')
|
701
|
+
end
|
702
|
+
|
703
|
+
# Get a destination.
|
704
|
+
# Get the destination of the given destinationID.
|
705
|
+
# @param destination_id [String] The destination UUID. (required)
|
706
|
+
# @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
|
+
# @return [Http::Response] the response
|
708
|
+
def get_destination_with_http_info(destination_id, request_options = {})
|
709
|
+
# verify the required parameter 'destination_id' is set
|
710
|
+
if @api_client.config.client_side_validation && destination_id.nil?
|
711
|
+
raise ArgumentError, "Parameter `destination_id` is required when calling `get_destination`."
|
712
|
+
end
|
713
|
+
|
714
|
+
path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', @api_client.encode_uri(destination_id.to_s))
|
715
|
+
query_params = {}
|
716
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
717
|
+
header_params = {}
|
718
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
719
|
+
|
720
|
+
post_body = request_options[:debug_body]
|
721
|
+
|
722
|
+
new_options = request_options.merge(
|
723
|
+
:operation => :'IngestionClient.get_destination',
|
724
|
+
:header_params => header_params,
|
725
|
+
:query_params => query_params,
|
726
|
+
:body => post_body,
|
727
|
+
:use_read_transporter => false
|
728
|
+
)
|
729
|
+
|
730
|
+
@api_client.call_api(:GET, path, new_options)
|
731
|
+
end
|
732
|
+
|
733
|
+
# Get a destination.
|
734
|
+
# Get the destination of the given destinationID.
|
735
|
+
# @param destination_id [String] The destination UUID. (required)
|
736
|
+
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
737
|
+
# @return [Destination]
|
738
|
+
def get_destination(destination_id, request_options = {})
|
739
|
+
response = get_destination_with_http_info(destination_id, request_options)
|
740
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Destination')
|
741
|
+
end
|
742
|
+
|
743
|
+
# Get a list of destinations.
|
744
|
+
# Get a list of destinations for the given query parameters, with pagination details.
|
745
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
746
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
747
|
+
# @param type [Array<DestinationType>] The type of the destinations to retrive.
|
748
|
+
# @param authentication_id [Array<String>] The authenticationIDs of the destinations to retrive.
|
749
|
+
# @param sort [DestinationSortKeys] The key by which the list should be sorted.
|
750
|
+
# @param order [OrderKeys] The order of the returned list.
|
751
|
+
# @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)
|
752
|
+
# @return [Http::Response] the response
|
753
|
+
def get_destinations_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
|
754
|
+
path = '/1/destinations'
|
755
|
+
query_params = {}
|
756
|
+
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
757
|
+
query_params[:page] = page unless page.nil?
|
758
|
+
query_params[:type] = @api_client.build_collection_param(type, :csv) unless type.nil?
|
759
|
+
query_params[:authenticationID] = @api_client.build_collection_param(authentication_id, :csv) unless authentication_id.nil?
|
760
|
+
query_params[:sort] = sort unless sort.nil?
|
761
|
+
query_params[:order] = order unless order.nil?
|
762
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
763
|
+
header_params = {}
|
764
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
765
|
+
|
766
|
+
post_body = request_options[:debug_body]
|
767
|
+
|
768
|
+
new_options = request_options.merge(
|
769
|
+
:operation => :'IngestionClient.get_destinations',
|
770
|
+
:header_params => header_params,
|
771
|
+
:query_params => query_params,
|
772
|
+
:body => post_body,
|
773
|
+
:use_read_transporter => false
|
774
|
+
)
|
775
|
+
|
776
|
+
@api_client.call_api(:GET, path, new_options)
|
777
|
+
end
|
778
|
+
|
779
|
+
# Get a list of destinations.
|
780
|
+
# Get a list of destinations for the given query parameters, with pagination details.
|
781
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
782
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
783
|
+
# @param type [Array<DestinationType>] The type of the destinations to retrive.
|
784
|
+
# @param authentication_id [Array<String>] The authenticationIDs of the destinations to retrive.
|
785
|
+
# @param sort [DestinationSortKeys] The key by which the list should be sorted.
|
786
|
+
# @param order [OrderKeys] The order of the returned list.
|
787
|
+
# @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)
|
788
|
+
# @return [ListDestinationsResponse]
|
789
|
+
def get_destinations(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
|
790
|
+
response = get_destinations_with_http_info(items_per_page, page, type, authentication_id, sort, order, request_options)
|
791
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListDestinationsResponse')
|
792
|
+
end
|
793
|
+
|
794
|
+
# Retrieve a stream listing.
|
795
|
+
# Retrieve a stream listing for a given Singer specification compatible docker type source ID.
|
796
|
+
# @param source_id [String] The source UUID. (required)
|
797
|
+
# @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
|
+
# @return [Http::Response] the response
|
799
|
+
def get_docker_source_streams_with_http_info(source_id, request_options = {})
|
800
|
+
# verify the required parameter 'source_id' is set
|
801
|
+
if @api_client.config.client_side_validation && source_id.nil?
|
802
|
+
raise ArgumentError, "Parameter `source_id` is required when calling `get_docker_source_streams`."
|
803
|
+
end
|
804
|
+
|
805
|
+
path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
|
806
|
+
query_params = {}
|
807
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
808
|
+
header_params = {}
|
809
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
810
|
+
|
811
|
+
post_body = request_options[:debug_body]
|
812
|
+
|
813
|
+
new_options = request_options.merge(
|
814
|
+
:operation => :'IngestionClient.get_docker_source_streams',
|
815
|
+
:header_params => header_params,
|
816
|
+
:query_params => query_params,
|
817
|
+
:body => post_body,
|
818
|
+
:use_read_transporter => false
|
819
|
+
)
|
820
|
+
|
821
|
+
@api_client.call_api(:GET, path, new_options)
|
822
|
+
end
|
823
|
+
|
824
|
+
# Retrieve a stream listing.
|
825
|
+
# Retrieve a stream listing for a given Singer specification compatible docker type source ID.
|
826
|
+
# @param source_id [String] The source UUID. (required)
|
827
|
+
# @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
|
+
# @return [DockerSourceStreams]
|
829
|
+
def get_docker_source_streams(source_id, request_options = {})
|
830
|
+
response = get_docker_source_streams_with_http_info(source_id, request_options)
|
831
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceStreams')
|
832
|
+
end
|
833
|
+
|
834
|
+
# Get an event.
|
835
|
+
# Get a single event for a specific runID.
|
836
|
+
# @param run_id [String] The run UUID. (required)
|
837
|
+
# @param event_id [String] The event UUID. (required)
|
838
|
+
# @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)
|
839
|
+
# @return [Http::Response] the response
|
840
|
+
def get_event_with_http_info(run_id, event_id, request_options = {})
|
841
|
+
# verify the required parameter 'run_id' is set
|
842
|
+
if @api_client.config.client_side_validation && run_id.nil?
|
843
|
+
raise ArgumentError, "Parameter `run_id` is required when calling `get_event`."
|
844
|
+
end
|
845
|
+
# verify the required parameter 'event_id' is set
|
846
|
+
if @api_client.config.client_side_validation && event_id.nil?
|
847
|
+
raise ArgumentError, "Parameter `event_id` is required when calling `get_event`."
|
848
|
+
end
|
849
|
+
|
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))
|
851
|
+
query_params = {}
|
852
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
853
|
+
header_params = {}
|
854
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
855
|
+
|
856
|
+
post_body = request_options[:debug_body]
|
857
|
+
|
858
|
+
new_options = request_options.merge(
|
859
|
+
:operation => :'IngestionClient.get_event',
|
860
|
+
:header_params => header_params,
|
861
|
+
:query_params => query_params,
|
862
|
+
:body => post_body,
|
863
|
+
:use_read_transporter => false
|
864
|
+
)
|
865
|
+
|
866
|
+
@api_client.call_api(:GET, path, new_options)
|
867
|
+
end
|
868
|
+
|
869
|
+
# Get an event.
|
870
|
+
# Get a single event for a specific runID.
|
871
|
+
# @param run_id [String] The run UUID. (required)
|
872
|
+
# @param event_id [String] The event UUID. (required)
|
873
|
+
# @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)
|
874
|
+
# @return [Event]
|
875
|
+
def get_event(run_id, event_id, request_options = {})
|
876
|
+
response = get_event_with_http_info(run_id, event_id, request_options)
|
877
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Event')
|
878
|
+
end
|
879
|
+
|
880
|
+
# Get a list of events.
|
881
|
+
# Get a list of events associated to the given runID, for the given query parameters.
|
882
|
+
# @param run_id [String] The run UUID. (required)
|
883
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
884
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
885
|
+
# @param status [Array<EventStatus>] Filter the status of the events.
|
886
|
+
# @param type [Array<EventType>] Filter the type of the events.
|
887
|
+
# @param sort [EventSortKeys] The key by which the list should be sorted.
|
888
|
+
# @param order [OrderKeys] The order of the returned list.
|
889
|
+
# @param start_date [String] The start date (in RFC3339 format) of the events fetching window. Defaults to 'now'-3 hours if omitted.
|
890
|
+
# @param end_date [String] The end date (in RFC3339 format) of the events fetching window. Defaults to 'now' days if omitted.
|
891
|
+
# @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)
|
892
|
+
# @return [Http::Response] the response
|
893
|
+
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,
|
894
|
+
request_options = {})
|
895
|
+
# verify the required parameter 'run_id' is set
|
896
|
+
if @api_client.config.client_side_validation && run_id.nil?
|
897
|
+
raise ArgumentError, "Parameter `run_id` is required when calling `get_events`."
|
898
|
+
end
|
899
|
+
|
900
|
+
path = '/1/runs/{runID}/events'.sub('{' + 'runID' + '}', @api_client.encode_uri(run_id.to_s))
|
901
|
+
query_params = {}
|
902
|
+
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
903
|
+
query_params[:page] = page unless page.nil?
|
904
|
+
query_params[:status] = @api_client.build_collection_param(status, :multi) unless status.nil?
|
905
|
+
query_params[:type] = @api_client.build_collection_param(type, :multi) unless type.nil?
|
906
|
+
query_params[:sort] = sort unless sort.nil?
|
907
|
+
query_params[:order] = order unless order.nil?
|
908
|
+
query_params[:startDate] = start_date unless start_date.nil?
|
909
|
+
query_params[:endDate] = end_date unless end_date.nil?
|
910
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
911
|
+
header_params = {}
|
912
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
913
|
+
|
914
|
+
post_body = request_options[:debug_body]
|
915
|
+
|
916
|
+
new_options = request_options.merge(
|
917
|
+
:operation => :'IngestionClient.get_events',
|
918
|
+
:header_params => header_params,
|
919
|
+
:query_params => query_params,
|
920
|
+
:body => post_body,
|
921
|
+
:use_read_transporter => false
|
922
|
+
)
|
923
|
+
|
924
|
+
@api_client.call_api(:GET, path, new_options)
|
925
|
+
end
|
926
|
+
|
927
|
+
# Get a list of events.
|
928
|
+
# Get a list of events associated to the given runID, for the given query parameters.
|
929
|
+
# @param run_id [String] The run UUID. (required)
|
930
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
931
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
932
|
+
# @param status [Array<EventStatus>] Filter the status of the events.
|
933
|
+
# @param type [Array<EventType>] Filter the type of the events.
|
934
|
+
# @param sort [EventSortKeys] The key by which the list should be sorted.
|
935
|
+
# @param order [OrderKeys] The order of the returned list.
|
936
|
+
# @param start_date [String] The start date (in RFC3339 format) of the events fetching window. Defaults to 'now'-3 hours if omitted.
|
937
|
+
# @param end_date [String] The end date (in RFC3339 format) of the events fetching window. Defaults to 'now' days if omitted.
|
938
|
+
# @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)
|
939
|
+
# @return [ListEventsResponse]
|
940
|
+
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 = {})
|
941
|
+
response = get_events_with_http_info(run_id, items_per_page, page, status, type, sort, order, start_date, end_date, request_options)
|
942
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListEventsResponse')
|
943
|
+
end
|
944
|
+
|
945
|
+
# Get a run.
|
946
|
+
# Get a single run for the given ID.
|
947
|
+
# @param run_id [String] The run UUID. (required)
|
948
|
+
# @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
|
+
# @return [Http::Response] the response
|
950
|
+
def get_run_with_http_info(run_id, request_options = {})
|
951
|
+
# verify the required parameter 'run_id' is set
|
952
|
+
if @api_client.config.client_side_validation && run_id.nil?
|
953
|
+
raise ArgumentError, "Parameter `run_id` is required when calling `get_run`."
|
954
|
+
end
|
955
|
+
|
956
|
+
path = '/1/runs/{runID}'.sub('{' + 'runID' + '}', @api_client.encode_uri(run_id.to_s))
|
957
|
+
query_params = {}
|
958
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
959
|
+
header_params = {}
|
960
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
961
|
+
|
962
|
+
post_body = request_options[:debug_body]
|
963
|
+
|
964
|
+
new_options = request_options.merge(
|
965
|
+
:operation => :'IngestionClient.get_run',
|
966
|
+
:header_params => header_params,
|
967
|
+
:query_params => query_params,
|
968
|
+
:body => post_body,
|
969
|
+
:use_read_transporter => false
|
970
|
+
)
|
971
|
+
|
972
|
+
@api_client.call_api(:GET, path, new_options)
|
973
|
+
end
|
974
|
+
|
975
|
+
# Get a run.
|
976
|
+
# Get a single run for the given ID.
|
977
|
+
# @param run_id [String] The run UUID. (required)
|
978
|
+
# @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
|
+
# @return [Run]
|
980
|
+
def get_run(run_id, request_options = {})
|
981
|
+
response = get_run_with_http_info(run_id, request_options)
|
982
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Run')
|
983
|
+
end
|
984
|
+
|
985
|
+
# Get a list of runs.
|
986
|
+
# Get a list of runs for the given query parameters, with pagination details.
|
987
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
988
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
989
|
+
# @param status [Array<RunStatus>] Filter the status of the runs.
|
990
|
+
# @param task_id [String] Filter by taskID.
|
991
|
+
# @param sort [RunSortKeys] The key by which the list should be sorted.
|
992
|
+
# @param order [OrderKeys] The order of the returned list.
|
993
|
+
# @param start_date [String] The start date (in RFC3339 format) of the runs fetching window. Defaults to 'now'-7 days if omitted.
|
994
|
+
# @param end_date [String] The end date (in RFC3339 format) of the runs fetching window. Defaults to 'now' days if omitted.
|
995
|
+
# @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)
|
996
|
+
# @return [Http::Response] the response
|
997
|
+
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 = {})
|
998
|
+
path = '/1/runs'
|
999
|
+
query_params = {}
|
1000
|
+
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
1001
|
+
query_params[:page] = page unless page.nil?
|
1002
|
+
query_params[:status] = @api_client.build_collection_param(status, :multi) unless status.nil?
|
1003
|
+
query_params[:taskID] = task_id unless task_id.nil?
|
1004
|
+
query_params[:sort] = sort unless sort.nil?
|
1005
|
+
query_params[:order] = order unless order.nil?
|
1006
|
+
query_params[:startDate] = start_date unless start_date.nil?
|
1007
|
+
query_params[:endDate] = end_date unless end_date.nil?
|
1008
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1009
|
+
header_params = {}
|
1010
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1011
|
+
|
1012
|
+
post_body = request_options[:debug_body]
|
1013
|
+
|
1014
|
+
new_options = request_options.merge(
|
1015
|
+
:operation => :'IngestionClient.get_runs',
|
1016
|
+
:header_params => header_params,
|
1017
|
+
:query_params => query_params,
|
1018
|
+
:body => post_body,
|
1019
|
+
:use_read_transporter => false
|
1020
|
+
)
|
1021
|
+
|
1022
|
+
@api_client.call_api(:GET, path, new_options)
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
# Get a list of runs.
|
1026
|
+
# Get a list of runs for the given query parameters, with pagination details.
|
1027
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
1028
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
1029
|
+
# @param status [Array<RunStatus>] Filter the status of the runs.
|
1030
|
+
# @param task_id [String] Filter by taskID.
|
1031
|
+
# @param sort [RunSortKeys] The key by which the list should be sorted.
|
1032
|
+
# @param order [OrderKeys] The order of the returned list.
|
1033
|
+
# @param start_date [String] The start date (in RFC3339 format) of the runs fetching window. Defaults to 'now'-7 days if omitted.
|
1034
|
+
# @param end_date [String] The end date (in RFC3339 format) of the runs fetching window. Defaults to 'now' days if omitted.
|
1035
|
+
# @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)
|
1036
|
+
# @return [RunListResponse]
|
1037
|
+
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 = {})
|
1038
|
+
response = get_runs_with_http_info(items_per_page, page, status, task_id, sort, order, start_date, end_date, request_options)
|
1039
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::RunListResponse')
|
1040
|
+
end
|
1041
|
+
|
1042
|
+
# Get a source.
|
1043
|
+
# Get the source of the given sourceID.
|
1044
|
+
# @param source_id [String] The source UUID. (required)
|
1045
|
+
# @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
|
+
# @return [Http::Response] the response
|
1047
|
+
def get_source_with_http_info(source_id, request_options = {})
|
1048
|
+
# verify the required parameter 'source_id' is set
|
1049
|
+
if @api_client.config.client_side_validation && source_id.nil?
|
1050
|
+
raise ArgumentError, "Parameter `source_id` is required when calling `get_source`."
|
1051
|
+
end
|
1052
|
+
|
1053
|
+
path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
|
1054
|
+
query_params = {}
|
1055
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1056
|
+
header_params = {}
|
1057
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1058
|
+
|
1059
|
+
post_body = request_options[:debug_body]
|
1060
|
+
|
1061
|
+
new_options = request_options.merge(
|
1062
|
+
:operation => :'IngestionClient.get_source',
|
1063
|
+
:header_params => header_params,
|
1064
|
+
:query_params => query_params,
|
1065
|
+
:body => post_body,
|
1066
|
+
:use_read_transporter => false
|
1067
|
+
)
|
1068
|
+
|
1069
|
+
@api_client.call_api(:GET, path, new_options)
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Get a source.
|
1073
|
+
# Get the source of the given sourceID.
|
1074
|
+
# @param source_id [String] The source UUID. (required)
|
1075
|
+
# @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
|
+
# @return [Source]
|
1077
|
+
def get_source(source_id, request_options = {})
|
1078
|
+
response = get_source_with_http_info(source_id, request_options)
|
1079
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Source')
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# Get a list of sources.
|
1083
|
+
# Get a list of sources for the given query parameters, with pagination details.
|
1084
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
1085
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
1086
|
+
# @param type [Array<SourceType>] The type of the sources to retrieve.
|
1087
|
+
# @param authentication_id [Array<String>] The authenticationIDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication.
|
1088
|
+
# @param sort [SourceSortKeys] The key by which the list should be sorted.
|
1089
|
+
# @param order [OrderKeys] The order of the returned list.
|
1090
|
+
# @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)
|
1091
|
+
# @return [Http::Response] the response
|
1092
|
+
def get_sources_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
|
1093
|
+
path = '/1/sources'
|
1094
|
+
query_params = {}
|
1095
|
+
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
1096
|
+
query_params[:page] = page unless page.nil?
|
1097
|
+
query_params[:type] = @api_client.build_collection_param(type, :csv) unless type.nil?
|
1098
|
+
query_params[:authenticationID] = @api_client.build_collection_param(authentication_id, :csv) unless authentication_id.nil?
|
1099
|
+
query_params[:sort] = sort unless sort.nil?
|
1100
|
+
query_params[:order] = order unless order.nil?
|
1101
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1102
|
+
header_params = {}
|
1103
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1104
|
+
|
1105
|
+
post_body = request_options[:debug_body]
|
1106
|
+
|
1107
|
+
new_options = request_options.merge(
|
1108
|
+
:operation => :'IngestionClient.get_sources',
|
1109
|
+
:header_params => header_params,
|
1110
|
+
:query_params => query_params,
|
1111
|
+
:body => post_body,
|
1112
|
+
:use_read_transporter => false
|
1113
|
+
)
|
1114
|
+
|
1115
|
+
@api_client.call_api(:GET, path, new_options)
|
1116
|
+
end
|
1117
|
+
|
1118
|
+
# Get a list of sources.
|
1119
|
+
# Get a list of sources for the given query parameters, with pagination details.
|
1120
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
1121
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
1122
|
+
# @param type [Array<SourceType>] The type of the sources to retrieve.
|
1123
|
+
# @param authentication_id [Array<String>] The authenticationIDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication.
|
1124
|
+
# @param sort [SourceSortKeys] The key by which the list should be sorted.
|
1125
|
+
# @param order [OrderKeys] The order of the returned list.
|
1126
|
+
# @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)
|
1127
|
+
# @return [ListSourcesResponse]
|
1128
|
+
def get_sources(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
|
1129
|
+
response = get_sources_with_http_info(items_per_page, page, type, authentication_id, sort, order, request_options)
|
1130
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListSourcesResponse')
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
# Get a task.
|
1134
|
+
# Get the task of the given taskID.
|
1135
|
+
# @param task_id [String] The task UUID. (required)
|
1136
|
+
# @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
|
+
# @return [Http::Response] the response
|
1138
|
+
def get_task_with_http_info(task_id, request_options = {})
|
1139
|
+
# verify the required parameter 'task_id' is set
|
1140
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
1141
|
+
raise ArgumentError, "Parameter `task_id` is required when calling `get_task`."
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
|
1145
|
+
query_params = {}
|
1146
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1147
|
+
header_params = {}
|
1148
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1149
|
+
|
1150
|
+
post_body = request_options[:debug_body]
|
1151
|
+
|
1152
|
+
new_options = request_options.merge(
|
1153
|
+
:operation => :'IngestionClient.get_task',
|
1154
|
+
:header_params => header_params,
|
1155
|
+
:query_params => query_params,
|
1156
|
+
:body => post_body,
|
1157
|
+
:use_read_transporter => false
|
1158
|
+
)
|
1159
|
+
|
1160
|
+
@api_client.call_api(:GET, path, new_options)
|
1161
|
+
end
|
1162
|
+
|
1163
|
+
# Get a task.
|
1164
|
+
# Get the task of the given taskID.
|
1165
|
+
# @param task_id [String] The task UUID. (required)
|
1166
|
+
# @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
|
+
# @return [Task]
|
1168
|
+
def get_task(task_id, request_options = {})
|
1169
|
+
response = get_task_with_http_info(task_id, request_options)
|
1170
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Task')
|
1171
|
+
end
|
1172
|
+
|
1173
|
+
# Get a list of tasks.
|
1174
|
+
# Get a list of tasks for the given query parameters, with pagination details.
|
1175
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
1176
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
1177
|
+
# @param action [Array<ActionType>] The action of the tasks to retrieve.
|
1178
|
+
# @param enabled [Boolean] Whether the task is enabled or not.
|
1179
|
+
# @param source_id [Array<String>] The sourceIDs of the tasks to retrive.
|
1180
|
+
# @param destination_id [Array<String>] The destinationIDs of the tasks to retrive.
|
1181
|
+
# @param trigger_type [Array<TriggerType>] The trigger type of the task.
|
1182
|
+
# @param sort [TaskSortKeys] The key by which the list should be sorted.
|
1183
|
+
# @param order [OrderKeys] The order of the returned list.
|
1184
|
+
# @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)
|
1185
|
+
# @return [Http::Response] the response
|
1186
|
+
def get_tasks_with_http_info(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, destination_id = nil, trigger_type = nil, sort = nil, order = nil,
|
1187
|
+
request_options = {})
|
1188
|
+
path = '/1/tasks'
|
1189
|
+
query_params = {}
|
1190
|
+
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
1191
|
+
query_params[:page] = page unless page.nil?
|
1192
|
+
query_params[:action] = @api_client.build_collection_param(action, :csv) unless action.nil?
|
1193
|
+
query_params[:enabled] = enabled unless enabled.nil?
|
1194
|
+
query_params[:sourceID] = @api_client.build_collection_param(source_id, :csv) unless source_id.nil?
|
1195
|
+
query_params[:destinationID] = @api_client.build_collection_param(destination_id, :csv) unless destination_id.nil?
|
1196
|
+
query_params[:triggerType] = @api_client.build_collection_param(trigger_type, :csv) unless trigger_type.nil?
|
1197
|
+
query_params[:sort] = sort unless sort.nil?
|
1198
|
+
query_params[:order] = order unless order.nil?
|
1199
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1200
|
+
header_params = {}
|
1201
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1202
|
+
|
1203
|
+
post_body = request_options[:debug_body]
|
1204
|
+
|
1205
|
+
new_options = request_options.merge(
|
1206
|
+
:operation => :'IngestionClient.get_tasks',
|
1207
|
+
:header_params => header_params,
|
1208
|
+
:query_params => query_params,
|
1209
|
+
:body => post_body,
|
1210
|
+
:use_read_transporter => false
|
1211
|
+
)
|
1212
|
+
|
1213
|
+
@api_client.call_api(:GET, path, new_options)
|
1214
|
+
end
|
1215
|
+
|
1216
|
+
# Get a list of tasks.
|
1217
|
+
# Get a list of tasks for the given query parameters, with pagination details.
|
1218
|
+
# @param items_per_page [Integer] The number of items per page to return.
|
1219
|
+
# @param page [Integer] The page number to fetch, starting at 1.
|
1220
|
+
# @param action [Array<ActionType>] The action of the tasks to retrieve.
|
1221
|
+
# @param enabled [Boolean] Whether the task is enabled or not.
|
1222
|
+
# @param source_id [Array<String>] The sourceIDs of the tasks to retrive.
|
1223
|
+
# @param destination_id [Array<String>] The destinationIDs of the tasks to retrive.
|
1224
|
+
# @param trigger_type [Array<TriggerType>] The trigger type of the task.
|
1225
|
+
# @param sort [TaskSortKeys] The key by which the list should be sorted.
|
1226
|
+
# @param order [OrderKeys] The order of the returned list.
|
1227
|
+
# @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)
|
1228
|
+
# @return [ListTasksResponse]
|
1229
|
+
def get_tasks(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, destination_id = nil, trigger_type = nil, sort = nil, order = nil,
|
1230
|
+
request_options = {})
|
1231
|
+
response = get_tasks_with_http_info(items_per_page, page, action, enabled, source_id, destination_id, trigger_type, sort, order, request_options)
|
1232
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListTasksResponse')
|
1233
|
+
end
|
1234
|
+
|
1235
|
+
# Run a task.
|
1236
|
+
# Run the task of the given taskID.
|
1237
|
+
# @param task_id [String] The task UUID. (required)
|
1238
|
+
# @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
|
+
# @return [Http::Response] the response
|
1240
|
+
def run_task_with_http_info(task_id, request_options = {})
|
1241
|
+
# verify the required parameter 'task_id' is set
|
1242
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
1243
|
+
raise ArgumentError, "Parameter `task_id` is required when calling `run_task`."
|
1244
|
+
end
|
1245
|
+
|
1246
|
+
path = '/1/tasks/{taskID}/run'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
|
1247
|
+
query_params = {}
|
1248
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1249
|
+
header_params = {}
|
1250
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1251
|
+
|
1252
|
+
post_body = request_options[:debug_body]
|
1253
|
+
|
1254
|
+
new_options = request_options.merge(
|
1255
|
+
:operation => :'IngestionClient.run_task',
|
1256
|
+
:header_params => header_params,
|
1257
|
+
:query_params => query_params,
|
1258
|
+
:body => post_body,
|
1259
|
+
:use_read_transporter => false
|
1260
|
+
)
|
1261
|
+
|
1262
|
+
@api_client.call_api(:POST, path, new_options)
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
# Run a task.
|
1266
|
+
# Run the task of the given taskID.
|
1267
|
+
# @param task_id [String] The task UUID. (required)
|
1268
|
+
# @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
|
+
# @return [RunResponse]
|
1270
|
+
def run_task(task_id, request_options = {})
|
1271
|
+
response = run_task_with_http_info(task_id, request_options)
|
1272
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::RunResponse')
|
1273
|
+
end
|
1274
|
+
|
1275
|
+
# Search among authentications.
|
1276
|
+
# Search among authentications with a defined set of parameters.
|
1277
|
+
# @param authentication_search [AuthenticationSearch] (required)
|
1278
|
+
# @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
|
+
# @return [Http::Response] the response
|
1280
|
+
def search_authentications_with_http_info(authentication_search, request_options = {})
|
1281
|
+
# verify the required parameter 'authentication_search' is set
|
1282
|
+
if @api_client.config.client_side_validation && authentication_search.nil?
|
1283
|
+
raise ArgumentError, "Parameter `authentication_search` is required when calling `search_authentications`."
|
1284
|
+
end
|
1285
|
+
|
1286
|
+
path = '/1/authentications/search'
|
1287
|
+
query_params = {}
|
1288
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1289
|
+
header_params = {}
|
1290
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1291
|
+
|
1292
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(authentication_search)
|
1293
|
+
|
1294
|
+
new_options = request_options.merge(
|
1295
|
+
:operation => :'IngestionClient.search_authentications',
|
1296
|
+
:header_params => header_params,
|
1297
|
+
:query_params => query_params,
|
1298
|
+
:body => post_body,
|
1299
|
+
:use_read_transporter => false
|
1300
|
+
)
|
1301
|
+
|
1302
|
+
@api_client.call_api(:POST, path, new_options)
|
1303
|
+
end
|
1304
|
+
|
1305
|
+
# Search among authentications.
|
1306
|
+
# Search among authentications with a defined set of parameters.
|
1307
|
+
# @param authentication_search [AuthenticationSearch] (required)
|
1308
|
+
# @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
|
+
# @return [Array<Authentication>]
|
1310
|
+
def search_authentications(authentication_search, request_options = {})
|
1311
|
+
response = search_authentications_with_http_info(authentication_search, request_options)
|
1312
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Authentication>')
|
1313
|
+
end
|
1314
|
+
|
1315
|
+
# Search among destinations.
|
1316
|
+
# Search among destinations with a defined set of parameters.
|
1317
|
+
# @param destination_search [DestinationSearch] (required)
|
1318
|
+
# @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
|
+
# @return [Http::Response] the response
|
1320
|
+
def search_destinations_with_http_info(destination_search, request_options = {})
|
1321
|
+
# verify the required parameter 'destination_search' is set
|
1322
|
+
if @api_client.config.client_side_validation && destination_search.nil?
|
1323
|
+
raise ArgumentError, "Parameter `destination_search` is required when calling `search_destinations`."
|
1324
|
+
end
|
1325
|
+
|
1326
|
+
path = '/1/destinations/search'
|
1327
|
+
query_params = {}
|
1328
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1329
|
+
header_params = {}
|
1330
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1331
|
+
|
1332
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(destination_search)
|
1333
|
+
|
1334
|
+
new_options = request_options.merge(
|
1335
|
+
:operation => :'IngestionClient.search_destinations',
|
1336
|
+
:header_params => header_params,
|
1337
|
+
:query_params => query_params,
|
1338
|
+
:body => post_body,
|
1339
|
+
:use_read_transporter => false
|
1340
|
+
)
|
1341
|
+
|
1342
|
+
@api_client.call_api(:POST, path, new_options)
|
1343
|
+
end
|
1344
|
+
|
1345
|
+
# Search among destinations.
|
1346
|
+
# Search among destinations with a defined set of parameters.
|
1347
|
+
# @param destination_search [DestinationSearch] (required)
|
1348
|
+
# @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
|
+
# @return [Array<Destination>]
|
1350
|
+
def search_destinations(destination_search, request_options = {})
|
1351
|
+
response = search_destinations_with_http_info(destination_search, request_options)
|
1352
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Destination>')
|
1353
|
+
end
|
1354
|
+
|
1355
|
+
# Search among sources.
|
1356
|
+
# Search among sources with a defined set of parameters.
|
1357
|
+
# @param source_search [SourceSearch] (required)
|
1358
|
+
# @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
|
+
# @return [Http::Response] the response
|
1360
|
+
def search_sources_with_http_info(source_search, request_options = {})
|
1361
|
+
# verify the required parameter 'source_search' is set
|
1362
|
+
if @api_client.config.client_side_validation && source_search.nil?
|
1363
|
+
raise ArgumentError, "Parameter `source_search` is required when calling `search_sources`."
|
1364
|
+
end
|
1365
|
+
|
1366
|
+
path = '/1/sources/search'
|
1367
|
+
query_params = {}
|
1368
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1369
|
+
header_params = {}
|
1370
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1371
|
+
|
1372
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_search)
|
1373
|
+
|
1374
|
+
new_options = request_options.merge(
|
1375
|
+
:operation => :'IngestionClient.search_sources',
|
1376
|
+
:header_params => header_params,
|
1377
|
+
:query_params => query_params,
|
1378
|
+
:body => post_body,
|
1379
|
+
:use_read_transporter => false
|
1380
|
+
)
|
1381
|
+
|
1382
|
+
@api_client.call_api(:POST, path, new_options)
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
# Search among sources.
|
1386
|
+
# Search among sources with a defined set of parameters.
|
1387
|
+
# @param source_search [SourceSearch] (required)
|
1388
|
+
# @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
|
+
# @return [Array<Source>]
|
1390
|
+
def search_sources(source_search, request_options = {})
|
1391
|
+
response = search_sources_with_http_info(source_search, request_options)
|
1392
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Source>')
|
1393
|
+
end
|
1394
|
+
|
1395
|
+
# Search among tasks.
|
1396
|
+
# Search among tasks with a defined set of parameters.
|
1397
|
+
# @param task_search [TaskSearch] (required)
|
1398
|
+
# @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
|
+
# @return [Http::Response] the response
|
1400
|
+
def search_tasks_with_http_info(task_search, request_options = {})
|
1401
|
+
# verify the required parameter 'task_search' is set
|
1402
|
+
if @api_client.config.client_side_validation && task_search.nil?
|
1403
|
+
raise ArgumentError, "Parameter `task_search` is required when calling `search_tasks`."
|
1404
|
+
end
|
1405
|
+
|
1406
|
+
path = '/1/tasks/search'
|
1407
|
+
query_params = {}
|
1408
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1409
|
+
header_params = {}
|
1410
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1411
|
+
|
1412
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(task_search)
|
1413
|
+
|
1414
|
+
new_options = request_options.merge(
|
1415
|
+
:operation => :'IngestionClient.search_tasks',
|
1416
|
+
:header_params => header_params,
|
1417
|
+
:query_params => query_params,
|
1418
|
+
:body => post_body,
|
1419
|
+
:use_read_transporter => false
|
1420
|
+
)
|
1421
|
+
|
1422
|
+
@api_client.call_api(:POST, path, new_options)
|
1423
|
+
end
|
1424
|
+
|
1425
|
+
# Search among tasks.
|
1426
|
+
# Search among tasks with a defined set of parameters.
|
1427
|
+
# @param task_search [TaskSearch] (required)
|
1428
|
+
# @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
|
+
# @return [Array<Task>]
|
1430
|
+
def search_tasks(task_search, request_options = {})
|
1431
|
+
response = search_tasks_with_http_info(task_search, request_options)
|
1432
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Task>')
|
1433
|
+
end
|
1434
|
+
|
1435
|
+
# Trigger a stream listing request.
|
1436
|
+
# Trigger a stream listing request for a Singer specification compatible docker type source.
|
1437
|
+
# @param source_id [String] The source UUID. (required)
|
1438
|
+
# @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
|
+
# @return [Http::Response] the response
|
1440
|
+
def trigger_docker_source_discover_with_http_info(source_id, request_options = {})
|
1441
|
+
# verify the required parameter 'source_id' is set
|
1442
|
+
if @api_client.config.client_side_validation && source_id.nil?
|
1443
|
+
raise ArgumentError, "Parameter `source_id` is required when calling `trigger_docker_source_discover`."
|
1444
|
+
end
|
1445
|
+
|
1446
|
+
path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
|
1447
|
+
query_params = {}
|
1448
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1449
|
+
header_params = {}
|
1450
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1451
|
+
|
1452
|
+
post_body = request_options[:debug_body]
|
1453
|
+
|
1454
|
+
new_options = request_options.merge(
|
1455
|
+
:operation => :'IngestionClient.trigger_docker_source_discover',
|
1456
|
+
:header_params => header_params,
|
1457
|
+
:query_params => query_params,
|
1458
|
+
:body => post_body,
|
1459
|
+
:use_read_transporter => false
|
1460
|
+
)
|
1461
|
+
|
1462
|
+
@api_client.call_api(:POST, path, new_options)
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
# Trigger a stream listing request.
|
1466
|
+
# Trigger a stream listing request for a Singer specification compatible docker type source.
|
1467
|
+
# @param source_id [String] The source UUID. (required)
|
1468
|
+
# @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
|
+
# @return [DockerSourceDiscover]
|
1470
|
+
def trigger_docker_source_discover(source_id, request_options = {})
|
1471
|
+
response = trigger_docker_source_discover_with_http_info(source_id, request_options)
|
1472
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceDiscover')
|
1473
|
+
end
|
1474
|
+
|
1475
|
+
# Update a authentication.
|
1476
|
+
# Update the authentication of the given authenticationID.
|
1477
|
+
# @param authentication_id [String] The authentication UUID. (required)
|
1478
|
+
# @param authentication_update [AuthenticationUpdate] (required)
|
1479
|
+
# @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)
|
1480
|
+
# @return [Http::Response] the response
|
1481
|
+
def update_authentication_with_http_info(authentication_id, authentication_update, request_options = {})
|
1482
|
+
# verify the required parameter 'authentication_id' is set
|
1483
|
+
if @api_client.config.client_side_validation && authentication_id.nil?
|
1484
|
+
raise ArgumentError, "Parameter `authentication_id` is required when calling `update_authentication`."
|
1485
|
+
end
|
1486
|
+
# verify the required parameter 'authentication_update' is set
|
1487
|
+
if @api_client.config.client_side_validation && authentication_update.nil?
|
1488
|
+
raise ArgumentError, "Parameter `authentication_update` is required when calling `update_authentication`."
|
1489
|
+
end
|
1490
|
+
|
1491
|
+
path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', @api_client.encode_uri(authentication_id.to_s))
|
1492
|
+
query_params = {}
|
1493
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1494
|
+
header_params = {}
|
1495
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1496
|
+
|
1497
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(authentication_update)
|
1498
|
+
|
1499
|
+
new_options = request_options.merge(
|
1500
|
+
:operation => :'IngestionClient.update_authentication',
|
1501
|
+
:header_params => header_params,
|
1502
|
+
:query_params => query_params,
|
1503
|
+
:body => post_body,
|
1504
|
+
:use_read_transporter => false
|
1505
|
+
)
|
1506
|
+
|
1507
|
+
@api_client.call_api(:PATCH, path, new_options)
|
1508
|
+
end
|
1509
|
+
|
1510
|
+
# Update a authentication.
|
1511
|
+
# Update the authentication of the given authenticationID.
|
1512
|
+
# @param authentication_id [String] The authentication UUID. (required)
|
1513
|
+
# @param authentication_update [AuthenticationUpdate] (required)
|
1514
|
+
# @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)
|
1515
|
+
# @return [AuthenticationUpdateResponse]
|
1516
|
+
def update_authentication(authentication_id, authentication_update, request_options = {})
|
1517
|
+
response = update_authentication_with_http_info(authentication_id, authentication_update, request_options)
|
1518
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::AuthenticationUpdateResponse')
|
1519
|
+
end
|
1520
|
+
|
1521
|
+
# Update a destination.
|
1522
|
+
# Update the destination of the given destinationID.
|
1523
|
+
# @param destination_id [String] The destination UUID. (required)
|
1524
|
+
# @param destination_update [DestinationUpdate] (required)
|
1525
|
+
# @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)
|
1526
|
+
# @return [Http::Response] the response
|
1527
|
+
def update_destination_with_http_info(destination_id, destination_update, request_options = {})
|
1528
|
+
# verify the required parameter 'destination_id' is set
|
1529
|
+
if @api_client.config.client_side_validation && destination_id.nil?
|
1530
|
+
raise ArgumentError, "Parameter `destination_id` is required when calling `update_destination`."
|
1531
|
+
end
|
1532
|
+
# verify the required parameter 'destination_update' is set
|
1533
|
+
if @api_client.config.client_side_validation && destination_update.nil?
|
1534
|
+
raise ArgumentError, "Parameter `destination_update` is required when calling `update_destination`."
|
1535
|
+
end
|
1536
|
+
|
1537
|
+
path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', @api_client.encode_uri(destination_id.to_s))
|
1538
|
+
query_params = {}
|
1539
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1540
|
+
header_params = {}
|
1541
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1542
|
+
|
1543
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(destination_update)
|
1544
|
+
|
1545
|
+
new_options = request_options.merge(
|
1546
|
+
:operation => :'IngestionClient.update_destination',
|
1547
|
+
:header_params => header_params,
|
1548
|
+
:query_params => query_params,
|
1549
|
+
:body => post_body,
|
1550
|
+
:use_read_transporter => false
|
1551
|
+
)
|
1552
|
+
|
1553
|
+
@api_client.call_api(:PATCH, path, new_options)
|
1554
|
+
end
|
1555
|
+
|
1556
|
+
# Update a destination.
|
1557
|
+
# Update the destination of the given destinationID.
|
1558
|
+
# @param destination_id [String] The destination UUID. (required)
|
1559
|
+
# @param destination_update [DestinationUpdate] (required)
|
1560
|
+
# @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)
|
1561
|
+
# @return [DestinationUpdateResponse]
|
1562
|
+
def update_destination(destination_id, destination_update, request_options = {})
|
1563
|
+
response = update_destination_with_http_info(destination_id, destination_update, request_options)
|
1564
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DestinationUpdateResponse')
|
1565
|
+
end
|
1566
|
+
|
1567
|
+
# Update a source.
|
1568
|
+
# Update the source of the given sourceID.
|
1569
|
+
# @param source_id [String] The source UUID. (required)
|
1570
|
+
# @param source_update [SourceUpdate] (required)
|
1571
|
+
# @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)
|
1572
|
+
# @return [Http::Response] the response
|
1573
|
+
def update_source_with_http_info(source_id, source_update, request_options = {})
|
1574
|
+
# verify the required parameter 'source_id' is set
|
1575
|
+
if @api_client.config.client_side_validation && source_id.nil?
|
1576
|
+
raise ArgumentError, "Parameter `source_id` is required when calling `update_source`."
|
1577
|
+
end
|
1578
|
+
# verify the required parameter 'source_update' is set
|
1579
|
+
if @api_client.config.client_side_validation && source_update.nil?
|
1580
|
+
raise ArgumentError, "Parameter `source_update` is required when calling `update_source`."
|
1581
|
+
end
|
1582
|
+
|
1583
|
+
path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', @api_client.encode_uri(source_id.to_s))
|
1584
|
+
query_params = {}
|
1585
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1586
|
+
header_params = {}
|
1587
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1588
|
+
|
1589
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_update)
|
1590
|
+
|
1591
|
+
new_options = request_options.merge(
|
1592
|
+
:operation => :'IngestionClient.update_source',
|
1593
|
+
:header_params => header_params,
|
1594
|
+
:query_params => query_params,
|
1595
|
+
:body => post_body,
|
1596
|
+
:use_read_transporter => false
|
1597
|
+
)
|
1598
|
+
|
1599
|
+
@api_client.call_api(:PATCH, path, new_options)
|
1600
|
+
end
|
1601
|
+
|
1602
|
+
# Update a source.
|
1603
|
+
# Update the source of the given sourceID.
|
1604
|
+
# @param source_id [String] The source UUID. (required)
|
1605
|
+
# @param source_update [SourceUpdate] (required)
|
1606
|
+
# @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)
|
1607
|
+
# @return [SourceUpdateResponse]
|
1608
|
+
def update_source(source_id, source_update, request_options = {})
|
1609
|
+
response = update_source_with_http_info(source_id, source_update, request_options)
|
1610
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceUpdateResponse')
|
1611
|
+
end
|
1612
|
+
|
1613
|
+
# Update a task.
|
1614
|
+
# Update the task of the given taskID.
|
1615
|
+
# @param task_id [String] The task UUID. (required)
|
1616
|
+
# @param task_update [TaskUpdate] (required)
|
1617
|
+
# @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)
|
1618
|
+
# @return [Http::Response] the response
|
1619
|
+
def update_task_with_http_info(task_id, task_update, request_options = {})
|
1620
|
+
# verify the required parameter 'task_id' is set
|
1621
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
1622
|
+
raise ArgumentError, "Parameter `task_id` is required when calling `update_task`."
|
1623
|
+
end
|
1624
|
+
# verify the required parameter 'task_update' is set
|
1625
|
+
if @api_client.config.client_side_validation && task_update.nil?
|
1626
|
+
raise ArgumentError, "Parameter `task_update` is required when calling `update_task`."
|
1627
|
+
end
|
1628
|
+
|
1629
|
+
path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s))
|
1630
|
+
query_params = {}
|
1631
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
1632
|
+
header_params = {}
|
1633
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
1634
|
+
|
1635
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(task_update)
|
1636
|
+
|
1637
|
+
new_options = request_options.merge(
|
1638
|
+
:operation => :'IngestionClient.update_task',
|
1639
|
+
:header_params => header_params,
|
1640
|
+
:query_params => query_params,
|
1641
|
+
:body => post_body,
|
1642
|
+
:use_read_transporter => false
|
1643
|
+
)
|
1644
|
+
|
1645
|
+
@api_client.call_api(:PATCH, path, new_options)
|
1646
|
+
end
|
1647
|
+
|
1648
|
+
# Update a task.
|
1649
|
+
# Update the task of the given taskID.
|
1650
|
+
# @param task_id [String] The task UUID. (required)
|
1651
|
+
# @param task_update [TaskUpdate] (required)
|
1652
|
+
# @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)
|
1653
|
+
# @return [TaskUpdateResponse]
|
1654
|
+
def update_task(task_id, task_update, request_options = {})
|
1655
|
+
response = update_task_with_http_info(task_id, task_update, request_options)
|
1656
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
|
1657
|
+
end
|
1658
|
+
end
|
1659
|
+
end
|