algolia 3.0.0.alpha.5 → 3.0.0.alpha.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (421) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/VERSION +1 -1
  3. data/CHANGELOG.md +17 -0
  4. data/Gemfile.lock +12 -12
  5. data/algolia.gemspec +2 -1
  6. data/lib/algolia/api/abtesting_client.rb +50 -30
  7. data/lib/algolia/api/analytics_client.rb +132 -64
  8. data/lib/algolia/api/ingestion_client.rb +371 -131
  9. data/lib/algolia/api/insights_client.rb +18 -18
  10. data/lib/algolia/api/monitoring_client.rb +46 -53
  11. data/lib/algolia/api/personalization_client.rb +42 -26
  12. data/lib/algolia/api/query_suggestions_client.rb +66 -38
  13. data/lib/algolia/api/recommend_client.rb +57 -38
  14. data/lib/algolia/api/search_client.rb +625 -280
  15. data/lib/algolia/api_client.rb +2 -5
  16. data/lib/algolia/models/abtesting/ab_test.rb +14 -4
  17. data/lib/algolia/models/abtesting/ab_test_response.rb +7 -3
  18. data/lib/algolia/models/abtesting/ab_tests_variant.rb +7 -3
  19. data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +7 -3
  20. data/lib/algolia/models/abtesting/add_ab_tests_request.rb +7 -3
  21. data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +1 -1
  22. data/lib/algolia/models/abtesting/currencies_value.rb +7 -3
  23. data/lib/algolia/models/abtesting/custom_search_params.rb +7 -3
  24. data/lib/algolia/models/abtesting/error_base.rb +13 -4
  25. data/lib/algolia/models/abtesting/filter_effects.rb +7 -3
  26. data/lib/algolia/models/abtesting/filter_effects_empty_search.rb +7 -3
  27. data/lib/algolia/models/abtesting/filter_effects_outliers.rb +7 -3
  28. data/lib/algolia/models/abtesting/list_ab_tests_response.rb +10 -4
  29. data/lib/algolia/models/abtesting/variant.rb +46 -11
  30. data/lib/algolia/models/analytics/average_click_event.rb +7 -3
  31. data/lib/algolia/models/analytics/click_position.rb +7 -3
  32. data/lib/algolia/models/analytics/click_through_rate_event.rb +10 -4
  33. data/lib/algolia/models/analytics/conversion_rate_event.rb +10 -4
  34. data/lib/algolia/models/analytics/error_base.rb +13 -4
  35. data/lib/algolia/models/analytics/get_average_click_position_response.rb +7 -3
  36. data/lib/algolia/models/analytics/get_click_positions_response.rb +7 -3
  37. data/lib/algolia/models/analytics/get_click_through_rate_response.rb +10 -4
  38. data/lib/algolia/models/analytics/get_conversation_rate_response.rb +10 -4
  39. data/lib/algolia/models/analytics/get_no_click_rate_response.rb +7 -3
  40. data/lib/algolia/models/analytics/get_no_results_rate_response.rb +7 -3
  41. data/lib/algolia/models/analytics/get_searches_count_response.rb +7 -3
  42. data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +7 -3
  43. data/lib/algolia/models/analytics/get_searches_no_results_response.rb +7 -3
  44. data/lib/algolia/models/analytics/get_status_response.rb +7 -3
  45. data/lib/algolia/models/analytics/get_top_countries_response.rb +7 -3
  46. data/lib/algolia/models/analytics/get_top_filter_attribute.rb +7 -3
  47. data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +7 -3
  48. data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +7 -3
  49. data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +7 -3
  50. data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +7 -3
  51. data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +7 -3
  52. data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +7 -3
  53. data/lib/algolia/models/analytics/get_top_hits_response.rb +1 -1
  54. data/lib/algolia/models/analytics/get_top_searches_response.rb +1 -1
  55. data/lib/algolia/models/analytics/get_users_count_response.rb +7 -3
  56. data/lib/algolia/models/analytics/no_click_rate_event.rb +7 -3
  57. data/lib/algolia/models/analytics/no_results_rate_event.rb +7 -3
  58. data/lib/algolia/models/analytics/search_event.rb +7 -3
  59. data/lib/algolia/models/analytics/search_no_click_event.rb +7 -3
  60. data/lib/algolia/models/analytics/search_no_result_event.rb +7 -3
  61. data/lib/algolia/models/analytics/top_country.rb +7 -3
  62. data/lib/algolia/models/analytics/top_hit.rb +7 -3
  63. data/lib/algolia/models/analytics/top_hit_with_analytics.rb +10 -4
  64. data/lib/algolia/models/analytics/top_hits_response.rb +7 -3
  65. data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +7 -3
  66. data/lib/algolia/models/analytics/top_search.rb +7 -3
  67. data/lib/algolia/models/analytics/top_search_with_analytics.rb +10 -4
  68. data/lib/algolia/models/analytics/top_searches_response.rb +7 -3
  69. data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +7 -3
  70. data/lib/algolia/models/analytics/user_with_date.rb +7 -3
  71. data/lib/algolia/models/ingestion/auth_algolia.rb +7 -3
  72. data/lib/algolia/models/ingestion/auth_algolia_partial.rb +7 -3
  73. data/lib/algolia/models/ingestion/auth_api_key.rb +7 -3
  74. data/lib/algolia/models/ingestion/auth_api_key_partial.rb +7 -3
  75. data/lib/algolia/models/ingestion/auth_basic.rb +7 -3
  76. data/lib/algolia/models/ingestion/auth_basic_partial.rb +7 -3
  77. data/lib/algolia/models/ingestion/auth_google_service_account.rb +7 -3
  78. data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +7 -3
  79. data/lib/algolia/models/ingestion/auth_input.rb +1 -1
  80. data/lib/algolia/models/ingestion/auth_input_partial.rb +1 -1
  81. data/lib/algolia/models/ingestion/auth_o_auth.rb +7 -3
  82. data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +7 -3
  83. data/lib/algolia/models/ingestion/authentication.rb +7 -3
  84. data/lib/algolia/models/ingestion/authentication_create.rb +7 -3
  85. data/lib/algolia/models/ingestion/authentication_create_response.rb +7 -3
  86. data/lib/algolia/models/ingestion/authentication_search.rb +7 -3
  87. data/lib/algolia/models/ingestion/authentication_update.rb +7 -3
  88. data/lib/algolia/models/ingestion/authentication_update_response.rb +7 -3
  89. data/lib/algolia/models/ingestion/big_commerce_channel.rb +7 -3
  90. data/lib/algolia/models/ingestion/big_commerce_metafield.rb +7 -3
  91. data/lib/algolia/models/ingestion/delete_response.rb +7 -3
  92. data/lib/algolia/models/ingestion/destination.rb +7 -3
  93. data/lib/algolia/models/ingestion/destination_create.rb +7 -3
  94. data/lib/algolia/models/ingestion/destination_create_response.rb +7 -3
  95. data/lib/algolia/models/ingestion/destination_index_name.rb +7 -3
  96. data/lib/algolia/models/ingestion/destination_index_prefix.rb +7 -3
  97. data/lib/algolia/models/ingestion/destination_input.rb +1 -1
  98. data/lib/algolia/models/ingestion/destination_search.rb +7 -3
  99. data/lib/algolia/models/ingestion/destination_update.rb +7 -3
  100. data/lib/algolia/models/ingestion/destination_update_response.rb +7 -3
  101. data/lib/algolia/models/ingestion/docker_source_discover.rb +7 -3
  102. data/lib/algolia/models/ingestion/docker_source_streams.rb +7 -3
  103. data/lib/algolia/models/ingestion/error_base.rb +13 -4
  104. data/lib/algolia/models/ingestion/event.rb +7 -3
  105. data/lib/algolia/models/ingestion/list_authentications_response.rb +7 -3
  106. data/lib/algolia/models/ingestion/list_destinations_response.rb +7 -3
  107. data/lib/algolia/models/ingestion/list_events_response.rb +7 -3
  108. data/lib/algolia/models/ingestion/list_sources_response.rb +7 -3
  109. data/lib/algolia/models/ingestion/list_tasks_response.rb +7 -3
  110. data/lib/algolia/models/ingestion/on_demand_date_utils_input.rb +7 -3
  111. data/lib/algolia/models/ingestion/on_demand_trigger.rb +7 -3
  112. data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +7 -3
  113. data/lib/algolia/models/ingestion/pagination.rb +7 -3
  114. data/lib/algolia/models/ingestion/platform_with_none.rb +1 -1
  115. data/lib/algolia/models/ingestion/run.rb +7 -3
  116. data/lib/algolia/models/ingestion/run_list_response.rb +7 -3
  117. data/lib/algolia/models/ingestion/run_progress.rb +7 -3
  118. data/lib/algolia/models/ingestion/run_response.rb +7 -3
  119. data/lib/algolia/models/ingestion/schedule_date_utils_input.rb +7 -3
  120. data/lib/algolia/models/ingestion/schedule_trigger.rb +7 -3
  121. data/lib/algolia/models/ingestion/schedule_trigger_input.rb +7 -3
  122. data/lib/algolia/models/ingestion/source.rb +7 -3
  123. data/lib/algolia/models/ingestion/source_big_commerce.rb +7 -3
  124. data/lib/algolia/models/ingestion/source_big_query.rb +7 -3
  125. data/lib/algolia/models/ingestion/source_commercetools.rb +7 -3
  126. data/lib/algolia/models/ingestion/source_create.rb +7 -3
  127. data/lib/algolia/models/ingestion/source_create_response.rb +7 -3
  128. data/lib/algolia/models/ingestion/source_csv.rb +7 -3
  129. data/lib/algolia/models/ingestion/source_docker.rb +7 -3
  130. data/lib/algolia/models/ingestion/source_input.rb +1 -1
  131. data/lib/algolia/models/ingestion/source_json.rb +7 -3
  132. data/lib/algolia/models/ingestion/source_search.rb +7 -3
  133. data/lib/algolia/models/ingestion/source_update.rb +7 -3
  134. data/lib/algolia/models/ingestion/source_update_commercetools.rb +7 -3
  135. data/lib/algolia/models/ingestion/source_update_docker.rb +7 -3
  136. data/lib/algolia/models/ingestion/source_update_input.rb +1 -1
  137. data/lib/algolia/models/ingestion/source_update_response.rb +7 -3
  138. data/lib/algolia/models/ingestion/subscription_trigger.rb +7 -3
  139. data/lib/algolia/models/ingestion/task.rb +7 -3
  140. data/lib/algolia/models/ingestion/task_create.rb +7 -3
  141. data/lib/algolia/models/ingestion/task_create_response.rb +7 -3
  142. data/lib/algolia/models/ingestion/task_create_trigger.rb +1 -1
  143. data/lib/algolia/models/ingestion/task_input.rb +1 -1
  144. data/lib/algolia/models/ingestion/task_search.rb +7 -3
  145. data/lib/algolia/models/ingestion/task_update.rb +7 -3
  146. data/lib/algolia/models/ingestion/task_update_response.rb +7 -3
  147. data/lib/algolia/models/ingestion/trigger.rb +1 -1
  148. data/lib/algolia/models/ingestion/trigger_update_input.rb +7 -3
  149. data/lib/algolia/models/ingestion/window.rb +7 -3
  150. data/lib/algolia/models/insights/added_to_cart_object_ids.rb +7 -3
  151. data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +7 -3
  152. data/lib/algolia/models/insights/clicked_filters.rb +7 -3
  153. data/lib/algolia/models/insights/clicked_object_ids.rb +7 -3
  154. data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +7 -3
  155. data/lib/algolia/models/insights/converted_filters.rb +7 -3
  156. data/lib/algolia/models/insights/converted_object_ids.rb +7 -3
  157. data/lib/algolia/models/insights/converted_object_ids_after_search.rb +7 -3
  158. data/lib/algolia/models/insights/discount.rb +1 -1
  159. data/lib/algolia/models/insights/error_base.rb +13 -4
  160. data/lib/algolia/models/insights/events_items.rb +1 -1
  161. data/lib/algolia/models/insights/events_response.rb +7 -3
  162. data/lib/algolia/models/insights/insights_events.rb +7 -3
  163. data/lib/algolia/models/insights/object_data.rb +7 -3
  164. data/lib/algolia/models/insights/object_data_after_search.rb +7 -3
  165. data/lib/algolia/models/insights/price.rb +1 -1
  166. data/lib/algolia/models/insights/purchased_object_ids.rb +7 -3
  167. data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +7 -3
  168. data/lib/algolia/models/insights/value.rb +1 -1
  169. data/lib/algolia/models/insights/viewed_filters.rb +7 -3
  170. data/lib/algolia/models/insights/viewed_object_ids.rb +7 -3
  171. data/lib/algolia/models/monitoring/error_base.rb +13 -4
  172. data/lib/algolia/models/monitoring/get_inventory403_response.rb +7 -3
  173. data/lib/algolia/models/monitoring/incident.rb +7 -3
  174. data/lib/algolia/models/monitoring/incidents_inner.rb +7 -3
  175. data/lib/algolia/models/monitoring/incidents_response.rb +7 -3
  176. data/lib/algolia/models/monitoring/indexing_time_response.rb +7 -3
  177. data/lib/algolia/models/monitoring/indexing_time_response_metrics.rb +7 -3
  178. data/lib/algolia/models/monitoring/infrastructure_response.rb +7 -3
  179. data/lib/algolia/models/monitoring/infrastructure_response_metrics.rb +7 -3
  180. data/lib/algolia/models/monitoring/inventory_response.rb +7 -3
  181. data/lib/algolia/models/monitoring/latency_response.rb +7 -3
  182. data/lib/algolia/models/monitoring/latency_response_metrics.rb +7 -3
  183. data/lib/algolia/models/monitoring/probes_metric.rb +7 -3
  184. data/lib/algolia/models/monitoring/server.rb +7 -3
  185. data/lib/algolia/models/monitoring/status_response.rb +7 -3
  186. data/lib/algolia/models/monitoring/time_inner.rb +7 -3
  187. data/lib/algolia/models/personalization/delete_user_profile_response.rb +7 -3
  188. data/lib/algolia/models/personalization/error_base.rb +13 -4
  189. data/lib/algolia/models/personalization/event_scoring.rb +7 -3
  190. data/lib/algolia/models/personalization/facet_scoring.rb +7 -3
  191. data/lib/algolia/models/personalization/get_user_token_response.rb +7 -3
  192. data/lib/algolia/models/personalization/personalization_strategy_params.rb +7 -3
  193. data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +7 -3
  194. data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb +8 -14
  195. data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_with_index.rb +7 -3
  196. data/lib/algolia/models/query-suggestions/base_response.rb +7 -3
  197. data/lib/algolia/models/query-suggestions/error_base.rb +13 -4
  198. data/lib/algolia/models/query-suggestions/facet.rb +7 -3
  199. data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +7 -3
  200. data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +7 -3
  201. data/lib/algolia/models/query-suggestions/languages.rb +1 -1
  202. data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +7 -3
  203. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +8 -14
  204. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +7 -3
  205. data/lib/algolia/models/query-suggestions/source_index.rb +7 -3
  206. data/lib/algolia/models/recommend/around_precision.rb +1 -1
  207. data/lib/algolia/models/recommend/around_precision_from_value_inner.rb +7 -3
  208. data/lib/algolia/models/recommend/around_radius.rb +1 -1
  209. data/lib/algolia/models/recommend/automatic_facet_filter.rb +7 -3
  210. data/lib/algolia/models/recommend/automatic_facet_filters.rb +1 -1
  211. data/lib/algolia/models/recommend/base_recommend_request.rb +7 -3
  212. data/lib/algolia/models/recommend/base_recommendations_query.rb +7 -3
  213. data/lib/algolia/models/recommend/base_recommended_for_you_query.rb +7 -3
  214. data/lib/algolia/models/recommend/base_recommended_for_you_query_parameters.rb +7 -3
  215. data/lib/algolia/models/recommend/base_search_params.rb +7 -3
  216. data/lib/algolia/models/recommend/base_search_params_without_query.rb +7 -3
  217. data/lib/algolia/models/recommend/base_search_response.rb +13 -4
  218. data/lib/algolia/models/recommend/base_trending_facets_query.rb +7 -3
  219. data/lib/algolia/models/recommend/base_trending_items_query.rb +7 -3
  220. data/lib/algolia/models/recommend/condition.rb +7 -3
  221. data/lib/algolia/models/recommend/consequence.rb +7 -3
  222. data/lib/algolia/models/recommend/consequence_hide.rb +7 -3
  223. data/lib/algolia/models/recommend/consequence_params.rb +7 -3
  224. data/lib/algolia/models/recommend/consequence_query.rb +1 -1
  225. data/lib/algolia/models/recommend/consequence_query_object.rb +7 -3
  226. data/lib/algolia/models/recommend/deleted_at_response.rb +7 -3
  227. data/lib/algolia/models/recommend/distinct.rb +1 -1
  228. data/lib/algolia/models/recommend/edit.rb +7 -3
  229. data/lib/algolia/models/recommend/error_base.rb +13 -4
  230. data/lib/algolia/models/recommend/exhaustive.rb +7 -3
  231. data/lib/algolia/models/recommend/facet_filters.rb +1 -1
  232. data/lib/algolia/models/recommend/facet_ordering.rb +7 -3
  233. data/lib/algolia/models/recommend/facets.rb +7 -3
  234. data/lib/algolia/models/recommend/facets_stats.rb +7 -3
  235. data/lib/algolia/models/recommend/get_recommend_task_response.rb +7 -3
  236. data/lib/algolia/models/recommend/get_recommendations_params.rb +7 -3
  237. data/lib/algolia/models/recommend/get_recommendations_response.rb +7 -3
  238. data/lib/algolia/models/recommend/highlight_result.rb +2 -1
  239. data/lib/algolia/models/recommend/highlight_result_option.rb +7 -3
  240. data/lib/algolia/models/recommend/ignore_plurals.rb +1 -1
  241. data/lib/algolia/models/recommend/index_settings_as_search_params.rb +7 -3
  242. data/lib/algolia/models/recommend/matched_geo_location.rb +7 -3
  243. data/lib/algolia/models/recommend/mixed_search_filters.rb +1 -1
  244. data/lib/algolia/models/recommend/numeric_filters.rb +1 -1
  245. data/lib/algolia/models/recommend/optional_filters.rb +1 -1
  246. data/lib/algolia/models/recommend/params.rb +7 -3
  247. data/lib/algolia/models/recommend/personalization.rb +7 -3
  248. data/lib/algolia/models/recommend/promote.rb +1 -1
  249. data/lib/algolia/models/recommend/promote_object_id.rb +7 -3
  250. data/lib/algolia/models/recommend/promote_object_ids.rb +7 -3
  251. data/lib/algolia/models/recommend/ranking_info.rb +7 -3
  252. data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +1 -1
  253. data/lib/algolia/models/recommend/recommend_hit.rb +13 -4
  254. data/lib/algolia/models/recommend/recommendations_hit.rb +1 -1
  255. data/lib/algolia/models/recommend/recommendations_hits.rb +7 -3
  256. data/lib/algolia/models/recommend/recommendations_query.rb +7 -3
  257. data/lib/algolia/models/recommend/recommendations_request.rb +1 -1
  258. data/lib/algolia/models/recommend/recommendations_results.rb +7 -3
  259. data/lib/algolia/models/recommend/recommended_for_you_query.rb +7 -3
  260. data/lib/algolia/models/recommend/recommended_for_you_query_parameters.rb +7 -3
  261. data/lib/algolia/models/recommend/redirect.rb +7 -3
  262. data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +7 -3
  263. data/lib/algolia/models/recommend/redirect_rule_index_metadata_data.rb +7 -3
  264. data/lib/algolia/models/recommend/remove_stop_words.rb +1 -1
  265. data/lib/algolia/models/recommend/rendering_content.rb +7 -3
  266. data/lib/algolia/models/recommend/rule_response.rb +7 -3
  267. data/lib/algolia/models/recommend/rule_response_metadata.rb +7 -3
  268. data/lib/algolia/models/recommend/search_params_object.rb +7 -3
  269. data/lib/algolia/models/recommend/search_params_query.rb +7 -3
  270. data/lib/algolia/models/recommend/search_recommend_rules_params.rb +7 -3
  271. data/lib/algolia/models/recommend/search_recommend_rules_response.rb +7 -3
  272. data/lib/algolia/models/recommend/semantic_search.rb +7 -3
  273. data/lib/algolia/models/recommend/snippet_result.rb +2 -1
  274. data/lib/algolia/models/recommend/snippet_result_option.rb +7 -3
  275. data/lib/algolia/models/recommend/tag_filters.rb +1 -1
  276. data/lib/algolia/models/recommend/trending_facet_hit.rb +7 -3
  277. data/lib/algolia/models/recommend/trending_facets_query.rb +7 -3
  278. data/lib/algolia/models/recommend/trending_items_query.rb +7 -3
  279. data/lib/algolia/models/recommend/typo_tolerance.rb +1 -1
  280. data/lib/algolia/models/recommend/value.rb +7 -3
  281. data/lib/algolia/models/search/add_api_key_response.rb +7 -3
  282. data/lib/algolia/models/search/api_key.rb +7 -3
  283. data/lib/algolia/models/search/around_precision.rb +1 -1
  284. data/lib/algolia/models/search/around_precision_from_value_inner.rb +7 -3
  285. data/lib/algolia/models/search/around_radius.rb +1 -1
  286. data/lib/algolia/models/search/assign_user_id_params.rb +7 -3
  287. data/lib/algolia/models/search/attribute_to_update.rb +1 -1
  288. data/lib/algolia/models/search/automatic_facet_filter.rb +7 -3
  289. data/lib/algolia/models/search/automatic_facet_filters.rb +1 -1
  290. data/lib/algolia/models/search/base_get_api_key_response.rb +7 -3
  291. data/lib/algolia/models/search/base_index_settings.rb +7 -3
  292. data/lib/algolia/models/search/base_search_params.rb +7 -3
  293. data/lib/algolia/models/search/base_search_params_without_query.rb +7 -3
  294. data/lib/algolia/models/search/base_search_response.rb +13 -4
  295. data/lib/algolia/models/search/batch_assign_user_ids_params.rb +7 -3
  296. data/lib/algolia/models/search/batch_dictionary_entries_params.rb +7 -3
  297. data/lib/algolia/models/search/batch_dictionary_entries_request.rb +7 -3
  298. data/lib/algolia/models/search/batch_params.rb +7 -3
  299. data/lib/algolia/models/search/batch_request.rb +7 -3
  300. data/lib/algolia/models/search/batch_response.rb +7 -3
  301. data/lib/algolia/models/search/batch_write_params.rb +7 -3
  302. data/lib/algolia/models/search/browse_params.rb +1 -1
  303. data/lib/algolia/models/search/browse_params_object.rb +7 -3
  304. data/lib/algolia/models/search/browse_response.rb +7 -3
  305. data/lib/algolia/models/search/built_in_operation.rb +7 -3
  306. data/lib/algolia/models/search/condition.rb +7 -3
  307. data/lib/algolia/models/search/consequence.rb +7 -3
  308. data/lib/algolia/models/search/consequence_hide.rb +7 -3
  309. data/lib/algolia/models/search/consequence_params.rb +7 -3
  310. data/lib/algolia/models/search/consequence_query.rb +1 -1
  311. data/lib/algolia/models/search/consequence_query_object.rb +7 -3
  312. data/lib/algolia/models/search/created_at_response.rb +7 -3
  313. data/lib/algolia/models/search/cursor.rb +7 -3
  314. data/lib/algolia/models/search/delete_api_key_response.rb +7 -3
  315. data/lib/algolia/models/search/delete_by_params.rb +7 -3
  316. data/lib/algolia/models/search/delete_source_response.rb +7 -3
  317. data/lib/algolia/models/search/deleted_at_response.rb +7 -3
  318. data/lib/algolia/models/search/dictionary_entry.rb +13 -4
  319. data/lib/algolia/models/search/dictionary_language.rb +7 -3
  320. data/lib/algolia/models/search/dictionary_settings_params.rb +7 -3
  321. data/lib/algolia/models/search/distinct.rb +1 -1
  322. data/lib/algolia/models/search/edit.rb +7 -3
  323. data/lib/algolia/models/search/error_base.rb +13 -4
  324. data/lib/algolia/models/search/exhaustive.rb +7 -3
  325. data/lib/algolia/models/search/facet_filters.rb +1 -1
  326. data/lib/algolia/models/search/facet_hits.rb +7 -3
  327. data/lib/algolia/models/search/facet_ordering.rb +7 -3
  328. data/lib/algolia/models/search/facets.rb +7 -3
  329. data/lib/algolia/models/search/facets_stats.rb +7 -3
  330. data/lib/algolia/models/search/fetched_index.rb +7 -3
  331. data/lib/algolia/models/search/get_api_key_response.rb +7 -3
  332. data/lib/algolia/models/search/get_dictionary_settings_response.rb +7 -3
  333. data/lib/algolia/models/search/get_logs_response.rb +7 -3
  334. data/lib/algolia/models/search/get_objects_params.rb +7 -3
  335. data/lib/algolia/models/search/get_objects_request.rb +7 -3
  336. data/lib/algolia/models/search/get_objects_response.rb +7 -3
  337. data/lib/algolia/models/search/get_task_response.rb +7 -3
  338. data/lib/algolia/models/search/get_top_user_ids_response.rb +7 -3
  339. data/lib/algolia/models/search/has_pending_mappings_response.rb +7 -3
  340. data/lib/algolia/models/search/highlight_result.rb +2 -1
  341. data/lib/algolia/models/search/highlight_result_option.rb +7 -3
  342. data/lib/algolia/models/search/hit.rb +13 -4
  343. data/lib/algolia/models/search/ignore_plurals.rb +1 -1
  344. data/lib/algolia/models/search/index_settings.rb +7 -3
  345. data/lib/algolia/models/search/index_settings_as_search_params.rb +7 -3
  346. data/lib/algolia/models/search/languages.rb +7 -3
  347. data/lib/algolia/models/search/list_api_keys_response.rb +7 -3
  348. data/lib/algolia/models/search/list_clusters_response.rb +7 -3
  349. data/lib/algolia/models/search/list_indices_response.rb +7 -3
  350. data/lib/algolia/models/search/list_user_ids_response.rb +7 -3
  351. data/lib/algolia/models/search/log.rb +7 -3
  352. data/lib/algolia/models/search/log_query.rb +7 -3
  353. data/lib/algolia/models/search/matched_geo_location.rb +7 -3
  354. data/lib/algolia/models/search/mixed_search_filters.rb +1 -1
  355. data/lib/algolia/models/search/multiple_batch_request.rb +7 -3
  356. data/lib/algolia/models/search/multiple_batch_response.rb +7 -3
  357. data/lib/algolia/models/search/numeric_filters.rb +1 -1
  358. data/lib/algolia/models/search/operation_index_params.rb +7 -3
  359. data/lib/algolia/models/search/optional_filters.rb +1 -1
  360. data/lib/algolia/models/search/params.rb +7 -3
  361. data/lib/algolia/models/search/personalization.rb +7 -3
  362. data/lib/algolia/models/search/promote.rb +1 -1
  363. data/lib/algolia/models/search/promote_object_id.rb +7 -3
  364. data/lib/algolia/models/search/promote_object_ids.rb +7 -3
  365. data/lib/algolia/models/search/ranking_info.rb +7 -3
  366. data/lib/algolia/models/search/re_ranking_apply_filter.rb +1 -1
  367. data/lib/algolia/models/search/redirect.rb +7 -3
  368. data/lib/algolia/models/search/redirect_rule_index_metadata.rb +7 -3
  369. data/lib/algolia/models/search/redirect_rule_index_metadata_data.rb +7 -3
  370. data/lib/algolia/models/search/remove_stop_words.rb +1 -1
  371. data/lib/algolia/models/search/remove_user_id_response.rb +7 -3
  372. data/lib/algolia/models/search/rendering_content.rb +7 -3
  373. data/lib/algolia/models/search/replace_source_response.rb +7 -3
  374. data/lib/algolia/models/search/rule.rb +7 -3
  375. data/lib/algolia/models/search/save_object_response.rb +7 -3
  376. data/lib/algolia/models/search/save_synonym_response.rb +7 -3
  377. data/lib/algolia/models/search/search_dictionary_entries_params.rb +7 -3
  378. data/lib/algolia/models/search/search_for_facet_values_request.rb +7 -3
  379. data/lib/algolia/models/search/search_for_facet_values_response.rb +7 -3
  380. data/lib/algolia/models/search/search_for_facets.rb +7 -3
  381. data/lib/algolia/models/search/search_for_facets_options.rb +7 -3
  382. data/lib/algolia/models/search/search_for_hits.rb +7 -3
  383. data/lib/algolia/models/search/search_for_hits_options.rb +7 -3
  384. data/lib/algolia/models/search/search_hits.rb +13 -4
  385. data/lib/algolia/models/search/search_method_params.rb +7 -3
  386. data/lib/algolia/models/search/search_params.rb +1 -1
  387. data/lib/algolia/models/search/search_params_object.rb +7 -3
  388. data/lib/algolia/models/search/search_params_query.rb +7 -3
  389. data/lib/algolia/models/search/search_params_string.rb +7 -3
  390. data/lib/algolia/models/search/search_query.rb +1 -1
  391. data/lib/algolia/models/search/search_response.rb +13 -4
  392. data/lib/algolia/models/search/search_responses.rb +7 -3
  393. data/lib/algolia/models/search/search_result.rb +1 -1
  394. data/lib/algolia/models/search/search_rules_params.rb +7 -3
  395. data/lib/algolia/models/search/search_rules_response.rb +7 -3
  396. data/lib/algolia/models/search/search_synonyms_params.rb +80 -7
  397. data/lib/algolia/models/search/search_synonyms_response.rb +13 -4
  398. data/lib/algolia/models/search/search_user_ids_params.rb +7 -3
  399. data/lib/algolia/models/search/search_user_ids_response.rb +7 -3
  400. data/lib/algolia/models/search/semantic_search.rb +7 -3
  401. data/lib/algolia/models/search/snippet_result.rb +2 -1
  402. data/lib/algolia/models/search/snippet_result_option.rb +7 -3
  403. data/lib/algolia/models/search/source.rb +7 -3
  404. data/lib/algolia/models/search/standard_entries.rb +7 -3
  405. data/lib/algolia/models/search/synonym_hit.rb +7 -3
  406. data/lib/algolia/models/search/tag_filters.rb +1 -1
  407. data/lib/algolia/models/search/time_range.rb +7 -3
  408. data/lib/algolia/models/search/typo_tolerance.rb +1 -1
  409. data/lib/algolia/models/search/update_api_key_response.rb +7 -3
  410. data/lib/algolia/models/search/updated_at_response.rb +7 -3
  411. data/lib/algolia/models/search/updated_at_with_object_id_response.rb +7 -3
  412. data/lib/algolia/models/search/updated_rule_response.rb +7 -3
  413. data/lib/algolia/models/search/user_highlight_result.rb +7 -3
  414. data/lib/algolia/models/search/user_hit.rb +7 -3
  415. data/lib/algolia/models/search/user_id.rb +7 -3
  416. data/lib/algolia/models/search/value.rb +7 -3
  417. data/lib/algolia/transport/http/http_requester.rb +2 -2
  418. data/lib/algolia/transport/stateful_host.rb +2 -1
  419. data/lib/algolia/transport/transport.rb +9 -6
  420. data/lib/algolia/version.rb +1 -1
  421. metadata +2 -2
