algolia 3.11.0 → 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.
Files changed (603) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/Gemfile.lock +1 -1
  4. data/lib/algolia/api/abtesting_client.rb +3 -1
  5. data/lib/algolia/api/analytics_client.rb +45 -43
  6. data/lib/algolia/api/composition_client.rb +174 -0
  7. data/lib/algolia/api/ingestion_client.rb +7 -1
  8. data/lib/algolia/api/insights_client.rb +3 -1
  9. data/lib/algolia/api/monitoring_client.rb +2 -0
  10. data/lib/algolia/api/personalization_client.rb +3 -1
  11. data/lib/algolia/api/query_suggestions_client.rb +3 -1
  12. data/lib/algolia/api/recommend_client.rb +20 -18
  13. data/lib/algolia/api/search_client.rb +104 -90
  14. data/lib/algolia/models/abtesting/ab_test.rb +2 -0
  15. data/lib/algolia/models/abtesting/ab_test_configuration.rb +2 -0
  16. data/lib/algolia/models/abtesting/ab_test_response.rb +2 -0
  17. data/lib/algolia/models/abtesting/ab_tests_variant.rb +2 -0
  18. data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +2 -0
  19. data/lib/algolia/models/abtesting/add_ab_tests_request.rb +2 -0
  20. data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +2 -0
  21. data/lib/algolia/models/abtesting/currency.rb +2 -0
  22. data/lib/algolia/models/abtesting/effect_metric.rb +2 -0
  23. data/lib/algolia/models/abtesting/empty_search.rb +2 -0
  24. data/lib/algolia/models/abtesting/empty_search_filter.rb +2 -0
  25. data/lib/algolia/models/abtesting/error_base.rb +2 -0
  26. data/lib/algolia/models/abtesting/estimate_ab_test_request.rb +2 -0
  27. data/lib/algolia/models/abtesting/estimate_ab_test_response.rb +2 -0
  28. data/lib/algolia/models/abtesting/estimate_configuration.rb +2 -0
  29. data/lib/algolia/models/abtesting/filter_effects.rb +2 -0
  30. data/lib/algolia/models/abtesting/list_ab_tests_response.rb +2 -0
  31. data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +2 -0
  32. data/lib/algolia/models/abtesting/outliers.rb +2 -0
  33. data/lib/algolia/models/abtesting/outliers_filter.rb +2 -0
  34. data/lib/algolia/models/abtesting/schedule_ab_test_response.rb +2 -0
  35. data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +2 -0
  36. data/lib/algolia/models/abtesting/status.rb +2 -0
  37. data/lib/algolia/models/abtesting/variant.rb +2 -0
  38. data/lib/algolia/models/analytics/click_position.rb +2 -0
  39. data/lib/algolia/models/analytics/currency_code.rb +2 -0
  40. data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +3 -1
  41. data/lib/algolia/models/analytics/daily_average_clicks.rb +2 -0
  42. data/lib/algolia/models/analytics/daily_click_through_rates.rb +3 -1
  43. data/lib/algolia/models/analytics/daily_conversion_rates.rb +3 -1
  44. data/lib/algolia/models/analytics/daily_no_click_rates.rb +3 -1
  45. data/lib/algolia/models/analytics/daily_no_results_rates.rb +3 -1
  46. data/lib/algolia/models/analytics/daily_purchase_rates.rb +3 -1
  47. data/lib/algolia/models/analytics/daily_revenue.rb +3 -1
  48. data/lib/algolia/models/analytics/daily_searches.rb +2 -0
  49. data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +2 -0
  50. data/lib/algolia/models/analytics/daily_searches_no_results.rb +2 -0
  51. data/lib/algolia/models/analytics/daily_users.rb +2 -0
  52. data/lib/algolia/models/analytics/direction.rb +2 -0
  53. data/lib/algolia/models/analytics/error_base.rb +2 -0
  54. data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +3 -1
  55. data/lib/algolia/models/analytics/get_average_click_position_response.rb +2 -0
  56. data/lib/algolia/models/analytics/get_click_positions_response.rb +2 -0
  57. data/lib/algolia/models/analytics/get_click_through_rate_response.rb +3 -1
  58. data/lib/algolia/models/analytics/get_conversion_rate_response.rb +3 -1
  59. data/lib/algolia/models/analytics/get_no_click_rate_response.rb +3 -1
  60. data/lib/algolia/models/analytics/get_no_results_rate_response.rb +3 -1
  61. data/lib/algolia/models/analytics/get_purchase_rate_response.rb +3 -1
  62. data/lib/algolia/models/analytics/get_revenue.rb +3 -1
  63. data/lib/algolia/models/analytics/get_searches_count_response.rb +2 -0
  64. data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +2 -0
  65. data/lib/algolia/models/analytics/get_searches_no_results_response.rb +2 -0
  66. data/lib/algolia/models/analytics/get_status_response.rb +2 -0
  67. data/lib/algolia/models/analytics/get_top_countries_response.rb +2 -0
  68. data/lib/algolia/models/analytics/get_top_filter_attribute.rb +2 -0
  69. data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +2 -0
  70. data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +2 -0
  71. data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +2 -0
  72. data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +3 -1
  73. data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +2 -0
  74. data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +2 -0
  75. data/lib/algolia/models/analytics/get_top_hits_response.rb +2 -0
  76. data/lib/algolia/models/analytics/get_top_searches_response.rb +2 -0
  77. data/lib/algolia/models/analytics/get_users_count_response.rb +2 -0
  78. data/lib/algolia/models/analytics/operator.rb +2 -0
  79. data/lib/algolia/models/analytics/order_by.rb +2 -0
  80. data/lib/algolia/models/analytics/top_country.rb +2 -0
  81. data/lib/algolia/models/analytics/top_hit.rb +3 -1
  82. data/lib/algolia/models/analytics/top_hit_with_analytics.rb +5 -3
  83. data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +8 -6
  84. data/lib/algolia/models/analytics/top_hits_response.rb +2 -0
  85. data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +2 -0
  86. data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +2 -0
  87. data/lib/algolia/models/analytics/top_search.rb +2 -0
  88. data/lib/algolia/models/analytics/top_search_with_analytics.rb +4 -2
  89. data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +7 -5
  90. data/lib/algolia/models/analytics/top_searches_response.rb +2 -0
  91. data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +2 -0
  92. data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +2 -0
  93. data/lib/algolia/models/composition/around_precision.rb +110 -0
  94. data/lib/algolia/models/composition/around_radius.rb +110 -0
  95. data/lib/algolia/models/{ingestion/docker_registry.rb → composition/around_radius_all.rb} +8 -7
  96. data/lib/algolia/models/composition/banner.rb +215 -0
  97. data/lib/algolia/models/composition/banner_image.rb +220 -0
  98. data/lib/algolia/models/composition/banner_image_url.rb +209 -0
  99. data/lib/algolia/models/composition/banner_link.rb +209 -0
  100. data/lib/algolia/models/composition/composition_id_ranking_info.rb +221 -0
  101. data/lib/algolia/models/composition/composition_run_applied_rules.rb +211 -0
  102. data/lib/algolia/models/composition/composition_run_search_response.rb +222 -0
  103. data/lib/algolia/models/composition/compositions_search_response.rb +212 -0
  104. data/lib/algolia/models/composition/error_base.rb +209 -0
  105. data/lib/algolia/models/composition/exhaustive.rb +250 -0
  106. data/lib/algolia/models/composition/facet_filters.rb +110 -0
  107. data/lib/algolia/models/composition/facet_hits.rb +235 -0
  108. data/lib/algolia/models/composition/facet_ordering.rb +221 -0
  109. data/lib/algolia/models/composition/facet_stats.rb +239 -0
  110. data/lib/algolia/models/composition/facets.rb +209 -0
  111. data/lib/algolia/models/composition/highlight_result.rb +110 -0
  112. data/lib/algolia/models/composition/highlight_result_option.rb +255 -0
  113. data/lib/algolia/models/composition/hit.rb +251 -0
  114. data/lib/algolia/models/composition/hit_ranking_info.rb +371 -0
  115. data/lib/algolia/models/composition/inside_bounding_box.rb +109 -0
  116. data/lib/algolia/models/{ingestion/docker_image_type.rb → composition/match_level.rb} +10 -7
  117. data/lib/algolia/models/composition/matched_geo_location.rb +229 -0
  118. data/lib/algolia/models/composition/numeric_filters.rb +110 -0
  119. data/lib/algolia/models/composition/optional_filters.rb +110 -0
  120. data/lib/algolia/models/composition/params.rb +488 -0
  121. data/lib/algolia/models/composition/personalization.rb +229 -0
  122. data/lib/algolia/models/composition/range.rb +217 -0
  123. data/lib/algolia/models/composition/redirect.rb +208 -0
  124. data/lib/algolia/models/composition/redirect_rule_index_data.rb +211 -0
  125. data/lib/algolia/models/composition/redirect_rule_index_metadata.rb +258 -0
  126. data/lib/algolia/models/composition/redirect_url.rb +209 -0
  127. data/lib/algolia/models/composition/rendering_content.rb +227 -0
  128. data/lib/algolia/models/composition/request_body.rb +208 -0
  129. data/lib/algolia/models/composition/results_composition_info_response.rb +212 -0
  130. data/lib/algolia/models/composition/results_injected_item_applied_rules_info_response.rb +211 -0
  131. data/lib/algolia/models/composition/results_injected_item_info_response.rb +221 -0
  132. data/lib/algolia/models/composition/search_for_facet_values_params.rb +228 -0
  133. data/lib/algolia/models/composition/search_for_facet_values_request.rb +208 -0
  134. data/lib/algolia/models/composition/search_for_facet_values_response.rb +211 -0
  135. data/lib/algolia/models/composition/search_for_facet_values_results.rb +253 -0
  136. data/lib/algolia/models/composition/search_response.rb +230 -0
  137. data/lib/algolia/models/composition/search_results_item.rb +608 -0
  138. data/lib/algolia/models/composition/snippet_result.rb +110 -0
  139. data/lib/algolia/models/composition/snippet_result_option.rb +230 -0
  140. data/lib/algolia/models/composition/sort_remaining_by.rb +35 -0
  141. data/lib/algolia/models/composition/supported_language.rb +169 -0
  142. data/lib/algolia/models/composition/value.rb +229 -0
  143. data/lib/algolia/models/composition/widgets.rb +209 -0
  144. data/lib/algolia/models/ingestion/action.rb +2 -0
  145. data/lib/algolia/models/ingestion/action_type.rb +2 -0
  146. data/lib/algolia/models/ingestion/auth_algolia.rb +2 -0
  147. data/lib/algolia/models/ingestion/auth_algolia_insights.rb +2 -0
  148. data/lib/algolia/models/ingestion/auth_algolia_insights_partial.rb +2 -0
  149. data/lib/algolia/models/ingestion/auth_algolia_partial.rb +2 -0
  150. data/lib/algolia/models/ingestion/auth_api_key.rb +2 -0
  151. data/lib/algolia/models/ingestion/auth_api_key_partial.rb +2 -0
  152. data/lib/algolia/models/ingestion/auth_basic.rb +2 -0
  153. data/lib/algolia/models/ingestion/auth_basic_partial.rb +2 -0
  154. data/lib/algolia/models/ingestion/auth_google_service_account.rb +2 -0
  155. data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +2 -0
  156. data/lib/algolia/models/ingestion/auth_input.rb +2 -0
  157. data/lib/algolia/models/ingestion/auth_input_partial.rb +2 -0
  158. data/lib/algolia/models/ingestion/auth_o_auth.rb +2 -0
  159. data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +2 -0
  160. data/lib/algolia/models/ingestion/authentication.rb +2 -0
  161. data/lib/algolia/models/ingestion/authentication_create.rb +2 -0
  162. data/lib/algolia/models/ingestion/authentication_create_response.rb +2 -0
  163. data/lib/algolia/models/ingestion/authentication_search.rb +2 -0
  164. data/lib/algolia/models/ingestion/authentication_sort_keys.rb +2 -0
  165. data/lib/algolia/models/ingestion/authentication_type.rb +2 -0
  166. data/lib/algolia/models/ingestion/authentication_update.rb +2 -0
  167. data/lib/algolia/models/ingestion/authentication_update_response.rb +2 -0
  168. data/lib/algolia/models/ingestion/big_commerce_channel.rb +2 -0
  169. data/lib/algolia/models/ingestion/big_commerce_metafield.rb +2 -0
  170. data/lib/algolia/models/ingestion/big_query_data_type.rb +2 -0
  171. data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +2 -0
  172. data/lib/algolia/models/ingestion/delete_response.rb +2 -0
  173. data/lib/algolia/models/ingestion/destination.rb +2 -0
  174. data/lib/algolia/models/ingestion/destination_create.rb +2 -0
  175. data/lib/algolia/models/ingestion/destination_create_response.rb +2 -0
  176. data/lib/algolia/models/ingestion/destination_index_name.rb +2 -0
  177. data/lib/algolia/models/ingestion/destination_input.rb +2 -0
  178. data/lib/algolia/models/ingestion/destination_search.rb +2 -0
  179. data/lib/algolia/models/ingestion/destination_sort_keys.rb +2 -0
  180. data/lib/algolia/models/ingestion/destination_type.rb +2 -0
  181. data/lib/algolia/models/ingestion/destination_update.rb +2 -0
  182. data/lib/algolia/models/ingestion/destination_update_response.rb +2 -0
  183. data/lib/algolia/models/ingestion/docker_streams.rb +2 -0
  184. data/lib/algolia/models/ingestion/docker_streams_input.rb +2 -0
  185. data/lib/algolia/models/ingestion/docker_streams_sync_mode.rb +2 -0
  186. data/lib/algolia/models/ingestion/email_notifications.rb +2 -0
  187. data/lib/algolia/models/ingestion/entity_type.rb +2 -0
  188. data/lib/algolia/models/ingestion/error_base.rb +2 -0
  189. data/lib/algolia/models/ingestion/event.rb +2 -0
  190. data/lib/algolia/models/ingestion/event_sort_keys.rb +2 -0
  191. data/lib/algolia/models/ingestion/event_status.rb +2 -0
  192. data/lib/algolia/models/ingestion/event_type.rb +2 -0
  193. data/lib/algolia/models/ingestion/list_authentications_response.rb +2 -0
  194. data/lib/algolia/models/ingestion/list_destinations_response.rb +2 -0
  195. data/lib/algolia/models/ingestion/list_events_response.rb +2 -0
  196. data/lib/algolia/models/ingestion/list_sources_response.rb +2 -0
  197. data/lib/algolia/models/ingestion/list_tasks_response.rb +2 -0
  198. data/lib/algolia/models/ingestion/list_tasks_response_v1.rb +2 -0
  199. data/lib/algolia/models/ingestion/list_transformations_response.rb +2 -0
  200. data/lib/algolia/models/ingestion/mapping_field_directive.rb +2 -0
  201. data/lib/algolia/models/ingestion/mapping_format_schema.rb +2 -0
  202. data/lib/algolia/models/ingestion/mapping_input.rb +2 -0
  203. data/lib/algolia/models/ingestion/mapping_kit_action.rb +2 -0
  204. data/lib/algolia/models/ingestion/mapping_type_csv.rb +2 -0
  205. data/lib/algolia/models/ingestion/method_type.rb +2 -0
  206. data/lib/algolia/models/ingestion/notifications.rb +2 -0
  207. data/lib/algolia/models/ingestion/on_demand_trigger.rb +2 -0
  208. data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +2 -0
  209. data/lib/algolia/models/ingestion/on_demand_trigger_type.rb +2 -0
  210. data/lib/algolia/models/ingestion/order_keys.rb +2 -0
  211. data/lib/algolia/models/ingestion/pagination.rb +2 -0
  212. data/lib/algolia/models/ingestion/platform.rb +2 -0
  213. data/lib/algolia/models/ingestion/platform_none.rb +2 -0
  214. data/lib/algolia/models/ingestion/platform_with_none.rb +2 -0
  215. data/lib/algolia/models/ingestion/policies.rb +2 -0
  216. data/lib/algolia/models/ingestion/push_task_payload.rb +2 -0
  217. data/lib/algolia/models/ingestion/push_task_records.rb +10 -8
  218. data/lib/algolia/models/ingestion/record_type.rb +2 -0
  219. data/lib/algolia/models/ingestion/run.rb +2 -0
  220. data/lib/algolia/models/ingestion/run_list_response.rb +2 -0
  221. data/lib/algolia/models/ingestion/run_outcome.rb +3 -2
  222. data/lib/algolia/models/ingestion/run_progress.rb +6 -0
  223. data/lib/algolia/models/ingestion/run_reason_code.rb +2 -0
  224. data/lib/algolia/models/ingestion/run_response.rb +2 -0
  225. data/lib/algolia/models/ingestion/run_sort_keys.rb +2 -0
  226. data/lib/algolia/models/ingestion/run_source_payload.rb +2 -0
  227. data/lib/algolia/models/ingestion/run_source_response.rb +2 -0
  228. data/lib/algolia/models/ingestion/run_status.rb +2 -0
  229. data/lib/algolia/models/ingestion/run_type.rb +2 -0
  230. data/lib/algolia/models/ingestion/schedule_trigger.rb +2 -0
  231. data/lib/algolia/models/ingestion/schedule_trigger_input.rb +2 -0
  232. data/lib/algolia/models/ingestion/schedule_trigger_type.rb +2 -0
  233. data/lib/algolia/models/ingestion/shopify_input.rb +2 -0
  234. data/lib/algolia/models/ingestion/shopify_market.rb +2 -0
  235. data/lib/algolia/models/ingestion/shopify_metafield.rb +2 -0
  236. data/lib/algolia/models/ingestion/source.rb +2 -0
  237. data/lib/algolia/models/ingestion/source_big_commerce.rb +2 -0
  238. data/lib/algolia/models/ingestion/source_big_query.rb +2 -0
  239. data/lib/algolia/models/ingestion/source_commercetools.rb +2 -0
  240. data/lib/algolia/models/ingestion/source_create.rb +2 -0
  241. data/lib/algolia/models/ingestion/source_create_response.rb +2 -0
  242. data/lib/algolia/models/ingestion/source_csv.rb +2 -0
  243. data/lib/algolia/models/ingestion/source_docker.rb +4 -36
  244. data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +2 -0
  245. data/lib/algolia/models/ingestion/source_input.rb +2 -0
  246. data/lib/algolia/models/ingestion/source_json.rb +2 -0
  247. data/lib/algolia/models/ingestion/source_search.rb +2 -0
  248. data/lib/algolia/models/ingestion/source_shopify.rb +2 -0
  249. data/lib/algolia/models/ingestion/source_sort_keys.rb +2 -0
  250. data/lib/algolia/models/ingestion/source_type.rb +2 -0
  251. data/lib/algolia/models/ingestion/source_update.rb +2 -0
  252. data/lib/algolia/models/ingestion/source_update_commercetools.rb +2 -0
  253. data/lib/algolia/models/ingestion/source_update_docker.rb +3 -30
  254. data/lib/algolia/models/ingestion/source_update_input.rb +2 -0
  255. data/lib/algolia/models/ingestion/source_update_response.rb +2 -0
  256. data/lib/algolia/models/ingestion/source_update_shopify.rb +2 -0
  257. data/lib/algolia/models/ingestion/streaming_input.rb +2 -0
  258. data/lib/algolia/models/ingestion/streaming_trigger.rb +2 -0
  259. data/lib/algolia/models/ingestion/streaming_trigger_type.rb +2 -0
  260. data/lib/algolia/models/ingestion/subscription_trigger.rb +2 -0
  261. data/lib/algolia/models/ingestion/subscription_trigger_type.rb +2 -0
  262. data/lib/algolia/models/ingestion/task.rb +2 -0
  263. data/lib/algolia/models/ingestion/task_create.rb +2 -0
  264. data/lib/algolia/models/ingestion/task_create_response.rb +2 -0
  265. data/lib/algolia/models/ingestion/task_create_trigger.rb +2 -0
  266. data/lib/algolia/models/ingestion/task_create_v1.rb +2 -0
  267. data/lib/algolia/models/ingestion/task_input.rb +2 -0
  268. data/lib/algolia/models/ingestion/task_search.rb +2 -0
  269. data/lib/algolia/models/ingestion/task_sort_keys.rb +2 -0
  270. data/lib/algolia/models/ingestion/task_update.rb +2 -0
  271. data/lib/algolia/models/ingestion/task_update_response.rb +2 -0
  272. data/lib/algolia/models/ingestion/task_update_v1.rb +2 -0
  273. data/lib/algolia/models/ingestion/task_v1.rb +2 -0
  274. data/lib/algolia/models/ingestion/transformation.rb +2 -0
  275. data/lib/algolia/models/ingestion/transformation_create.rb +2 -0
  276. data/lib/algolia/models/ingestion/transformation_create_response.rb +2 -0
  277. data/lib/algolia/models/ingestion/transformation_error.rb +2 -0
  278. data/lib/algolia/models/ingestion/transformation_search.rb +2 -0
  279. data/lib/algolia/models/ingestion/transformation_sort_keys.rb +2 -0
  280. data/lib/algolia/models/ingestion/transformation_try.rb +2 -0
  281. data/lib/algolia/models/ingestion/transformation_try_response.rb +2 -0
  282. data/lib/algolia/models/ingestion/transformation_update_response.rb +2 -0
  283. data/lib/algolia/models/ingestion/trigger.rb +2 -0
  284. data/lib/algolia/models/ingestion/trigger_type.rb +2 -0
  285. data/lib/algolia/models/ingestion/trigger_update_input.rb +2 -0
  286. data/lib/algolia/models/ingestion/watch_response.rb +2 -0
  287. data/lib/algolia/models/ingestion/window.rb +2 -0
  288. data/lib/algolia/models/insights/add_to_cart_event.rb +2 -0
  289. data/lib/algolia/models/insights/added_to_cart_object_ids.rb +2 -0
  290. data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +2 -0
  291. data/lib/algolia/models/insights/click_event.rb +2 -0
  292. data/lib/algolia/models/insights/clicked_filters.rb +2 -0
  293. data/lib/algolia/models/insights/clicked_object_ids.rb +2 -0
  294. data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +2 -0
  295. data/lib/algolia/models/insights/conversion_event.rb +2 -0
  296. data/lib/algolia/models/insights/converted_filters.rb +2 -0
  297. data/lib/algolia/models/insights/converted_object_ids.rb +2 -0
  298. data/lib/algolia/models/insights/converted_object_ids_after_search.rb +2 -0
  299. data/lib/algolia/models/insights/discount.rb +2 -0
  300. data/lib/algolia/models/insights/error_base.rb +2 -0
  301. data/lib/algolia/models/insights/events_items.rb +2 -0
  302. data/lib/algolia/models/insights/events_response.rb +2 -0
  303. data/lib/algolia/models/insights/insights_events.rb +2 -0
  304. data/lib/algolia/models/insights/object_data.rb +2 -0
  305. data/lib/algolia/models/insights/object_data_after_search.rb +2 -0
  306. data/lib/algolia/models/insights/price.rb +2 -0
  307. data/lib/algolia/models/insights/purchase_event.rb +2 -0
  308. data/lib/algolia/models/insights/purchased_object_ids.rb +2 -0
  309. data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -0
  310. data/lib/algolia/models/insights/value.rb +2 -0
  311. data/lib/algolia/models/insights/view_event.rb +2 -0
  312. data/lib/algolia/models/insights/viewed_filters.rb +2 -0
  313. data/lib/algolia/models/insights/viewed_object_ids.rb +2 -0
  314. data/lib/algolia/models/monitoring/error_base.rb +2 -0
  315. data/lib/algolia/models/monitoring/incident.rb +2 -0
  316. data/lib/algolia/models/monitoring/incident_entry.rb +2 -0
  317. data/lib/algolia/models/monitoring/incidents_response.rb +2 -0
  318. data/lib/algolia/models/monitoring/indexing_metric.rb +2 -0
  319. data/lib/algolia/models/monitoring/indexing_time_response.rb +2 -0
  320. data/lib/algolia/models/monitoring/infrastructure_response.rb +2 -0
  321. data/lib/algolia/models/monitoring/inventory_response.rb +2 -0
  322. data/lib/algolia/models/monitoring/latency_metric.rb +2 -0
  323. data/lib/algolia/models/monitoring/latency_response.rb +2 -0
  324. data/lib/algolia/models/monitoring/metric.rb +2 -0
  325. data/lib/algolia/models/monitoring/metrics.rb +2 -0
  326. data/lib/algolia/models/monitoring/period.rb +2 -0
  327. data/lib/algolia/models/monitoring/probes_metric.rb +2 -0
  328. data/lib/algolia/models/monitoring/region.rb +2 -0
  329. data/lib/algolia/models/monitoring/server.rb +2 -0
  330. data/lib/algolia/models/monitoring/server_status.rb +2 -0
  331. data/lib/algolia/models/monitoring/status.rb +2 -0
  332. data/lib/algolia/models/monitoring/status_response.rb +2 -0
  333. data/lib/algolia/models/monitoring/time_entry.rb +2 -0
  334. data/lib/algolia/models/monitoring/type.rb +2 -0
  335. data/lib/algolia/models/personalization/delete_user_profile_response.rb +2 -0
  336. data/lib/algolia/models/personalization/error_base.rb +2 -0
  337. data/lib/algolia/models/personalization/event_type.rb +2 -0
  338. data/lib/algolia/models/personalization/events_scoring.rb +2 -0
  339. data/lib/algolia/models/personalization/facets_scoring.rb +2 -0
  340. data/lib/algolia/models/personalization/get_user_token_response.rb +2 -0
  341. data/lib/algolia/models/personalization/personalization_strategy_params.rb +2 -0
  342. data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +2 -0
  343. data/lib/algolia/models/query-suggestions/base_response.rb +2 -0
  344. data/lib/algolia/models/query-suggestions/config_status.rb +2 -0
  345. data/lib/algolia/models/query-suggestions/configuration.rb +2 -0
  346. data/lib/algolia/models/query-suggestions/configuration_response.rb +2 -0
  347. data/lib/algolia/models/query-suggestions/configuration_with_index.rb +2 -0
  348. data/lib/algolia/models/query-suggestions/error_base.rb +2 -0
  349. data/lib/algolia/models/query-suggestions/facet.rb +2 -0
  350. data/lib/algolia/models/query-suggestions/languages.rb +2 -0
  351. data/lib/algolia/models/query-suggestions/log_file.rb +2 -0
  352. data/lib/algolia/models/query-suggestions/log_level.rb +2 -0
  353. data/lib/algolia/models/query-suggestions/source_index.rb +2 -0
  354. data/lib/algolia/models/recommend/advanced_syntax_features.rb +2 -0
  355. data/lib/algolia/models/recommend/alternatives_as_exact.rb +2 -0
  356. data/lib/algolia/models/recommend/around_precision.rb +2 -0
  357. data/lib/algolia/models/recommend/around_radius.rb +2 -0
  358. data/lib/algolia/models/recommend/around_radius_all.rb +2 -0
  359. data/lib/algolia/models/recommend/auto_facet_filter.rb +2 -0
  360. data/lib/algolia/models/recommend/banner.rb +3 -1
  361. data/lib/algolia/models/recommend/banner_image.rb +3 -1
  362. data/lib/algolia/models/recommend/banner_image_url.rb +3 -1
  363. data/lib/algolia/models/recommend/banner_link.rb +3 -1
  364. data/lib/algolia/models/recommend/boolean_string.rb +2 -0
  365. data/lib/algolia/models/recommend/bought_together_query.rb +10 -8
  366. data/lib/algolia/models/recommend/condition.rb +2 -0
  367. data/lib/algolia/models/recommend/consequence.rb +2 -0
  368. data/lib/algolia/models/recommend/deleted_at_response.rb +2 -0
  369. data/lib/algolia/models/recommend/distinct.rb +2 -0
  370. data/lib/algolia/models/recommend/error_base.rb +2 -0
  371. data/lib/algolia/models/recommend/exact_on_single_word_query.rb +2 -0
  372. data/lib/algolia/models/recommend/exhaustive.rb +2 -0
  373. data/lib/algolia/models/recommend/facet_filters.rb +2 -0
  374. data/lib/algolia/models/recommend/facet_ordering.rb +2 -0
  375. data/lib/algolia/models/recommend/facet_stats.rb +2 -0
  376. data/lib/algolia/models/recommend/fallback_params.rb +26 -0
  377. data/lib/algolia/models/recommend/fbt_model.rb +2 -0
  378. data/lib/algolia/models/recommend/get_recommend_task_response.rb +2 -0
  379. data/lib/algolia/models/recommend/get_recommendations_params.rb +2 -0
  380. data/lib/algolia/models/recommend/get_recommendations_response.rb +2 -0
  381. data/lib/algolia/models/recommend/hide_consequence_object.rb +9 -7
  382. data/lib/algolia/models/recommend/highlight_result.rb +2 -0
  383. data/lib/algolia/models/recommend/highlight_result_option.rb +2 -0
  384. data/lib/algolia/models/recommend/ignore_plurals.rb +2 -0
  385. data/lib/algolia/models/recommend/index_settings_facets.rb +2 -0
  386. data/lib/algolia/models/recommend/inside_bounding_box.rb +2 -0
  387. data/lib/algolia/models/recommend/looking_similar_model.rb +2 -0
  388. data/lib/algolia/models/recommend/looking_similar_query.rb +10 -8
  389. data/lib/algolia/models/recommend/match_level.rb +2 -0
  390. data/lib/algolia/models/recommend/matched_geo_location.rb +2 -0
  391. data/lib/algolia/models/recommend/numeric_filters.rb +2 -0
  392. data/lib/algolia/models/recommend/optional_filters.rb +3 -1
  393. data/lib/algolia/models/recommend/optional_words.rb +2 -0
  394. data/lib/algolia/models/recommend/params_consequence.rb +2 -0
  395. data/lib/algolia/models/recommend/personalization.rb +2 -0
  396. data/lib/algolia/models/recommend/promote_consequence_object.rb +9 -7
  397. data/lib/algolia/models/recommend/query_type.rb +2 -0
  398. data/lib/algolia/models/recommend/range.rb +2 -0
  399. data/lib/algolia/models/recommend/ranking_info.rb +2 -0
  400. data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +2 -0
  401. data/lib/algolia/models/recommend/recommend_hit.rb +10 -8
  402. data/lib/algolia/models/recommend/recommend_models.rb +2 -0
  403. data/lib/algolia/models/recommend/recommend_rule.rb +9 -7
  404. data/lib/algolia/models/recommend/recommend_search_params.rb +26 -0
  405. data/lib/algolia/models/recommend/recommend_updated_at_response.rb +2 -0
  406. data/lib/algolia/models/recommend/recommendations_hit.rb +2 -0
  407. data/lib/algolia/models/recommend/recommendations_request.rb +2 -0
  408. data/lib/algolia/models/recommend/recommendations_results.rb +2 -0
  409. data/lib/algolia/models/recommend/redirect.rb +2 -0
  410. data/lib/algolia/models/recommend/redirect_rule_index_data.rb +2 -0
  411. data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +2 -0
  412. data/lib/algolia/models/recommend/redirect_url.rb +2 -0
  413. data/lib/algolia/models/recommend/related_model.rb +2 -0
  414. data/lib/algolia/models/recommend/related_query.rb +10 -8
  415. data/lib/algolia/models/recommend/remove_stop_words.rb +2 -0
  416. data/lib/algolia/models/recommend/remove_words_if_no_results.rb +2 -0
  417. data/lib/algolia/models/recommend/rendering_content.rb +2 -0
  418. data/lib/algolia/models/recommend/rule_metadata.rb +2 -0
  419. data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -0
  420. data/lib/algolia/models/recommend/search_recommend_rules_response.rb +2 -0
  421. data/lib/algolia/models/recommend/snippet_result.rb +2 -0
  422. data/lib/algolia/models/recommend/snippet_result_option.rb +2 -0
  423. data/lib/algolia/models/recommend/sort_remaining_by.rb +2 -0
  424. data/lib/algolia/models/recommend/supported_language.rb +2 -0
  425. data/lib/algolia/models/recommend/tag_filters.rb +2 -0
  426. data/lib/algolia/models/recommend/task_status.rb +2 -0
  427. data/lib/algolia/models/recommend/time_range.rb +2 -0
  428. data/lib/algolia/models/recommend/trending_facet_hit.rb +2 -0
  429. data/lib/algolia/models/recommend/trending_facets_model.rb +2 -0
  430. data/lib/algolia/models/recommend/trending_facets_query.rb +2 -0
  431. data/lib/algolia/models/recommend/trending_items_model.rb +2 -0
  432. data/lib/algolia/models/recommend/trending_items_query.rb +2 -0
  433. data/lib/algolia/models/recommend/typo_tolerance.rb +2 -0
  434. data/lib/algolia/models/recommend/typo_tolerance_enum.rb +2 -0
  435. data/lib/algolia/models/recommend/value.rb +2 -0
  436. data/lib/algolia/models/recommend/widgets.rb +4 -2
  437. data/lib/algolia/models/search/acl.rb +2 -0
  438. data/lib/algolia/models/search/action.rb +2 -0
  439. data/lib/algolia/models/search/add_api_key_response.rb +2 -0
  440. data/lib/algolia/models/search/advanced_syntax_features.rb +2 -0
  441. data/lib/algolia/models/search/alternatives_as_exact.rb +2 -0
  442. data/lib/algolia/models/search/anchoring.rb +2 -0
  443. data/lib/algolia/models/search/api_key.rb +2 -0
  444. data/lib/algolia/models/search/api_key_operation.rb +2 -0
  445. data/lib/algolia/models/search/around_precision.rb +2 -0
  446. data/lib/algolia/models/search/around_radius.rb +2 -0
  447. data/lib/algolia/models/search/around_radius_all.rb +2 -0
  448. data/lib/algolia/models/search/assign_user_id_params.rb +2 -0
  449. data/lib/algolia/models/search/attribute_to_update.rb +2 -0
  450. data/lib/algolia/models/search/automatic_facet_filter.rb +2 -0
  451. data/lib/algolia/models/search/automatic_facet_filters.rb +2 -0
  452. data/lib/algolia/models/search/banner.rb +3 -1
  453. data/lib/algolia/models/search/banner_image.rb +3 -1
  454. data/lib/algolia/models/search/banner_image_url.rb +3 -1
  455. data/lib/algolia/models/search/banner_link.rb +3 -1
  456. data/lib/algolia/models/search/batch_assign_user_ids_params.rb +2 -0
  457. data/lib/algolia/models/search/batch_dictionary_entries_params.rb +2 -0
  458. data/lib/algolia/models/search/batch_dictionary_entries_request.rb +2 -0
  459. data/lib/algolia/models/search/batch_params.rb +2 -0
  460. data/lib/algolia/models/search/batch_request.rb +2 -0
  461. data/lib/algolia/models/search/batch_response.rb +2 -0
  462. data/lib/algolia/models/search/batch_write_params.rb +2 -0
  463. data/lib/algolia/models/search/boolean_string.rb +2 -0
  464. data/lib/algolia/models/search/browse_params.rb +2 -0
  465. data/lib/algolia/models/search/browse_params_object.rb +2 -24
  466. data/lib/algolia/models/search/browse_response.rb +2 -0
  467. data/lib/algolia/models/search/built_in_operation.rb +2 -0
  468. data/lib/algolia/models/search/built_in_operation_type.rb +2 -0
  469. data/lib/algolia/models/search/built_in_operation_value.rb +2 -0
  470. data/lib/algolia/models/search/condition.rb +2 -0
  471. data/lib/algolia/models/search/consequence.rb +2 -0
  472. data/lib/algolia/models/search/consequence_hide.rb +10 -8
  473. data/lib/algolia/models/search/consequence_params.rb +2 -24
  474. data/lib/algolia/models/search/consequence_query.rb +2 -0
  475. data/lib/algolia/models/search/consequence_query_object.rb +2 -0
  476. data/lib/algolia/models/search/created_at_response.rb +2 -0
  477. data/lib/algolia/models/search/delete_api_key_response.rb +2 -0
  478. data/lib/algolia/models/search/delete_by_params.rb +2 -0
  479. data/lib/algolia/models/search/delete_source_response.rb +2 -0
  480. data/lib/algolia/models/search/deleted_at_response.rb +2 -0
  481. data/lib/algolia/models/search/dictionary_action.rb +2 -0
  482. data/lib/algolia/models/search/dictionary_entry.rb +10 -8
  483. data/lib/algolia/models/search/dictionary_entry_state.rb +2 -0
  484. data/lib/algolia/models/search/dictionary_entry_type.rb +2 -0
  485. data/lib/algolia/models/search/dictionary_language.rb +2 -0
  486. data/lib/algolia/models/search/dictionary_settings_params.rb +2 -0
  487. data/lib/algolia/models/search/dictionary_type.rb +2 -0
  488. data/lib/algolia/models/search/distinct.rb +2 -0
  489. data/lib/algolia/models/search/edit.rb +2 -0
  490. data/lib/algolia/models/search/edit_type.rb +2 -0
  491. data/lib/algolia/models/search/error_base.rb +2 -0
  492. data/lib/algolia/models/search/exact_on_single_word_query.rb +2 -0
  493. data/lib/algolia/models/search/exhaustive.rb +2 -0
  494. data/lib/algolia/models/search/facet_filters.rb +2 -0
  495. data/lib/algolia/models/search/facet_hits.rb +2 -0
  496. data/lib/algolia/models/search/facet_ordering.rb +2 -0
  497. data/lib/algolia/models/search/facet_stats.rb +2 -0
  498. data/lib/algolia/models/search/facets.rb +2 -0
  499. data/lib/algolia/models/search/fetched_index.rb +2 -0
  500. data/lib/algolia/models/search/get_api_key_response.rb +2 -0
  501. data/lib/algolia/models/search/get_dictionary_settings_response.rb +2 -0
  502. data/lib/algolia/models/search/get_logs_response.rb +2 -0
  503. data/lib/algolia/models/search/get_objects_params.rb +2 -0
  504. data/lib/algolia/models/search/get_objects_request.rb +10 -8
  505. data/lib/algolia/models/search/get_objects_response.rb +2 -0
  506. data/lib/algolia/models/search/get_task_response.rb +2 -0
  507. data/lib/algolia/models/search/get_top_user_ids_response.rb +2 -0
  508. data/lib/algolia/models/search/has_pending_mappings_response.rb +2 -0
  509. data/lib/algolia/models/search/highlight_result.rb +2 -0
  510. data/lib/algolia/models/search/highlight_result_option.rb +2 -0
  511. data/lib/algolia/models/search/hit.rb +10 -8
  512. data/lib/algolia/models/search/ignore_plurals.rb +2 -0
  513. data/lib/algolia/models/search/index_settings.rb +26 -24
  514. data/lib/algolia/models/search/inside_bounding_box.rb +2 -0
  515. data/lib/algolia/models/search/languages.rb +2 -0
  516. data/lib/algolia/models/search/list_api_keys_response.rb +2 -0
  517. data/lib/algolia/models/search/list_clusters_response.rb +2 -0
  518. data/lib/algolia/models/search/list_indices_response.rb +2 -0
  519. data/lib/algolia/models/search/list_user_ids_response.rb +2 -0
  520. data/lib/algolia/models/search/log.rb +2 -0
  521. data/lib/algolia/models/search/log_query.rb +2 -0
  522. data/lib/algolia/models/search/log_type.rb +2 -0
  523. data/lib/algolia/models/search/match_level.rb +2 -0
  524. data/lib/algolia/models/search/matched_geo_location.rb +2 -0
  525. data/lib/algolia/models/search/mode.rb +2 -0
  526. data/lib/algolia/models/search/multiple_batch_request.rb +2 -0
  527. data/lib/algolia/models/search/multiple_batch_response.rb +2 -0
  528. data/lib/algolia/models/search/numeric_filters.rb +2 -0
  529. data/lib/algolia/models/search/operation_index_params.rb +2 -0
  530. data/lib/algolia/models/search/operation_type.rb +2 -0
  531. data/lib/algolia/models/search/optional_filters.rb +3 -1
  532. data/lib/algolia/models/search/optional_words.rb +2 -0
  533. data/lib/algolia/models/search/personalization.rb +2 -0
  534. data/lib/algolia/models/search/promote.rb +2 -0
  535. data/lib/algolia/models/search/promote_object_id.rb +10 -8
  536. data/lib/algolia/models/search/promote_object_ids.rb +2 -0
  537. data/lib/algolia/models/search/query_type.rb +2 -0
  538. data/lib/algolia/models/search/range.rb +2 -0
  539. data/lib/algolia/models/search/ranking_info.rb +2 -0
  540. data/lib/algolia/models/search/re_ranking_apply_filter.rb +2 -0
  541. data/lib/algolia/models/search/redirect.rb +2 -0
  542. data/lib/algolia/models/search/redirect_rule_index_data.rb +2 -0
  543. data/lib/algolia/models/search/redirect_rule_index_metadata.rb +2 -0
  544. data/lib/algolia/models/search/redirect_url.rb +2 -0
  545. data/lib/algolia/models/search/remove_stop_words.rb +2 -0
  546. data/lib/algolia/models/search/remove_user_id_response.rb +2 -0
  547. data/lib/algolia/models/search/remove_words_if_no_results.rb +2 -0
  548. data/lib/algolia/models/search/rendering_content.rb +2 -0
  549. data/lib/algolia/models/search/replace_all_objects_response.rb +2 -0
  550. data/lib/algolia/models/search/replace_source_response.rb +2 -0
  551. data/lib/algolia/models/search/rule.rb +10 -8
  552. data/lib/algolia/models/search/save_object_response.rb +9 -7
  553. data/lib/algolia/models/search/save_synonym_response.rb +2 -0
  554. data/lib/algolia/models/search/scope_type.rb +2 -0
  555. data/lib/algolia/models/search/search_dictionary_entries_params.rb +2 -0
  556. data/lib/algolia/models/search/search_dictionary_entries_response.rb +2 -0
  557. data/lib/algolia/models/search/search_for_facet_values_request.rb +2 -0
  558. data/lib/algolia/models/search/search_for_facet_values_response.rb +2 -0
  559. data/lib/algolia/models/search/search_for_facets.rb +2 -24
  560. data/lib/algolia/models/search/search_for_hits.rb +2 -24
  561. data/lib/algolia/models/search/search_method_params.rb +2 -0
  562. data/lib/algolia/models/search/search_params.rb +2 -0
  563. data/lib/algolia/models/search/search_params_object.rb +2 -24
  564. data/lib/algolia/models/search/search_params_string.rb +2 -0
  565. data/lib/algolia/models/search/search_query.rb +2 -0
  566. data/lib/algolia/models/search/search_response.rb +2 -0
  567. data/lib/algolia/models/search/search_responses.rb +2 -0
  568. data/lib/algolia/models/search/search_result.rb +2 -0
  569. data/lib/algolia/models/search/search_rules_params.rb +2 -0
  570. data/lib/algolia/models/search/search_rules_response.rb +2 -0
  571. data/lib/algolia/models/search/search_strategy.rb +2 -0
  572. data/lib/algolia/models/search/search_synonyms_params.rb +2 -0
  573. data/lib/algolia/models/search/search_synonyms_response.rb +2 -0
  574. data/lib/algolia/models/search/search_type_default.rb +2 -0
  575. data/lib/algolia/models/search/search_type_facet.rb +2 -0
  576. data/lib/algolia/models/search/search_user_ids_params.rb +2 -0
  577. data/lib/algolia/models/search/search_user_ids_response.rb +2 -0
  578. data/lib/algolia/models/search/secured_api_key_restrictions.rb +2 -0
  579. data/lib/algolia/models/search/semantic_search.rb +2 -0
  580. data/lib/algolia/models/search/settings_response.rb +26 -24
  581. data/lib/algolia/models/search/snippet_result.rb +2 -0
  582. data/lib/algolia/models/search/snippet_result_option.rb +2 -0
  583. data/lib/algolia/models/search/sort_remaining_by.rb +2 -0
  584. data/lib/algolia/models/search/source.rb +2 -0
  585. data/lib/algolia/models/search/standard_entries.rb +2 -0
  586. data/lib/algolia/models/search/supported_language.rb +2 -0
  587. data/lib/algolia/models/search/synonym_hit.rb +10 -8
  588. data/lib/algolia/models/search/synonym_type.rb +2 -0
  589. data/lib/algolia/models/search/tag_filters.rb +2 -0
  590. data/lib/algolia/models/search/task_status.rb +2 -0
  591. data/lib/algolia/models/search/time_range.rb +2 -0
  592. data/lib/algolia/models/search/typo_tolerance.rb +2 -0
  593. data/lib/algolia/models/search/typo_tolerance_enum.rb +2 -0
  594. data/lib/algolia/models/search/update_api_key_response.rb +2 -0
  595. data/lib/algolia/models/search/updated_at_response.rb +2 -0
  596. data/lib/algolia/models/search/updated_at_with_object_id_response.rb +9 -7
  597. data/lib/algolia/models/search/user_highlight_result.rb +2 -0
  598. data/lib/algolia/models/search/user_hit.rb +10 -8
  599. data/lib/algolia/models/search/user_id.rb +2 -0
  600. data/lib/algolia/models/search/value.rb +2 -0
  601. data/lib/algolia/models/search/widgets.rb +4 -2
  602. data/lib/algolia/version.rb +3 -1
  603. 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"
