algolia 3.27.0 → 3.28.0
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/.github/workflows/do-not-edit-this-repository.yml +1 -1
- data/.github/workflows/release.yml +2 -2
- data/CHANGELOG.md +7 -0
- data/Gemfile.lock +11 -11
- data/lib/algolia/api/abtesting_client.rb +13 -13
- data/lib/algolia/api/abtesting_v3_client.rb +13 -13
- data/lib/algolia/api/analytics_client.rb +69 -69
- data/lib/algolia/api/composition_client.rb +17 -17
- data/lib/algolia/api/ingestion_client.rb +15 -15
- data/lib/algolia/api/insights_client.rb +13 -13
- data/lib/algolia/api/monitoring_client.rb +12 -12
- data/lib/algolia/api/personalization_client.rb +13 -13
- data/lib/algolia/api/query_suggestions_client.rb +13 -13
- data/lib/algolia/api/recommend_client.rb +13 -13
- data/lib/algolia/api/search_client.rb +41 -41
- data/lib/algolia/models/abtesting/ab_test.rb +0 -2
- data/lib/algolia/models/abtesting/ab_test_configuration.rb +0 -2
- data/lib/algolia/models/abtesting/ab_test_response.rb +1 -3
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +0 -2
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +0 -2
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +0 -2
- data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +0 -1
- data/lib/algolia/models/abtesting/currency.rb +0 -2
- data/lib/algolia/models/abtesting/empty_search.rb +0 -2
- data/lib/algolia/models/abtesting/empty_search_filter.rb +0 -2
- data/lib/algolia/models/abtesting/error_base.rb +0 -2
- data/lib/algolia/models/abtesting/estimate_ab_test_request.rb +0 -2
- data/lib/algolia/models/abtesting/estimate_ab_test_response.rb +0 -2
- data/lib/algolia/models/abtesting/estimate_configuration.rb +0 -2
- data/lib/algolia/models/abtesting/filter_effects.rb +0 -2
- data/lib/algolia/models/abtesting/list_ab_tests_response.rb +0 -2
- data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +0 -2
- data/lib/algolia/models/abtesting/outliers.rb +0 -2
- data/lib/algolia/models/abtesting/outliers_filter.rb +0 -2
- data/lib/algolia/models/abtesting/schedule_ab_test_response.rb +0 -2
- data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +0 -2
- data/lib/algolia/models/abtesting/variant.rb +0 -2
- data/lib/algolia/models/abtesting-v3/ab_test.rb +0 -2
- data/lib/algolia/models/abtesting-v3/ab_test_configuration.rb +0 -2
- data/lib/algolia/models/abtesting-v3/ab_test_response.rb +1 -3
- data/lib/algolia/models/abtesting-v3/ab_tests_variant.rb +0 -2
- data/lib/algolia/models/abtesting-v3/ab_tests_variant_search_params.rb +0 -2
- data/lib/algolia/models/abtesting-v3/add_ab_tests_request.rb +0 -2
- data/lib/algolia/models/abtesting-v3/add_ab_tests_variant.rb +0 -1
- data/lib/algolia/models/abtesting-v3/create_metric.rb +0 -2
- data/lib/algolia/models/abtesting-v3/empty_search_filter.rb +0 -2
- data/lib/algolia/models/abtesting-v3/error_base.rb +0 -2
- data/lib/algolia/models/abtesting-v3/estimate_ab_test_request.rb +0 -2
- data/lib/algolia/models/abtesting-v3/estimate_ab_test_response.rb +0 -2
- data/lib/algolia/models/abtesting-v3/estimate_configuration.rb +0 -2
- data/lib/algolia/models/abtesting-v3/filter_effects.rb +0 -2
- data/lib/algolia/models/abtesting-v3/list_ab_tests_response.rb +0 -2
- data/lib/algolia/models/abtesting-v3/metric_date.rb +0 -2
- data/lib/algolia/models/abtesting-v3/metric_metadata.rb +0 -2
- data/lib/algolia/models/abtesting-v3/metric_result.rb +0 -2
- data/lib/algolia/models/abtesting-v3/metrics_filter.rb +0 -2
- data/lib/algolia/models/abtesting-v3/minimum_detectable_effect.rb +0 -2
- data/lib/algolia/models/abtesting-v3/outliers_filter.rb +0 -2
- data/lib/algolia/models/abtesting-v3/schedule_ab_test_response.rb +0 -2
- data/lib/algolia/models/abtesting-v3/schedule_ab_tests_request.rb +0 -2
- data/lib/algolia/models/abtesting-v3/timeseries.rb +0 -2
- data/lib/algolia/models/abtesting-v3/timeseries_variant.rb +0 -2
- data/lib/algolia/models/abtesting-v3/variant.rb +0 -2
- data/lib/algolia/models/abtesting-v3/variant_metadata.rb +0 -2
- data/lib/algolia/models/analytics/click_position.rb +0 -2
- data/lib/algolia/models/analytics/currency_code.rb +0 -2
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_average_clicks.rb +0 -2
- data/lib/algolia/models/analytics/daily_click_through_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_no_click_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_no_results_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_purchase_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_revenue.rb +0 -2
- data/lib/algolia/models/analytics/daily_searches.rb +0 -2
- data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +0 -2
- data/lib/algolia/models/analytics/daily_searches_no_results.rb +0 -2
- data/lib/algolia/models/analytics/daily_users.rb +0 -2
- data/lib/algolia/models/analytics/error_base.rb +0 -2
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +0 -2
- data/lib/algolia/models/analytics/get_click_positions_response.rb +0 -2
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_purchase_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_revenue.rb +0 -2
- data/lib/algolia/models/analytics/get_searches_count_response.rb +0 -2
- data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +0 -2
- data/lib/algolia/models/analytics/get_searches_no_results_response.rb +0 -2
- data/lib/algolia/models/analytics/get_status_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_countries_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filter_attribute.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +0 -2
- data/lib/algolia/models/analytics/get_top_hits_response.rb +0 -1
- data/lib/algolia/models/analytics/get_top_searches_response.rb +0 -1
- data/lib/algolia/models/analytics/get_users_count_response.rb +0 -2
- data/lib/algolia/models/analytics/top_country.rb +0 -2
- data/lib/algolia/models/analytics/top_hit.rb +0 -2
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_hits_response.rb +0 -2
- data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_search.rb +0 -2
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_searches_response.rb +0 -2
- data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +0 -2
- data/lib/algolia/models/composition/around_precision.rb +0 -1
- data/lib/algolia/models/composition/around_radius.rb +0 -1
- data/lib/algolia/models/composition/banner.rb +0 -2
- data/lib/algolia/models/composition/banner_image.rb +0 -2
- data/lib/algolia/models/composition/banner_image_url.rb +0 -2
- data/lib/algolia/models/composition/banner_link.rb +0 -2
- data/lib/algolia/models/composition/base_injection_query_parameters.rb +6 -8
- data/lib/algolia/models/composition/batch_composition_action.rb +0 -1
- data/lib/algolia/models/composition/batch_params.rb +0 -2
- data/lib/algolia/models/composition/composition.rb +0 -2
- data/lib/algolia/models/composition/composition_behavior.rb +0 -2
- data/lib/algolia/models/composition/composition_id_ranking_info.rb +0 -2
- data/lib/algolia/models/composition/composition_rule.rb +0 -2
- data/lib/algolia/models/composition/composition_rule_consequence.rb +0 -2
- data/lib/algolia/models/composition/composition_rules_batch_params.rb +0 -2
- data/lib/algolia/models/composition/composition_run_applied_rules.rb +0 -2
- data/lib/algolia/models/composition/composition_run_search_response.rb +0 -2
- data/lib/algolia/models/composition/composition_source.rb +0 -2
- data/lib/algolia/models/composition/composition_source_search.rb +0 -2
- data/lib/algolia/models/composition/compositions_search_response.rb +0 -2
- data/lib/algolia/models/composition/condition.rb +0 -2
- data/lib/algolia/models/composition/dedup_positioning.rb +34 -0
- data/lib/algolia/models/composition/deduplication.rb +209 -0
- data/lib/algolia/models/composition/delete_composition_action.rb +0 -2
- data/lib/algolia/models/composition/delete_composition_rule_action.rb +0 -2
- data/lib/algolia/models/composition/distinct.rb +0 -1
- data/lib/algolia/models/composition/error_base.rb +0 -2
- data/lib/algolia/models/composition/exhaustive.rb +0 -2
- data/lib/algolia/models/composition/external.rb +0 -2
- data/lib/algolia/models/composition/external_injected_item.rb +0 -2
- data/lib/algolia/models/composition/external_injection.rb +0 -2
- data/lib/algolia/models/composition/external_source.rb +0 -2
- data/lib/algolia/models/composition/facet_filters.rb +0 -1
- data/lib/algolia/models/composition/facet_hits.rb +0 -2
- data/lib/algolia/models/composition/facet_ordering.rb +0 -2
- data/lib/algolia/models/composition/facet_stats.rb +0 -2
- data/lib/algolia/models/composition/facets.rb +0 -2
- data/lib/algolia/models/composition/get_task_response.rb +0 -2
- data/lib/algolia/models/composition/highlight_result.rb +0 -1
- data/lib/algolia/models/composition/highlight_result_option.rb +0 -2
- data/lib/algolia/models/composition/hit.rb +0 -2
- data/lib/algolia/models/composition/hit_metadata.rb +0 -2
- data/lib/algolia/models/composition/hit_ranking_info.rb +0 -2
- data/lib/algolia/models/composition/ignore_plurals.rb +0 -1
- data/lib/algolia/models/composition/injected_item.rb +0 -2
- data/lib/algolia/models/composition/injected_item_hits_metadata.rb +0 -2
- data/lib/algolia/models/composition/injected_item_metadata.rb +0 -2
- data/lib/algolia/models/composition/injected_item_source.rb +0 -1
- data/lib/algolia/models/composition/injection.rb +13 -6
- data/lib/algolia/models/composition/inside_bounding_box.rb +0 -1
- data/lib/algolia/models/composition/list_compositions_response.rb +0 -2
- data/lib/algolia/models/composition/main.rb +0 -2
- data/lib/algolia/models/composition/main_injection_query_parameters.rb +7 -9
- data/lib/algolia/models/composition/matched_geo_location.rb +0 -2
- data/lib/algolia/models/composition/multiple_batch_request.rb +0 -2
- data/lib/algolia/models/composition/multiple_batch_response.rb +0 -2
- data/lib/algolia/models/composition/numeric_filters.rb +0 -1
- data/lib/algolia/models/composition/optional_filters.rb +1 -2
- data/lib/algolia/models/composition/optional_words.rb +0 -1
- data/lib/algolia/models/composition/params.rb +6 -8
- data/lib/algolia/models/composition/personalization.rb +0 -2
- data/lib/algolia/models/composition/range.rb +0 -2
- data/lib/algolia/models/composition/redirect.rb +1 -3
- data/lib/algolia/models/composition/redirect_rule_index_data.rb +0 -2
- data/lib/algolia/models/composition/redirect_rule_index_metadata.rb +0 -2
- data/lib/algolia/models/composition/redirect_url.rb +0 -2
- data/lib/algolia/models/composition/remove_stop_words.rb +0 -1
- data/lib/algolia/models/composition/rendering_content.rb +0 -2
- data/lib/algolia/models/composition/request_body.rb +0 -2
- data/lib/algolia/models/composition/results_composition_info_response.rb +0 -2
- data/lib/algolia/models/composition/results_injected_item_applied_rules_info_response.rb +0 -2
- data/lib/algolia/models/composition/results_injected_item_info_response.rb +0 -2
- data/lib/algolia/models/composition/rules_batch_composition_action.rb +0 -1
- data/lib/algolia/models/composition/rules_multiple_batch_request.rb +0 -2
- data/lib/algolia/models/composition/rules_multiple_batch_response.rb +1 -3
- data/lib/algolia/models/composition/search.rb +0 -2
- data/lib/algolia/models/composition/search_composition_rules_params.rb +2 -4
- data/lib/algolia/models/composition/search_composition_rules_response.rb +0 -2
- data/lib/algolia/models/composition/search_for_facet_values_params.rb +0 -2
- data/lib/algolia/models/composition/search_for_facet_values_request.rb +0 -2
- data/lib/algolia/models/composition/search_for_facet_values_response.rb +0 -2
- data/lib/algolia/models/composition/search_for_facet_values_results.rb +0 -2
- data/lib/algolia/models/composition/search_response.rb +0 -2
- data/lib/algolia/models/composition/search_results_item.rb +1 -3
- data/lib/algolia/models/composition/search_source.rb +0 -2
- data/lib/algolia/models/composition/snippet_result.rb +0 -1
- data/lib/algolia/models/composition/snippet_result_option.rb +0 -2
- data/lib/algolia/models/composition/task_id_response.rb +1 -3
- data/lib/algolia/models/composition/time_range.rb +0 -2
- data/lib/algolia/models/composition/typo_tolerance.rb +1 -2
- data/lib/algolia/models/composition/value.rb +0 -2
- data/lib/algolia/models/composition/widgets.rb +0 -2
- data/lib/algolia/models/ingestion/auth_algolia.rb +0 -2
- data/lib/algolia/models/ingestion/auth_algolia_insights.rb +0 -2
- data/lib/algolia/models/ingestion/auth_algolia_insights_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_algolia_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_api_key.rb +0 -2
- data/lib/algolia/models/ingestion/auth_api_key_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_basic.rb +0 -2
- data/lib/algolia/models/ingestion/auth_basic_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_google_service_account.rb +0 -2
- data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_input.rb +0 -1
- data/lib/algolia/models/ingestion/auth_input_partial.rb +0 -1
- data/lib/algolia/models/ingestion/auth_o_auth.rb +0 -2
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +0 -2
- data/lib/algolia/models/ingestion/authentication.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_create.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_search.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_update.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/big_commerce_channel.rb +0 -2
- data/lib/algolia/models/ingestion/big_commerce_metafield.rb +0 -2
- data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +0 -2
- data/lib/algolia/models/ingestion/delete_response.rb +0 -2
- data/lib/algolia/models/ingestion/destination.rb +0 -2
- data/lib/algolia/models/ingestion/destination_create.rb +0 -2
- data/lib/algolia/models/ingestion/destination_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/destination_input.rb +0 -2
- data/lib/algolia/models/ingestion/destination_search.rb +0 -2
- data/lib/algolia/models/ingestion/destination_update.rb +0 -2
- data/lib/algolia/models/ingestion/destination_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/docker_streams.rb +0 -2
- data/lib/algolia/models/ingestion/docker_streams_input.rb +0 -2
- data/lib/algolia/models/ingestion/email_notifications.rb +0 -2
- data/lib/algolia/models/ingestion/error_base.rb +0 -2
- data/lib/algolia/models/ingestion/event.rb +0 -2
- data/lib/algolia/models/ingestion/list_authentications_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_destinations_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_events_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_sources_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_tasks_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_tasks_response_v1.rb +0 -2
- data/lib/algolia/models/ingestion/list_transformations_response.rb +0 -2
- data/lib/algolia/models/ingestion/mapping_field_directive.rb +0 -2
- data/lib/algolia/models/ingestion/mapping_input.rb +0 -2
- data/lib/algolia/models/ingestion/mapping_kit_action.rb +0 -2
- data/lib/algolia/models/ingestion/notifications.rb +0 -2
- data/lib/algolia/models/ingestion/on_demand_trigger.rb +0 -2
- data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +0 -2
- data/lib/algolia/models/ingestion/pagination.rb +0 -2
- data/lib/algolia/models/ingestion/platform_with_none.rb +0 -1
- data/lib/algolia/models/ingestion/policies.rb +0 -2
- data/lib/algolia/models/ingestion/push_task_payload.rb +0 -2
- data/lib/algolia/models/ingestion/push_task_records.rb +0 -2
- data/lib/algolia/models/ingestion/run.rb +0 -2
- data/lib/algolia/models/ingestion/run_list_response.rb +0 -2
- data/lib/algolia/models/ingestion/run_progress.rb +0 -2
- data/lib/algolia/models/ingestion/run_response.rb +0 -2
- data/lib/algolia/models/ingestion/run_source_payload.rb +0 -2
- data/lib/algolia/models/ingestion/run_source_response.rb +0 -2
- data/lib/algolia/models/ingestion/run_task_payload.rb +0 -2
- data/lib/algolia/models/ingestion/schedule_trigger.rb +0 -2
- data/lib/algolia/models/ingestion/schedule_trigger_input.rb +0 -2
- data/lib/algolia/models/ingestion/shopify_input.rb +0 -2
- data/lib/algolia/models/ingestion/shopify_market.rb +0 -2
- data/lib/algolia/models/ingestion/shopify_metafield.rb +0 -2
- data/lib/algolia/models/ingestion/source.rb +0 -2
- data/lib/algolia/models/ingestion/source_big_commerce.rb +0 -2
- data/lib/algolia/models/ingestion/source_big_query.rb +0 -2
- data/lib/algolia/models/ingestion/source_commercetools.rb +0 -2
- data/lib/algolia/models/ingestion/source_create.rb +0 -2
- data/lib/algolia/models/ingestion/source_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/source_csv.rb +0 -2
- data/lib/algolia/models/ingestion/source_docker.rb +0 -2
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +0 -2
- data/lib/algolia/models/ingestion/source_input.rb +0 -1
- data/lib/algolia/models/ingestion/source_json.rb +0 -2
- data/lib/algolia/models/ingestion/source_search.rb +0 -2
- data/lib/algolia/models/ingestion/source_shopify.rb +0 -2
- data/lib/algolia/models/ingestion/source_update.rb +0 -2
- data/lib/algolia/models/ingestion/source_update_commercetools.rb +0 -2
- data/lib/algolia/models/ingestion/source_update_docker.rb +0 -2
- data/lib/algolia/models/ingestion/source_update_input.rb +0 -1
- data/lib/algolia/models/ingestion/source_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/source_update_shopify.rb +0 -2
- data/lib/algolia/models/ingestion/streaming_input.rb +0 -2
- data/lib/algolia/models/ingestion/streaming_trigger.rb +0 -2
- data/lib/algolia/models/ingestion/subscription_trigger.rb +0 -2
- data/lib/algolia/models/ingestion/task.rb +0 -2
- data/lib/algolia/models/ingestion/task_create.rb +0 -2
- data/lib/algolia/models/ingestion/task_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/task_create_trigger.rb +0 -1
- data/lib/algolia/models/ingestion/task_create_v1.rb +0 -2
- data/lib/algolia/models/ingestion/task_input.rb +0 -1
- data/lib/algolia/models/ingestion/task_replace.rb +0 -2
- data/lib/algolia/models/ingestion/task_search.rb +0 -2
- data/lib/algolia/models/ingestion/task_update.rb +0 -2
- data/lib/algolia/models/ingestion/task_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/task_update_v1.rb +0 -2
- data/lib/algolia/models/ingestion/task_v1.rb +0 -2
- data/lib/algolia/models/ingestion/transformation.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_code.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_create.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_error.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_input.rb +0 -1
- data/lib/algolia/models/ingestion/transformation_no_code.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_search.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_try.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_try_response.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/trigger.rb +0 -1
- data/lib/algolia/models/ingestion/trigger_update_input.rb +0 -2
- data/lib/algolia/models/ingestion/watch_response.rb +0 -2
- data/lib/algolia/models/ingestion/window.rb +0 -2
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +2 -4
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +2 -4
- data/lib/algolia/models/insights/clicked_filters.rb +2 -4
- data/lib/algolia/models/insights/clicked_object_ids.rb +2 -4
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +2 -4
- data/lib/algolia/models/insights/converted_filters.rb +2 -4
- data/lib/algolia/models/insights/converted_object_ids.rb +2 -4
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +2 -4
- data/lib/algolia/models/insights/discount.rb +0 -1
- data/lib/algolia/models/insights/error_base.rb +0 -2
- data/lib/algolia/models/insights/events_items.rb +0 -1
- data/lib/algolia/models/insights/events_response.rb +0 -2
- data/lib/algolia/models/insights/insights_events.rb +0 -2
- data/lib/algolia/models/insights/object_data.rb +0 -2
- data/lib/algolia/models/insights/object_data_after_search.rb +0 -2
- data/lib/algolia/models/insights/price.rb +0 -1
- data/lib/algolia/models/insights/purchased_object_ids.rb +2 -4
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -4
- data/lib/algolia/models/insights/value.rb +0 -1
- data/lib/algolia/models/insights/viewed_filters.rb +2 -4
- data/lib/algolia/models/insights/viewed_object_ids.rb +2 -4
- data/lib/algolia/models/monitoring/error_base.rb +0 -2
- data/lib/algolia/models/monitoring/incident.rb +0 -2
- data/lib/algolia/models/monitoring/incident_entry.rb +0 -2
- data/lib/algolia/models/monitoring/incidents_response.rb +0 -2
- data/lib/algolia/models/monitoring/indexing_metric.rb +0 -2
- data/lib/algolia/models/monitoring/indexing_time_response.rb +0 -2
- data/lib/algolia/models/monitoring/infrastructure_response.rb +0 -2
- data/lib/algolia/models/monitoring/inventory_response.rb +0 -2
- data/lib/algolia/models/monitoring/latency_metric.rb +0 -2
- data/lib/algolia/models/monitoring/latency_response.rb +0 -2
- data/lib/algolia/models/monitoring/metrics.rb +0 -2
- data/lib/algolia/models/monitoring/probes_metric.rb +0 -2
- data/lib/algolia/models/monitoring/server.rb +0 -2
- data/lib/algolia/models/monitoring/status_response.rb +0 -2
- data/lib/algolia/models/monitoring/time_entry.rb +0 -2
- data/lib/algolia/models/personalization/delete_user_profile_response.rb +1 -3
- data/lib/algolia/models/personalization/error_base.rb +0 -2
- data/lib/algolia/models/personalization/events_scoring.rb +0 -2
- data/lib/algolia/models/personalization/facets_scoring.rb +0 -2
- data/lib/algolia/models/personalization/get_user_token_response.rb +1 -3
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +0 -2
- data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +0 -2
- data/lib/algolia/models/query-suggestions/base_response.rb +0 -2
- data/lib/algolia/models/query-suggestions/config_status.rb +0 -2
- data/lib/algolia/models/query-suggestions/configuration.rb +0 -2
- data/lib/algolia/models/query-suggestions/configuration_response.rb +0 -2
- data/lib/algolia/models/query-suggestions/configuration_with_index.rb +0 -2
- data/lib/algolia/models/query-suggestions/error_base.rb +0 -2
- data/lib/algolia/models/query-suggestions/facet.rb +0 -2
- data/lib/algolia/models/query-suggestions/languages.rb +0 -1
- data/lib/algolia/models/query-suggestions/log_file.rb +0 -2
- data/lib/algolia/models/query-suggestions/source_index.rb +0 -2
- data/lib/algolia/models/recommend/around_precision.rb +0 -1
- data/lib/algolia/models/recommend/around_radius.rb +0 -1
- data/lib/algolia/models/recommend/auto_facet_filter.rb +0 -2
- data/lib/algolia/models/recommend/banner.rb +0 -2
- data/lib/algolia/models/recommend/banner_image.rb +0 -2
- data/lib/algolia/models/recommend/banner_image_url.rb +0 -2
- data/lib/algolia/models/recommend/banner_link.rb +0 -2
- data/lib/algolia/models/recommend/bought_together_query.rb +0 -2
- data/lib/algolia/models/recommend/condition.rb +1 -3
- data/lib/algolia/models/recommend/consequence.rb +0 -2
- data/lib/algolia/models/recommend/deleted_at_response.rb +1 -3
- data/lib/algolia/models/recommend/distinct.rb +0 -1
- data/lib/algolia/models/recommend/error_base.rb +0 -2
- data/lib/algolia/models/recommend/exhaustive.rb +0 -2
- data/lib/algolia/models/recommend/facet_filters.rb +0 -1
- data/lib/algolia/models/recommend/facet_ordering.rb +0 -2
- data/lib/algolia/models/recommend/facet_stats.rb +0 -2
- data/lib/algolia/models/recommend/fallback_params.rb +19 -21
- data/lib/algolia/models/recommend/get_recommend_task_response.rb +0 -2
- data/lib/algolia/models/recommend/get_recommendations_params.rb +0 -2
- data/lib/algolia/models/recommend/get_recommendations_response.rb +0 -2
- data/lib/algolia/models/recommend/hide_consequence_object.rb +0 -2
- data/lib/algolia/models/recommend/highlight_result.rb +0 -1
- data/lib/algolia/models/recommend/highlight_result_option.rb +0 -2
- data/lib/algolia/models/recommend/ignore_plurals.rb +0 -1
- data/lib/algolia/models/recommend/index_settings_facets.rb +0 -2
- data/lib/algolia/models/recommend/inside_bounding_box.rb +0 -1
- data/lib/algolia/models/recommend/looking_similar_query.rb +0 -2
- data/lib/algolia/models/recommend/matched_geo_location.rb +0 -2
- data/lib/algolia/models/recommend/numeric_filters.rb +0 -1
- data/lib/algolia/models/recommend/optional_filters.rb +1 -2
- data/lib/algolia/models/recommend/optional_words.rb +0 -1
- data/lib/algolia/models/recommend/params_consequence.rb +1 -3
- data/lib/algolia/models/recommend/personalization.rb +0 -2
- data/lib/algolia/models/recommend/promote_consequence_object.rb +0 -2
- data/lib/algolia/models/recommend/range.rb +0 -2
- data/lib/algolia/models/recommend/ranking_info.rb +0 -2
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +1 -2
- data/lib/algolia/models/recommend/recommend_hit.rb +0 -2
- data/lib/algolia/models/recommend/recommend_rule.rb +0 -2
- data/lib/algolia/models/recommend/recommend_search_params.rb +19 -21
- data/lib/algolia/models/recommend/recommend_updated_at_response.rb +1 -3
- data/lib/algolia/models/recommend/recommendations_hit.rb +0 -1
- data/lib/algolia/models/recommend/recommendations_request.rb +0 -1
- data/lib/algolia/models/recommend/recommendations_results.rb +1 -3
- data/lib/algolia/models/recommend/redirect.rb +1 -3
- data/lib/algolia/models/recommend/redirect_rule_index_data.rb +0 -2
- data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +0 -2
- data/lib/algolia/models/recommend/redirect_url.rb +0 -2
- data/lib/algolia/models/recommend/related_query.rb +0 -2
- data/lib/algolia/models/recommend/remove_stop_words.rb +0 -1
- data/lib/algolia/models/recommend/rendering_content.rb +0 -2
- data/lib/algolia/models/recommend/rule_metadata.rb +0 -2
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -4
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +0 -2
- data/lib/algolia/models/recommend/snippet_result.rb +0 -1
- data/lib/algolia/models/recommend/snippet_result_option.rb +0 -2
- data/lib/algolia/models/recommend/tag_filters.rb +0 -1
- data/lib/algolia/models/recommend/time_range.rb +0 -2
- data/lib/algolia/models/recommend/trending_facet_hit.rb +0 -2
- data/lib/algolia/models/recommend/trending_facets_query.rb +0 -2
- data/lib/algolia/models/recommend/trending_items_query.rb +0 -2
- data/lib/algolia/models/recommend/typo_tolerance.rb +1 -2
- data/lib/algolia/models/recommend/value.rb +0 -2
- data/lib/algolia/models/recommend/widgets.rb +0 -2
- data/lib/algolia/models/search/add_api_key_response.rb +0 -2
- data/lib/algolia/models/search/api_key.rb +1 -3
- data/lib/algolia/models/search/around_precision.rb +0 -1
- data/lib/algolia/models/search/around_radius.rb +0 -1
- data/lib/algolia/models/search/assign_user_id_params.rb +0 -2
- data/lib/algolia/models/search/attribute_to_update.rb +0 -1
- data/lib/algolia/models/search/automatic_facet_filter.rb +0 -2
- data/lib/algolia/models/search/automatic_facet_filters.rb +0 -1
- data/lib/algolia/models/search/banner.rb +0 -2
- data/lib/algolia/models/search/banner_image.rb +0 -2
- data/lib/algolia/models/search/banner_image_url.rb +0 -2
- data/lib/algolia/models/search/banner_link.rb +0 -2
- data/lib/algolia/models/search/batch_assign_user_ids_params.rb +0 -2
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +0 -2
- data/lib/algolia/models/search/batch_dictionary_entries_request.rb +0 -2
- data/lib/algolia/models/search/batch_params.rb +0 -2
- data/lib/algolia/models/search/batch_request.rb +0 -2
- data/lib/algolia/models/search/batch_response.rb +1 -3
- data/lib/algolia/models/search/batch_write_params.rb +0 -2
- data/lib/algolia/models/search/browse_params.rb +0 -1
- data/lib/algolia/models/search/browse_params_object.rb +10 -12
- data/lib/algolia/models/search/browse_response.rb +1 -3
- data/lib/algolia/models/search/built_in_operation.rb +0 -2
- data/lib/algolia/models/search/built_in_operation_value.rb +0 -1
- data/lib/algolia/models/search/condition.rb +0 -2
- data/lib/algolia/models/search/consequence.rb +0 -2
- data/lib/algolia/models/search/consequence_hide.rb +0 -2
- data/lib/algolia/models/search/consequence_params.rb +10 -12
- data/lib/algolia/models/search/consequence_query.rb +0 -1
- data/lib/algolia/models/search/consequence_query_object.rb +0 -2
- data/lib/algolia/models/search/created_at_response.rb +0 -2
- data/lib/algolia/models/search/delete_api_key_response.rb +0 -2
- data/lib/algolia/models/search/delete_by_params.rb +1 -3
- data/lib/algolia/models/search/delete_source_response.rb +0 -2
- data/lib/algolia/models/search/deleted_at_response.rb +1 -3
- data/lib/algolia/models/search/dictionary_entry.rb +0 -2
- data/lib/algolia/models/search/dictionary_language.rb +0 -2
- data/lib/algolia/models/search/dictionary_settings_params.rb +0 -2
- data/lib/algolia/models/search/distinct.rb +0 -1
- data/lib/algolia/models/search/edit.rb +0 -2
- data/lib/algolia/models/search/error_base.rb +0 -2
- data/lib/algolia/models/search/event.rb +0 -2
- data/lib/algolia/models/search/exhaustive.rb +0 -2
- data/lib/algolia/models/search/facet_filters.rb +0 -1
- data/lib/algolia/models/search/facet_hits.rb +0 -2
- data/lib/algolia/models/search/facet_ordering.rb +0 -2
- data/lib/algolia/models/search/facet_stats.rb +0 -2
- data/lib/algolia/models/search/facets.rb +0 -2
- data/lib/algolia/models/search/fetched_index.rb +0 -2
- data/lib/algolia/models/search/get_api_key_response.rb +1 -3
- data/lib/algolia/models/search/get_dictionary_settings_response.rb +0 -2
- data/lib/algolia/models/search/get_logs_response.rb +0 -2
- data/lib/algolia/models/search/get_objects_params.rb +0 -2
- data/lib/algolia/models/search/get_objects_request.rb +0 -2
- data/lib/algolia/models/search/get_objects_response.rb +0 -2
- data/lib/algolia/models/search/get_task_response.rb +0 -2
- data/lib/algolia/models/search/get_top_user_ids_response.rb +0 -2
- data/lib/algolia/models/search/has_pending_mappings_response.rb +0 -2
- data/lib/algolia/models/search/highlight_result.rb +0 -1
- data/lib/algolia/models/search/highlight_result_option.rb +0 -2
- data/lib/algolia/models/search/hit.rb +0 -2
- data/lib/algolia/models/search/ignore_plurals.rb +0 -1
- data/lib/algolia/models/search/index_settings.rb +15 -17
- data/lib/algolia/models/search/inside_bounding_box.rb +0 -1
- data/lib/algolia/models/search/languages.rb +0 -2
- data/lib/algolia/models/search/list_api_keys_response.rb +0 -2
- data/lib/algolia/models/search/list_clusters_response.rb +0 -2
- data/lib/algolia/models/search/list_indices_response.rb +0 -2
- data/lib/algolia/models/search/list_user_ids_response.rb +0 -2
- data/lib/algolia/models/search/log.rb +0 -2
- data/lib/algolia/models/search/log_query.rb +0 -2
- data/lib/algolia/models/search/matched_geo_location.rb +0 -2
- data/lib/algolia/models/search/multiple_batch_request.rb +0 -2
- data/lib/algolia/models/search/multiple_batch_response.rb +0 -2
- data/lib/algolia/models/search/numeric_filters.rb +0 -1
- data/lib/algolia/models/search/operation_index_params.rb +0 -2
- data/lib/algolia/models/search/optional_filters.rb +1 -2
- data/lib/algolia/models/search/optional_words.rb +0 -1
- data/lib/algolia/models/search/personalization.rb +0 -2
- data/lib/algolia/models/search/promote.rb +0 -1
- data/lib/algolia/models/search/promote_object_id.rb +0 -2
- data/lib/algolia/models/search/promote_object_ids.rb +0 -2
- data/lib/algolia/models/search/range.rb +0 -2
- data/lib/algolia/models/search/ranking_info.rb +0 -2
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +1 -2
- data/lib/algolia/models/search/redirect.rb +1 -3
- data/lib/algolia/models/search/redirect_rule_index_data.rb +0 -2
- data/lib/algolia/models/search/redirect_rule_index_metadata.rb +0 -2
- data/lib/algolia/models/search/redirect_url.rb +0 -2
- data/lib/algolia/models/search/remove_stop_words.rb +0 -1
- data/lib/algolia/models/search/remove_user_id_response.rb +0 -2
- data/lib/algolia/models/search/rendering_content.rb +0 -2
- data/lib/algolia/models/search/replace_all_objects_response.rb +0 -2
- data/lib/algolia/models/search/replace_all_objects_with_transformation_response.rb +0 -2
- data/lib/algolia/models/search/replace_source_response.rb +0 -2
- data/lib/algolia/models/search/rule.rb +0 -2
- data/lib/algolia/models/search/save_object_response.rb +1 -3
- data/lib/algolia/models/search/save_synonym_response.rb +1 -3
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +0 -2
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +1 -3
- data/lib/algolia/models/search/search_for_facet_values_request.rb +0 -2
- data/lib/algolia/models/search/search_for_facet_values_response.rb +0 -2
- data/lib/algolia/models/search/search_for_facets.rb +10 -12
- data/lib/algolia/models/search/search_for_hits.rb +10 -12
- data/lib/algolia/models/search/search_method_params.rb +0 -2
- data/lib/algolia/models/search/search_params.rb +0 -1
- data/lib/algolia/models/search/search_params_object.rb +10 -12
- data/lib/algolia/models/search/search_params_string.rb +0 -2
- data/lib/algolia/models/search/search_query.rb +0 -1
- data/lib/algolia/models/search/search_response.rb +1 -3
- data/lib/algolia/models/search/search_responses.rb +0 -2
- data/lib/algolia/models/search/search_result.rb +0 -1
- data/lib/algolia/models/search/search_rules_params.rb +2 -4
- data/lib/algolia/models/search/search_rules_response.rb +0 -2
- data/lib/algolia/models/search/search_synonyms_params.rb +0 -2
- data/lib/algolia/models/search/search_synonyms_response.rb +0 -2
- data/lib/algolia/models/search/search_user_ids_params.rb +0 -3
- data/lib/algolia/models/search/search_user_ids_response.rb +1 -3
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +0 -2
- data/lib/algolia/models/search/semantic_search.rb +0 -2
- data/lib/algolia/models/search/settings_response.rb +15 -17
- data/lib/algolia/models/search/snippet_result.rb +0 -1
- data/lib/algolia/models/search/snippet_result_option.rb +0 -2
- data/lib/algolia/models/search/source.rb +0 -2
- data/lib/algolia/models/search/standard_entries.rb +1 -3
- data/lib/algolia/models/search/synonym_hit.rb +4 -6
- data/lib/algolia/models/search/tag_filters.rb +0 -1
- data/lib/algolia/models/search/time_range.rb +0 -2
- data/lib/algolia/models/search/typo_tolerance.rb +1 -2
- data/lib/algolia/models/search/update_api_key_response.rb +0 -2
- data/lib/algolia/models/search/updated_at_response.rb +1 -3
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +1 -3
- data/lib/algolia/models/search/user_highlight_result.rb +0 -2
- data/lib/algolia/models/search/user_hit.rb +0 -2
- data/lib/algolia/models/search/user_id.rb +0 -2
- data/lib/algolia/models/search/value.rb +0 -2
- data/lib/algolia/models/search/watch_response.rb +0 -2
- data/lib/algolia/models/search/widgets.rb +0 -2
- data/lib/algolia/version.rb +1 -1
- metadata +3 -1
@@ -14,6 +14,18 @@ module Algolia
|
|
14
14
|
raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
|
15
15
|
raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
|
16
16
|
|
17
|
+
if config.connect_timeout.nil?
|
18
|
+
config.connect_timeout = 2000
|
19
|
+
end
|
20
|
+
|
21
|
+
if config.read_timeout.nil?
|
22
|
+
config.read_timeout = 5000
|
23
|
+
end
|
24
|
+
|
25
|
+
if config.write_timeout.nil?
|
26
|
+
config.write_timeout = 30000
|
27
|
+
end
|
28
|
+
|
17
29
|
@api_client = Algolia::ApiClient.new(config)
|
18
30
|
end
|
19
31
|
|
@@ -30,22 +42,10 @@ module Algolia
|
|
30
42
|
.shuffle
|
31
43
|
|
32
44
|
config = Algolia::Configuration.new(app_id, api_key, hosts, "Search", opts)
|
33
|
-
|
45
|
+
new(config)
|
34
46
|
end
|
35
47
|
|
36
48
|
def self.create_with_config(config)
|
37
|
-
if config.connect_timeout.nil?
|
38
|
-
config.connect_timeout = 2000
|
39
|
-
end
|
40
|
-
|
41
|
-
if config.read_timeout.nil?
|
42
|
-
config.read_timeout = 5000
|
43
|
-
end
|
44
|
-
|
45
|
-
if config.write_timeout.nil?
|
46
|
-
config.write_timeout = 30000
|
47
|
-
end
|
48
|
-
|
49
49
|
new(config)
|
50
50
|
end
|
51
51
|
|
@@ -109,7 +109,7 @@ module Algolia
|
|
109
109
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::AddApiKeyResponse")
|
110
110
|
end
|
111
111
|
|
112
|
-
# If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use auto-generated object IDs, use the [`saveObject` operation](
|
112
|
+
# If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use auto-generated object IDs, use the [`saveObject` operation](https://www.algolia.com/doc/rest-api/search/save-object). To update _some_ attributes of an existing record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object) instead. To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).
|
113
113
|
#
|
114
114
|
# Required API Key ACLs:
|
115
115
|
# - addObject
|
@@ -154,7 +154,7 @@ module Algolia
|
|
154
154
|
@api_client.call_api(:PUT, path, new_options)
|
155
155
|
end
|
156
156
|
|
157
|
-
# If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use auto-generated object IDs, use the [`saveObject` operation](
|
157
|
+
# If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use auto-generated object IDs, use the [`saveObject` operation](https://www.algolia.com/doc/rest-api/search/save-object). To update _some_ attributes of an existing record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object) instead. To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).
|
158
158
|
#
|
159
159
|
# Required API Key ACLs:
|
160
160
|
# - addObject
|
@@ -832,7 +832,7 @@ module Algolia
|
|
832
832
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeleteApiKeyResponse")
|
833
833
|
end
|
834
834
|
|
835
|
-
# This operation doesn't accept empty filters. This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. It's more efficient to get a list of object IDs with the [`browse` operation](
|
835
|
+
# This operation doesn't accept empty filters. This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. It's more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
836
836
|
#
|
837
837
|
# Required API Key ACLs:
|
838
838
|
# - deleteIndex
|
@@ -869,7 +869,7 @@ module Algolia
|
|
869
869
|
@api_client.call_api(:POST, path, new_options)
|
870
870
|
end
|
871
871
|
|
872
|
-
# This operation doesn't accept empty filters. This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. It's more efficient to get a list of object IDs with the [`browse` operation](
|
872
|
+
# This operation doesn't accept empty filters. This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. It's more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
873
873
|
#
|
874
874
|
# Required API Key ACLs:
|
875
875
|
# - deleteIndex
|
@@ -882,7 +882,7 @@ module Algolia
|
|
882
882
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
|
883
883
|
end
|
884
884
|
|
885
|
-
# Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas
|
885
|
+
# Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas).
|
886
886
|
#
|
887
887
|
# Required API Key ACLs:
|
888
888
|
# - deleteIndex
|
@@ -914,7 +914,7 @@ module Algolia
|
|
914
914
|
@api_client.call_api(:DELETE, path, new_options)
|
915
915
|
end
|
916
916
|
|
917
|
-
# Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas
|
917
|
+
# Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas).
|
918
918
|
#
|
919
919
|
# Required API Key ACLs:
|
920
920
|
# - deleteIndex
|
@@ -926,7 +926,7 @@ module Algolia
|
|
926
926
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
|
927
927
|
end
|
928
928
|
|
929
|
-
# Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](
|
929
|
+
# Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). To delete records matching a query, use the [`deleteBy` operation](https://www.algolia.com/doc/rest-api/search/delete-by).
|
930
930
|
#
|
931
931
|
# Required API Key ACLs:
|
932
932
|
# - deleteObject
|
@@ -966,7 +966,7 @@ module Algolia
|
|
966
966
|
@api_client.call_api(:DELETE, path, new_options)
|
967
967
|
end
|
968
968
|
|
969
|
-
# Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](
|
969
|
+
# Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). To delete records matching a query, use the [`deleteBy` operation](https://www.algolia.com/doc/rest-api/search/delete-by).
|
970
970
|
#
|
971
971
|
# Required API Key ACLs:
|
972
972
|
# - deleteObject
|
@@ -979,7 +979,7 @@ module Algolia
|
|
979
979
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
|
980
980
|
end
|
981
981
|
|
982
|
-
# Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](
|
982
|
+
# Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
|
983
983
|
#
|
984
984
|
# Required API Key ACLs:
|
985
985
|
# - editSettings
|
@@ -1020,7 +1020,7 @@ module Algolia
|
|
1020
1020
|
@api_client.call_api(:DELETE, path, new_options)
|
1021
1021
|
end
|
1022
1022
|
|
1023
|
-
# Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](
|
1023
|
+
# Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
|
1024
1024
|
#
|
1025
1025
|
# Required API Key ACLs:
|
1026
1026
|
# - editSettings
|
@@ -1078,7 +1078,7 @@ module Algolia
|
|
1078
1078
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeleteSourceResponse")
|
1079
1079
|
end
|
1080
1080
|
|
1081
|
-
# Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](
|
1081
|
+
# Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms).
|
1082
1082
|
#
|
1083
1083
|
# Required API Key ACLs:
|
1084
1084
|
# - editSettings
|
@@ -1119,7 +1119,7 @@ module Algolia
|
|
1119
1119
|
@api_client.call_api(:DELETE, path, new_options)
|
1120
1120
|
end
|
1121
1121
|
|
1122
|
-
# Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](
|
1122
|
+
# Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms).
|
1123
1123
|
#
|
1124
1124
|
# Required API Key ACLs:
|
1125
1125
|
# - editSettings
|
@@ -1343,7 +1343,7 @@ module Algolia
|
|
1343
1343
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetLogsResponse")
|
1344
1344
|
end
|
1345
1345
|
|
1346
|
-
# Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](
|
1346
|
+
# Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/get-objects).
|
1347
1347
|
#
|
1348
1348
|
# Required API Key ACLs:
|
1349
1349
|
# - search
|
@@ -1388,7 +1388,7 @@ module Algolia
|
|
1388
1388
|
@api_client.call_api(:GET, path, new_options)
|
1389
1389
|
end
|
1390
1390
|
|
1391
|
-
# Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](
|
1391
|
+
# Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/get-objects).
|
1392
1392
|
#
|
1393
1393
|
# Required API Key ACLs:
|
1394
1394
|
# - search
|
@@ -1446,7 +1446,7 @@ module Algolia
|
|
1446
1446
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetObjectsResponse")
|
1447
1447
|
end
|
1448
1448
|
|
1449
|
-
# Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](
|
1449
|
+
# Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
|
1450
1450
|
#
|
1451
1451
|
# Required API Key ACLs:
|
1452
1452
|
# - settings
|
@@ -1485,7 +1485,7 @@ module Algolia
|
|
1485
1485
|
@api_client.call_api(:GET, path, new_options)
|
1486
1486
|
end
|
1487
1487
|
|
1488
|
-
# Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](
|
1488
|
+
# Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
|
1489
1489
|
#
|
1490
1490
|
# Required API Key ACLs:
|
1491
1491
|
# - settings
|
@@ -1582,7 +1582,7 @@ module Algolia
|
|
1582
1582
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Array<Search::Source>")
|
1583
1583
|
end
|
1584
1584
|
|
1585
|
-
# Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](
|
1585
|
+
# Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms).
|
1586
1586
|
#
|
1587
1587
|
# Required API Key ACLs:
|
1588
1588
|
# - settings
|
@@ -1621,7 +1621,7 @@ module Algolia
|
|
1621
1621
|
@api_client.call_api(:GET, path, new_options)
|
1622
1622
|
end
|
1623
1623
|
|
1624
|
-
# Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](
|
1624
|
+
# Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms).
|
1625
1625
|
#
|
1626
1626
|
# Required API Key ACLs:
|
1627
1627
|
# - settings
|
@@ -2015,7 +2015,7 @@ module Algolia
|
|
2015
2015
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::MultipleBatchResponse")
|
2016
2016
|
end
|
2017
2017
|
|
2018
|
-
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. - This operation is resource-intensive. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices
|
2018
|
+
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. - This operation is resource-intensive. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2019
2019
|
#
|
2020
2020
|
# Required API Key ACLs:
|
2021
2021
|
# - addObject
|
@@ -2052,7 +2052,7 @@ module Algolia
|
|
2052
2052
|
@api_client.call_api(:POST, path, new_options)
|
2053
2053
|
end
|
2054
2054
|
|
2055
|
-
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. - This operation is resource-intensive. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices
|
2055
|
+
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. - This operation is resource-intensive. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2056
2056
|
#
|
2057
2057
|
# Required API Key ACLs:
|
2058
2058
|
# - addObject
|
@@ -2280,7 +2280,7 @@ module Algolia
|
|
2280
2280
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::AddApiKeyResponse")
|
2281
2281
|
end
|
2282
2282
|
|
2283
|
-
# Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](
|
2283
|
+
# Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2284
2284
|
#
|
2285
2285
|
# Required API Key ACLs:
|
2286
2286
|
# - addObject
|
@@ -2317,7 +2317,7 @@ module Algolia
|
|
2317
2317
|
@api_client.call_api(:POST, path, new_options)
|
2318
2318
|
end
|
2319
2319
|
|
2320
|
-
# Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](
|
2320
|
+
# Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2321
2321
|
#
|
2322
2322
|
# Required API Key ACLs:
|
2323
2323
|
# - addObject
|
@@ -2330,7 +2330,7 @@ module Algolia
|
|
2330
2330
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SaveObjectResponse")
|
2331
2331
|
end
|
2332
2332
|
|
2333
|
-
# If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](
|
2333
|
+
# If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-rules).
|
2334
2334
|
#
|
2335
2335
|
# Required API Key ACLs:
|
2336
2336
|
# - editSettings
|
@@ -2376,7 +2376,7 @@ module Algolia
|
|
2376
2376
|
@api_client.call_api(:PUT, path, new_options)
|
2377
2377
|
end
|
2378
2378
|
|
2379
|
-
# If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](
|
2379
|
+
# If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-rules).
|
2380
2380
|
#
|
2381
2381
|
# Required API Key ACLs:
|
2382
2382
|
# - editSettings
|
@@ -2459,7 +2459,7 @@ module Algolia
|
|
2459
2459
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
|
2460
2460
|
end
|
2461
2461
|
|
2462
|
-
# If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](
|
2462
|
+
# If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-synonyms).
|
2463
2463
|
#
|
2464
2464
|
# Required API Key ACLs:
|
2465
2465
|
# - editSettings
|
@@ -2511,7 +2511,7 @@ module Algolia
|
|
2511
2511
|
@api_client.call_api(:PUT, path, new_options)
|
2512
2512
|
end
|
2513
2513
|
|
2514
|
-
# If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](
|
2514
|
+
# If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-synonyms).
|
2515
2515
|
#
|
2516
2516
|
# Required API Key ACLs:
|
2517
2517
|
# - editSettings
|
@@ -2830,7 +2830,7 @@ module Algolia
|
|
2830
2830
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchRulesResponse")
|
2831
2831
|
end
|
2832
2832
|
|
2833
|
-
# Searches a single index and returns matching search results
|
2833
|
+
# Searches a single index and returns matching search results as hits. This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse) or increase the `paginatedLimitedTo` index setting.
|
2834
2834
|
#
|
2835
2835
|
# Required API Key ACLs:
|
2836
2836
|
# - search
|
@@ -2863,7 +2863,7 @@ module Algolia
|
|
2863
2863
|
@api_client.call_api(:POST, path, new_options)
|
2864
2864
|
end
|
2865
2865
|
|
2866
|
-
# Searches a single index and returns matching search results
|
2866
|
+
# Searches a single index and returns matching search results as hits. This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse) or increase the `paginatedLimitedTo` index setting.
|
2867
2867
|
#
|
2868
2868
|
# Required API Key ACLs:
|
2869
2869
|
# - search
|
@@ -14,7 +14,7 @@ module Algolia
|
|
14
14
|
# Unique A/B test identifier.
|
15
15
|
attr_accessor :ab_test_id
|
16
16
|
|
17
|
-
# Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](
|
17
|
+
# Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.
|
18
18
|
attr_accessor :task_id
|
19
19
|
|
20
20
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -228,8 +228,6 @@ module Algolia
|
|
228
228
|
value
|
229
229
|
end
|
230
230
|
end
|
231
|
-
|
232
231
|
end
|
233
|
-
|
234
232
|
end
|
235
233
|
end
|
@@ -14,7 +14,7 @@ module Algolia
|
|
14
14
|
# Unique A/B test identifier.
|
15
15
|
attr_accessor :ab_test_id
|
16
16
|
|
17
|
-
# Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](
|
17
|
+
# Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.
|
18
18
|
attr_accessor :task_id
|
19
19
|
|
20
20
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -228,8 +228,6 @@ module Algolia
|
|
228
228
|
value
|
229
229
|
end
|
230
230
|
end
|
231
|
-
|
232
231
|
end
|
233
|
-
|
234
232
|
end
|
235
233
|
end
|