@@ -33,8 +33,8 @@ module Algolia
33
33
  new(config)
34
34
  end
35
35
 
36
- # Send requests to the Algolia REST API.
37
36
  # This method allow you to send requests to the Algolia REST API.
37
+
38
38
  # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
39
39
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
40
40
  # @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)
@@ -65,19 +65,19 @@ module Algolia
65
65
  @api_client.call_api(:DELETE, path, new_options)
66
66
  end
67
67
 
68
- # Send requests to the Algolia REST API.
69
68
  # This method allow you to send requests to the Algolia REST API.
69
+
70
70
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
71
71
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
72
72
  # @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)
73
73
  # @return [Object]
74
74
  def custom_delete(path, parameters = nil, request_options = {})
75
75
  response = custom_delete_with_http_info(path, parameters, request_options)
76
- deserialize(response.body, request_options[:debug_return_type] || 'Object')
76
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
77
77
  end
78
78
 
79
- # Send requests to the Algolia REST API.
80
79
  # This method allow you to send requests to the Algolia REST API.
80
+
81
81
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
82
82
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
83
83
  # @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)
@@ -108,19 +108,19 @@ module Algolia
108
108
  @api_client.call_api(:GET, path, new_options)
109
109
  end
110
110
 
111
- # Send requests to the Algolia REST API.
112
111
  # This method allow you to send requests to the Algolia REST API.
