algolia 2.3.3 → 3.0.0.alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,460 @@
|
|
|
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 RecommendClient
|
|
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, opts = {})
|
|
16
|
+
hosts = []
|
|
17
|
+
|
|
18
|
+
hosts << Transport::StatefulHost.new("#{app_id}-dsn.algolia.net", accept: CallType::READ)
|
|
19
|
+
hosts << Transport::StatefulHost.new("#{app_id}.algolia.net", accept: CallType::WRITE)
|
|
20
|
+
|
|
21
|
+
hosts += 1.upto(3).map do |i|
|
|
22
|
+
Transport::StatefulHost.new("#{app_id}-#{i}.algolianet.com", accept: CallType::READ | CallType::WRITE)
|
|
23
|
+
end.shuffle
|
|
24
|
+
|
|
25
|
+
config = Algolia::Configuration.new(app_id, api_key, hosts, 'Recommend', opts)
|
|
26
|
+
create_with_config(config)
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
def self.create_with_config(config)
|
|
30
|
+
new(config)
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Send requests to the Algolia REST API.
|
|
34
|
+
# This method allow you to send requests to the Algolia REST API.
|
|
35
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
|
36
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
|
37
|
+
# @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)
|
|
38
|
+
# @return [Http::Response] the response
|
|
39
|
+
def custom_delete_with_http_info(path, parameters = nil, request_options = {})
|
|
40
|
+
# verify the required parameter 'path' is set
|
|
41
|
+
if @api_client.config.client_side_validation && path.nil?
|
|
42
|
+
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
|
|
46
|
+
query_params = {}
|
|
47
|
+
query_params = query_params.merge(parameters) unless parameters.nil?
|
|
48
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
49
|
+
header_params = {}
|
|
50
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
51
|
+
|
|
52
|
+
post_body = request_options[:debug_body]
|
|
53
|
+
|
|
54
|
+
new_options = request_options.merge(
|
|
55
|
+
:operation => :'RecommendClient.custom_delete',
|
|
56
|
+
:header_params => header_params,
|
|
57
|
+
:query_params => query_params,
|
|
58
|
+
:body => post_body,
|
|
59
|
+
:use_read_transporter => false
|
|
60
|
+
)
|
|
61
|
+
|
|
62
|
+
@api_client.call_api(:DELETE, path, new_options)
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# Send requests to the Algolia REST API.
|
|
66
|
+
# This method allow you to send requests to the Algolia REST API.
|
|
67
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
|
68
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
|
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 [Object]
|
|
71
|
+
def custom_delete(path, parameters = nil, request_options = {})
|
|
72
|
+
response = custom_delete_with_http_info(path, parameters, request_options)
|
|
73
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# Send requests to the Algolia REST API.
|
|
77
|
+
# This method allow you to send requests to the Algolia REST API.
|
|
78
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
|
79
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
|
80
|
+
# @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)
|
|
81
|
+
# @return [Http::Response] the response
|
|
82
|
+
def custom_get_with_http_info(path, parameters = nil, request_options = {})
|
|
83
|
+
# verify the required parameter 'path' is set
|
|
84
|
+
if @api_client.config.client_side_validation && path.nil?
|
|
85
|
+
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
|
|
89
|
+
query_params = {}
|
|
90
|
+
query_params = query_params.merge(parameters) unless parameters.nil?
|
|
91
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
92
|
+
header_params = {}
|
|
93
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
94
|
+
|
|
95
|
+
post_body = request_options[:debug_body]
|
|
96
|
+
|
|
97
|
+
new_options = request_options.merge(
|
|
98
|
+
:operation => :'RecommendClient.custom_get',
|
|
99
|
+
:header_params => header_params,
|
|
100
|
+
:query_params => query_params,
|
|
101
|
+
:body => post_body,
|
|
102
|
+
:use_read_transporter => false
|
|
103
|
+
)
|
|
104
|
+
|
|
105
|
+
@api_client.call_api(:GET, path, new_options)
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Send requests to the Algolia REST API.
|
|
109
|
+
# This method allow you to send requests to the Algolia REST API.
|
|
110
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
|
111
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
|
112
|
+
# @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)
|
|
113
|
+
# @return [Object]
|
|
114
|
+
def custom_get(path, parameters = nil, request_options = {})
|
|
115
|
+
response = custom_get_with_http_info(path, parameters, request_options)
|
|
116
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# Send requests to the Algolia REST API.
|
|
120
|
+
# This method allow you to send requests to the Algolia REST API.
|
|
121
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
|
122
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
|
123
|
+
# @param body [Object] Parameters to send with the custom request.
|
|
124
|
+
# @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)
|
|
125
|
+
# @return [Http::Response] the response
|
|
126
|
+
def custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {})
|
|
127
|
+
# verify the required parameter 'path' is set
|
|
128
|
+
if @api_client.config.client_side_validation && path.nil?
|
|
129
|
+
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
|
|
133
|
+
query_params = {}
|
|
134
|
+
query_params = query_params.merge(parameters) unless parameters.nil?
|
|
135
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
136
|
+
header_params = {}
|
|
137
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
138
|
+
|
|
139
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
|
|
140
|
+
|
|
141
|
+
new_options = request_options.merge(
|
|
142
|
+
:operation => :'RecommendClient.custom_post',
|
|
143
|
+
:header_params => header_params,
|
|
144
|
+
:query_params => query_params,
|
|
145
|
+
:body => post_body,
|
|
146
|
+
:use_read_transporter => false
|
|
147
|
+
)
|
|
148
|
+
|
|
149
|
+
@api_client.call_api(:POST, path, new_options)
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# Send requests to the Algolia REST API.
|
|
153
|
+
# This method allow you to send requests to the Algolia REST API.
|
|
154
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
|
155
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
|
156
|
+
# @param body [Object] Parameters to send with the custom request.
|
|
157
|
+
# @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)
|
|
158
|
+
# @return [Object]
|
|
159
|
+
def custom_post(path, parameters = nil, body = nil, request_options = {})
|
|
160
|
+
response = custom_post_with_http_info(path, parameters, body, request_options)
|
|
161
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Send requests to the Algolia REST API.
|
|
165
|
+
# This method allow you to send requests to the Algolia REST API.
|
|
166
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
|
167
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
|
168
|
+
# @param body [Object] Parameters to send with the custom request.
|
|
169
|
+
# @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)
|
|
170
|
+
# @return [Http::Response] the response
|
|
171
|
+
def custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {})
|
|
172
|
+
# verify the required parameter 'path' is set
|
|
173
|
+
if @api_client.config.client_side_validation && path.nil?
|
|
174
|
+
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
|
|
178
|
+
query_params = {}
|
|
179
|
+
query_params = query_params.merge(parameters) unless parameters.nil?
|
|
180
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
181
|
+
header_params = {}
|
|
182
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
183
|
+
|
|
184
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
|
|
185
|
+
|
|
186
|
+
new_options = request_options.merge(
|
|
187
|
+
:operation => :'RecommendClient.custom_put',
|
|
188
|
+
:header_params => header_params,
|
|
189
|
+
:query_params => query_params,
|
|
190
|
+
:body => post_body,
|
|
191
|
+
:use_read_transporter => false
|
|
192
|
+
)
|
|
193
|
+
|
|
194
|
+
@api_client.call_api(:PUT, path, new_options)
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
# Send requests to the Algolia REST API.
|
|
198
|
+
# This method allow you to send requests to the Algolia REST API.
|
|
199
|
+
# @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
|
|
200
|
+
# @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
|
|
201
|
+
# @param body [Object] Parameters to send with the custom request.
|
|
202
|
+
# @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)
|
|
203
|
+
# @return [Object]
|
|
204
|
+
def custom_put(path, parameters = nil, body = nil, request_options = {})
|
|
205
|
+
response = custom_put_with_http_info(path, parameters, body, request_options)
|
|
206
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Object')
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# Delete a Recommend rule.
|
|
210
|
+
# Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
|
|
211
|
+
# @param index_name [String] Index on which to perform the request. (required)
|
|
212
|
+
# @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
|
|
213
|
+
# @param object_id [String] Unique record (object) identifier. (required)
|
|
214
|
+
# @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)
|
|
215
|
+
# @return [Http::Response] the response
|
|
216
|
+
def delete_recommend_rule_with_http_info(index_name, model, object_id, request_options = {})
|
|
217
|
+
# verify the required parameter 'index_name' is set
|
|
218
|
+
if @api_client.config.client_side_validation && index_name.nil?
|
|
219
|
+
raise ArgumentError, "Parameter `index_name` is required when calling `delete_recommend_rule`."
|
|
220
|
+
end
|
|
221
|
+
# verify the required parameter 'model' is set
|
|
222
|
+
if @api_client.config.client_side_validation && model.nil?
|
|
223
|
+
raise ArgumentError, "Parameter `model` is required when calling `delete_recommend_rule`."
|
|
224
|
+
end
|
|
225
|
+
# verify the required parameter 'object_id' is set
|
|
226
|
+
if @api_client.config.client_side_validation && object_id.nil?
|
|
227
|
+
raise ArgumentError, "Parameter `object_id` is required when calling `delete_recommend_rule`."
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
path = '/1/indexes/{indexName}/{model}/recommend/rules/{objectID}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', @api_client.encode_uri(model.to_s)).sub(
|
|
231
|
+
'{' + 'objectID' + '}', @api_client.encode_uri(object_id.to_s)
|
|
232
|
+
)
|
|
233
|
+
query_params = {}
|
|
234
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
235
|
+
header_params = {}
|
|
236
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
237
|
+
|
|
238
|
+
post_body = request_options[:debug_body]
|
|
239
|
+
|
|
240
|
+
new_options = request_options.merge(
|
|
241
|
+
:operation => :'RecommendClient.delete_recommend_rule',
|
|
242
|
+
:header_params => header_params,
|
|
243
|
+
:query_params => query_params,
|
|
244
|
+
:body => post_body,
|
|
245
|
+
:use_read_transporter => false
|
|
246
|
+
)
|
|
247
|
+
|
|
248
|
+
@api_client.call_api(:DELETE, path, new_options)
|
|
249
|
+
end
|
|
250
|
+
|
|
251
|
+
# Delete a Recommend rule.
|
|
252
|
+
# Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
|
|
253
|
+
# @param index_name [String] Index on which to perform the request. (required)
|
|
254
|
+
# @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
|
|
255
|
+
# @param object_id [String] Unique record (object) identifier. (required)
|
|
256
|
+
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
257
|
+
# @return [DeletedAtResponse]
|
|
258
|
+
def delete_recommend_rule(index_name, model, object_id, request_options = {})
|
|
259
|
+
response = delete_recommend_rule_with_http_info(index_name, model, object_id, request_options)
|
|
260
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Recommend::DeletedAtResponse')
|
|
261
|
+
end
|
|
262
|
+
|
|
263
|
+
# Get a Recommend rule.
|
|
264
|
+
# Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
|
|
265
|
+
# @param index_name [String] Index on which to perform the request. (required)
|
|
266
|
+
# @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
|
|
267
|
+
# @param object_id [String] Unique record (object) identifier. (required)
|
|
268
|
+
# @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)
|
|
269
|
+
# @return [Http::Response] the response
|
|
270
|
+
def get_recommend_rule_with_http_info(index_name, model, object_id, request_options = {})
|
|
271
|
+
# verify the required parameter 'index_name' is set
|
|
272
|
+
if @api_client.config.client_side_validation && index_name.nil?
|
|
273
|
+
raise ArgumentError, "Parameter `index_name` is required when calling `get_recommend_rule`."
|
|
274
|
+
end
|
|
275
|
+
# verify the required parameter 'model' is set
|
|
276
|
+
if @api_client.config.client_side_validation && model.nil?
|
|
277
|
+
raise ArgumentError, "Parameter `model` is required when calling `get_recommend_rule`."
|
|
278
|
+
end
|
|
279
|
+
# verify the required parameter 'object_id' is set
|
|
280
|
+
if @api_client.config.client_side_validation && object_id.nil?
|
|
281
|
+
raise ArgumentError, "Parameter `object_id` is required when calling `get_recommend_rule`."
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
path = '/1/indexes/{indexName}/{model}/recommend/rules/{objectID}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', @api_client.encode_uri(model.to_s)).sub(
|
|
285
|
+
'{' + 'objectID' + '}', @api_client.encode_uri(object_id.to_s)
|
|
286
|
+
)
|
|
287
|
+
query_params = {}
|
|
288
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
289
|
+
header_params = {}
|
|
290
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
291
|
+
|
|
292
|
+
post_body = request_options[:debug_body]
|
|
293
|
+
|
|
294
|
+
new_options = request_options.merge(
|
|
295
|
+
:operation => :'RecommendClient.get_recommend_rule',
|
|
296
|
+
:header_params => header_params,
|
|
297
|
+
:query_params => query_params,
|
|
298
|
+
:body => post_body,
|
|
299
|
+
:use_read_transporter => false
|
|
300
|
+
)
|
|
301
|
+
|
|
302
|
+
@api_client.call_api(:GET, path, new_options)
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
# Get a Recommend rule.
|
|
306
|
+
# Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
|
|
307
|
+
# @param index_name [String] Index on which to perform the request. (required)
|
|
308
|
+
# @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
|
|
309
|
+
# @param object_id [String] Unique record (object) identifier. (required)
|
|
310
|
+
# @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)
|
|
311
|
+
# @return [RuleResponse]
|
|
312
|
+
def get_recommend_rule(index_name, model, object_id, request_options = {})
|
|
313
|
+
response = get_recommend_rule_with_http_info(index_name, model, object_id, request_options)
|
|
314
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Recommend::RuleResponse')
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
# Get a Recommend task's status.
|
|
318
|
+
# Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
|
|
319
|
+
# @param index_name [String] Index on which to perform the request. (required)
|
|
320
|
+
# @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
|
|
321
|
+
# @param task_id [Integer] Unique identifier of a task. Numeric value (up to 64bits). (required)
|
|
322
|
+
# @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)
|
|
323
|
+
# @return [Http::Response] the response
|
|
324
|
+
def get_recommend_status_with_http_info(index_name, model, task_id, request_options = {})
|
|
325
|
+
# verify the required parameter 'index_name' is set
|
|
326
|
+
if @api_client.config.client_side_validation && index_name.nil?
|
|
327
|
+
raise ArgumentError, "Parameter `index_name` is required when calling `get_recommend_status`."
|
|
328
|
+
end
|
|
329
|
+
# verify the required parameter 'model' is set
|
|
330
|
+
if @api_client.config.client_side_validation && model.nil?
|
|
331
|
+
raise ArgumentError, "Parameter `model` is required when calling `get_recommend_status`."
|
|
332
|
+
end
|
|
333
|
+
# verify the required parameter 'task_id' is set
|
|
334
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
335
|
+
raise ArgumentError, "Parameter `task_id` is required when calling `get_recommend_status`."
|
|
336
|
+
end
|
|
337
|
+
|
|
338
|
+
path = '/1/indexes/{indexName}/{model}/task/{taskID}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s)).sub('{' + 'model' + '}', @api_client.encode_uri(model.to_s)).sub(
|
|
339
|
+
'{' + 'taskID' + '}', @api_client.encode_uri(task_id.to_s)
|
|
340
|
+
)
|
|
341
|
+
query_params = {}
|
|
342
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
343
|
+
header_params = {}
|
|
344
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
345
|
+
|
|
346
|
+
post_body = request_options[:debug_body]
|
|
347
|
+
|
|
348
|
+
new_options = request_options.merge(
|
|
349
|
+
:operation => :'RecommendClient.get_recommend_status',
|
|
350
|
+
:header_params => header_params,
|
|
351
|
+
:query_params => query_params,
|
|
352
|
+
:body => post_body,
|
|
353
|
+
:use_read_transporter => false
|
|
354
|
+
)
|
|
355
|
+
|
|
356
|
+
@api_client.call_api(:GET, path, new_options)
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
# Get a Recommend task's status.
|
|
360
|
+
# Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
|
|
361
|
+
# @param index_name [String] Index on which to perform the request. (required)
|
|
362
|
+
# @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
|
|
363
|
+
# @param task_id [Integer] Unique identifier of a task. Numeric value (up to 64bits). (required)
|
|
364
|
+
# @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)
|
|
365
|
+
# @return [GetRecommendTaskResponse]
|
|
366
|
+
def get_recommend_status(index_name, model, task_id, request_options = {})
|
|
367
|
+
response = get_recommend_status_with_http_info(index_name, model, task_id, request_options)
|
|
368
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Recommend::GetRecommendTaskResponse')
|
|
369
|
+
end
|
|
370
|
+
|
|
371
|
+
# Get recommendations and trending items.
|
|
372
|
+
# Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
|
|
373
|
+
# @param get_recommendations_params [GetRecommendationsParams] (required)
|
|
374
|
+
# @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)
|
|
375
|
+
# @return [Http::Response] the response
|
|
376
|
+
def get_recommendations_with_http_info(get_recommendations_params, request_options = {})
|
|
377
|
+
# verify the required parameter 'get_recommendations_params' is set
|
|
378
|
+
if @api_client.config.client_side_validation && get_recommendations_params.nil?
|
|
379
|
+
raise ArgumentError, "Parameter `get_recommendations_params` is required when calling `get_recommendations`."
|
|
380
|
+
end
|
|
381
|
+
|
|
382
|
+
path = '/1/indexes/*/recommendations'
|
|
383
|
+
query_params = {}
|
|
384
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
385
|
+
header_params = {}
|
|
386
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
387
|
+
|
|
388
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(get_recommendations_params)
|
|
389
|
+
|
|
390
|
+
new_options = request_options.merge(
|
|
391
|
+
:operation => :'RecommendClient.get_recommendations',
|
|
392
|
+
:header_params => header_params,
|
|
393
|
+
:query_params => query_params,
|
|
394
|
+
:body => post_body,
|
|
395
|
+
:use_read_transporter => false
|
|
396
|
+
)
|
|
397
|
+
|
|
398
|
+
@api_client.call_api(:POST, path, new_options)
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
# Get recommendations and trending items.
|
|
402
|
+
# Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
|
|
403
|
+
# @param get_recommendations_params [GetRecommendationsParams] (required)
|
|
404
|
+
# @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)
|
|
405
|
+
# @return [GetRecommendationsResponse]
|
|
406
|
+
def get_recommendations(get_recommendations_params, request_options = {})
|
|
407
|
+
response = get_recommendations_with_http_info(get_recommendations_params, request_options)
|
|
408
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Recommend::GetRecommendationsResponse')
|
|
409
|
+
end
|
|
410
|
+
|
|
411
|
+
# List Recommend rules.
|
|
412
|
+
# List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
|
|
413
|
+
# @param index_name [String] Index on which to perform the request. (required)
|
|
414
|
+
# @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
|
|
415
|
+
# @param search_recommend_rules_params [SearchRecommendRulesParams]
|
|
416
|
+
# @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)
|
|
417
|
+
# @return [Http::Response] the response
|
|
418
|
+
def search_recommend_rules_with_http_info(index_name, model, search_recommend_rules_params = nil, request_options = {})
|
|
419
|
+
# verify the required parameter 'index_name' is set
|
|
420
|
+
if @api_client.config.client_side_validation && index_name.nil?
|
|
421
|
+
raise ArgumentError, "Parameter `index_name` is required when calling `search_recommend_rules`."
|
|
422
|
+
end
|
|
423
|
+
# verify the required parameter 'model' is set
|
|
424
|
+
if @api_client.config.client_side_validation && model.nil?
|
|
425
|
+
raise ArgumentError, "Parameter `model` is required when calling `search_recommend_rules`."
|
|
426
|
+
end
|
|
427
|
+
|
|
428
|
+
path = '/1/indexes/{indexName}/{model}/recommend/rules/search'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s)).sub('{' + 'model' + '}',
|
|
429
|
+
@api_client.encode_uri(model.to_s))
|
|
430
|
+
query_params = {}
|
|
431
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
432
|
+
header_params = {}
|
|
433
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
|
434
|
+
|
|
435
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(search_recommend_rules_params)
|
|
436
|
+
|
|
437
|
+
new_options = request_options.merge(
|
|
438
|
+
:operation => :'RecommendClient.search_recommend_rules',
|
|
439
|
+
:header_params => header_params,
|
|
440
|
+
:query_params => query_params,
|
|
441
|
+
:body => post_body,
|
|
442
|
+
:use_read_transporter => false
|
|
443
|
+
)
|
|
444
|
+
|
|
445
|
+
@api_client.call_api(:POST, path, new_options)
|
|
446
|
+
end
|
|
447
|
+
|
|
448
|
+
# List Recommend rules.
|
|
449
|
+
# List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
|
|
450
|
+
# @param index_name [String] Index on which to perform the request. (required)
|
|
451
|
+
# @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
|
|
452
|
+
# @param search_recommend_rules_params [SearchRecommendRulesParams]
|
|
453
|
+
# @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)
|
|
454
|
+
# @return [SearchRecommendRulesResponse]
|
|
455
|
+
def search_recommend_rules(index_name, model, search_recommend_rules_params = nil, request_options = {})
|
|
456
|
+
response = search_recommend_rules_with_http_info(index_name, model, search_recommend_rules_params, request_options)
|
|
457
|
+
deserialize(response.body, request_options[:debug_return_type] || 'Recommend::SearchRecommendRulesResponse')
|
|
458
|
+
end
|
|
459
|
+
end
|
|
460
|
+
end
|