@@ -140,6 +142,12 @@ module Algolia
140
142
  # 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).
141
143
  attr_accessor :max_facet_hits
142
144
 
145
+ # 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.
146
+ attr_accessor :keep_diacritics_on_characters
147
+
148
+ # 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.
149
+ attr_accessor :custom_ranking
150
+
143
151
  # 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.
144
152
  attr_accessor :attributes_to_retrieve
145
153
 
@@ -294,6 +302,8 @@ module Algolia
294
302
  :custom_normalization => :customNormalization,
295
303
  :attribute_for_distinct => :attributeForDistinct,
296
304
  :max_facet_hits => :maxFacetHits,
305
+ :keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
306
+ :custom_ranking => :customRanking,
297
307
  :attributes_to_retrieve => :attributesToRetrieve,
298
308
  :ranking => :ranking,
299
309
  :relevancy_strictness => :relevancyStrictness,
@@ -385,6 +395,8 @@ module Algolia
385
395
  :custom_normalization => :"Hash<String, Hash<String, String>>",
386
396
  :attribute_for_distinct => :"String",
387
397
  :max_facet_hits => :"Integer",
398
+ :keep_diacritics_on_characters => :"String",
399
+ :custom_ranking => :"Array<String>",
388
400
  :attributes_to_retrieve => :"Array<String>",