112
+
113
113
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
114
114
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
115
115
  # @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)
116
116
  # @return [Object]
117
117
  def custom_get(path, parameters = nil, request_options = {})
118
118
  response = custom_get_with_http_info(path, parameters, request_options)
119
- deserialize(response.body, request_options[:debug_return_type] || 'Object')
119
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
120
120
  end
121
121
 
122
- # Send requests to the Algolia REST API.
123
122
  # This method allow you to send requests to the Algolia REST API.
123
+
124
124
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
125
125
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
126
126
  # @param body [Object] Parameters to send with the custom request.
@@ -152,8 +152,8 @@ module Algolia
152
152
  @api_client.call_api(:POST, path, new_options)
153
153
  end
154
154
 
155
- # Send requests to the Algolia REST API.
156
155
  # This method allow you to send requests to the Algolia REST API.
156
+
157
157
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
158
158
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
159
159
  # @param body [Object] Parameters to send with the custom request.
@@ -161,11 +161,11 @@ module Algolia
161
161
  # @return [Object]
162
162
  def custom_post(path, parameters = nil, body = nil, request_options = {})
163
163
  response = custom_post_with_http_info(path, parameters, body, request_options)
164
- deserialize(response.body, request_options[:debug_return_type] || 'Object')
164
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
165
165
  end
