algolia 3.5.1 → 3.5.2

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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/Gemfile.lock +1 -1
  4. data/lib/algolia/api/abtesting_client.rb +17 -9
  5. data/lib/algolia/api/analytics_client.rb +173 -165
  6. data/lib/algolia/api/ingestion_client.rb +38 -30
  7. data/lib/algolia/api/insights_client.rb +18 -10
  8. data/lib/algolia/api/monitoring_client.rb +22 -14
  9. data/lib/algolia/api/personalization_client.rb +16 -8
  10. data/lib/algolia/api/query_suggestions_client.rb +17 -9
  11. data/lib/algolia/api/recommend_client.rb +17 -9
  12. data/lib/algolia/api/search_client.rb +60 -52
  13. data/lib/algolia/configuration.rb +16 -1
  14. data/lib/algolia/models/abtesting/ab_test_configuration.rb +0 -2
  15. data/lib/algolia/models/abtesting/variant.rb +0 -2
  16. data/lib/algolia/models/ingestion/event.rb +1 -11
  17. data/lib/algolia/models/recommend/fallback_params.rb +3 -3
  18. data/lib/algolia/models/recommend/recommend_hit.rb +0 -2
  19. data/lib/algolia/models/recommend/recommend_search_params.rb +3 -3
  20. data/lib/algolia/models/recommend/recommendations_results.rb +13 -0
  21. data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -2
  22. data/lib/algolia/models/recommend/trending_facet_hit.rb +0 -2
  23. data/lib/algolia/models/search/browse_params_object.rb +1 -1
  24. data/lib/algolia/models/search/browse_response.rb +13 -0
  25. data/lib/algolia/models/search/consequence_params.rb +1 -1
  26. data/lib/algolia/models/search/get_api_key_response.rb +2 -0
  27. data/lib/algolia/models/search/get_objects_response.rb +0 -2
  28. data/lib/algolia/models/search/index_settings.rb +3 -3
  29. data/lib/algolia/models/search/search_dictionary_entries_response.rb +1 -1
  30. data/lib/algolia/models/search/search_for_facets.rb +1 -1
  31. data/lib/algolia/models/search/search_for_hits.rb +1 -1
  32. data/lib/algolia/models/search/search_params_object.rb +1 -1
  33. data/lib/algolia/models/search/search_response.rb +13 -0
  34. data/lib/algolia/models/search/search_rules_params.rb +2 -2
  35. data/lib/algolia/models/search/search_user_ids_response.rb +1 -1
  36. data/lib/algolia/models/search/settings_response.rb +3 -3
  37. data/lib/algolia/user_agent.rb +8 -2
  38. data/lib/algolia/version.rb +1 -1
  39. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5951dab150232853689a45534049c7ffb99d79971aeda7169a3578350cf42260
4
- data.tar.gz: 3a3fe188b233e96b31396909ff99a5a5aa2168c43e7129a5655e0775cb26ea0a
3
+ metadata.gz: 84a0ee67eb820ef65c0a92aa71b5dc4d0c70c7522496f0dc5a9e0a1cccc0bb0b
4
+ data.tar.gz: 609c3231f74e5a113affbed7cb4377c35ddea0d6dbcf45f9634dcfdab4151733
5
5
  SHA512:
6
- metadata.gz: 79075e4e73c306652e3d2dcc108f4fbd02a23db702389c5e759f3253be9cf8f64f30e6eb1a5b463d48f42d46ece034b5d457393419b915a26d6bdbf530072b5e
7
- data.tar.gz: d1c426190bb2317252e66596de800475e21faac2d030c1dbfe457f4cb23df52cb6960f09eeef309636889f59ef0f086c4ce3ae510f15d18796c46058db1c9f58
6
+ metadata.gz: d7a02c43e9dbddc8f1e8cad80e5437977ba777c36d2f4e6ae91861ee75e212615a9c408fd4f1a5e549394e6421f515207de2feb092ca390111a6d1186f016a06
7
+ data.tar.gz: f4b505358a57ec09aa27a65140f9da14d1e043bf43ae9f3dd5e28e324fdcc5a1fb724efe5757648853f93becc44a273cfed19c25be8d08b731a4abbb7ad1a5d8
data/CHANGELOG.md CHANGED
@@ -1,3 +1,13 @@
1
+ ## [3.5.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.1...3.5.2)
2
+
3
+ - [cd98290fa](https://github.com/algolia/api-clients-automation/commit/cd98290fa) fix(specs): Typo tolernace on words ([#3968](https://github.com/algolia/api-clients-automation/pull/3968)) by [@gazconroy](https://github.com/gazconroy/)
4
+ - [5866c2954](https://github.com/algolia/api-clients-automation/commit/5866c2954) fix(specs): Add context to hitsPerPage ([#3969](https://github.com/algolia/api-clients-automation/pull/3969)) by [@gazconroy](https://github.com/gazconroy/)
5
+ - [9e73e971c](https://github.com/algolia/api-clients-automation/commit/9e73e971c) fix(ruby): add helper to add segment to user agent ([#3972](https://github.com/algolia/api-clients-automation/pull/3972)) by [@millotp](https://github.com/millotp/)
6
+ - [162dfafa1](https://github.com/algolia/api-clients-automation/commit/162dfafa1) fix(clients): escape char in comments ([#3973](https://github.com/algolia/api-clients-automation/pull/3973)) by [@millotp](https://github.com/millotp/)
7
+ - [8b879dead](https://github.com/algolia/api-clients-automation/commit/8b879dead) fix(specs): alternativesAsExact is plurals and synonyms ([#3974](https://github.com/algolia/api-clients-automation/pull/3974)) by [@gazconroy](https://github.com/gazconroy/)
8
+ - [1a9b95e85](https://github.com/algolia/api-clients-automation/commit/1a9b95e85) fix(specs): Separators are non-alphanumeric characters ([#3978](https://github.com/algolia/api-clients-automation/pull/3978)) by [@gazconroy](https://github.com/gazconroy/)
9
+ - [519fd9840](https://github.com/algolia/api-clients-automation/commit/519fd9840) fix(specs): multiple clients fixes ([#3971](https://github.com/algolia/api-clients-automation/pull/3971)) by [@shortcuts](https://github.com/shortcuts/)
10
+
1
11
  ## [3.5.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.0...3.5.1)
2
12
 
3
13
  - [8b343d2ee](https://github.com/algolia/api-clients-automation/commit/8b343d2ee) fix(ruby): only prefix model by client:: ([#3923](https://github.com/algolia/api-clients-automation/pull/3923)) by [@millotp](https://github.com/millotp/)
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- algolia (3.5.1)
4
+ algolia (3.5.2)
5
5
  base64 (>= 0.2.0, < 1)
6
6
  faraday (>= 1.0.1, < 3.0)
7
7
  faraday-net_http_persistent (>= 0.15, < 3)
@@ -45,6 +45,14 @@ module Algolia
45
45
  # @return [void]
46
46
  def set_client_api_key(api_key)
47
47
  @api_client.set_client_api_key(api_key)
48
+
49
+ self
50
+ end
51
+
52
+ def add_user_agent_segment(segment, version = nil)
53
+ @api_client.config.add_user_agent_segment(segment, version)
54
+
55
+ self
48
56
  end
49
57
 
50
58
  # Creates a new A/B test.
@@ -93,7 +101,7 @@ module Algolia
93
101
 
94
102
  # This method allow you to send requests to the Algolia REST API.
95
103
 
96
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
104
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
97
105
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
98
106
  # @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)
99
107
  # @return [Http::Response] the response
@@ -125,7 +133,7 @@ module Algolia
125
133
 
126
134
  # This method allow you to send requests to the Algolia REST API.
127
135
 
128
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
136
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
129
137
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
130
138
  # @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)
131
139
  # @return [Object]
@@ -136,7 +144,7 @@ module Algolia
136
144
 
137
145
  # This method allow you to send requests to the Algolia REST API.
138
146
 
139
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
147
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
140
148
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
141
149
  # @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)
142
150
  # @return [Http::Response] the response
@@ -168,7 +176,7 @@ module Algolia
168
176
 
169
177
  # This method allow you to send requests to the Algolia REST API.
170
178
 
171
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
179
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
172
180
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
173
181
  # @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)
174
182
  # @return [Object]
@@ -179,7 +187,7 @@ module Algolia
179
187
 
180
188
  # This method allow you to send requests to the Algolia REST API.
181
189
 
182
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
190
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
183
191
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
184
192
  # @param body [Object] Parameters to send with the custom request.
185
193
  # @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)
@@ -212,7 +220,7 @@ module Algolia
212
220
 
213
221
  # This method allow you to send requests to the Algolia REST API.
214
222
 
215
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
223
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
216
224
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
217
225
  # @param body [Object] Parameters to send with the custom request.
218
226
  # @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)
@@ -224,7 +232,7 @@ module Algolia
224
232
 
225
233
  # This method allow you to send requests to the Algolia REST API.
226
234
 
227
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
235
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
228
236
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
229
237
  # @param body [Object] Parameters to send with the custom request.
230
238
  # @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)
@@ -257,7 +265,7 @@ module Algolia
257
265
 
258
266
  # This method allow you to send requests to the Algolia REST API.
259
267
 
260
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
268
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
261
269
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
262
270
  # @param body [Object] Parameters to send with the custom request.
263
271
  # @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)
@@ -454,7 +462,7 @@ module Algolia
454
462
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ScheduleABTestResponse")
455
463
  end
456
464
 
457
- # Stops an A/B test by its ID. You can&#39;t restart stopped A/B tests.
465
+ # Stops an A/B test by its ID. You can't restart stopped A/B tests.
458
466
  #
459
467
  # Required API Key ACLs:
460
468
  # - editSettings