389
401
  :ranking => :"Array<String>",
390
402
  :relevancy_strictness => :"Integer",
@@ -688,6 +700,16 @@ module Algolia
688
700
  self.max_facet_hits = attributes[:max_facet_hits]
689
701
  end
690
702
 
703
+ if attributes.key?(:keep_diacritics_on_characters)
704
+ self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters]
705
+ end
706
+
707
+ if attributes.key?(:custom_ranking)
708
+ if (value = attributes[:custom_ranking]).is_a?(Array)
709
+ self.custom_ranking = value
710
+ end
711
+ end
712
+
691
713
  if attributes.key?(:attributes_to_retrieve)
692
714
  if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
693
715
  self.attributes_to_retrieve = value
@@ -913,6 +935,8 @@ module Algolia
913
935
  custom_normalization == other.custom_normalization &&
914
936
  attribute_for_distinct == other.attribute_for_distinct &&
915
937
  max_facet_hits == other.max_facet_hits &&
938
+ keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
939
+ custom_ranking == other.custom_ranking &&
916
940
  attributes_to_retrieve == other.attributes_to_retrieve &&
917
941
  ranking == other.ranking &&
918
942
  relevancy_strictness == other.relevancy_strictness &&
@@ -1010,6 +1034,8 @@ module Algolia
1010
1034
  custom_normalization,