166
166
 
167
- # Send requests to the Algolia REST API.
168
167
  # This method allow you to send requests to the Algolia REST API.
168
+
169
169
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
170
170
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
171
171
  # @param body [Object] Parameters to send with the custom request.
@@ -197,8 +197,8 @@ module Algolia
197
197
  @api_client.call_api(:PUT, path, new_options)
198
198
  end
199
199
 
200
- # Send requests to the Algolia REST API.
201
200
  # This method allow you to send requests to the Algolia REST API.
201
+
202
202
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
203
203
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
204
204
  # @param body [Object] Parameters to send with the custom request.
@@ -206,11 +206,13 @@ module Algolia
206
206
  # @return [Object]
207
207
  def custom_put(path, parameters = nil, body = nil, request_options = {})
208
208
  response = custom_put_with_http_info(path, parameters, body, request_options)
209
- deserialize(response.body, request_options[:debug_return_type] || 'Object')
209
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
210
210
  end
211
211
 
212
- # Delete a user profile.
213
212
  # Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.
213
+ #
214
+ # Required API Key ACLs:
215
+ # - recommendation
214
216
  # @param user_token [String] userToken representing the user for which to fetch the Personalization profile. (required)
215
217
  # @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)
216
218
  # @return [Http::Response] the response
@@ -220,7 +222,7 @@ module Algolia
220
222
  raise ArgumentError, "Parameter `user_token` is required when calling `delete_user_profile`."
