algolia 3.10.2 → 3.12.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/ISSUE_TEMPLATE/Bug_report.yml +1 -1
- data/.github/workflows/release.yml +1 -1
- data/CHANGELOG.md +24 -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 +15 -3
- 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 +160 -141
- data/lib/algolia/models/abtesting/ab_test.rb +2 -5
- data/lib/algolia/models/abtesting/ab_test_configuration.rb +2 -5
- data/lib/algolia/models/abtesting/ab_test_response.rb +2 -5
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +2 -5
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +7 -3
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +2 -5
- data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +7 -6
- data/lib/algolia/models/abtesting/currency.rb +2 -5
- data/lib/algolia/models/abtesting/effect_metric.rb +2 -0
- data/lib/algolia/models/abtesting/empty_search.rb +2 -5
- data/lib/algolia/models/abtesting/empty_search_filter.rb +2 -5
- data/lib/algolia/models/abtesting/error_base.rb +2 -5
- data/lib/algolia/models/abtesting/estimate_ab_test_request.rb +2 -5
- data/lib/algolia/models/abtesting/estimate_ab_test_response.rb +2 -5
- data/lib/algolia/models/abtesting/estimate_configuration.rb +2 -5
- data/lib/algolia/models/abtesting/filter_effects.rb +2 -5
- data/lib/algolia/models/abtesting/list_ab_tests_response.rb +2 -5
- data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +2 -5
- data/lib/algolia/models/abtesting/outliers.rb +2 -5
- data/lib/algolia/models/abtesting/outliers_filter.rb +2 -5
- data/lib/algolia/models/abtesting/schedule_ab_test_response.rb +2 -5
- data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +2 -5
- data/lib/algolia/models/abtesting/status.rb +2 -0
- data/lib/algolia/models/abtesting/variant.rb +2 -5
- data/lib/algolia/models/analytics/click_position.rb +2 -5
- data/lib/algolia/models/analytics/currency_code.rb +2 -5
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +3 -6
- data/lib/algolia/models/analytics/daily_average_clicks.rb +2 -5
- data/lib/algolia/models/analytics/daily_click_through_rates.rb +3 -6
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +3 -6
- data/lib/algolia/models/analytics/daily_no_click_rates.rb +3 -6
- data/lib/algolia/models/analytics/daily_no_results_rates.rb +3 -6
- data/lib/algolia/models/analytics/daily_purchase_rates.rb +3 -6
- data/lib/algolia/models/analytics/daily_revenue.rb +3 -6
- data/lib/algolia/models/analytics/daily_searches.rb +2 -5
- data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +2 -5
- data/lib/algolia/models/analytics/daily_searches_no_results.rb +2 -5
- data/lib/algolia/models/analytics/daily_users.rb +2 -5
- data/lib/algolia/models/analytics/direction.rb +2 -0
- data/lib/algolia/models/analytics/error_base.rb +2 -5
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +3 -6
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +2 -5
- data/lib/algolia/models/analytics/get_click_positions_response.rb +2 -5
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +3 -6
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +3 -6
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +3 -6
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +3 -6
- data/lib/algolia/models/analytics/get_purchase_rate_response.rb +3 -6
- data/lib/algolia/models/analytics/get_revenue.rb +3 -6
- data/lib/algolia/models/analytics/get_searches_count_response.rb +2 -5
- data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +2 -5
- data/lib/algolia/models/analytics/get_searches_no_results_response.rb +2 -5
- data/lib/algolia/models/analytics/get_status_response.rb +2 -5
- data/lib/algolia/models/analytics/get_top_countries_response.rb +2 -5
- data/lib/algolia/models/analytics/get_top_filter_attribute.rb +2 -5
- data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +2 -5
- data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +2 -5
- data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +2 -5
- data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +3 -6
- data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +2 -5
- data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +2 -5
- data/lib/algolia/models/analytics/get_top_hits_response.rb +7 -6
- data/lib/algolia/models/analytics/get_top_searches_response.rb +7 -6
- data/lib/algolia/models/analytics/get_users_count_response.rb +2 -5
- 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 -5
- data/lib/algolia/models/analytics/top_hit.rb +3 -6
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +5 -8
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +8 -11
- data/lib/algolia/models/analytics/top_hits_response.rb +2 -5
- data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +2 -5
- data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +2 -5
- data/lib/algolia/models/analytics/top_search.rb +2 -5
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +4 -7
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +7 -10
- data/lib/algolia/models/analytics/top_searches_response.rb +2 -5
- data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +2 -5
- data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +2 -5
- 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 -8
- 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 -5
- data/lib/algolia/models/ingestion/auth_algolia_insights.rb +2 -5
- data/lib/algolia/models/ingestion/auth_algolia_insights_partial.rb +2 -5
- data/lib/algolia/models/ingestion/auth_algolia_partial.rb +2 -5
- data/lib/algolia/models/ingestion/auth_api_key.rb +7 -3
- data/lib/algolia/models/ingestion/auth_api_key_partial.rb +7 -3
- data/lib/algolia/models/ingestion/auth_basic.rb +8 -3
- data/lib/algolia/models/ingestion/auth_basic_partial.rb +7 -3
- data/lib/algolia/models/ingestion/auth_google_service_account.rb +8 -3
- data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +7 -3
- data/lib/algolia/models/ingestion/auth_input.rb +7 -6
- data/lib/algolia/models/ingestion/auth_input_partial.rb +7 -6
- data/lib/algolia/models/ingestion/auth_o_auth.rb +9 -3
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +7 -3
- data/lib/algolia/models/ingestion/authentication.rb +2 -5
- data/lib/algolia/models/ingestion/authentication_create.rb +2 -5
- data/lib/algolia/models/ingestion/authentication_create_response.rb +2 -5
- data/lib/algolia/models/ingestion/authentication_search.rb +2 -5
- 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 -5
- data/lib/algolia/models/ingestion/authentication_update_response.rb +2 -5
- data/lib/algolia/models/ingestion/big_commerce_channel.rb +2 -5
- data/lib/algolia/models/ingestion/big_commerce_metafield.rb +2 -5
- data/lib/algolia/models/ingestion/big_query_data_type.rb +2 -0
- data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +2 -5
- data/lib/algolia/models/ingestion/delete_response.rb +2 -5
- data/lib/algolia/models/ingestion/destination.rb +2 -5
- data/lib/algolia/models/ingestion/destination_create.rb +2 -5
- data/lib/algolia/models/ingestion/destination_create_response.rb +2 -5
- data/lib/algolia/models/ingestion/destination_index_name.rb +2 -5
- data/lib/algolia/models/ingestion/destination_input.rb +7 -6
- data/lib/algolia/models/ingestion/destination_search.rb +2 -5
- 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 -5
- data/lib/algolia/models/ingestion/destination_update_response.rb +2 -5
- data/lib/algolia/models/ingestion/docker_streams.rb +2 -5
- data/lib/algolia/models/ingestion/docker_streams_input.rb +8 -4
- data/lib/algolia/models/ingestion/docker_streams_sync_mode.rb +2 -0
- data/lib/algolia/models/ingestion/email_notifications.rb +209 -0
- data/lib/algolia/models/ingestion/entity_type.rb +2 -0
- data/lib/algolia/models/ingestion/error_base.rb +2 -5
- data/lib/algolia/models/ingestion/event.rb +2 -5
- 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 -5
- data/lib/algolia/models/ingestion/list_destinations_response.rb +2 -5
- data/lib/algolia/models/ingestion/list_events_response.rb +2 -5
- data/lib/algolia/models/ingestion/list_sources_response.rb +2 -5
- data/lib/algolia/models/ingestion/list_tasks_response.rb +2 -5
- data/lib/algolia/models/ingestion/list_tasks_response_v1.rb +2 -5
- data/lib/algolia/models/ingestion/list_transformations_response.rb +2 -5
- data/lib/algolia/models/ingestion/mapping_field_directive.rb +2 -5
- data/lib/algolia/models/ingestion/mapping_format_schema.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_input.rb +8 -3
- data/lib/algolia/models/ingestion/mapping_kit_action.rb +2 -5
- 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 +211 -0
- data/lib/algolia/models/ingestion/on_demand_trigger.rb +2 -5
- data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +2 -5
- 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 -5
- 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 +7 -6
- data/lib/algolia/models/ingestion/policies.rb +207 -0
- data/lib/algolia/models/ingestion/push_task_payload.rb +2 -5
- data/lib/algolia/models/ingestion/push_task_records.rb +10 -13
- data/lib/algolia/models/ingestion/record_type.rb +2 -0
- data/lib/algolia/models/ingestion/run.rb +2 -5
- data/lib/algolia/models/ingestion/run_list_response.rb +2 -5
- data/lib/algolia/models/ingestion/run_outcome.rb +3 -2
- data/lib/algolia/models/ingestion/run_progress.rb +6 -5
- data/lib/algolia/models/ingestion/run_reason_code.rb +2 -0
- data/lib/algolia/models/ingestion/run_response.rb +2 -5
- data/lib/algolia/models/ingestion/run_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/run_source_payload.rb +2 -5
- data/lib/algolia/models/ingestion/run_source_response.rb +2 -5
- 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 -5
- data/lib/algolia/models/ingestion/schedule_trigger_input.rb +7 -3
- data/lib/algolia/models/ingestion/schedule_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/shopify_input.rb +2 -5
- data/lib/algolia/models/ingestion/shopify_market.rb +2 -5
- data/lib/algolia/models/ingestion/shopify_metafield.rb +2 -5
- data/lib/algolia/models/ingestion/source.rb +2 -5
- data/lib/algolia/models/ingestion/source_big_commerce.rb +7 -3
- data/lib/algolia/models/ingestion/source_big_query.rb +7 -3
- data/lib/algolia/models/ingestion/source_commercetools.rb +7 -3
- data/lib/algolia/models/ingestion/source_create.rb +2 -5
- data/lib/algolia/models/ingestion/source_create_response.rb +2 -5
- data/lib/algolia/models/ingestion/source_csv.rb +2 -5
- data/lib/algolia/models/ingestion/source_docker.rb +10 -37
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +9 -3
- data/lib/algolia/models/ingestion/source_input.rb +7 -6
- data/lib/algolia/models/ingestion/source_json.rb +2 -5
- data/lib/algolia/models/ingestion/source_search.rb +2 -5
- data/lib/algolia/models/ingestion/source_shopify.rb +7 -3
- 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 -5
- data/lib/algolia/models/ingestion/source_update_commercetools.rb +2 -5
- data/lib/algolia/models/ingestion/source_update_docker.rb +8 -33
- data/lib/algolia/models/ingestion/source_update_input.rb +7 -6
- data/lib/algolia/models/ingestion/source_update_response.rb +2 -5
- data/lib/algolia/models/ingestion/source_update_shopify.rb +2 -5
- data/lib/algolia/models/ingestion/streaming_input.rb +7 -3
- data/lib/algolia/models/ingestion/streaming_trigger.rb +2 -5
- data/lib/algolia/models/ingestion/streaming_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/subscription_trigger.rb +2 -5
- data/lib/algolia/models/ingestion/subscription_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/task.rb +22 -5
- data/lib/algolia/models/ingestion/task_create.rb +24 -9
- data/lib/algolia/models/ingestion/task_create_response.rb +2 -5
- data/lib/algolia/models/ingestion/task_create_trigger.rb +7 -6
- data/lib/algolia/models/ingestion/task_create_v1.rb +2 -5
- data/lib/algolia/models/ingestion/task_input.rb +7 -6
- data/lib/algolia/models/ingestion/task_search.rb +2 -5
- data/lib/algolia/models/ingestion/task_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/task_update.rb +24 -9
- data/lib/algolia/models/ingestion/task_update_response.rb +2 -5
- data/lib/algolia/models/ingestion/task_update_v1.rb +2 -5
- data/lib/algolia/models/ingestion/task_v1.rb +22 -5
- data/lib/algolia/models/ingestion/transformation.rb +2 -5
- data/lib/algolia/models/ingestion/transformation_create.rb +2 -5
- data/lib/algolia/models/ingestion/transformation_create_response.rb +2 -5
- data/lib/algolia/models/ingestion/transformation_error.rb +2 -5
- data/lib/algolia/models/ingestion/transformation_search.rb +2 -5
- data/lib/algolia/models/ingestion/transformation_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_try.rb +2 -5
- data/lib/algolia/models/ingestion/transformation_try_response.rb +2 -5
- data/lib/algolia/models/ingestion/transformation_update_response.rb +2 -5
- data/lib/algolia/models/ingestion/trigger.rb +7 -6
- data/lib/algolia/models/ingestion/trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/trigger_update_input.rb +2 -5
- data/lib/algolia/models/ingestion/watch_response.rb +2 -5
- data/lib/algolia/models/ingestion/window.rb +2 -5
- data/lib/algolia/models/insights/add_to_cart_event.rb +2 -0
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +9 -3
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +10 -3
- data/lib/algolia/models/insights/click_event.rb +2 -0
- data/lib/algolia/models/insights/clicked_filters.rb +8 -3
- data/lib/algolia/models/insights/clicked_object_ids.rb +8 -3
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +9 -3
- data/lib/algolia/models/insights/conversion_event.rb +2 -0
- data/lib/algolia/models/insights/converted_filters.rb +8 -3
- data/lib/algolia/models/insights/converted_object_ids.rb +8 -3
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +8 -3
- data/lib/algolia/models/insights/discount.rb +7 -6
- data/lib/algolia/models/insights/error_base.rb +2 -5
- data/lib/algolia/models/insights/events_items.rb +7 -6
- data/lib/algolia/models/insights/events_response.rb +2 -5
- data/lib/algolia/models/insights/insights_events.rb +2 -5
- data/lib/algolia/models/insights/object_data.rb +2 -5
- data/lib/algolia/models/insights/object_data_after_search.rb +2 -5
- data/lib/algolia/models/insights/price.rb +7 -6
- data/lib/algolia/models/insights/purchase_event.rb +2 -0
- data/lib/algolia/models/insights/purchased_object_ids.rb +9 -3
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +10 -3
- data/lib/algolia/models/insights/value.rb +7 -6
- data/lib/algolia/models/insights/view_event.rb +2 -0
- data/lib/algolia/models/insights/viewed_filters.rb +8 -3
- data/lib/algolia/models/insights/viewed_object_ids.rb +8 -3
- data/lib/algolia/models/monitoring/error_base.rb +2 -5
- data/lib/algolia/models/monitoring/incident.rb +2 -5
- data/lib/algolia/models/monitoring/incident_entry.rb +2 -5
- data/lib/algolia/models/monitoring/incidents_response.rb +2 -5
- data/lib/algolia/models/monitoring/indexing_metric.rb +2 -5
- data/lib/algolia/models/monitoring/indexing_time_response.rb +2 -5
- data/lib/algolia/models/monitoring/infrastructure_response.rb +2 -5
- data/lib/algolia/models/monitoring/inventory_response.rb +2 -5
- data/lib/algolia/models/monitoring/latency_metric.rb +2 -5
- data/lib/algolia/models/monitoring/latency_response.rb +2 -5
- data/lib/algolia/models/monitoring/metric.rb +2 -0
- data/lib/algolia/models/monitoring/metrics.rb +2 -5
- data/lib/algolia/models/monitoring/period.rb +2 -0
- data/lib/algolia/models/monitoring/probes_metric.rb +2 -5
- data/lib/algolia/models/monitoring/region.rb +2 -0
- data/lib/algolia/models/monitoring/server.rb +2 -5
- 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 -5
- data/lib/algolia/models/monitoring/time_entry.rb +2 -5
- data/lib/algolia/models/monitoring/type.rb +2 -0
- data/lib/algolia/models/personalization/delete_user_profile_response.rb +2 -5
- data/lib/algolia/models/personalization/error_base.rb +2 -5
- data/lib/algolia/models/personalization/event_type.rb +2 -0
- data/lib/algolia/models/personalization/{event_scoring.rb → events_scoring.rb} +5 -8
- data/lib/algolia/models/personalization/{facet_scoring.rb → facets_scoring.rb} +5 -8
- data/lib/algolia/models/personalization/get_user_token_response.rb +2 -5
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +19 -22
- data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +2 -5
- data/lib/algolia/models/query-suggestions/base_response.rb +2 -5
- data/lib/algolia/models/query-suggestions/config_status.rb +2 -5
- data/lib/algolia/models/query-suggestions/configuration.rb +2 -5
- data/lib/algolia/models/query-suggestions/configuration_response.rb +2 -5
- data/lib/algolia/models/query-suggestions/configuration_with_index.rb +2 -5
- data/lib/algolia/models/query-suggestions/error_base.rb +2 -5
- data/lib/algolia/models/query-suggestions/facet.rb +2 -5
- data/lib/algolia/models/query-suggestions/languages.rb +7 -6
- data/lib/algolia/models/query-suggestions/log_file.rb +2 -5
- data/lib/algolia/models/query-suggestions/log_level.rb +2 -0
- data/lib/algolia/models/query-suggestions/source_index.rb +2 -5
- 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 +7 -6
- data/lib/algolia/models/recommend/around_radius.rb +7 -6
- data/lib/algolia/models/recommend/around_radius_all.rb +2 -0
- data/lib/algolia/models/recommend/auto_facet_filter.rb +2 -5
- data/lib/algolia/models/recommend/banner.rb +3 -6
- data/lib/algolia/models/recommend/banner_image.rb +3 -6
- data/lib/algolia/models/recommend/banner_image_url.rb +3 -6
- data/lib/algolia/models/recommend/banner_link.rb +3 -6
- data/lib/algolia/models/recommend/boolean_string.rb +2 -0
- data/lib/algolia/models/recommend/bought_together_query.rb +10 -13
- data/lib/algolia/models/recommend/condition.rb +2 -5
- data/lib/algolia/models/recommend/consequence.rb +2 -5
- data/lib/algolia/models/recommend/deleted_at_response.rb +2 -5
- data/lib/algolia/models/recommend/distinct.rb +7 -6
- data/lib/algolia/models/recommend/error_base.rb +2 -5
- data/lib/algolia/models/recommend/exact_on_single_word_query.rb +2 -0
- data/lib/algolia/models/recommend/exhaustive.rb +2 -5
- data/lib/algolia/models/recommend/facet_filters.rb +7 -6
- data/lib/algolia/models/recommend/facet_ordering.rb +2 -5
- data/lib/algolia/models/recommend/facet_stats.rb +2 -5
- data/lib/algolia/models/recommend/fallback_params.rb +26 -5
- data/lib/algolia/models/recommend/fbt_model.rb +2 -0
- data/lib/algolia/models/recommend/get_recommend_task_response.rb +2 -5
- data/lib/algolia/models/recommend/get_recommendations_params.rb +2 -5
- data/lib/algolia/models/recommend/get_recommendations_response.rb +2 -5
- data/lib/algolia/models/recommend/hide_consequence_object.rb +9 -12
- data/lib/algolia/models/recommend/highlight_result.rb +7 -6
- data/lib/algolia/models/recommend/highlight_result_option.rb +8 -3
- data/lib/algolia/models/recommend/ignore_plurals.rb +7 -6
- data/lib/algolia/models/recommend/index_settings_facets.rb +2 -5
- data/lib/algolia/models/recommend/inside_bounding_box.rb +7 -6
- data/lib/algolia/models/recommend/looking_similar_model.rb +2 -0
- data/lib/algolia/models/recommend/looking_similar_query.rb +10 -13
- data/lib/algolia/models/recommend/match_level.rb +2 -0
- data/lib/algolia/models/recommend/matched_geo_location.rb +2 -5
- data/lib/algolia/models/recommend/numeric_filters.rb +7 -6
- data/lib/algolia/models/recommend/optional_filters.rb +8 -7
- data/lib/algolia/models/recommend/optional_words.rb +7 -6
- data/lib/algolia/models/recommend/params_consequence.rb +2 -5
- data/lib/algolia/models/recommend/personalization.rb +2 -5
- data/lib/algolia/models/recommend/promote_consequence_object.rb +9 -12
- data/lib/algolia/models/recommend/query_type.rb +2 -0
- data/lib/algolia/models/recommend/range.rb +2 -5
- data/lib/algolia/models/recommend/ranking_info.rb +2 -5
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +7 -6
- data/lib/algolia/models/recommend/recommend_hit.rb +15 -11
- data/lib/algolia/models/recommend/recommend_models.rb +2 -0
- data/lib/algolia/models/recommend/recommend_rule.rb +9 -12
- data/lib/algolia/models/recommend/recommend_search_params.rb +26 -5
- data/lib/algolia/models/recommend/recommend_updated_at_response.rb +2 -5
- data/lib/algolia/models/recommend/recommendations_hit.rb +7 -6
- data/lib/algolia/models/recommend/recommendations_request.rb +7 -6
- data/lib/algolia/models/recommend/recommendations_results.rb +2 -5
- data/lib/algolia/models/recommend/redirect.rb +2 -5
- data/lib/algolia/models/recommend/redirect_rule_index_data.rb +2 -5
- data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +2 -5
- data/lib/algolia/models/recommend/redirect_url.rb +2 -5
- data/lib/algolia/models/recommend/related_model.rb +2 -0
- data/lib/algolia/models/recommend/related_query.rb +10 -13
- data/lib/algolia/models/recommend/remove_stop_words.rb +7 -6
- data/lib/algolia/models/recommend/remove_words_if_no_results.rb +2 -0
- data/lib/algolia/models/recommend/rendering_content.rb +2 -5
- data/lib/algolia/models/recommend/rule_metadata.rb +2 -5
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -5
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +2 -5
- data/lib/algolia/models/recommend/snippet_result.rb +7 -6
- data/lib/algolia/models/recommend/snippet_result_option.rb +7 -3
- 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 +7 -6
- data/lib/algolia/models/recommend/task_status.rb +2 -0
- data/lib/algolia/models/recommend/time_range.rb +2 -5
- data/lib/algolia/models/recommend/trending_facet_hit.rb +8 -3
- data/lib/algolia/models/recommend/trending_facets_model.rb +2 -0
- data/lib/algolia/models/recommend/trending_facets_query.rb +2 -5
- data/lib/algolia/models/recommend/trending_items_model.rb +2 -0
- data/lib/algolia/models/recommend/trending_items_query.rb +2 -5
- data/lib/algolia/models/recommend/typo_tolerance.rb +7 -6
- data/lib/algolia/models/recommend/typo_tolerance_enum.rb +2 -0
- data/lib/algolia/models/recommend/value.rb +2 -5
- data/lib/algolia/models/recommend/widgets.rb +4 -7
- 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 -5
- 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 -5
- data/lib/algolia/models/search/api_key_operation.rb +2 -0
- data/lib/algolia/models/search/around_precision.rb +7 -6
- data/lib/algolia/models/search/around_radius.rb +7 -6
- data/lib/algolia/models/search/around_radius_all.rb +2 -0
- data/lib/algolia/models/search/assign_user_id_params.rb +2 -5
- data/lib/algolia/models/search/attribute_to_update.rb +7 -6
- data/lib/algolia/models/search/automatic_facet_filter.rb +2 -5
- data/lib/algolia/models/search/automatic_facet_filters.rb +7 -6
- data/lib/algolia/models/search/banner.rb +3 -6
- data/lib/algolia/models/search/banner_image.rb +3 -6
- data/lib/algolia/models/search/banner_image_url.rb +3 -6
- data/lib/algolia/models/search/banner_link.rb +3 -6
- data/lib/algolia/models/search/batch_assign_user_ids_params.rb +2 -5
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +2 -5
- data/lib/algolia/models/search/batch_dictionary_entries_request.rb +2 -5
- data/lib/algolia/models/search/batch_params.rb +2 -5
- data/lib/algolia/models/search/batch_request.rb +2 -5
- data/lib/algolia/models/search/batch_response.rb +2 -5
- data/lib/algolia/models/search/batch_write_params.rb +2 -5
- data/lib/algolia/models/search/boolean_string.rb +2 -0
- data/lib/algolia/models/search/browse_params.rb +7 -6
- data/lib/algolia/models/search/browse_params_object.rb +2 -29
- data/lib/algolia/models/search/browse_response.rb +2 -5
- data/lib/algolia/models/search/built_in_operation.rb +2 -5
- data/lib/algolia/models/search/built_in_operation_type.rb +2 -0
- data/lib/algolia/models/search/built_in_operation_value.rb +7 -6
- data/lib/algolia/models/search/condition.rb +2 -5
- data/lib/algolia/models/search/consequence.rb +2 -5
- data/lib/algolia/models/search/consequence_hide.rb +10 -13
- data/lib/algolia/models/search/consequence_params.rb +2 -29
- data/lib/algolia/models/search/consequence_query.rb +7 -6
- data/lib/algolia/models/search/consequence_query_object.rb +2 -5
- data/lib/algolia/models/search/created_at_response.rb +2 -5
- data/lib/algolia/models/search/delete_api_key_response.rb +2 -5
- data/lib/algolia/models/search/delete_by_params.rb +2 -5
- data/lib/algolia/models/search/delete_source_response.rb +2 -5
- data/lib/algolia/models/search/deleted_at_response.rb +2 -5
- data/lib/algolia/models/search/dictionary_action.rb +2 -0
- data/lib/algolia/models/search/dictionary_entry.rb +10 -13
- 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 -5
- data/lib/algolia/models/search/dictionary_settings_params.rb +2 -5
- data/lib/algolia/models/search/dictionary_type.rb +2 -0
- data/lib/algolia/models/search/distinct.rb +7 -6
- data/lib/algolia/models/search/edit.rb +2 -5
- data/lib/algolia/models/search/edit_type.rb +2 -0
- data/lib/algolia/models/search/error_base.rb +2 -5
- data/lib/algolia/models/search/exact_on_single_word_query.rb +2 -0
- data/lib/algolia/models/search/exhaustive.rb +2 -5
- data/lib/algolia/models/search/facet_filters.rb +7 -6
- data/lib/algolia/models/search/facet_hits.rb +2 -5
- data/lib/algolia/models/search/facet_ordering.rb +2 -5
- data/lib/algolia/models/search/facet_stats.rb +2 -5
- data/lib/algolia/models/search/facets.rb +2 -5
- data/lib/algolia/models/search/fetched_index.rb +2 -5
- data/lib/algolia/models/search/get_api_key_response.rb +2 -5
- data/lib/algolia/models/search/get_dictionary_settings_response.rb +2 -5
- data/lib/algolia/models/search/get_logs_response.rb +2 -5
- data/lib/algolia/models/search/get_objects_params.rb +2 -5
- data/lib/algolia/models/search/get_objects_request.rb +10 -13
- data/lib/algolia/models/search/get_objects_response.rb +2 -5
- data/lib/algolia/models/search/get_task_response.rb +2 -5
- data/lib/algolia/models/search/get_top_user_ids_response.rb +2 -5
- data/lib/algolia/models/search/has_pending_mappings_response.rb +2 -5
- data/lib/algolia/models/search/highlight_result.rb +7 -6
- data/lib/algolia/models/search/highlight_result_option.rb +8 -3
- data/lib/algolia/models/search/hit.rb +10 -13
- data/lib/algolia/models/search/ignore_plurals.rb +7 -6
- data/lib/algolia/models/search/index_settings.rb +26 -29
- data/lib/algolia/models/search/inside_bounding_box.rb +7 -6
- data/lib/algolia/models/search/languages.rb +2 -5
- data/lib/algolia/models/search/list_api_keys_response.rb +2 -5
- data/lib/algolia/models/search/list_clusters_response.rb +2 -5
- data/lib/algolia/models/search/list_indices_response.rb +2 -5
- data/lib/algolia/models/search/list_user_ids_response.rb +2 -5
- data/lib/algolia/models/search/log.rb +2 -5
- data/lib/algolia/models/search/log_query.rb +2 -5
- 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 -5
- data/lib/algolia/models/search/mode.rb +2 -0
- data/lib/algolia/models/search/multiple_batch_request.rb +2 -5
- data/lib/algolia/models/search/multiple_batch_response.rb +2 -5
- data/lib/algolia/models/search/numeric_filters.rb +7 -6
- data/lib/algolia/models/search/operation_index_params.rb +2 -5
- data/lib/algolia/models/search/operation_type.rb +2 -0
- data/lib/algolia/models/search/optional_filters.rb +8 -7
- data/lib/algolia/models/search/optional_words.rb +7 -6
- data/lib/algolia/models/search/personalization.rb +2 -5
- data/lib/algolia/models/search/promote.rb +7 -6
- data/lib/algolia/models/search/promote_object_id.rb +15 -11
- data/lib/algolia/models/search/promote_object_ids.rb +7 -3
- data/lib/algolia/models/search/query_type.rb +2 -0
- data/lib/algolia/models/search/range.rb +2 -5
- data/lib/algolia/models/search/ranking_info.rb +2 -5
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +7 -6
- data/lib/algolia/models/search/redirect.rb +2 -5
- data/lib/algolia/models/search/redirect_rule_index_data.rb +2 -5
- data/lib/algolia/models/search/redirect_rule_index_metadata.rb +2 -5
- data/lib/algolia/models/search/redirect_url.rb +2 -5
- data/lib/algolia/models/search/remove_stop_words.rb +7 -6
- data/lib/algolia/models/search/remove_user_id_response.rb +2 -5
- data/lib/algolia/models/search/remove_words_if_no_results.rb +2 -0
- data/lib/algolia/models/search/rendering_content.rb +2 -5
- data/lib/algolia/models/search/replace_all_objects_response.rb +2 -5
- data/lib/algolia/models/search/replace_source_response.rb +2 -5
- data/lib/algolia/models/search/rule.rb +10 -13
- data/lib/algolia/models/search/save_object_response.rb +9 -12
- data/lib/algolia/models/search/save_synonym_response.rb +2 -5
- data/lib/algolia/models/search/scope_type.rb +2 -0
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +2 -5
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +2 -5
- data/lib/algolia/models/search/search_for_facet_values_request.rb +2 -5
- data/lib/algolia/models/search/search_for_facet_values_response.rb +7 -3
- data/lib/algolia/models/search/search_for_facets.rb +8 -27
- data/lib/algolia/models/search/search_for_hits.rb +2 -29
- data/lib/algolia/models/search/search_method_params.rb +2 -5
- data/lib/algolia/models/search/search_params.rb +7 -6
- data/lib/algolia/models/search/search_params_object.rb +2 -29
- data/lib/algolia/models/search/search_params_string.rb +7 -3
- data/lib/algolia/models/search/search_query.rb +7 -6
- data/lib/algolia/models/search/search_response.rb +2 -5
- data/lib/algolia/models/search/search_responses.rb +2 -5
- data/lib/algolia/models/search/search_result.rb +7 -6
- data/lib/algolia/models/search/search_rules_params.rb +2 -5
- data/lib/algolia/models/search/search_rules_response.rb +2 -5
- data/lib/algolia/models/search/search_strategy.rb +2 -0
- data/lib/algolia/models/search/search_synonyms_params.rb +2 -5
- data/lib/algolia/models/search/search_synonyms_response.rb +2 -5
- 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 -5
- data/lib/algolia/models/search/search_user_ids_response.rb +2 -5
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +2 -5
- data/lib/algolia/models/search/semantic_search.rb +2 -5
- data/lib/algolia/models/search/settings_response.rb +26 -29
- data/lib/algolia/models/search/snippet_result.rb +7 -6
- data/lib/algolia/models/search/snippet_result_option.rb +7 -3
- data/lib/algolia/models/search/sort_remaining_by.rb +2 -0
- data/lib/algolia/models/search/source.rb +2 -5
- data/lib/algolia/models/search/standard_entries.rb +2 -5
- data/lib/algolia/models/search/supported_language.rb +2 -0
- data/lib/algolia/models/search/synonym_hit.rb +10 -13
- data/lib/algolia/models/search/synonym_type.rb +2 -0
- data/lib/algolia/models/search/tag_filters.rb +7 -6
- data/lib/algolia/models/search/task_status.rb +2 -0
- data/lib/algolia/models/search/time_range.rb +2 -5
- data/lib/algolia/models/search/typo_tolerance.rb +7 -6
- data/lib/algolia/models/search/typo_tolerance_enum.rb +2 -0
- data/lib/algolia/models/search/update_api_key_response.rb +2 -5
- data/lib/algolia/models/search/updated_at_response.rb +2 -5
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +9 -12
- data/lib/algolia/models/search/user_highlight_result.rb +2 -5
- data/lib/algolia/models/search/user_hit.rb +10 -13
- data/lib/algolia/models/search/user_id.rb +2 -5
- data/lib/algolia/models/search/value.rb +2 -5
- data/lib/algolia/models/search/widgets.rb +4 -7
- data/lib/algolia/version.rb +3 -1
- metadata +60 -11
|
@@ -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 "openssl"
|
|
@@ -100,18 +102,18 @@ module Algolia
|
|
|
100
102
|
# Required API Key ACLs:
|
|
101
103
|
# - addObject
|
|
102
104
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
103
|
-
# @param
|
|
105
|
+
# @param algolia_object_id [String] Unique record identifier. (required)
|
|
104
106
|
# @param body [Object] The record. A schemaless object with attributes that are useful in the context of search and discovery. (required)
|
|
105
107
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
106
108
|
# @return [Http::Response] the response
|
|
107
|
-
def add_or_update_object_with_http_info(index_name,
|
|
109
|
+
def add_or_update_object_with_http_info(index_name, algolia_object_id, body, request_options = {})
|
|
108
110
|
# verify the required parameter 'index_name' is set
|
|
109
111
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
110
112
|
raise ArgumentError, "Parameter `index_name` is required when calling `add_or_update_object`."
|
|
111
113
|
end
|
|
112
|
-
# verify the required parameter '
|
|
113
|
-
if @api_client.config.client_side_validation &&
|
|
114
|
-
raise ArgumentError, "Parameter `
|
|
114
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
115
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
116
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `add_or_update_object`."
|
|
115
117
|
end
|
|
116
118
|
# verify the required parameter 'body' is set
|
|
117
119
|
if @api_client.config.client_side_validation && body.nil?
|
|
@@ -120,7 +122,7 @@ module Algolia
|
|
|
120
122
|
|
|
121
123
|
path = "/1/indexes/{indexName}/{objectID}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s)).sub(
|
|
122
124
|
"{" + "objectID" + "}",
|
|
123
|
-
Transport.encode_uri(
|
|
125
|
+
Transport.encode_uri(algolia_object_id.to_s)
|
|
124
126
|
)
|
|
125
127
|
query_params = {}
|
|
126
128
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
@@ -145,12 +147,12 @@ module Algolia
|
|
|
145
147
|
# Required API Key ACLs:
|
|
146
148
|
# - addObject
|
|
147
149
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
148
|
-
# @param
|
|
150
|
+
# @param algolia_object_id [String] Unique record identifier. (required)
|
|
149
151
|
# @param body [Object] The record. A schemaless object with attributes that are useful in the context of search and discovery. (required)
|
|
150
152
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
151
153
|
# @return [UpdatedAtWithObjectIdResponse]
|
|
152
|
-
def add_or_update_object(index_name,
|
|
153
|
-
response = add_or_update_object_with_http_info(index_name,
|
|
154
|
+
def add_or_update_object(index_name, algolia_object_id, body, request_options = {})
|
|
155
|
+
response = add_or_update_object_with_http_info(index_name, algolia_object_id, body, request_options)
|
|
154
156
|
@api_client.deserialize(
|
|
155
157
|
response.body,
|
|
156
158
|
request_options[:debug_return_type] || "Search::UpdatedAtWithObjectIdResponse"
|
|
@@ -915,22 +917,22 @@ module Algolia
|
|
|
915
917
|
# Required API Key ACLs:
|
|
916
918
|
# - deleteObject
|
|
917
919
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
918
|
-
# @param
|
|
920
|
+
# @param algolia_object_id [String] Unique record identifier. (required)
|
|
919
921
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
920
922
|
# @return [Http::Response] the response
|
|
921
|
-
def delete_object_with_http_info(index_name,
|
|
923
|
+
def delete_object_with_http_info(index_name, algolia_object_id, request_options = {})
|
|
922
924
|
# verify the required parameter 'index_name' is set
|
|
923
925
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
924
926
|
raise ArgumentError, "Parameter `index_name` is required when calling `delete_object`."
|
|
925
927
|
end
|
|
926
|
-
# verify the required parameter '
|
|
927
|
-
if @api_client.config.client_side_validation &&
|
|
928
|
-
raise ArgumentError, "Parameter `
|
|
928
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
929
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
930
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_object`."
|
|
929
931
|
end
|
|
930
932
|
|
|
931
933
|
path = "/1/indexes/{indexName}/{objectID}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s)).sub(
|
|
932
934
|
"{" + "objectID" + "}",
|
|
933
|
-
Transport.encode_uri(
|
|
935
|
+
Transport.encode_uri(algolia_object_id.to_s)
|
|
934
936
|
)
|
|
935
937
|
query_params = {}
|
|
936
938
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
@@ -955,11 +957,11 @@ module Algolia
|
|
|
955
957
|
# Required API Key ACLs:
|
|
956
958
|
# - deleteObject
|
|
957
959
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
958
|
-
# @param
|
|
960
|
+
# @param algolia_object_id [String] Unique record identifier. (required)
|
|
959
961
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
960
962
|
# @return [DeletedAtResponse]
|
|
961
|
-
def delete_object(index_name,
|
|
962
|
-
response = delete_object_with_http_info(index_name,
|
|
963
|
+
def delete_object(index_name, algolia_object_id, request_options = {})
|
|
964
|
+
response = delete_object_with_http_info(index_name, algolia_object_id, request_options)
|
|
963
965
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
|
|
964
966
|
end
|
|
965
967
|
|
|
@@ -968,23 +970,23 @@ module Algolia
|
|
|
968
970
|
# Required API Key ACLs:
|
|
969
971
|
# - editSettings
|
|
970
972
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
971
|
-
# @param
|
|
973
|
+
# @param algolia_object_id [String] Unique identifier of a rule object. (required)
|
|
972
974
|
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
|
973
975
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
974
976
|
# @return [Http::Response] the response
|
|
975
|
-
def delete_rule_with_http_info(index_name,
|
|
977
|
+
def delete_rule_with_http_info(index_name, algolia_object_id, forward_to_replicas = nil, request_options = {})
|
|
976
978
|
# verify the required parameter 'index_name' is set
|
|
977
979
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
978
980
|
raise ArgumentError, "Parameter `index_name` is required when calling `delete_rule`."
|
|
979
981
|
end
|
|
980
|
-
# verify the required parameter '
|
|
981
|
-
if @api_client.config.client_side_validation &&
|
|
982
|
-
raise ArgumentError, "Parameter `
|
|
982
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
983
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
984
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_rule`."
|
|
983
985
|
end
|
|
984
986
|
|
|
985
987
|
path = "/1/indexes/{indexName}/rules/{objectID}"
|
|
986
988
|
.sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
|
|
987
|
-
.sub("{" + "objectID" + "}", Transport.encode_uri(
|
|
989
|
+
.sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
|
|
988
990
|
query_params = {}
|
|
989
991
|
query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
|
|
990
992
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
@@ -1009,12 +1011,12 @@ module Algolia
|
|
|
1009
1011
|
# Required API Key ACLs:
|
|
1010
1012
|
# - editSettings
|
|
1011
1013
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1012
|
-
# @param
|
|
1014
|
+
# @param algolia_object_id [String] Unique identifier of a rule object. (required)
|
|
1013
1015
|
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
|
1014
1016
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1015
1017
|
# @return [UpdatedAtResponse]
|
|
1016
|
-
def delete_rule(index_name,
|
|
1017
|
-
response = delete_rule_with_http_info(index_name,
|
|
1018
|
+
def delete_rule(index_name, algolia_object_id, forward_to_replicas = nil, request_options = {})
|
|
1019
|
+
response = delete_rule_with_http_info(index_name, algolia_object_id, forward_to_replicas, request_options)
|
|
1018
1020
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
|
|
1019
1021
|
end
|
|
1020
1022
|
|
|
@@ -1067,23 +1069,23 @@ module Algolia
|
|
|
1067
1069
|
# Required API Key ACLs:
|
|
1068
1070
|
# - editSettings
|
|
1069
1071
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1070
|
-
# @param
|
|
1072
|
+
# @param algolia_object_id [String] Unique identifier of a synonym object. (required)
|
|
1071
1073
|
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
|
1072
1074
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1073
1075
|
# @return [Http::Response] the response
|
|
1074
|
-
def delete_synonym_with_http_info(index_name,
|
|
1076
|
+
def delete_synonym_with_http_info(index_name, algolia_object_id, forward_to_replicas = nil, request_options = {})
|
|
1075
1077
|
# verify the required parameter 'index_name' is set
|
|
1076
1078
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
1077
1079
|
raise ArgumentError, "Parameter `index_name` is required when calling `delete_synonym`."
|
|
1078
1080
|
end
|
|
1079
|
-
# verify the required parameter '
|
|
1080
|
-
if @api_client.config.client_side_validation &&
|
|
1081
|
-
raise ArgumentError, "Parameter `
|
|
1081
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
1082
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
1083
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_synonym`."
|
|
1082
1084
|
end
|
|
1083
1085
|
|
|
1084
1086
|
path = "/1/indexes/{indexName}/synonyms/{objectID}"
|
|
1085
1087
|
.sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
|
|
1086
|
-
.sub("{" + "objectID" + "}", Transport.encode_uri(
|
|
1088
|
+
.sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
|
|
1087
1089
|
query_params = {}
|
|
1088
1090
|
query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
|
|
1089
1091
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
@@ -1108,12 +1110,12 @@ module Algolia
|
|
|
1108
1110
|
# Required API Key ACLs:
|
|
1109
1111
|
# - editSettings
|
|
1110
1112
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1111
|
-
# @param
|
|
1113
|
+
# @param algolia_object_id [String] Unique identifier of a synonym object. (required)
|
|
1112
1114
|
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
|
1113
1115
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1114
1116
|
# @return [DeletedAtResponse]
|
|
1115
|
-
def delete_synonym(index_name,
|
|
1116
|
-
response = delete_synonym_with_http_info(index_name,
|
|
1117
|
+
def delete_synonym(index_name, algolia_object_id, forward_to_replicas = nil, request_options = {})
|
|
1118
|
+
response = delete_synonym_with_http_info(index_name, algolia_object_id, forward_to_replicas, request_options)
|
|
1117
1119
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
|
|
1118
1120
|
end
|
|
1119
1121
|
|
|
@@ -1332,23 +1334,23 @@ module Algolia
|
|
|
1332
1334
|
# Required API Key ACLs:
|
|
1333
1335
|
# - search
|
|
1334
1336
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1335
|
-
# @param
|
|
1337
|
+
# @param algolia_object_id [String] Unique record identifier. (required)
|
|
1336
1338
|
# @param attributes_to_retrieve [Array<String>] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key.
|
|
1337
1339
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1338
1340
|
# @return [Http::Response] the response
|
|
1339
|
-
def get_object_with_http_info(index_name,
|
|
1341
|
+
def get_object_with_http_info(index_name, algolia_object_id, attributes_to_retrieve = nil, request_options = {})
|
|
1340
1342
|
# verify the required parameter 'index_name' is set
|
|
1341
1343
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
1342
1344
|
raise ArgumentError, "Parameter `index_name` is required when calling `get_object`."
|
|
1343
1345
|
end
|
|
1344
|
-
# verify the required parameter '
|
|
1345
|
-
if @api_client.config.client_side_validation &&
|
|
1346
|
-
raise ArgumentError, "Parameter `
|
|
1346
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
1347
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
1348
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_object`."
|
|
1347
1349
|
end
|
|
1348
1350
|
|
|
1349
1351
|
path = "/1/indexes/{indexName}/{objectID}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s)).sub(
|
|
1350
1352
|
"{" + "objectID" + "}",
|
|
1351
|
-
Transport.encode_uri(
|
|
1353
|
+
Transport.encode_uri(algolia_object_id.to_s)
|
|
1352
1354
|
)
|
|
1353
1355
|
query_params = {}
|
|
1354
1356
|
unless attributes_to_retrieve.nil?
|
|
@@ -1377,12 +1379,12 @@ module Algolia
|
|
|
1377
1379
|
# Required API Key ACLs:
|
|
1378
1380
|
# - search
|
|
1379
1381
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1380
|
-
# @param
|
|
1382
|
+
# @param algolia_object_id [String] Unique record identifier. (required)
|
|
1381
1383
|
# @param attributes_to_retrieve [Array<String>] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key.
|
|
1382
1384
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1383
1385
|
# @return [Object]
|
|
1384
|
-
def get_object(index_name,
|
|
1385
|
-
response = get_object_with_http_info(index_name,
|
|
1386
|
+
def get_object(index_name, algolia_object_id, attributes_to_retrieve = nil, request_options = {})
|
|
1387
|
+
response = get_object_with_http_info(index_name, algolia_object_id, attributes_to_retrieve, request_options)
|
|
1386
1388
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
|
|
1387
1389
|
end
|
|
1388
1390
|
|
|
@@ -1435,22 +1437,22 @@ module Algolia
|
|
|
1435
1437
|
# Required API Key ACLs:
|
|
1436
1438
|
# - settings
|
|
1437
1439
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1438
|
-
# @param
|
|
1440
|
+
# @param algolia_object_id [String] Unique identifier of a rule object. (required)
|
|
1439
1441
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1440
1442
|
# @return [Http::Response] the response
|
|
1441
|
-
def get_rule_with_http_info(index_name,
|
|
1443
|
+
def get_rule_with_http_info(index_name, algolia_object_id, request_options = {})
|
|
1442
1444
|
# verify the required parameter 'index_name' is set
|
|
1443
1445
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
1444
1446
|
raise ArgumentError, "Parameter `index_name` is required when calling `get_rule`."
|
|
1445
1447
|
end
|
|
1446
|
-
# verify the required parameter '
|
|
1447
|
-
if @api_client.config.client_side_validation &&
|
|
1448
|
-
raise ArgumentError, "Parameter `
|
|
1448
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
1449
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
1450
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_rule`."
|
|
1449
1451
|
end
|
|
1450
1452
|
|
|
1451
1453
|
path = "/1/indexes/{indexName}/rules/{objectID}"
|
|
1452
1454
|
.sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
|
|
1453
|
-
.sub("{" + "objectID" + "}", Transport.encode_uri(
|
|
1455
|
+
.sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
|
|
1454
1456
|
query_params = {}
|
|
1455
1457
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
1456
1458
|
header_params = {}
|
|
@@ -1474,11 +1476,11 @@ module Algolia
|
|
|
1474
1476
|
# Required API Key ACLs:
|
|
1475
1477
|
# - settings
|
|
1476
1478
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1477
|
-
# @param
|
|
1479
|
+
# @param algolia_object_id [String] Unique identifier of a rule object. (required)
|
|
1478
1480
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1479
1481
|
# @return [Rule]
|
|
1480
|
-
def get_rule(index_name,
|
|
1481
|
-
response = get_rule_with_http_info(index_name,
|
|
1482
|
+
def get_rule(index_name, algolia_object_id, request_options = {})
|
|
1483
|
+
response = get_rule_with_http_info(index_name, algolia_object_id, request_options)
|
|
1482
1484
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Rule")
|
|
1483
1485
|
end
|
|
1484
1486
|
|
|
@@ -1568,22 +1570,22 @@ module Algolia
|
|
|
1568
1570
|
# Required API Key ACLs:
|
|
1569
1571
|
# - settings
|
|
1570
1572
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1571
|
-
# @param
|
|
1573
|
+
# @param algolia_object_id [String] Unique identifier of a synonym object. (required)
|
|
1572
1574
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1573
1575
|
# @return [Http::Response] the response
|
|
1574
|
-
def get_synonym_with_http_info(index_name,
|
|
1576
|
+
def get_synonym_with_http_info(index_name, algolia_object_id, request_options = {})
|
|
1575
1577
|
# verify the required parameter 'index_name' is set
|
|
1576
1578
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
1577
1579
|
raise ArgumentError, "Parameter `index_name` is required when calling `get_synonym`."
|
|
1578
1580
|
end
|
|
1579
|
-
# verify the required parameter '
|
|
1580
|
-
if @api_client.config.client_side_validation &&
|
|
1581
|
-
raise ArgumentError, "Parameter `
|
|
1581
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
1582
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
1583
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_synonym`."
|
|
1582
1584
|
end
|
|
1583
1585
|
|
|
1584
1586
|
path = "/1/indexes/{indexName}/synonyms/{objectID}"
|
|
1585
1587
|
.sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
|
|
1586
|
-
.sub("{" + "objectID" + "}", Transport.encode_uri(
|
|
1588
|
+
.sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
|
|
1587
1589
|
query_params = {}
|
|
1588
1590
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
1589
1591
|
header_params = {}
|
|
@@ -1607,11 +1609,11 @@ module Algolia
|
|
|
1607
1609
|
# Required API Key ACLs:
|
|
1608
1610
|
# - settings
|
|
1609
1611
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
1610
|
-
# @param
|
|
1612
|
+
# @param algolia_object_id [String] Unique identifier of a synonym object. (required)
|
|
1611
1613
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
1612
1614
|
# @return [SynonymHit]
|
|
1613
|
-
def get_synonym(index_name,
|
|
1614
|
-
response = get_synonym_with_http_info(index_name,
|
|
1615
|
+
def get_synonym(index_name, algolia_object_id, request_options = {})
|
|
1616
|
+
response = get_synonym_with_http_info(index_name, algolia_object_id, request_options)
|
|
1615
1617
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SynonymHit")
|
|
1616
1618
|
end
|
|
1617
1619
|
|
|
@@ -2046,14 +2048,14 @@ module Algolia
|
|
|
2046
2048
|
# Required API Key ACLs:
|
|
2047
2049
|
# - addObject
|
|
2048
2050
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
2049
|
-
# @param
|
|
2051
|
+
# @param algolia_object_id [String] Unique record identifier. (required)
|
|
2050
2052
|
# @param attributes_to_update [Object] Attributes with their values. (required)
|
|
2051
2053
|
# @param create_if_not_exists [Boolean] Whether to create a new record if it doesn't exist. (default to true)
|
|
2052
2054
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
2053
2055
|
# @return [Http::Response] the response
|
|
2054
2056
|
def partial_update_object_with_http_info(
|
|
2055
2057
|
index_name,
|
|
2056
|
-
|
|
2058
|
+
algolia_object_id,
|
|
2057
2059
|
attributes_to_update,
|
|
2058
2060
|
create_if_not_exists = nil,
|
|
2059
2061
|
request_options = {}
|
|
@@ -2062,9 +2064,9 @@ module Algolia
|
|
|
2062
2064
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
2063
2065
|
raise ArgumentError, "Parameter `index_name` is required when calling `partial_update_object`."
|
|
2064
2066
|
end
|
|
2065
|
-
# verify the required parameter '
|
|
2066
|
-
if @api_client.config.client_side_validation &&
|
|
2067
|
-
raise ArgumentError, "Parameter `
|
|
2067
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
2068
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
2069
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `partial_update_object`."
|
|
2068
2070
|
end
|
|
2069
2071
|
# verify the required parameter 'attributes_to_update' is set
|
|
2070
2072
|
if @api_client.config.client_side_validation && attributes_to_update.nil?
|
|
@@ -2073,7 +2075,7 @@ module Algolia
|
|
|
2073
2075
|
|
|
2074
2076
|
path = "/1/indexes/{indexName}/{objectID}/partial"
|
|
2075
2077
|
.sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
|
|
2076
|
-
.sub("{" + "objectID" + "}", Transport.encode_uri(
|
|
2078
|
+
.sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
|
|
2077
2079
|
query_params = {}
|
|
2078
2080
|
query_params[:createIfNotExists] = create_if_not_exists unless create_if_not_exists.nil?
|
|
2079
2081
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
@@ -2098,21 +2100,21 @@ module Algolia
|
|
|
2098
2100
|
# Required API Key ACLs:
|
|
2099
2101
|
# - addObject
|
|
2100
2102
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
2101
|
-
# @param
|
|
2103
|
+
# @param algolia_object_id [String] Unique record identifier. (required)
|
|
2102
2104
|
# @param attributes_to_update [Object] Attributes with their values. (required)
|
|
2103
2105
|
# @param create_if_not_exists [Boolean] Whether to create a new record if it doesn't exist. (default to true)
|
|
2104
2106
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
2105
2107
|
# @return [UpdatedAtWithObjectIdResponse]
|
|
2106
2108
|
def partial_update_object(
|
|
2107
2109
|
index_name,
|
|
2108
|
-
|
|
2110
|
+
algolia_object_id,
|
|
2109
2111
|
attributes_to_update,
|
|
2110
2112
|
create_if_not_exists = nil,
|
|
2111
2113
|
request_options = {}
|
|
2112
2114
|
)
|
|
2113
2115
|
response = partial_update_object_with_http_info(
|
|
2114
2116
|
index_name,
|
|
2115
|
-
|
|
2117
|
+
algolia_object_id,
|
|
2116
2118
|
attributes_to_update,
|
|
2117
2119
|
create_if_not_exists,
|
|
2118
2120
|
request_options
|
|
@@ -2310,19 +2312,19 @@ module Algolia
|
|
|
2310
2312
|
# Required API Key ACLs:
|
|
2311
2313
|
# - editSettings
|
|
2312
2314
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
2313
|
-
# @param
|
|
2315
|
+
# @param algolia_object_id [String] Unique identifier of a rule object. (required)
|
|
2314
2316
|
# @param rule [Rule] (required)
|
|
2315
2317
|
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
|
2316
2318
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
2317
2319
|
# @return [Http::Response] the response
|
|
2318
|
-
def save_rule_with_http_info(index_name,
|
|
2320
|
+
def save_rule_with_http_info(index_name, algolia_object_id, rule, forward_to_replicas = nil, request_options = {})
|
|
2319
2321
|
# verify the required parameter 'index_name' is set
|
|
2320
2322
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
2321
2323
|
raise ArgumentError, "Parameter `index_name` is required when calling `save_rule`."
|
|
2322
2324
|
end
|
|
2323
|
-
# verify the required parameter '
|
|
2324
|
-
if @api_client.config.client_side_validation &&
|
|
2325
|
-
raise ArgumentError, "Parameter `
|
|
2325
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
2326
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
2327
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `save_rule`."
|
|
2326
2328
|
end
|
|
2327
2329
|
# verify the required parameter 'rule' is set
|
|
2328
2330
|
if @api_client.config.client_side_validation && rule.nil?
|
|
@@ -2331,7 +2333,7 @@ module Algolia
|
|
|
2331
2333
|
|
|
2332
2334
|
path = "/1/indexes/{indexName}/rules/{objectID}"
|
|
2333
2335
|
.sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
|
|
2334
|
-
.sub("{" + "objectID" + "}", Transport.encode_uri(
|
|
2336
|
+
.sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
|
|
2335
2337
|
query_params = {}
|
|
2336
2338
|
query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
|
|
2337
2339
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
@@ -2356,13 +2358,13 @@ module Algolia
|
|
|
2356
2358
|
# Required API Key ACLs:
|
|
2357
2359
|
# - editSettings
|
|
2358
2360
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
2359
|
-
# @param
|
|
2361
|
+
# @param algolia_object_id [String] Unique identifier of a rule object. (required)
|
|
2360
2362
|
# @param rule [Rule] (required)
|
|
2361
2363
|
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
|
2362
2364
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
2363
2365
|
# @return [UpdatedAtResponse]
|
|
2364
|
-
def save_rule(index_name,
|
|
2365
|
-
response = save_rule_with_http_info(index_name,
|
|
2366
|
+
def save_rule(index_name, algolia_object_id, rule, forward_to_replicas = nil, request_options = {})
|
|
2367
|
+
response = save_rule_with_http_info(index_name, algolia_object_id, rule, forward_to_replicas, request_options)
|
|
2366
2368
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
|
|
2367
2369
|
end
|
|
2368
2370
|
|
|
@@ -2439,19 +2441,25 @@ module Algolia
|
|
|
2439
2441
|
# Required API Key ACLs:
|
|
2440
2442
|
# - editSettings
|
|
2441
2443
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
2442
|
-
# @param
|
|
2444
|
+
# @param algolia_object_id [String] Unique identifier of a synonym object. (required)
|
|
2443
2445
|
# @param synonym_hit [SynonymHit] (required)
|
|
2444
2446
|
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
|
2445
2447
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
2446
2448
|
# @return [Http::Response] the response
|
|
2447
|
-
def save_synonym_with_http_info(
|
|
2449
|
+
def save_synonym_with_http_info(
|
|
2450
|
+
index_name,
|
|
2451
|
+
algolia_object_id,
|
|
2452
|
+
synonym_hit,
|
|
2453
|
+
forward_to_replicas = nil,
|
|
2454
|
+
request_options = {}
|
|
2455
|
+
)
|
|
2448
2456
|
# verify the required parameter 'index_name' is set
|
|
2449
2457
|
if @api_client.config.client_side_validation && index_name.nil?
|
|
2450
2458
|
raise ArgumentError, "Parameter `index_name` is required when calling `save_synonym`."
|
|
2451
2459
|
end
|
|
2452
|
-
# verify the required parameter '
|
|
2453
|
-
if @api_client.config.client_side_validation &&
|
|
2454
|
-
raise ArgumentError, "Parameter `
|
|
2460
|
+
# verify the required parameter 'algolia_object_id' is set
|
|
2461
|
+
if @api_client.config.client_side_validation && algolia_object_id.nil?
|
|
2462
|
+
raise ArgumentError, "Parameter `algolia_object_id` is required when calling `save_synonym`."
|
|
2455
2463
|
end
|
|
2456
2464
|
# verify the required parameter 'synonym_hit' is set
|
|
2457
2465
|
if @api_client.config.client_side_validation && synonym_hit.nil?
|
|
@@ -2460,7 +2468,7 @@ module Algolia
|
|
|
2460
2468
|
|
|
2461
2469
|
path = "/1/indexes/{indexName}/synonyms/{objectID}"
|
|
2462
2470
|
.sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
|
|
2463
|
-
.sub("{" + "objectID" + "}", Transport.encode_uri(
|
|
2471
|
+
.sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
|
|
2464
2472
|
query_params = {}
|
|
2465
2473
|
query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
|
|
2466
2474
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
|
@@ -2485,13 +2493,19 @@ module Algolia
|
|
|
2485
2493
|
# Required API Key ACLs:
|
|
2486
2494
|
# - editSettings
|
|
2487
2495
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
|
2488
|
-
# @param
|
|
2496
|
+
# @param algolia_object_id [String] Unique identifier of a synonym object. (required)
|
|
2489
2497
|
# @param synonym_hit [SynonymHit] (required)
|
|
2490
2498
|
# @param forward_to_replicas [Boolean] Whether changes are applied to replica indices.
|
|
2491
2499
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
2492
2500
|
# @return [SaveSynonymResponse]
|
|
2493
|
-
def save_synonym(index_name,
|
|
2494
|
-
response = save_synonym_with_http_info(
|
|
2501
|
+
def save_synonym(index_name, algolia_object_id, synonym_hit, forward_to_replicas = nil, request_options = {})
|
|
2502
|
+
response = save_synonym_with_http_info(
|
|
2503
|
+
index_name,
|
|
2504
|
+
algolia_object_id,
|
|
2505
|
+
synonym_hit,
|
|
2506
|
+
forward_to_replicas,
|
|
2507
|
+
request_options
|
|
2508
|
+
)
|
|
2495
2509
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SaveSynonymResponse")
|
|
2496
2510
|
end
|
|
2497
2511
|
|
|
@@ -3472,69 +3486,74 @@ module Algolia
|
|
|
3472
3486
|
# @param index_name [String] The `index_name` to replace `objects` in.
|
|
3473
3487
|
# @param objects [Array] The array of `objects` to store in the given Algolia `index_name`.
|
|
3474
3488
|
# @param batch_size [int] The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
|
|
3489
|
+
# @param scopes [Array] The `scopes` to keep from the index. Defaults to `['settings', 'rules', 'synonyms']`.
|
|
3475
3490
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
|
3476
3491
|
#
|
|
3477
3492
|
# @return [Array<ReplaceAllObjectsResponse>]
|
|
3478
|
-
def replace_all_objects(
|
|
3493
|
+
def replace_all_objects(
|
|
3494
|
+
index_name,
|
|
3495
|
+
objects,
|
|
3496
|
+
batch_size = 1000,
|
|
3497
|
+
scopes = [Search::ScopeType::SETTINGS, Search::ScopeType::RULES, Search::ScopeType::SYNONYMS],
|
|
3498
|
+
request_options = {}
|
|
3499
|
+
)
|
|
3479
3500
|
tmp_index_name = index_name + "_tmp_" + rand(10_000_000).to_s
|
|
3480
3501
|
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
|
|
3488
|
-
|
|
3489
|
-
|
|
3490
|
-
|
|
3491
|
-
),
|
|
3492
|
-
request_options
|
|
3493
|
-
)
|
|
3502
|
+
begin
|
|
3503
|
+
copy_operation_response = operation_index(
|
|
3504
|
+
index_name,
|
|
3505
|
+
Search::OperationIndexParams.new(
|
|
3506
|
+
operation: Search::OperationType::COPY,
|
|
3507
|
+
destination: tmp_index_name,
|
|
3508
|
+
scope: scopes
|
|
3509
|
+
),
|
|
3510
|
+
request_options
|
|
3511
|
+
)
|
|
3494
3512
|
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
|
|
3498
|
-
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3513
|
+
batch_responses = chunked_batch(
|
|
3514
|
+
tmp_index_name,
|
|
3515
|
+
objects,
|
|
3516
|
+
Search::Action::ADD_OBJECT,
|
|
3517
|
+
true,
|
|
3518
|
+
batch_size,
|
|
3519
|
+
request_options
|
|
3520
|
+
)
|
|
3503
3521
|
|
|
3504
|
-
|
|
3522
|
+
wait_for_task(tmp_index_name, copy_operation_response.task_id)
|
|
3505
3523
|
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
]
|
|
3516
|
-
),
|
|
3517
|
-
request_options
|
|
3518
|
-
)
|
|
3524
|
+
copy_operation_response = operation_index(
|
|
3525
|
+
index_name,
|
|
3526
|
+
Search::OperationIndexParams.new(
|
|
3527
|
+
operation: Search::OperationType::COPY,
|
|
3528
|
+
destination: tmp_index_name,
|
|
3529
|
+
scope: scopes
|
|
3530
|
+
),
|
|
3531
|
+
request_options
|
|
3532
|
+
)
|
|
3519
3533
|
|
|
3520
|
-
|
|
3534
|
+
wait_for_task(tmp_index_name, copy_operation_response.task_id)
|
|
3521
3535
|
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
|
|
3536
|
+
move_operation_response = operation_index(
|
|
3537
|
+
tmp_index_name,
|
|
3538
|
+
Search::OperationIndexParams.new(
|
|
3539
|
+
operation: Search::OperationType::MOVE,
|
|
3540
|
+
destination: index_name
|
|
3541
|
+
),
|
|
3542
|
+
request_options
|
|
3543
|
+
)
|
|
3530
3544
|
|
|
3531
|
-
|
|
3545
|
+
wait_for_task(tmp_index_name, move_operation_response.task_id)
|
|
3532
3546
|
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3547
|
+
Search::ReplaceAllObjectsResponse.new(
|
|
3548
|
+
copy_operation_response: copy_operation_response,
|
|
3549
|
+
batch_responses: batch_responses,
|
|
3550
|
+
move_operation_response: move_operation_response
|
|
3551
|
+
)
|
|
3552
|
+
rescue Exception => e
|
|
3553
|
+
delete_index(tmp_index_name)
|
|
3554
|
+
|
|
3555
|
+
raise e
|
|
3556
|
+
end
|
|
3538
3557
|
end
|
|
3539
3558
|
|
|
3540
3559
|
def index_exists?(index_name)
|
|
@@ -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"
|
|
@@ -57,11 +59,6 @@ module Algolia
|
|
|
57
59
|
}
|
|
58
60
|
end
|
|
59
61
|
|
|
60
|
-
# Returns all the JSON keys this model knows about
|
|
61
|
-
def self.acceptable_attributes
|
|
62
|
-
attribute_map.values
|
|
63
|
-
end
|
|
64
|
-
|
|
65
62
|
# Attribute type mapping.
|
|
66
63
|
def self.types_mapping
|
|
67
64
|
{
|