1011
1035
  attribute_for_distinct,
1012
1036
  max_facet_hits,
1037
+ keep_diacritics_on_characters,
1038
+ custom_ranking,
1013
1039
  attributes_to_retrieve,
1014
1040
  ranking,
1015
1041
  relevancy_strictness,
@@ -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"
@@ -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"
@@ -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"
@@ -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"
@@ -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,19 +10,19 @@ module Algolia
8
10
  # Object ID of the recommendation you want to exclude.
9
11
  class HideConsequenceObject
10
12
  # Unique record identifier.
11
- attr_accessor :object_id
13
+ attr_accessor :algolia_object_id
12
14
 
13
15
  # Attribute mapping from ruby-style variable name to JSON key.
14
16
  def self.attribute_map
15
17
  {
16
- :object_id => :objectID
18
+ :algolia_object_id => :objectID
17
19
  }
18
20
  end
19
21
 
20
22
  # Attribute type mapping.
21
23
  def self.types_mapping
22
24
  {
23
- :object_id => :"String"
25
+ :algolia_object_id => :"String"
24
26
  }
25
27
  end
26
28
 
@@ -54,8 +56,8 @@ module Algolia
54
56
  h[k.to_sym] = v
55
57
  }
56
58
 
57
- if attributes.key?(:object_id)
58
- self.object_id = attributes[:object_id]
59
+ if attributes.key?(:algolia_object_id)
60
+ self.algolia_object_id = attributes[:algolia_object_id]
59
61
  end