221
223
  end
222
224
 
223
- path = '/1/profiles/{userToken}'.sub('{' + 'userToken' + '}', @api_client.encode_uri(user_token.to_s))
225
+ path = '/1/profiles/{userToken}'.sub('{' + 'userToken' + '}', Transport.encode_uri(user_token.to_s))
224
226
  query_params = {}
225
227
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
226
228
  header_params = {}
@@ -239,18 +241,22 @@ module Algolia
239
241
  @api_client.call_api(:DELETE, path, new_options)
240
242
  end
241
243
 
242
- # Delete a user profile.
243
244
  # Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.
245
+ #
246
+ # Required API Key ACLs:
247
+ # - recommendation
244
248
  # @param user_token [String] userToken representing the user for which to fetch the Personalization profile. (required)
245
249
  # @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)
246
250
  # @return [DeleteUserProfileResponse]
247
251
  def delete_user_profile(user_token, request_options = {})
248
252
  response = delete_user_profile_with_http_info(user_token, request_options)
249
- deserialize(response.body, request_options[:debug_return_type] || 'Personalization::DeleteUserProfileResponse')
253
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Personalization::DeleteUserProfileResponse')
250
254
  end
251
255
 
252
- # Get the current strategy.
253
256
  # The strategy contains information on the events and facets that impact user profiles and personalized search results.
