algolia 3.11.0 → 3.12.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +18 -0
- data/Gemfile.lock +1 -1
- data/lib/algolia/api/abtesting_client.rb +3 -1
- data/lib/algolia/api/analytics_client.rb +45 -43
- data/lib/algolia/api/composition_client.rb +174 -0
- data/lib/algolia/api/ingestion_client.rb +7 -1
- data/lib/algolia/api/insights_client.rb +3 -1
- data/lib/algolia/api/monitoring_client.rb +2 -0
- data/lib/algolia/api/personalization_client.rb +3 -1
- data/lib/algolia/api/query_suggestions_client.rb +3 -1
- data/lib/algolia/api/recommend_client.rb +20 -18
- data/lib/algolia/api/search_client.rb +104 -90
- data/lib/algolia/models/abtesting/ab_test.rb +2 -0
- data/lib/algolia/models/abtesting/ab_test_configuration.rb +2 -0
- data/lib/algolia/models/abtesting/ab_test_response.rb +2 -0
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +2 -0
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +2 -0
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +2 -0
- data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +2 -0
- data/lib/algolia/models/abtesting/currency.rb +2 -0
- data/lib/algolia/models/abtesting/effect_metric.rb +2 -0
- data/lib/algolia/models/abtesting/empty_search.rb +2 -0
- data/lib/algolia/models/abtesting/empty_search_filter.rb +2 -0
- data/lib/algolia/models/abtesting/error_base.rb +2 -0
- data/lib/algolia/models/abtesting/estimate_ab_test_request.rb +2 -0
- data/lib/algolia/models/abtesting/estimate_ab_test_response.rb +2 -0
- data/lib/algolia/models/abtesting/estimate_configuration.rb +2 -0
- data/lib/algolia/models/abtesting/filter_effects.rb +2 -0
- data/lib/algolia/models/abtesting/list_ab_tests_response.rb +3 -1
- data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +2 -0
- data/lib/algolia/models/abtesting/outliers.rb +2 -0
- data/lib/algolia/models/abtesting/outliers_filter.rb +2 -0
- data/lib/algolia/models/abtesting/schedule_ab_test_response.rb +2 -0
- data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +2 -0
- data/lib/algolia/models/abtesting/status.rb +2 -0
- data/lib/algolia/models/abtesting/variant.rb +2 -0
- data/lib/algolia/models/analytics/click_position.rb +2 -0
- data/lib/algolia/models/analytics/currency_code.rb +2 -0
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_average_clicks.rb +2 -0
- data/lib/algolia/models/analytics/daily_click_through_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_no_click_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_no_results_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_purchase_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_revenue.rb +3 -1
- data/lib/algolia/models/analytics/daily_searches.rb +2 -0
- data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +2 -0
- data/lib/algolia/models/analytics/daily_searches_no_results.rb +2 -0
- data/lib/algolia/models/analytics/daily_users.rb +2 -0
- data/lib/algolia/models/analytics/direction.rb +2 -0
- data/lib/algolia/models/analytics/error_base.rb +2 -0
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +2 -0
- data/lib/algolia/models/analytics/get_click_positions_response.rb +2 -0
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_purchase_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_revenue.rb +3 -1
- data/lib/algolia/models/analytics/get_searches_count_response.rb +2 -0
- data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +2 -0
- data/lib/algolia/models/analytics/get_searches_no_results_response.rb +2 -0
- data/lib/algolia/models/analytics/get_status_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_countries_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filter_attribute.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +3 -1
- data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +2 -0
- data/lib/algolia/models/analytics/get_top_hits_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_searches_response.rb +2 -0
- data/lib/algolia/models/analytics/get_users_count_response.rb +2 -0
- data/lib/algolia/models/analytics/operator.rb +2 -0
- data/lib/algolia/models/analytics/order_by.rb +2 -0
- data/lib/algolia/models/analytics/top_country.rb +2 -0
- data/lib/algolia/models/analytics/top_hit.rb +3 -1
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +5 -3
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +8 -6
- data/lib/algolia/models/analytics/top_hits_response.rb +2 -0
- data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +2 -0
- data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +2 -0
- data/lib/algolia/models/analytics/top_search.rb +2 -0
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +4 -2
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +7 -5
- data/lib/algolia/models/analytics/top_searches_response.rb +2 -0
- data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +2 -0
- data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +2 -0
- data/lib/algolia/models/composition/around_precision.rb +110 -0
- data/lib/algolia/models/composition/around_radius.rb +110 -0
- data/lib/algolia/models/{ingestion/docker_registry.rb → composition/around_radius_all.rb} +8 -7
- data/lib/algolia/models/composition/banner.rb +215 -0
- data/lib/algolia/models/composition/banner_image.rb +220 -0
- data/lib/algolia/models/composition/banner_image_url.rb +209 -0
- data/lib/algolia/models/composition/banner_link.rb +209 -0
- data/lib/algolia/models/composition/composition_id_ranking_info.rb +221 -0
- data/lib/algolia/models/composition/composition_run_applied_rules.rb +211 -0
- data/lib/algolia/models/composition/composition_run_search_response.rb +222 -0
- data/lib/algolia/models/composition/compositions_search_response.rb +212 -0
- data/lib/algolia/models/composition/error_base.rb +209 -0
- data/lib/algolia/models/composition/exhaustive.rb +250 -0
- data/lib/algolia/models/composition/facet_filters.rb +110 -0
- data/lib/algolia/models/composition/facet_hits.rb +235 -0
- data/lib/algolia/models/composition/facet_ordering.rb +221 -0
- data/lib/algolia/models/composition/facet_stats.rb +239 -0
- data/lib/algolia/models/composition/facets.rb +209 -0
- data/lib/algolia/models/composition/highlight_result.rb +110 -0
- data/lib/algolia/models/composition/highlight_result_option.rb +255 -0
- data/lib/algolia/models/composition/hit.rb +251 -0
- data/lib/algolia/models/composition/hit_ranking_info.rb +371 -0
- data/lib/algolia/models/composition/inside_bounding_box.rb +109 -0
- data/lib/algolia/models/{ingestion/docker_image_type.rb → composition/match_level.rb} +10 -7
- data/lib/algolia/models/composition/matched_geo_location.rb +229 -0
- data/lib/algolia/models/composition/numeric_filters.rb +110 -0
- data/lib/algolia/models/composition/optional_filters.rb +110 -0
- data/lib/algolia/models/composition/params.rb +488 -0
- data/lib/algolia/models/composition/personalization.rb +229 -0
- data/lib/algolia/models/composition/range.rb +217 -0
- data/lib/algolia/models/composition/redirect.rb +208 -0
- data/lib/algolia/models/composition/redirect_rule_index_data.rb +211 -0
- data/lib/algolia/models/composition/redirect_rule_index_metadata.rb +258 -0
- data/lib/algolia/models/composition/redirect_url.rb +209 -0
- data/lib/algolia/models/composition/rendering_content.rb +227 -0
- data/lib/algolia/models/composition/request_body.rb +208 -0
- data/lib/algolia/models/composition/results_composition_info_response.rb +212 -0
- data/lib/algolia/models/composition/results_injected_item_applied_rules_info_response.rb +211 -0
- data/lib/algolia/models/composition/results_injected_item_info_response.rb +221 -0
- data/lib/algolia/models/composition/search_for_facet_values_params.rb +228 -0
- data/lib/algolia/models/composition/search_for_facet_values_request.rb +208 -0
- data/lib/algolia/models/composition/search_for_facet_values_response.rb +211 -0
- data/lib/algolia/models/composition/search_for_facet_values_results.rb +253 -0
- data/lib/algolia/models/composition/search_response.rb +230 -0
- data/lib/algolia/models/composition/search_results_item.rb +608 -0
- data/lib/algolia/models/composition/snippet_result.rb +110 -0
- data/lib/algolia/models/composition/snippet_result_option.rb +230 -0
- data/lib/algolia/models/composition/sort_remaining_by.rb +35 -0
- data/lib/algolia/models/composition/supported_language.rb +169 -0
- data/lib/algolia/models/composition/value.rb +229 -0
- data/lib/algolia/models/composition/widgets.rb +209 -0
- data/lib/algolia/models/ingestion/action.rb +2 -0
- data/lib/algolia/models/ingestion/action_type.rb +2 -0
- data/lib/algolia/models/ingestion/auth_algolia.rb +2 -0
- data/lib/algolia/models/ingestion/auth_algolia_insights.rb +2 -0
- data/lib/algolia/models/ingestion/auth_algolia_insights_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_algolia_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_api_key.rb +2 -0
- data/lib/algolia/models/ingestion/auth_api_key_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_basic.rb +2 -0
- data/lib/algolia/models/ingestion/auth_basic_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_google_service_account.rb +2 -0
- data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_input.rb +2 -0
- data/lib/algolia/models/ingestion/auth_input_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_o_auth.rb +2 -0
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +2 -0
- data/lib/algolia/models/ingestion/authentication.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_create.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_search.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_type.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_update.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/big_commerce_channel.rb +2 -0
- data/lib/algolia/models/ingestion/big_commerce_metafield.rb +2 -0
- data/lib/algolia/models/ingestion/big_query_data_type.rb +2 -0
- data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +2 -0
- data/lib/algolia/models/ingestion/delete_response.rb +2 -0
- data/lib/algolia/models/ingestion/destination.rb +2 -0
- data/lib/algolia/models/ingestion/destination_create.rb +2 -0
- data/lib/algolia/models/ingestion/destination_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/destination_index_name.rb +2 -0
- data/lib/algolia/models/ingestion/destination_input.rb +2 -0
- data/lib/algolia/models/ingestion/destination_search.rb +2 -0
- data/lib/algolia/models/ingestion/destination_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/destination_type.rb +2 -0
- data/lib/algolia/models/ingestion/destination_update.rb +2 -0
- data/lib/algolia/models/ingestion/destination_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/docker_streams.rb +2 -0
- data/lib/algolia/models/ingestion/docker_streams_input.rb +2 -0
- data/lib/algolia/models/ingestion/docker_streams_sync_mode.rb +2 -0
- data/lib/algolia/models/ingestion/email_notifications.rb +2 -0
- data/lib/algolia/models/ingestion/entity_type.rb +2 -0
- data/lib/algolia/models/ingestion/error_base.rb +2 -0
- data/lib/algolia/models/ingestion/event.rb +2 -0
- data/lib/algolia/models/ingestion/event_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/event_status.rb +2 -0
- data/lib/algolia/models/ingestion/event_type.rb +2 -0
- data/lib/algolia/models/ingestion/list_authentications_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_destinations_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_events_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_sources_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_tasks_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_tasks_response_v1.rb +2 -0
- data/lib/algolia/models/ingestion/list_transformations_response.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_field_directive.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_format_schema.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_input.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_kit_action.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_type_csv.rb +2 -0
- data/lib/algolia/models/ingestion/method_type.rb +2 -0
- data/lib/algolia/models/ingestion/notifications.rb +2 -0
- data/lib/algolia/models/ingestion/on_demand_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +2 -0
- data/lib/algolia/models/ingestion/on_demand_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/order_keys.rb +2 -0
- data/lib/algolia/models/ingestion/pagination.rb +2 -0
- data/lib/algolia/models/ingestion/platform.rb +2 -0
- data/lib/algolia/models/ingestion/platform_none.rb +2 -0
- data/lib/algolia/models/ingestion/platform_with_none.rb +2 -0
- data/lib/algolia/models/ingestion/policies.rb +2 -0
- data/lib/algolia/models/ingestion/push_task_payload.rb +2 -0
- data/lib/algolia/models/ingestion/push_task_records.rb +10 -8
- data/lib/algolia/models/ingestion/record_type.rb +2 -0
- data/lib/algolia/models/ingestion/run.rb +2 -0
- data/lib/algolia/models/ingestion/run_list_response.rb +2 -0
- data/lib/algolia/models/ingestion/run_outcome.rb +3 -2
- data/lib/algolia/models/ingestion/run_progress.rb +6 -0
- data/lib/algolia/models/ingestion/run_reason_code.rb +2 -0
- data/lib/algolia/models/ingestion/run_response.rb +2 -0
- data/lib/algolia/models/ingestion/run_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/run_source_payload.rb +2 -0
- data/lib/algolia/models/ingestion/run_source_response.rb +2 -0
- data/lib/algolia/models/ingestion/run_status.rb +2 -0
- data/lib/algolia/models/ingestion/run_type.rb +2 -0
- data/lib/algolia/models/ingestion/schedule_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/schedule_trigger_input.rb +2 -0
- data/lib/algolia/models/ingestion/schedule_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/shopify_input.rb +2 -0
- data/lib/algolia/models/ingestion/shopify_market.rb +2 -0
- data/lib/algolia/models/ingestion/shopify_metafield.rb +2 -0
- data/lib/algolia/models/ingestion/source.rb +2 -0
- data/lib/algolia/models/ingestion/source_big_commerce.rb +2 -0
- data/lib/algolia/models/ingestion/source_big_query.rb +2 -0
- data/lib/algolia/models/ingestion/source_commercetools.rb +2 -0
- data/lib/algolia/models/ingestion/source_create.rb +2 -0
- data/lib/algolia/models/ingestion/source_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/source_csv.rb +2 -0
- data/lib/algolia/models/ingestion/source_docker.rb +4 -36
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +2 -0
- data/lib/algolia/models/ingestion/source_input.rb +2 -0
- data/lib/algolia/models/ingestion/source_json.rb +2 -0
- data/lib/algolia/models/ingestion/source_search.rb +2 -0
- data/lib/algolia/models/ingestion/source_shopify.rb +2 -0
- data/lib/algolia/models/ingestion/source_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/source_type.rb +2 -0
- data/lib/algolia/models/ingestion/source_update.rb +2 -0
- data/lib/algolia/models/ingestion/source_update_commercetools.rb +2 -0
- data/lib/algolia/models/ingestion/source_update_docker.rb +3 -30
- data/lib/algolia/models/ingestion/source_update_input.rb +2 -0
- data/lib/algolia/models/ingestion/source_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/source_update_shopify.rb +2 -0
- data/lib/algolia/models/ingestion/streaming_input.rb +2 -0
- data/lib/algolia/models/ingestion/streaming_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/streaming_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/subscription_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/subscription_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/task.rb +2 -0
- data/lib/algolia/models/ingestion/task_create.rb +2 -0
- data/lib/algolia/models/ingestion/task_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/task_create_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/task_create_v1.rb +2 -0
- data/lib/algolia/models/ingestion/task_input.rb +2 -0
- data/lib/algolia/models/ingestion/task_search.rb +2 -0
- data/lib/algolia/models/ingestion/task_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/task_update.rb +2 -0
- data/lib/algolia/models/ingestion/task_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/task_update_v1.rb +2 -0
- data/lib/algolia/models/ingestion/task_v1.rb +2 -0
- data/lib/algolia/models/ingestion/transformation.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_create.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_error.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_search.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_try.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_try_response.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/trigger.rb +2 -0
- data/lib/algolia/models/ingestion/trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/trigger_update_input.rb +2 -0
- data/lib/algolia/models/ingestion/watch_response.rb +2 -0
- data/lib/algolia/models/ingestion/window.rb +2 -0
- data/lib/algolia/models/insights/add_to_cart_event.rb +2 -0
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +2 -0
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/insights/click_event.rb +2 -0
- data/lib/algolia/models/insights/clicked_filters.rb +2 -0
- data/lib/algolia/models/insights/clicked_object_ids.rb +2 -0
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/insights/conversion_event.rb +2 -0
- data/lib/algolia/models/insights/converted_filters.rb +2 -0
- data/lib/algolia/models/insights/converted_object_ids.rb +2 -0
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/insights/discount.rb +2 -0
- data/lib/algolia/models/insights/error_base.rb +2 -0
- data/lib/algolia/models/insights/events_items.rb +2 -0
- data/lib/algolia/models/insights/events_response.rb +2 -0
- data/lib/algolia/models/insights/insights_events.rb +2 -0
- data/lib/algolia/models/insights/object_data.rb +2 -0
- data/lib/algolia/models/insights/object_data_after_search.rb +2 -0
- data/lib/algolia/models/insights/price.rb +2 -0
- data/lib/algolia/models/insights/purchase_event.rb +2 -0
- data/lib/algolia/models/insights/purchased_object_ids.rb +2 -0
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/insights/value.rb +2 -0
- data/lib/algolia/models/insights/view_event.rb +2 -0
- data/lib/algolia/models/insights/viewed_filters.rb +2 -0
- data/lib/algolia/models/insights/viewed_object_ids.rb +2 -0
- data/lib/algolia/models/monitoring/error_base.rb +2 -0
- data/lib/algolia/models/monitoring/incident.rb +2 -0
- data/lib/algolia/models/monitoring/incident_entry.rb +2 -0
- data/lib/algolia/models/monitoring/incidents_response.rb +2 -0
- data/lib/algolia/models/monitoring/indexing_metric.rb +2 -0
- data/lib/algolia/models/monitoring/indexing_time_response.rb +2 -0
- data/lib/algolia/models/monitoring/infrastructure_response.rb +2 -0
- data/lib/algolia/models/monitoring/inventory_response.rb +2 -0
- data/lib/algolia/models/monitoring/latency_metric.rb +2 -0
- data/lib/algolia/models/monitoring/latency_response.rb +2 -0
- data/lib/algolia/models/monitoring/metric.rb +2 -0
- data/lib/algolia/models/monitoring/metrics.rb +2 -0
- data/lib/algolia/models/monitoring/period.rb +2 -0
- data/lib/algolia/models/monitoring/probes_metric.rb +2 -0
- data/lib/algolia/models/monitoring/region.rb +2 -0
- data/lib/algolia/models/monitoring/server.rb +2 -0
- data/lib/algolia/models/monitoring/server_status.rb +2 -0
- data/lib/algolia/models/monitoring/status.rb +2 -0
- data/lib/algolia/models/monitoring/status_response.rb +2 -0
- data/lib/algolia/models/monitoring/time_entry.rb +2 -0
- data/lib/algolia/models/monitoring/type.rb +2 -0
- data/lib/algolia/models/personalization/delete_user_profile_response.rb +2 -0
- data/lib/algolia/models/personalization/error_base.rb +2 -0
- data/lib/algolia/models/personalization/event_type.rb +2 -0
- data/lib/algolia/models/personalization/events_scoring.rb +2 -0
- data/lib/algolia/models/personalization/facets_scoring.rb +2 -0
- data/lib/algolia/models/personalization/get_user_token_response.rb +2 -0
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +2 -0
- data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +2 -0
- data/lib/algolia/models/query-suggestions/base_response.rb +2 -0
- data/lib/algolia/models/query-suggestions/config_status.rb +2 -0
- data/lib/algolia/models/query-suggestions/configuration.rb +2 -0
- data/lib/algolia/models/query-suggestions/configuration_response.rb +2 -0
- data/lib/algolia/models/query-suggestions/configuration_with_index.rb +2 -0
- data/lib/algolia/models/query-suggestions/error_base.rb +2 -0
- data/lib/algolia/models/query-suggestions/facet.rb +2 -0
- data/lib/algolia/models/query-suggestions/languages.rb +2 -0
- data/lib/algolia/models/query-suggestions/log_file.rb +2 -0
- data/lib/algolia/models/query-suggestions/log_level.rb +2 -0
- data/lib/algolia/models/query-suggestions/source_index.rb +2 -0
- data/lib/algolia/models/recommend/advanced_syntax_features.rb +2 -0
- data/lib/algolia/models/recommend/alternatives_as_exact.rb +2 -0
- data/lib/algolia/models/recommend/around_precision.rb +2 -0
- data/lib/algolia/models/recommend/around_radius.rb +2 -0
- data/lib/algolia/models/recommend/around_radius_all.rb +2 -0
- data/lib/algolia/models/recommend/auto_facet_filter.rb +2 -0
- data/lib/algolia/models/recommend/banner.rb +3 -1
- data/lib/algolia/models/recommend/banner_image.rb +3 -1
- data/lib/algolia/models/recommend/banner_image_url.rb +3 -1
- data/lib/algolia/models/recommend/banner_link.rb +3 -1
- data/lib/algolia/models/recommend/boolean_string.rb +2 -0
- data/lib/algolia/models/recommend/bought_together_query.rb +10 -8
- data/lib/algolia/models/recommend/condition.rb +2 -0
- data/lib/algolia/models/recommend/consequence.rb +2 -0
- data/lib/algolia/models/recommend/deleted_at_response.rb +2 -0
- data/lib/algolia/models/recommend/distinct.rb +2 -0
- data/lib/algolia/models/recommend/error_base.rb +2 -0
- data/lib/algolia/models/recommend/exact_on_single_word_query.rb +2 -0
- data/lib/algolia/models/recommend/exhaustive.rb +2 -0
- data/lib/algolia/models/recommend/facet_filters.rb +2 -0
- data/lib/algolia/models/recommend/facet_ordering.rb +2 -0
- data/lib/algolia/models/recommend/facet_stats.rb +2 -0
- data/lib/algolia/models/recommend/fallback_params.rb +27 -1
- data/lib/algolia/models/recommend/fbt_model.rb +2 -0
- data/lib/algolia/models/recommend/get_recommend_task_response.rb +2 -0
- data/lib/algolia/models/recommend/get_recommendations_params.rb +2 -0
- data/lib/algolia/models/recommend/get_recommendations_response.rb +2 -0
- data/lib/algolia/models/recommend/hide_consequence_object.rb +9 -7
- data/lib/algolia/models/recommend/highlight_result.rb +2 -0
- data/lib/algolia/models/recommend/highlight_result_option.rb +2 -0
- data/lib/algolia/models/recommend/ignore_plurals.rb +2 -0
- data/lib/algolia/models/recommend/index_settings_facets.rb +2 -0
- data/lib/algolia/models/recommend/inside_bounding_box.rb +2 -0
- data/lib/algolia/models/recommend/looking_similar_model.rb +2 -0
- data/lib/algolia/models/recommend/looking_similar_query.rb +10 -8
- data/lib/algolia/models/recommend/match_level.rb +2 -0
- data/lib/algolia/models/recommend/matched_geo_location.rb +2 -0
- data/lib/algolia/models/recommend/numeric_filters.rb +2 -0
- data/lib/algolia/models/recommend/optional_filters.rb +3 -1
- data/lib/algolia/models/recommend/optional_words.rb +2 -0
- data/lib/algolia/models/recommend/params_consequence.rb +2 -0
- data/lib/algolia/models/recommend/personalization.rb +2 -0
- data/lib/algolia/models/recommend/promote_consequence_object.rb +9 -7
- data/lib/algolia/models/recommend/query_type.rb +2 -0
- data/lib/algolia/models/recommend/range.rb +2 -0
- data/lib/algolia/models/recommend/ranking_info.rb +2 -0
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +2 -0
- data/lib/algolia/models/recommend/recommend_hit.rb +10 -8
- data/lib/algolia/models/recommend/recommend_models.rb +2 -0
- data/lib/algolia/models/recommend/recommend_rule.rb +9 -7
- data/lib/algolia/models/recommend/recommend_search_params.rb +27 -1
- data/lib/algolia/models/recommend/recommend_updated_at_response.rb +2 -0
- data/lib/algolia/models/recommend/recommendations_hit.rb +2 -0
- data/lib/algolia/models/recommend/recommendations_request.rb +2 -0
- data/lib/algolia/models/recommend/recommendations_results.rb +2 -0
- data/lib/algolia/models/recommend/redirect.rb +2 -0
- data/lib/algolia/models/recommend/redirect_rule_index_data.rb +2 -0
- data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +2 -0
- data/lib/algolia/models/recommend/redirect_url.rb +2 -0
- data/lib/algolia/models/recommend/related_model.rb +2 -0
- data/lib/algolia/models/recommend/related_query.rb +10 -8
- data/lib/algolia/models/recommend/remove_stop_words.rb +2 -0
- data/lib/algolia/models/recommend/remove_words_if_no_results.rb +2 -0
- data/lib/algolia/models/recommend/rendering_content.rb +2 -0
- data/lib/algolia/models/recommend/rule_metadata.rb +2 -0
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -0
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +2 -0
- data/lib/algolia/models/recommend/snippet_result.rb +2 -0
- data/lib/algolia/models/recommend/snippet_result_option.rb +2 -0
- data/lib/algolia/models/recommend/sort_remaining_by.rb +2 -0
- data/lib/algolia/models/recommend/supported_language.rb +2 -0
- data/lib/algolia/models/recommend/tag_filters.rb +2 -0
- data/lib/algolia/models/recommend/task_status.rb +2 -0
- data/lib/algolia/models/recommend/time_range.rb +2 -0
- data/lib/algolia/models/recommend/trending_facet_hit.rb +2 -0
- data/lib/algolia/models/recommend/trending_facets_model.rb +2 -0
- data/lib/algolia/models/recommend/trending_facets_query.rb +4 -4
- data/lib/algolia/models/recommend/trending_items_model.rb +2 -0
- data/lib/algolia/models/recommend/trending_items_query.rb +2 -0
- data/lib/algolia/models/recommend/typo_tolerance.rb +2 -0
- data/lib/algolia/models/recommend/typo_tolerance_enum.rb +2 -0
- data/lib/algolia/models/recommend/value.rb +2 -0
- data/lib/algolia/models/recommend/widgets.rb +4 -2
- data/lib/algolia/models/search/acl.rb +2 -0
- data/lib/algolia/models/search/action.rb +2 -0
- data/lib/algolia/models/search/add_api_key_response.rb +2 -0
- data/lib/algolia/models/search/advanced_syntax_features.rb +2 -0
- data/lib/algolia/models/search/alternatives_as_exact.rb +2 -0
- data/lib/algolia/models/search/anchoring.rb +2 -0
- data/lib/algolia/models/search/api_key.rb +2 -0
- data/lib/algolia/models/search/api_key_operation.rb +2 -0
- data/lib/algolia/models/search/around_precision.rb +2 -0
- data/lib/algolia/models/search/around_radius.rb +2 -0
- data/lib/algolia/models/search/around_radius_all.rb +2 -0
- data/lib/algolia/models/search/assign_user_id_params.rb +2 -0
- data/lib/algolia/models/search/attribute_to_update.rb +2 -0
- data/lib/algolia/models/search/automatic_facet_filter.rb +2 -0
- data/lib/algolia/models/search/automatic_facet_filters.rb +2 -0
- data/lib/algolia/models/search/banner.rb +3 -1
- data/lib/algolia/models/search/banner_image.rb +3 -1
- data/lib/algolia/models/search/banner_image_url.rb +3 -1
- data/lib/algolia/models/search/banner_link.rb +3 -1
- data/lib/algolia/models/search/batch_assign_user_ids_params.rb +2 -0
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +2 -0
- data/lib/algolia/models/search/batch_dictionary_entries_request.rb +2 -0
- data/lib/algolia/models/search/batch_params.rb +2 -0
- data/lib/algolia/models/search/batch_request.rb +2 -0
- data/lib/algolia/models/search/batch_response.rb +2 -0
- data/lib/algolia/models/search/batch_write_params.rb +2 -0
- data/lib/algolia/models/search/boolean_string.rb +2 -0
- data/lib/algolia/models/search/browse_params.rb +2 -0
- data/lib/algolia/models/search/browse_params_object.rb +3 -25
- data/lib/algolia/models/search/browse_response.rb +2 -0
- data/lib/algolia/models/search/built_in_operation.rb +2 -0
- data/lib/algolia/models/search/built_in_operation_type.rb +2 -0
- data/lib/algolia/models/search/built_in_operation_value.rb +2 -0
- data/lib/algolia/models/search/condition.rb +2 -0
- data/lib/algolia/models/search/consequence.rb +3 -3
- data/lib/algolia/models/search/consequence_hide.rb +10 -8
- data/lib/algolia/models/search/consequence_params.rb +3 -25
- data/lib/algolia/models/search/consequence_query.rb +2 -0
- data/lib/algolia/models/search/consequence_query_object.rb +2 -0
- data/lib/algolia/models/search/created_at_response.rb +2 -0
- data/lib/algolia/models/search/delete_api_key_response.rb +2 -0
- data/lib/algolia/models/search/delete_by_params.rb +2 -0
- data/lib/algolia/models/search/delete_source_response.rb +2 -0
- data/lib/algolia/models/search/deleted_at_response.rb +2 -0
- data/lib/algolia/models/search/dictionary_action.rb +2 -0
- data/lib/algolia/models/search/dictionary_entry.rb +10 -8
- data/lib/algolia/models/search/dictionary_entry_state.rb +2 -0
- data/lib/algolia/models/search/dictionary_entry_type.rb +2 -0
- data/lib/algolia/models/search/dictionary_language.rb +2 -0
- data/lib/algolia/models/search/dictionary_settings_params.rb +2 -0
- data/lib/algolia/models/search/dictionary_type.rb +2 -0
- data/lib/algolia/models/search/distinct.rb +2 -0
- data/lib/algolia/models/search/edit.rb +2 -0
- data/lib/algolia/models/search/edit_type.rb +2 -0
- data/lib/algolia/models/search/error_base.rb +2 -0
- data/lib/algolia/models/search/exact_on_single_word_query.rb +2 -0
- data/lib/algolia/models/search/exhaustive.rb +2 -0
- data/lib/algolia/models/search/facet_filters.rb +2 -0
- data/lib/algolia/models/search/facet_hits.rb +2 -0
- data/lib/algolia/models/search/facet_ordering.rb +2 -0
- data/lib/algolia/models/search/facet_stats.rb +2 -0
- data/lib/algolia/models/search/facets.rb +2 -0
- data/lib/algolia/models/search/fetched_index.rb +2 -0
- data/lib/algolia/models/search/get_api_key_response.rb +2 -0
- data/lib/algolia/models/search/get_dictionary_settings_response.rb +2 -0
- data/lib/algolia/models/search/get_logs_response.rb +2 -0
- data/lib/algolia/models/search/get_objects_params.rb +2 -0
- data/lib/algolia/models/search/get_objects_request.rb +10 -8
- data/lib/algolia/models/search/get_objects_response.rb +2 -0
- data/lib/algolia/models/search/get_task_response.rb +2 -0
- data/lib/algolia/models/search/get_top_user_ids_response.rb +2 -0
- data/lib/algolia/models/search/has_pending_mappings_response.rb +2 -0
- data/lib/algolia/models/search/highlight_result.rb +2 -0
- data/lib/algolia/models/search/highlight_result_option.rb +2 -0
- data/lib/algolia/models/search/hit.rb +10 -8
- data/lib/algolia/models/search/ignore_plurals.rb +2 -0
- data/lib/algolia/models/search/index_settings.rb +27 -25
- data/lib/algolia/models/search/inside_bounding_box.rb +2 -0
- data/lib/algolia/models/search/languages.rb +2 -0
- data/lib/algolia/models/search/list_api_keys_response.rb +2 -0
- data/lib/algolia/models/search/list_clusters_response.rb +2 -0
- data/lib/algolia/models/search/list_indices_response.rb +2 -0
- data/lib/algolia/models/search/list_user_ids_response.rb +2 -0
- data/lib/algolia/models/search/log.rb +2 -0
- data/lib/algolia/models/search/log_query.rb +2 -0
- data/lib/algolia/models/search/log_type.rb +2 -0
- data/lib/algolia/models/search/match_level.rb +2 -0
- data/lib/algolia/models/search/matched_geo_location.rb +2 -0
- data/lib/algolia/models/search/mode.rb +2 -0
- data/lib/algolia/models/search/multiple_batch_request.rb +2 -0
- data/lib/algolia/models/search/multiple_batch_response.rb +2 -0
- data/lib/algolia/models/search/numeric_filters.rb +2 -0
- data/lib/algolia/models/search/operation_index_params.rb +2 -0
- data/lib/algolia/models/search/operation_type.rb +2 -0
- data/lib/algolia/models/search/optional_filters.rb +3 -1
- data/lib/algolia/models/search/optional_words.rb +2 -0
- data/lib/algolia/models/search/personalization.rb +2 -0
- data/lib/algolia/models/search/promote.rb +2 -0
- data/lib/algolia/models/search/promote_object_id.rb +10 -8
- data/lib/algolia/models/search/promote_object_ids.rb +2 -0
- data/lib/algolia/models/search/query_type.rb +2 -0
- data/lib/algolia/models/search/range.rb +2 -0
- data/lib/algolia/models/search/ranking_info.rb +2 -0
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +2 -0
- data/lib/algolia/models/search/redirect.rb +2 -0
- data/lib/algolia/models/search/redirect_rule_index_data.rb +2 -0
- data/lib/algolia/models/search/redirect_rule_index_metadata.rb +2 -0
- data/lib/algolia/models/search/redirect_url.rb +2 -0
- data/lib/algolia/models/search/remove_stop_words.rb +2 -0
- data/lib/algolia/models/search/remove_user_id_response.rb +2 -0
- data/lib/algolia/models/search/remove_words_if_no_results.rb +2 -0
- data/lib/algolia/models/search/rendering_content.rb +2 -0
- data/lib/algolia/models/search/replace_all_objects_response.rb +2 -0
- data/lib/algolia/models/search/replace_source_response.rb +2 -0
- data/lib/algolia/models/search/rule.rb +10 -8
- data/lib/algolia/models/search/save_object_response.rb +9 -7
- data/lib/algolia/models/search/save_synonym_response.rb +2 -0
- data/lib/algolia/models/search/scope_type.rb +2 -0
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +2 -0
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +2 -0
- data/lib/algolia/models/search/search_for_facet_values_request.rb +2 -0
- data/lib/algolia/models/search/search_for_facet_values_response.rb +2 -0
- data/lib/algolia/models/search/search_for_facets.rb +3 -25
- data/lib/algolia/models/search/search_for_hits.rb +3 -25
- data/lib/algolia/models/search/search_method_params.rb +2 -0
- data/lib/algolia/models/search/search_params.rb +2 -0
- data/lib/algolia/models/search/search_params_object.rb +3 -25
- data/lib/algolia/models/search/search_params_string.rb +2 -0
- data/lib/algolia/models/search/search_query.rb +2 -0
- data/lib/algolia/models/search/search_response.rb +2 -0
- data/lib/algolia/models/search/search_responses.rb +2 -0
- data/lib/algolia/models/search/search_result.rb +2 -0
- data/lib/algolia/models/search/search_rules_params.rb +2 -0
- data/lib/algolia/models/search/search_rules_response.rb +2 -0
- data/lib/algolia/models/search/search_strategy.rb +2 -0
- data/lib/algolia/models/search/search_synonyms_params.rb +2 -0
- data/lib/algolia/models/search/search_synonyms_response.rb +2 -0
- data/lib/algolia/models/search/search_type_default.rb +2 -0
- data/lib/algolia/models/search/search_type_facet.rb +2 -0
- data/lib/algolia/models/search/search_user_ids_params.rb +2 -0
- data/lib/algolia/models/search/search_user_ids_response.rb +2 -0
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +2 -0
- data/lib/algolia/models/search/semantic_search.rb +2 -0
- data/lib/algolia/models/search/settings_response.rb +27 -25
- data/lib/algolia/models/search/snippet_result.rb +2 -0
- data/lib/algolia/models/search/snippet_result_option.rb +2 -0
- data/lib/algolia/models/search/sort_remaining_by.rb +2 -0
- data/lib/algolia/models/search/source.rb +2 -0
- data/lib/algolia/models/search/standard_entries.rb +2 -0
- data/lib/algolia/models/search/supported_language.rb +2 -0
- data/lib/algolia/models/search/synonym_hit.rb +10 -8
- data/lib/algolia/models/search/synonym_type.rb +2 -0
- data/lib/algolia/models/search/tag_filters.rb +2 -0
- data/lib/algolia/models/search/task_status.rb +2 -0
- data/lib/algolia/models/search/time_range.rb +2 -0
- data/lib/algolia/models/search/typo_tolerance.rb +2 -0
- data/lib/algolia/models/search/typo_tolerance_enum.rb +2 -0
- data/lib/algolia/models/search/update_api_key_response.rb +2 -0
- data/lib/algolia/models/search/updated_at_response.rb +2 -0
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +9 -7
- data/lib/algolia/models/search/user_highlight_result.rb +2 -0
- data/lib/algolia/models/search/user_hit.rb +10 -8
- data/lib/algolia/models/search/user_id.rb +2 -0
- data/lib/algolia/models/search/value.rb +2 -0
- data/lib/algolia/models/search/widgets.rb +4 -2
- data/lib/algolia/version.rb +3 -1
- metadata +54 -4
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# 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
4
|
|
3
5
|
require "date"
|
@@ -11,7 +13,7 @@ module Algolia
|
|
11
13
|
attr_accessor :attributes_to_retrieve
|
12
14
|
|
13
15
|
# Object ID for the record to retrieve.
|
14
|
-
attr_accessor :
|
16
|
+
attr_accessor :algolia_object_id
|
15
17
|
|
16
18
|
# Index from which to retrieve the records.
|
17
19
|
attr_accessor :index_name
|
@@ -20,7 +22,7 @@ module Algolia
|
|
20
22
|
def self.attribute_map
|
21
23
|
{
|
22
24
|
:attributes_to_retrieve => :attributesToRetrieve,
|
23
|
-
:
|
25
|
+
:algolia_object_id => :objectID,
|
24
26
|
:index_name => :indexName
|
25
27
|
}
|
26
28
|
end
|
@@ -29,7 +31,7 @@ module Algolia
|
|
29
31
|
def self.types_mapping
|
30
32
|
{
|
31
33
|
:attributes_to_retrieve => :"Array<String>",
|
32
|
-
:
|
34
|
+
:algolia_object_id => :"String",
|
33
35
|
:index_name => :"String"
|
34
36
|
}
|
35
37
|
end
|
@@ -70,10 +72,10 @@ module Algolia
|
|
70
72
|
end
|
71
73
|
end
|
72
74
|
|
73
|
-
if attributes.key?(:
|
74
|
-
self.
|
75
|
+
if attributes.key?(:algolia_object_id)
|
76
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
75
77
|
else
|
76
|
-
self.
|
78
|
+
self.algolia_object_id = nil
|
77
79
|
end
|
78
80
|
|
79
81
|
if attributes.key?(:index_name)
|
@@ -89,7 +91,7 @@ module Algolia
|
|
89
91
|
return true if self.equal?(other)
|
90
92
|
self.class == other.class &&
|
91
93
|
attributes_to_retrieve == other.attributes_to_retrieve &&
|
92
|
-
|
94
|
+
algolia_object_id == other.algolia_object_id &&
|
93
95
|
index_name == other.index_name
|
94
96
|
end
|
95
97
|
|
@@ -102,7 +104,7 @@ module Algolia
|
|
102
104
|
# Calculates hash code according to all attributes.
|
103
105
|
# @return [Integer] Hash code
|
104
106
|
def hash
|
105
|
-
[attributes_to_retrieve,
|
107
|
+
[attributes_to_retrieve, algolia_object_id, index_name].hash
|
106
108
|
end
|
107
109
|
|
108
110
|
# Builds the object from hash
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# 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
4
|
|
3
5
|
require "date"
|
@@ -8,7 +10,7 @@ module Algolia
|
|
8
10
|
# Search result. A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
|
9
11
|
class Hit
|
10
12
|
# Unique record identifier.
|
11
|
-
attr_accessor :
|
13
|
+
attr_accessor :algolia_object_id
|
12
14
|
|
13
15
|
# Surround words that match the query with HTML tags for highlighting.
|
14
16
|
attr_accessor :_highlight_result
|
@@ -25,7 +27,7 @@ module Algolia
|
|
25
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
26
28
|
def self.attribute_map
|
27
29
|
{
|
28
|
-
:
|
30
|
+
:algolia_object_id => :objectID,
|
29
31
|
:_highlight_result => :_highlightResult,
|
30
32
|
:_snippet_result => :_snippetResult,
|
31
33
|
:_ranking_info => :_rankingInfo,
|
@@ -36,7 +38,7 @@ module Algolia
|
|
36
38
|
# Attribute type mapping.
|
37
39
|
def self.types_mapping
|
38
40
|
{
|
39
|
-
:
|
41
|
+
:algolia_object_id => :"String",
|
40
42
|
:_highlight_result => :"Hash<String, HighlightResult>",
|
41
43
|
:_snippet_result => :"Hash<String, SnippetResult>",
|
42
44
|
:_ranking_info => :"RankingInfo",
|
@@ -58,10 +60,10 @@ module Algolia
|
|
58
60
|
raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Hit` initialize method"
|
59
61
|
end
|
60
62
|
|
61
|
-
if attributes.key?(:
|
62
|
-
self.
|
63
|
+
if attributes.key?(:algolia_object_id)
|
64
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
63
65
|
else
|
64
|
-
self.
|
66
|
+
self.algolia_object_id = nil
|
65
67
|
end
|
66
68
|
|
67
69
|
if attributes.key?(:_highlight_result)
|
@@ -94,7 +96,7 @@ module Algolia
|
|
94
96
|
def ==(other)
|
95
97
|
return true if self.equal?(other)
|
96
98
|
self.class == other.class &&
|
97
|
-
|
99
|
+
algolia_object_id == other.algolia_object_id &&
|
98
100
|
_highlight_result == other._highlight_result &&
|
99
101
|
_snippet_result == other._snippet_result &&
|
100
102
|
_ranking_info == other._ranking_info &&
|
@@ -110,7 +112,7 @@ module Algolia
|
|
110
112
|
# Calculates hash code according to all attributes.
|
111
113
|
# @return [Integer] Hash code
|
112
114
|
def hash
|
113
|
-
[
|
115
|
+
[algolia_object_id, _highlight_result, _snippet_result, _ranking_info, _distinct_seq_id].hash
|
114
116
|
end
|
115
117
|
|
116
118
|
# Builds the object from hash
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# 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
4
|
|
3
5
|
require "date"
|
@@ -61,15 +63,18 @@ module Algolia
|
|
61
63
|
# Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
|
62
64
|
attr_accessor :max_facet_hits
|
63
65
|
|
66
|
+
# Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
|
67
|
+
attr_accessor :keep_diacritics_on_characters
|
68
|
+
|
69
|
+
# Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
|
70
|
+
attr_accessor :custom_ranking
|
71
|
+
|
64
72
|
# Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
|
65
73
|
attr_accessor :attributes_to_retrieve
|
66
74
|
|
67
75
|
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
|
68
76
|
attr_accessor :ranking
|
69
77
|
|
70
|
-
# Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
|
71
|
-
attr_accessor :custom_ranking
|
72
|
-
|
73
78
|
# Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
|
74
79
|
attr_accessor :relevancy_strictness
|
75
80
|
|
@@ -112,9 +117,6 @@ module Algolia
|
|
112
117
|
|
113
118
|
attr_accessor :remove_stop_words
|
114
119
|
|
115
|
-
# Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
|
116
|
-
attr_accessor :keep_diacritics_on_characters
|
117
|
-
|
118
120
|
# Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
|
119
121
|
attr_accessor :query_languages
|
120
122
|
|
@@ -159,7 +161,7 @@ module Algolia
|
|
159
161
|
# Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
|
160
162
|
attr_accessor :min_proximity
|
161
163
|
|
162
|
-
# Properties to include in the API response of
|
164
|
+
# Properties to include in the API response of search and browse requests. By default, all response properties are included. To reduce the response size, you can select which properties should be included. An empty list may lead to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
|
163
165
|
attr_accessor :response_fields
|
164
166
|
|
165
167
|
# Maximum number of facet values to return for each facet.
|
@@ -199,9 +201,10 @@ module Algolia
|
|
199
201
|
:custom_normalization => :customNormalization,
|
200
202
|
:attribute_for_distinct => :attributeForDistinct,
|
201
203
|
:max_facet_hits => :maxFacetHits,
|
204
|
+
:keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
|
205
|
+
:custom_ranking => :customRanking,
|
202
206
|
:attributes_to_retrieve => :attributesToRetrieve,
|
203
207
|
:ranking => :ranking,
|
204
|
-
:custom_ranking => :customRanking,
|
205
208
|
:relevancy_strictness => :relevancyStrictness,
|
206
209
|
:attributes_to_highlight => :attributesToHighlight,
|
207
210
|
:attributes_to_snippet => :attributesToSnippet,
|
@@ -217,7 +220,6 @@ module Algolia
|
|
217
220
|
:disable_typo_tolerance_on_attributes => :disableTypoToleranceOnAttributes,
|
218
221
|
:ignore_plurals => :ignorePlurals,
|
219
222
|
:remove_stop_words => :removeStopWords,
|
220
|
-
:keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
|
221
223
|
:query_languages => :queryLanguages,
|
222
224
|
:decompound_query => :decompoundQuery,
|
223
225
|
:enable_rules => :enableRules,
|
@@ -266,9 +268,10 @@ module Algolia
|
|
266
268
|
:custom_normalization => :"Hash<String, Hash<String, String>>",
|
267
269
|
:attribute_for_distinct => :"String",
|
268
270
|
:max_facet_hits => :"Integer",
|
271
|
+
:keep_diacritics_on_characters => :"String",
|
272
|
+
:custom_ranking => :"Array<String>",
|
269
273
|
:attributes_to_retrieve => :"Array<String>",
|
270
274
|
:ranking => :"Array<String>",
|
271
|
-
:custom_ranking => :"Array<String>",
|
272
275
|
:relevancy_strictness => :"Integer",
|
273
276
|
:attributes_to_highlight => :"Array<String>",
|
274
277
|
:attributes_to_snippet => :"Array<String>",
|
@@ -284,7 +287,6 @@ module Algolia
|
|
284
287
|
:disable_typo_tolerance_on_attributes => :"Array<String>",
|
285
288
|
:ignore_plurals => :"IgnorePlurals",
|
286
289
|
:remove_stop_words => :"RemoveStopWords",
|
287
|
-
:keep_diacritics_on_characters => :"String",
|
288
290
|
:query_languages => :"Array<SupportedLanguage>",
|
289
291
|
:decompound_query => :"Boolean",
|
290
292
|
:enable_rules => :"Boolean",
|
@@ -446,6 +448,16 @@ module Algolia
|
|
446
448
|
self.max_facet_hits = attributes[:max_facet_hits]
|
447
449
|
end
|
448
450
|
|
451
|
+
if attributes.key?(:keep_diacritics_on_characters)
|
452
|
+
self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters]
|
453
|
+
end
|
454
|
+
|
455
|
+
if attributes.key?(:custom_ranking)
|
456
|
+
if (value = attributes[:custom_ranking]).is_a?(Array)
|
457
|
+
self.custom_ranking = value
|
458
|
+
end
|
459
|
+
end
|
460
|
+
|
449
461
|
if attributes.key?(:attributes_to_retrieve)
|
450
462
|
if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
|
451
463
|
self.attributes_to_retrieve = value
|
@@ -458,12 +470,6 @@ module Algolia
|
|
458
470
|
end
|
459
471
|
end
|
460
472
|
|
461
|
-
if attributes.key?(:custom_ranking)
|
462
|
-
if (value = attributes[:custom_ranking]).is_a?(Array)
|
463
|
-
self.custom_ranking = value
|
464
|
-
end
|
465
|
-
end
|
466
|
-
|
467
473
|
if attributes.key?(:relevancy_strictness)
|
468
474
|
self.relevancy_strictness = attributes[:relevancy_strictness]
|
469
475
|
end
|
@@ -530,10 +536,6 @@ module Algolia
|
|
530
536
|
self.remove_stop_words = attributes[:remove_stop_words]
|
531
537
|
end
|
532
538
|
|
533
|
-
if attributes.key?(:keep_diacritics_on_characters)
|
534
|
-
self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters]
|
535
|
-
end
|
536
|
-
|
537
539
|
if attributes.key?(:query_languages)
|
538
540
|
if (value = attributes[:query_languages]).is_a?(Array)
|
539
541
|
self.query_languages = value
|
@@ -664,9 +666,10 @@ module Algolia
|
|
664
666
|
custom_normalization == other.custom_normalization &&
|
665
667
|
attribute_for_distinct == other.attribute_for_distinct &&
|
666
668
|
max_facet_hits == other.max_facet_hits &&
|
669
|
+
keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
|
670
|
+
custom_ranking == other.custom_ranking &&
|
667
671
|
attributes_to_retrieve == other.attributes_to_retrieve &&
|
668
672
|
ranking == other.ranking &&
|
669
|
-
custom_ranking == other.custom_ranking &&
|
670
673
|
relevancy_strictness == other.relevancy_strictness &&
|
671
674
|
attributes_to_highlight == other.attributes_to_highlight &&
|
672
675
|
attributes_to_snippet == other.attributes_to_snippet &&
|
@@ -682,7 +685,6 @@ module Algolia
|
|
682
685
|
disable_typo_tolerance_on_attributes == other.disable_typo_tolerance_on_attributes &&
|
683
686
|
ignore_plurals == other.ignore_plurals &&
|
684
687
|
remove_stop_words == other.remove_stop_words &&
|
685
|
-
keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
|
686
688
|
query_languages == other.query_languages &&
|
687
689
|
decompound_query == other.decompound_query &&
|
688
690
|
enable_rules == other.enable_rules &&
|
@@ -737,9 +739,10 @@ module Algolia
|
|
737
739
|
custom_normalization,
|
738
740
|
attribute_for_distinct,
|
739
741
|
max_facet_hits,
|
742
|
+
keep_diacritics_on_characters,
|
743
|
+
custom_ranking,
|
740
744
|
attributes_to_retrieve,
|
741
745
|
ranking,
|
742
|
-
custom_ranking,
|
743
746
|
relevancy_strictness,
|
744
747
|
attributes_to_highlight,
|
745
748
|
attributes_to_snippet,
|
@@ -755,7 +758,6 @@ module Algolia
|
|
755
758
|
disable_typo_tolerance_on_attributes,
|
756
759
|
ignore_plurals,
|
757
760
|
remove_stop_words,
|
758
|
-
keep_diacritics_on_characters,
|
759
761
|
query_languages,
|
760
762
|
decompound_query,
|
761
763
|
enable_rules,
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# 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
4
|
|
3
5
|
require "date"
|
@@ -5,7 +7,7 @@ require "time"
|
|
5
7
|
|
6
8
|
module Algolia
|
7
9
|
module Search
|
8
|
-
# Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes.
|
10
|
+
# Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)). - Optional filters don't work with numeric attributes.
|
9
11
|
module OptionalFilters
|
10
12
|
class << self
|
11
13
|
# List of class defined in oneOf (OpenAPI v3)
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# 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
4
|
|
3
5
|
require "date"
|
@@ -8,7 +10,7 @@ module Algolia
|
|
8
10
|
# Record to promote.
|
9
11
|
class PromoteObjectID
|
10
12
|
# Unique record identifier.
|
11
|
-
attr_accessor :
|
13
|
+
attr_accessor :algolia_object_id
|
12
14
|
|
13
15
|
# Position in the search results where you want to show the promoted records.
|
14
16
|
attr_accessor :position
|
@@ -16,7 +18,7 @@ module Algolia
|
|
16
18
|
# Attribute mapping from ruby-style variable name to JSON key.
|
17
19
|
def self.attribute_map
|
18
20
|
{
|
19
|
-
:
|
21
|
+
:algolia_object_id => :objectID,
|
20
22
|
:position => :position
|
21
23
|
}
|
22
24
|
end
|
@@ -31,7 +33,7 @@ module Algolia
|
|
31
33
|
# Attribute type mapping.
|
32
34
|
def self.types_mapping
|
33
35
|
{
|
34
|
-
:
|
36
|
+
:algolia_object_id => :"String",
|
35
37
|
:position => :"Integer"
|
36
38
|
}
|
37
39
|
end
|
@@ -66,10 +68,10 @@ module Algolia
|
|
66
68
|
h[k.to_sym] = v
|
67
69
|
}
|
68
70
|
|
69
|
-
if attributes.key?(:
|
70
|
-
self.
|
71
|
+
if attributes.key?(:algolia_object_id)
|
72
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
71
73
|
else
|
72
|
-
self.
|
74
|
+
self.algolia_object_id = nil
|
73
75
|
end
|
74
76
|
|
75
77
|
if attributes.key?(:position)
|
@@ -84,7 +86,7 @@ module Algolia
|
|
84
86
|
def ==(other)
|
85
87
|
return true if self.equal?(other)
|
86
88
|
self.class == other.class &&
|
87
|
-
|
89
|
+
algolia_object_id == other.algolia_object_id &&
|
88
90
|
position == other.position
|
89
91
|
end
|
90
92
|
|
@@ -97,7 +99,7 @@ module Algolia
|
|
97
99
|
# Calculates hash code according to all attributes.
|
98
100
|
# @return [Integer] Hash code
|
99
101
|
def hash
|
100
|
-
[
|
102
|
+
[algolia_object_id, position].hash
|
101
103
|
end
|
102
104
|
|
103
105
|
# Builds the object from hash
|