60
62
  end
61
63
 
@@ -64,7 +66,7 @@ module Algolia
64
66
  def ==(other)
65
67
  return true if self.equal?(other)
66
68
  self.class == other.class &&
67
- object_id == other.object_id
69
+ algolia_object_id == other.algolia_object_id
68
70
  end
69
71
 
70
72
  # @see the `==` method
@@ -76,7 +78,7 @@ module Algolia
76
78
  # Calculates hash code according to all attributes.
77
79
  # @return [Integer] Hash code
78
80
  def hash
79
- [object_id].hash
81
+ [algolia_object_id].hash
80
82
  end
81
83
 
82
84
  # 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"
@@ -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"
@@ -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"
@@ -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"
@@ -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"
@@ -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"
@@ -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"
@@ -20,7 +22,7 @@ module Algolia
20
22
  attr_accessor :model
21
23
 
22
24
  # Unique record identifier.
23
- attr_accessor :object_id
25
+ attr_accessor :algolia_object_id
24
26
 
25
27
  attr_accessor :fallback_parameters
26
28
 
@@ -32,7 +34,7 @@ module Algolia
32
34
  :max_recommendations => :maxRecommendations,
33
35
  :query_parameters => :queryParameters,
34
36
  :model => :model,
35
- :object_id => :objectID,
37
+ :algolia_object_id => :objectID,
36
38
  :fallback_parameters => :fallbackParameters