257
+ #
258
+ # Required API Key ACLs:
259
+ # - recommendation
254
260
  # @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)
255
261
  # @return [Http::Response] the response
256
262
  def get_personalization_strategy_with_http_info(request_options = {})
@@ -273,17 +279,21 @@ module Algolia
273
279
  @api_client.call_api(:GET, path, new_options)
274
280
  end
275
281
 
276
- # Get the current strategy.
277
282
  # The strategy contains information on the events and facets that impact user profiles and personalized search results.
283
+ #
284
+ # Required API Key ACLs:
285
+ # - recommendation
278
286
  # @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)
279
287
  # @return [PersonalizationStrategyParams]
280
288
  def get_personalization_strategy(request_options = {})
281
289
  response = get_personalization_strategy_with_http_info(request_options)
282
- deserialize(response.body, request_options[:debug_return_type] || 'Personalization::PersonalizationStrategyParams')
290
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Personalization::PersonalizationStrategyParams')
283
291
  end
284
292
 
285
- # Get a user profile.
286
293
  # Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
294
+ #
295
+ # Required API Key ACLs:
296
+ # - recommendation
287
297
  # @param user_token [String] userToken representing the user for which to fetch the Personalization profile. (required)
288
298
  # @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)
289
299
  # @return [Http::Response] the response
@@ -293,7 +303,7 @@ module Algolia
293
303
  raise ArgumentError, "Parameter `user_token` is required when calling `get_user_token_profile`."
294
304
  end
295
305
 
296
- path = '/1/profiles/personalization/{userToken}'.sub('{' + 'userToken' + '}', @api_client.encode_uri(user_token.to_s))
306
+ path = '/1/profiles/personalization/{userToken}'.sub('{' + 'userToken' + '}', Transport.encode_uri(user_token.to_s))
297
307
  query_params = {}
298
308
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
299
309
  header_params = {}
@@ -312,18 +322,22 @@ module Algolia
312
322
  @api_client.call_api(:GET, path, new_options)
313
323
  end
314
324
 
315
- # Get a user profile.
316
325
  # Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
326
+ #
327
+ # Required API Key ACLs:
328
+ # - recommendation
317
329
  # @param user_token [String] userToken representing the user for which to fetch the Personalization profile. (required)
318
330
  # @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)
319
331
  # @return [GetUserTokenResponse]
320
332
  def get_user_token_profile(user_token, request_options = {})
321
333
  response = get_user_token_profile_with_http_info(user_token, request_options)
322
- deserialize(response.body, request_options[:debug_return_type] || 'Personalization::GetUserTokenResponse')
334
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Personalization::GetUserTokenResponse')
323
335
  end
324
336
 
325
- # Set a new strategy.
326
337
  # A strategy defines the events and facets that impact user profiles and personalized search results.
338
+ #
339
+ # Required API Key ACLs:
340
+ # - recommendation
327
341
  # @param personalization_strategy_params [PersonalizationStrategyParams] (required)
328
342
  # @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)
329
343
  # @return [Http::Response] the response
@@ -352,14 +366,16 @@ module Algolia
352
366
  @api_client.call_api(:POST, path, new_options)
353
367
  end
354
368
 
355
- # Set a new strategy.
356
369
  # A strategy defines the events and facets that impact user profiles and personalized search results.
370
+ #
371
+ # Required API Key ACLs:
372
+ # - recommendation
357
373
  # @param personalization_strategy_params [PersonalizationStrategyParams] (required)
358
374
  # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
359
375
  # @return [SetPersonalizationStrategyResponse]
360
376
  def set_personalization_strategy(personalization_strategy_params, request_options = {})
361
377
  response = set_personalization_strategy_with_http_info(personalization_strategy_params, request_options)
362
- deserialize(response.body, request_options[:debug_return_type] || 'Personalization::SetPersonalizationStrategyResponse')
378
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Personalization::SetPersonalizationStrategyResponse')
363
379
  end
364
380
  end
365
381
  end
@@ -33,8 +33,10 @@ module Algolia
33
33
  new(config)
34
34
  end
35
35
 
36
- # Create a configuration.
37
36
  # Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
37
+ #
38
+ # Required API Key ACLs:
39
+ # - editSettings
38
40
  # @param query_suggestions_configuration_with_index [QuerySuggestionsConfigurationWithIndex] (required)
39
41
  # @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)
40
42
  # @return [Http::Response] the response
@@ -63,18 +65,20 @@ module Algolia
63
65
  @api_client.call_api(:POST, path, new_options)
64
66
  end
65
67
 
66
- # Create a configuration.
67
68
  # Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
69
+ #
70
+ # Required API Key ACLs:
71
+ # - editSettings
68
72
  # @param query_suggestions_configuration_with_index [QuerySuggestionsConfigurationWithIndex] (required)
69
73
  # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
70
74
  # @return [BaseResponse]
71
75
  def create_config(query_suggestions_configuration_with_index, request_options = {})
72
76
  response = create_config_with_http_info(query_suggestions_configuration_with_index, request_options)
73
- deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
77
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
74
78
  end
75
79
 
76
- # Send requests to the Algolia REST API.
77
80
  # This method allow you to send requests to the Algolia REST API.
81
+
78
82
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
79
83
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
80
84
  # @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)
@@ -105,19 +109,19 @@ module Algolia
105
109
  @api_client.call_api(:DELETE, path, new_options)
106
110
  end
107
111
 
108
- # Send requests to the Algolia REST API.
109
112
  # This method allow you to send requests to the Algolia REST API.
113
+
110
114
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
111
115
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
112
116
  # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
113
117
  # @return [Object]
114
118
  def custom_delete(path, parameters = nil, request_options = {})
115
119
  response = custom_delete_with_http_info(path, parameters, request_options)
116
- deserialize(response.body, request_options[:debug_return_type] || 'Object')
120
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
117
121
  end
118
122
 
119
- # Send requests to the Algolia REST API.
120
123
  # This method allow you to send requests to the Algolia REST API.
124
+
121
125
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
122
126
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
123
127
  # @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)
@@ -148,19 +152,19 @@ module Algolia
148
152
  @api_client.call_api(:GET, path, new_options)
149
153
  end
150
154
 
151
- # Send requests to the Algolia REST API.
152
155
  # This method allow you to send requests to the Algolia REST API.
156
+
153
157
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
154
158
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
155
159
  # @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)
156
160
  # @return [Object]
157
161
  def custom_get(path, parameters = nil, request_options = {})
158
162
  response = custom_get_with_http_info(path, parameters, request_options)
159
- deserialize(response.body, request_options[:debug_return_type] || 'Object')
163
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
160
164
  end
161
165
 
162
- # Send requests to the Algolia REST API.
163
166
  # This method allow you to send requests to the Algolia REST API.
167
+
164
168
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
165
169
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
166
170
  # @param body [Object] Parameters to send with the custom request.
@@ -192,8 +196,8 @@ module Algolia
192
196
  @api_client.call_api(:POST, path, new_options)
193
197
  end
194
198
 
195
- # Send requests to the Algolia REST API.
196
199
  # This method allow you to send requests to the Algolia REST API.
200
+
197
201
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
198
202
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
199
203
  # @param body [Object] Parameters to send with the custom request.
@@ -201,11 +205,11 @@ module Algolia
201
205
  # @return [Object]
202
206
  def custom_post(path, parameters = nil, body = nil, request_options = {})
203
207
  response = custom_post_with_http_info(path, parameters, body, request_options)
204
- deserialize(response.body, request_options[:debug_return_type] || 'Object')
208
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
205
209
  end
206
210
 
207
- # Send requests to the Algolia REST API.
208
211
  # This method allow you to send requests to the Algolia REST API.
212
+
209
213
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
210
214
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
211
215
  # @param body [Object] Parameters to send with the custom request.
@@ -237,8 +241,8 @@ module Algolia
237
241
  @api_client.call_api(:PUT, path, new_options)
238
242
  end
239
243
 
240
- # Send requests to the Algolia REST API.
241
244
  # This method allow you to send requests to the Algolia REST API.
245
+
242
246
  # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
243
247
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
244
248
  # @param body [Object] Parameters to send with the custom request.
@@ -246,11 +250,13 @@ module Algolia
246
250
  # @return [Object]
247
251
  def custom_put(path, parameters = nil, body = nil, request_options = {})
248
252
  response = custom_put_with_http_info(path, parameters, body, request_options)
249
- deserialize(response.body, request_options[:debug_return_type] || 'Object')
253
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
250
254
  end
251
255
 
252
- # Delete a configuration.
253
256
  # Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
257
+ #
258
+ # Required API Key ACLs:
259
+ # - editSettings
254
260
  # @param index_name [String] Query Suggestions index name. (required)
255
261
  # @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)
256
262
  # @return [Http::Response] the response
@@ -260,7 +266,7 @@ module Algolia
260
266
  raise ArgumentError, "Parameter `index_name` is required when calling `delete_config`."
261
267
  end
262
268
 
263
- path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
269
+ path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
264
270
  query_params = {}
265
271
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
266
272
  header_params = {}
@@ -279,18 +285,22 @@ module Algolia
279
285
  @api_client.call_api(:DELETE, path, new_options)
280
286
  end
281
287
 
282
- # Delete a configuration.
283
288
  # Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
289
+ #
290
+ # Required API Key ACLs:
291
+ # - editSettings
284
292
  # @param index_name [String] Query Suggestions index name. (required)
285
293
  # @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)
286
294
  # @return [BaseResponse]
287
295
  def delete_config(index_name, request_options = {})