37
39
  }
38
40
  end
@@ -45,7 +47,7 @@ module Algolia
45
47
  :max_recommendations => :"Integer",
46
48
  :query_parameters => :"RecommendSearchParams",
47
49
  :model => :"LookingSimilarModel",
48
- :object_id => :"String",
50
+ :algolia_object_id => :"String",
49
51
  :fallback_parameters => :"FallbackParams"
50
52
  }
51
53
  end
@@ -114,10 +116,10 @@ module Algolia
114
116
  self.model = nil
115
117
  end
116
118
 
117
- if attributes.key?(:object_id)
118
- self.object_id = attributes[:object_id]
119
+ if attributes.key?(:algolia_object_id)
120
+ self.algolia_object_id = attributes[:algolia_object_id]
119
121
  else
120
- self.object_id = nil
122
+ self.algolia_object_id = nil
121
123
  end
122
124
 
123
125
  if attributes.key?(:fallback_parameters)
@@ -135,7 +137,7 @@ module Algolia
135
137
  max_recommendations == other.max_recommendations &&
136
138
  query_parameters == other.query_parameters &&
137
139
  model == other.model &&
138
- object_id == other.object_id &&
140
+ algolia_object_id == other.algolia_object_id &&
139
141
  fallback_parameters == other.fallback_parameters
140
142
  end
141
143
 
@@ -148,7 +150,7 @@ module Algolia
148
150
  # Calculates hash code according to all attributes.
149
151
  # @return [Integer] Hash code
150
152
  def hash
151
- [index_name, threshold, max_recommendations, query_parameters, model, object_id, fallback_parameters].hash
153
+ [index_name, threshold, max_recommendations, query_parameters, model, algolia_object_id, fallback_parameters].hash
152
154
  end
153
155
 
154
156
  # 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"
@@ -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"
@@ -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"
@@ -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 Recommend
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"
@@ -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"
@@ -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"
@@ -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
  # Object ID and position of the recommendation you want to pin.
9
11
  class PromoteConsequenceObject
10
12
  # Unique record identifier.
11
- attr_accessor :object_id
13
+ attr_accessor :algolia_object_id
12
14
 
13
15
  # Index in the list of recommendations where to place this item.
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
- :object_id => :objectID,
21
+ :algolia_object_id => :objectID,
20
22
  :position => :position
21
23
  }
22
24
  end
@@ -24,7 +26,7 @@ module Algolia
24
26
  # Attribute type mapping.
25
27
  def self.types_mapping
26
28
  {
27
- :object_id => :"String",
29
+ :algolia_object_id => :"String",
28
30
  :position => :"Integer"
29
31
  }
30
32
  end
@@ -59,8 +61,8 @@ module Algolia
59
61
  h[k.to_sym] = v
60
62
  }
61
63
 
62
- if attributes.key?(:object_id)
63
- self.object_id = attributes[:object_id]
64
+ if attributes.key?(:algolia_object_id)
65
+ self.algolia_object_id = attributes[:algolia_object_id]
64
66
  end
65
67
 
66
68
  if attributes.key?(:position)
@@ -73,7 +75,7 @@ module Algolia
73
75
  def ==(other)
74
76
  return true if self.equal?(other)
75
77
  self.class == other.class &&
76
- object_id == other.object_id &&
78
+ algolia_object_id == other.algolia_object_id &&
77
79
  position == other.position
78
80
  end
79
81
 
@@ -86,7 +88,7 @@ module Algolia
86
88
  # Calculates hash code according to all attributes.