288
296
  response = delete_config_with_http_info(index_name, request_options)
289
- deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
297
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
290
298
  end
291
299
 
292
- # List configurations.
293
300
  # List all Query Suggestions configurations of your Algolia application.
301
+ #
302
+ # Required API Key ACLs:
303
+ # - settings
294
304
  # @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)
295
305
  # @return [Http::Response] the response
296
306
  def get_all_configs_with_http_info(request_options = {})
@@ -313,17 +323,21 @@ module Algolia
313
323
  @api_client.call_api(:GET, path, new_options)
314
324
  end
315
325
 
316
- # List configurations.
317
326
  # List all Query Suggestions configurations of your Algolia application.
327
+ #
328
+ # Required API Key ACLs:
329
+ # - settings
318
330
  # @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)
319
331
  # @return [Array<QuerySuggestionsConfigurationResponse>]
320
332
  def get_all_configs(request_options = {})
321
333
  response = get_all_configs_with_http_info(request_options)
322
- deserialize(response.body, request_options[:debug_return_type] || 'Array<QuerySuggestions::QuerySuggestionsConfigurationResponse>')
334
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<QuerySuggestions::QuerySuggestionsConfigurationResponse>')
323
335
  end
324
336
 
325
- # Get a configuration.
326
337
  # Get a single Query Suggestions configuration.
338
+ #
339
+ # Required API Key ACLs:
340
+ # - settings
327
341
  # @param index_name [String] Query Suggestions index name. (required)
328
342
  # @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)
329
343
  # @return [Http::Response] the response
@@ -333,7 +347,7 @@ module Algolia
333
347
  raise ArgumentError, "Parameter `index_name` is required when calling `get_config`."
334
348
  end
335
349
 
336
- path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
350
+ path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
337
351
  query_params = {}
338
352
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
339
353
  header_params = {}
@@ -352,18 +366,22 @@ module Algolia
352
366
  @api_client.call_api(:GET, path, new_options)
353
367
  end
354
368
 
355
- # Get a configuration.
356
369
  # Get a single Query Suggestions configuration.
370
+ #
371
+ # Required API Key ACLs:
372
+ # - settings
357
373
  # @param index_name [String] Query Suggestions index name. (required)
358
374
  # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
359
375
  # @return [QuerySuggestionsConfigurationResponse]
360
376
  def get_config(index_name, request_options = {})
361
377
  response = get_config_with_http_info(index_name, request_options)
362
- deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::QuerySuggestionsConfigurationResponse')
378
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::QuerySuggestionsConfigurationResponse')
363
379
  end
364
380
 
365
- # Get configuration status.
366
381
  # Report the status of a Query Suggestions index.
382
+ #
383
+ # Required API Key ACLs:
384
+ # - settings
367
385
  # @param index_name [String] Query Suggestions index name. (required)
368
386
  # @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)
369
387
  # @return [Http::Response] the response
@@ -373,7 +391,7 @@ module Algolia
373
391
  raise ArgumentError, "Parameter `index_name` is required when calling `get_config_status`."
374
392
  end
375
393
 
376
- path = '/1/configs/{indexName}/status'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
394
+ path = '/1/configs/{indexName}/status'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
377
395
  query_params = {}
378
396
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
379
397
  header_params = {}
@@ -392,18 +410,22 @@ module Algolia
392
410
  @api_client.call_api(:GET, path, new_options)
393
411
  end
394
412
 
395
- # Get configuration status.
396
413
  # Report the status of a Query Suggestions index.
414
+ #
415
+ # Required API Key ACLs:
416
+ # - settings
397
417
  # @param index_name [String] Query Suggestions index name. (required)
398
418
  # @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)
399
419
  # @return [GetConfigStatus200Response]
400
420
  def get_config_status(index_name, request_options = {})
401
421
  response = get_config_status_with_http_info(index_name, request_options)
402
- deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetConfigStatus200Response')
422
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetConfigStatus200Response')
403
423
  end
404
424
 
405
- # Get logs.
406
425
  # Get the logs for a single Query Suggestions index.
426
+ #
427
+ # Required API Key ACLs:
428
+ # - settings
407
429
  # @param index_name [String] Query Suggestions index name. (required)
408
430
  # @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)
409
431
  # @return [Http::Response] the response
@@ -413,7 +435,7 @@ module Algolia
413
435
  raise ArgumentError, "Parameter `index_name` is required when calling `get_log_file`."
414
436
  end
415
437
 
416
- path = '/1/logs/{indexName}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
438
+ path = '/1/logs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
417
439
  query_params = {}
418
440
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
419
441
  header_params = {}
@@ -432,18 +454,22 @@ module Algolia
432
454
  @api_client.call_api(:GET, path, new_options)
433
455
  end
434
456
 
435
- # Get logs.
436
457
  # Get the logs for a single Query Suggestions index.
458
+ #
459
+ # Required API Key ACLs:
460
+ # - settings
437
461
  # @param index_name [String] Query Suggestions index name. (required)
438
462
  # @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)
439
463
  # @return [GetLogFile200Response]
440
464
  def get_log_file(index_name, request_options = {})
441
465
  response = get_log_file_with_http_info(index_name, request_options)
442
- deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetLogFile200Response')
466
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetLogFile200Response')
443
467
  end
444
468
 
445
- # Update a configuration.
446
469
  # Update a QuerySuggestions configuration.
470
+ #
471
+ # Required API Key ACLs:
472
+ # - editSettings
447
473
  # @param index_name [String] Query Suggestions index name. (required)
448
474
  # @param query_suggestions_configuration [QuerySuggestionsConfiguration] (required)
449
475
  # @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)
@@ -458,7 +484,7 @@ module Algolia
458
484
  raise ArgumentError, "Parameter `query_suggestions_configuration` is required when calling `update_config`."
459
485
  end
460
486
 
461
- path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', @api_client.encode_uri(index_name.to_s))
487
+ path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
462
488
  query_params = {}
463
489
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
464
490
  header_params = {}
@@ -477,15 +503,17 @@ module Algolia
477
503
  @api_client.call_api(:PUT, path, new_options)
478
504
  end
479
505
 
480
- # Update a configuration.
481
506
  # Update a QuerySuggestions configuration.
507
+ #
508
+ # Required API Key ACLs:
509
+ # - editSettings
482
510
  # @param index_name [String] Query Suggestions index name. (required)
483
511
  # @param query_suggestions_configuration [QuerySuggestionsConfiguration] (required)
484
512
  # @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)
485
513
  # @return [BaseResponse]
486
514
  def update_config(index_name, query_suggestions_configuration, request_options = {})
487
515
  response = update_config_with_http_info(index_name, query_suggestions_configuration, request_options)
488
- deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
516
+ @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
489
517
  end
490
518
  end
491
519
  end