87
89
  # @return [Integer] Hash code
88
90
  def hash
89
- [object_id, position].hash
91
+ [algolia_object_id, position].hash
90
92
  end
91
93
 
92
94
  # 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"
@@ -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"
@@ -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"
@@ -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"
@@ -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
  # Recommend hit.
9
11
  class RecommendHit
10
12
  # Unique record identifier.
11
- attr_accessor :object_id
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
@@ -28,7 +30,7 @@ module Algolia
28
30
  # Attribute mapping from ruby-style variable name to JSON key.
29
31
  def self.attribute_map
30
32
  {
31
- :object_id => :objectID,
33
+ :algolia_object_id => :objectID,
32
34
  :_highlight_result => :_highlightResult,
33
35
  :_snippet_result => :_snippetResult,
34
36
  :_ranking_info => :_rankingInfo,
@@ -47,7 +49,7 @@ module Algolia
47
49
  # Attribute type mapping.
48
50
  def self.types_mapping
49
51
  {
50
- :object_id => :"String",
52
+ :algolia_object_id => :"String",
51
53
  :_highlight_result => :"Hash<String, HighlightResult>",
52
54
  :_snippet_result => :"Hash<String, SnippetResult>",
53
55
  :_ranking_info => :"RankingInfo",
@@ -73,10 +75,10 @@ module Algolia
73
75
  )
74
76
  end
75
77
 
76
- if attributes.key?(:object_id)
77
- self.object_id = attributes[:object_id]
78
+ if attributes.key?(:algolia_object_id)
79
+ self.algolia_object_id = attributes[:algolia_object_id]
78
80
  else
79
- self.object_id = nil
81
+ self.algolia_object_id = nil
80
82
  end
81
83
 
82
84
  if attributes.key?(:_highlight_result)
@@ -113,7 +115,7 @@ module Algolia
113
115
  def ==(other)
114
116
  return true if self.equal?(other)
115
117
  self.class == other.class &&
116
- object_id == other.object_id &&
118
+ algolia_object_id == other.algolia_object_id &&
117
119
  _highlight_result == other._highlight_result &&
118
120
  _snippet_result == other._snippet_result &&
119
121
  _ranking_info == other._ranking_info &&
@@ -130,7 +132,7 @@ module Algolia
130
132
  # Calculates hash code according to all attributes.
131
133
  # @return [Integer] Hash code
132
134
  def hash
133
- [object_id, _highlight_result, _snippet_result, _ranking_info, _distinct_seq_id, _score].hash
135
+ [algolia_object_id, _highlight_result, _snippet_result, _ranking_info, _distinct_seq_id, _score].hash
134
136
  end
135
137
 
136
138
  # 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"
@@ -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"
@@ -10,7 +12,7 @@ module Algolia
10
12
  attr_accessor :_metadata
11
13
 
12
14
  # Unique identifier of a rule object.
13
- attr_accessor :object_id
15
+ attr_accessor :algolia_object_id
14
16
 
15
17
  attr_accessor :condition
16
18
 
@@ -29,7 +31,7 @@ module Algolia
29
31
  def self.attribute_map
30
32
  {
31
33
  :_metadata => :_metadata,
32
- :object_id => :objectID,
34
+ :algolia_object_id => :objectID,
33
35
  :condition => :condition,
34
36
  :consequence => :consequence,
35
37
  :description => :description,
@@ -42,7 +44,7 @@ module Algolia
42
44
  def self.types_mapping
43
45
  {
44
46
  :_metadata => :"RuleMetadata",
45
- :object_id => :"String",
47
+ :algolia_object_id => :"String",
46
48
  :condition => :"Condition",
47
49
  :consequence => :"Consequence",
48
50
  :description => :"String",
@@ -85,8 +87,8 @@ module Algolia
85
87
  self._metadata = attributes[:_metadata]
86
88
  end
87
89
 
88
- if attributes.key?(:object_id)
89
- self.object_id = attributes[:object_id]
90
+ if attributes.key?(:algolia_object_id)
91
+ self.algolia_object_id = attributes[:algolia_object_id]
90
92
  end
91
93
 
92
94
  if attributes.key?(:condition)
@@ -118,7 +120,7 @@ module Algolia
118
120
  return true if self.equal?(other)
119
121
  self.class == other.class &&
120
122
  _metadata == other._metadata &&
121
- object_id == other.object_id &&
123
+ algolia_object_id == other.algolia_object_id &&
122
124
  condition == other.condition &&
123
125
  consequence == other.consequence &&
124
126
  description == other.description &&
@@ -135,7 +137,7 @@ module Algolia
135
137
  # Calculates hash code according to all attributes.
136
138
  # @return [Integer] Hash code
137
139
  def hash
138
- [_metadata, object_id, condition, consequence, description, enabled, validity].hash
140
+ [_metadata, algolia_object_id, condition, consequence, description, enabled, validity].hash
139
141
  end
140
142
 
141
143
  # 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"
@@ -141,6 +143,12 @@ module Algolia
141
143
  # 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).
142
144
  attr_accessor :max_facet_hits
143
145
 
146
+ # 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.
147
+ attr_accessor :keep_diacritics_on_characters
148
+
149
+ # 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.
150
+ attr_accessor :custom_ranking
151
+
144
152
  # 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.
145
153
  attr_accessor :attributes_to_retrieve
146
154
 
@@ -295,6 +303,8 @@ module Algolia
295
303
  :custom_normalization => :customNormalization,
296
304
  :attribute_for_distinct => :attributeForDistinct,
297
305
  :max_facet_hits => :maxFacetHits,
306
+ :keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
307
+ :custom_ranking => :customRanking,
298
308
  :attributes_to_retrieve => :attributesToRetrieve,
299
309
  :ranking => :ranking,
300
310
  :relevancy_strictness => :relevancyStrictness,
@@ -386,6 +396,8 @@ module Algolia
386
396
  :custom_normalization => :"Hash<String, Hash<String, String>>",
387
397
  :attribute_for_distinct => :"String",
388
398
  :max_facet_hits => :"Integer",
399
+ :keep_diacritics_on_characters => :"String",
400
+ :custom_ranking => :"Array<String>",
389
401
  :attributes_to_retrieve => :"Array<String>",
390
402
  :ranking => :"Array<String>",
391
403
  :relevancy_strictness => :"Integer",
@@ -691,6 +703,16 @@ module Algolia
691
703
  self.max_facet_hits = attributes[:max_facet_hits]
692
704
  end
693
705
 
706
+ if attributes.key?(:keep_diacritics_on_characters)
707
+ self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters]
708
+ end
709
+
710
+ if attributes.key?(:custom_ranking)
711
+ if (value = attributes[:custom_ranking]).is_a?(Array)
712
+ self.custom_ranking = value
713
+ end
714
+ end
715
+
694
716
  if attributes.key?(:attributes_to_retrieve)
695
717
  if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
696
718
  self.attributes_to_retrieve = value
@@ -916,6 +938,8 @@ module Algolia
916
938
  custom_normalization == other.custom_normalization &&
917
939
  attribute_for_distinct == other.attribute_for_distinct &&
918
940
  max_facet_hits == other.max_facet_hits &&
941
+ keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
942
+ custom_ranking == other.custom_ranking &&
919
943
  attributes_to_retrieve == other.attributes_to_retrieve &&
920
944
  ranking == other.ranking &&
921
945
  relevancy_strictness == other.relevancy_strictness &&
@@ -1013,6 +1037,8 @@ module Algolia
1013
1037
  custom_normalization,
1014
1038
  attribute_for_distinct,
1015
1039
  max_facet_hits,
1040
+ keep_diacritics_on_characters,
1041
+ custom_ranking,
1016
1042
  attributes_to_retrieve,
1017
1043
  ranking,
1018
1044
  relevancy_strictness,
@@ -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"
@@ -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"
@@ -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"
@@ -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"
@@ -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"