algolia 3.4.0 → 3.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/Gemfile.lock +1 -1
  4. data/lib/algolia/api/analytics_client.rb +144 -32
  5. data/lib/algolia/api/search_client.rb +16 -16
  6. data/lib/algolia/models/recommend/banner.rb +218 -0
  7. data/lib/algolia/models/recommend/banner_image.rb +221 -0
  8. data/lib/algolia/models/recommend/banner_image_url.rb +212 -0
  9. data/lib/algolia/models/recommend/banner_link.rb +212 -0
  10. data/lib/algolia/models/recommend/banners.rb +209 -0
  11. data/lib/algolia/models/recommend/fallback_params.rb +8 -8
  12. data/lib/algolia/models/recommend/numeric_filters.rb +1 -1
  13. data/lib/algolia/models/recommend/recommend_search_params.rb +8 -8
  14. data/lib/algolia/models/recommend/rendering_content.rb +14 -5
  15. data/lib/algolia/models/recommend/typo_tolerance.rb +1 -1
  16. data/lib/algolia/models/recommend/widgets.rb +209 -0
  17. data/lib/algolia/models/search/api_key.rb +1 -1
  18. data/lib/algolia/models/search/banner.rb +218 -0
  19. data/lib/algolia/models/search/banner_image.rb +221 -0
  20. data/lib/algolia/models/search/banner_image_url.rb +212 -0
  21. data/lib/algolia/models/search/banner_link.rb +212 -0
  22. data/lib/algolia/models/search/banners.rb +209 -0
  23. data/lib/algolia/models/search/browse_params_object.rb +4 -4
  24. data/lib/algolia/models/search/consequence_params.rb +4 -4
  25. data/lib/algolia/models/search/delete_by_params.rb +1 -1
  26. data/lib/algolia/models/search/get_api_key_response.rb +1 -1
  27. data/lib/algolia/models/search/index_settings.rb +7 -7
  28. data/lib/algolia/models/search/numeric_filters.rb +1 -1
  29. data/lib/algolia/models/search/rendering_content.rb +14 -5
  30. data/lib/algolia/models/search/search_for_facets.rb +4 -4
  31. data/lib/algolia/models/search/search_for_hits.rb +4 -4
  32. data/lib/algolia/models/search/search_params_object.rb +4 -4
  33. data/lib/algolia/models/search/settings_response.rb +7 -7
  34. data/lib/algolia/models/search/typo_tolerance.rb +1 -1
  35. data/lib/algolia/models/search/widgets.rb +209 -0
  36. data/lib/algolia/version.rb +1 -1
  37. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a9faf3750eb1a9ce64b6901f3e112776847b50317c804adf7ccc30f76a6392bc
4
- data.tar.gz: a5c4e70c12e4530f1b61b79cfca6d5c2962c3b4ea7d45db28d07e21615a213fa
3
+ metadata.gz: e9200f03830a6a4072814ecf540ec1c2ccd1c820a1302dd12a503f263066645d
4
+ data.tar.gz: 48ec72d14a23b49eef15e99dfdf4c9a1d46d4efc25020f844abe5f672b1e3acf
5
5
  SHA512:
6
- metadata.gz: 4794af9dcf6a949e2d8c1da6cfe92098745b4cd8f271a48317347390bafc0872ce518178873b37daf11cc902b5c5e1ede033733804be141d9beafd49304b1aae
7
- data.tar.gz: 162393a051eaec3b087b1651038fd9aa296524cfc335a76cbc2cadec3affeab3f87c3846c9decd2d7cdb7473617dd1af8ac96e3be668271f3f5a549f59184815
6
+ metadata.gz: 91c0f16ed9d08c1ab4b8c8743d72f493441bdc4f1f421c35ba7b7044025fb0ac38cba7928b4660c65abe01b878307ff298431d6ca21536b9a85fd056d1ec7033
7
+ data.tar.gz: c7118984d0a3e3db25d012ecd6abbe7d4e372360c85df3bff47382476f3a12386f084dbd14424d69ce8e0b6c8f739b218e04972acf7f71d1a02c54db07efa0de
data/CHANGELOG.md CHANGED
@@ -1,3 +1,10 @@
1
+ ## [3.5.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.4.0...3.5.0)
2
+
3
+ - [ad8e3d224](https://github.com/algolia/api-clients-automation/commit/ad8e3d224) fix(specs): update analytics and abtesting max pagination query limit ([#3696](https://github.com/algolia/api-clients-automation/pull/3696)) by [@febeck](https://github.com/febeck/)
4
+ - [bed119166](https://github.com/algolia/api-clients-automation/commit/bed119166) feat(specs): add support for widgets / banners in search for the csharp client ([#3870](https://github.com/algolia/api-clients-automation/pull/3870)) by [@Kalmar99](https://github.com/Kalmar99/)
5
+ - [844e57f35](https://github.com/algolia/api-clients-automation/commit/844e57f35) fix(specs): correct typos is Search API ([#3898](https://github.com/algolia/api-clients-automation/pull/3898)) by [@gazconroy](https://github.com/gazconroy/)
6
+ - [f554e09c3](https://github.com/algolia/api-clients-automation/commit/f554e09c3) chore: revert and fix release ([#3922](https://github.com/algolia/api-clients-automation/pull/3922)) by [@millotp](https://github.com/millotp/)
7
+
1
8
  ## [3.4.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.3.4...3.4.0)
2
9
 
3
10
  - [788483537](https://github.com/algolia/api-clients-automation/commit/788483537) chore(clients): add workflow to auto-close PR ([#3834](https://github.com/algolia/api-clients-automation/pull/3834)) by [@shortcuts](https://github.com/shortcuts/)
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- algolia (3.4.0)
4
+ algolia (3.5.0)
5
5
  base64 (>= 0.2.0, < 1)
6
6
  faraday (>= 1.0.1, < 3.0)
7
7
  faraday-net_http_persistent (>= 0.15, < 3)
@@ -800,8 +800,8 @@ module Algolia
800
800
  # @param index [String] Index name. (required)
801
801
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
802
802
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
803
- # @param limit [Integer] Number of items to return. (default to 10)
804
- # @param offset [Integer] Position of the first item to return. (default to 0)
803
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
804
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
805
805
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
806
806
  # @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)
807
807
  # @return [Http::Response] the response
@@ -819,6 +819,20 @@ module Algolia
819
819
  raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_clicks`."
820
820
  end
821
821
 
822
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
823
+ raise(
824
+ ArgumentError,
825
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_searches_no_clicks, must be smaller than or equal to 1000."
826
+ )
827
+ end
828
+
829
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
830
+ raise(
831
+ ArgumentError,
832
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_clicks, must be smaller than or equal to 1000."
833
+ )
834
+ end
835
+
822
836
  if @api_client.config.client_side_validation && !offset.nil? && offset < 0
823
837
  raise(
824
838
  ArgumentError,
@@ -858,8 +872,8 @@ module Algolia
858
872
  # @param index [String] Index name. (required)
859
873
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
860
874
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
861
- # @param limit [Integer] Number of items to return. (default to 10)
862
- # @param offset [Integer] Position of the first item to return. (default to 0)
875
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
876
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
863
877
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
864
878
  # @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)
865
879
  # @return [GetSearchesNoClicksResponse]
@@ -894,8 +908,8 @@ module Algolia
894
908
  # @param index [String] Index name. (required)
895
909
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
896
910
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
897
- # @param limit [Integer] Number of items to return. (default to 10)
898
- # @param offset [Integer] Position of the first item to return. (default to 0)
911
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
912
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
899
913
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
900
914
  # @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)
901
915
  # @return [Http::Response] the response
@@ -913,6 +927,20 @@ module Algolia
913
927
  raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_results`."
914
928
  end
915
929
 
930
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
931
+ raise(
932
+ ArgumentError,
933
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_searches_no_results, must be smaller than or equal to 1000."
934
+ )
935
+ end
936
+
937
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
938
+ raise(
939
+ ArgumentError,
940
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_results, must be smaller than or equal to 1000."
941
+ )
942
+ end
943
+
916
944
  if @api_client.config.client_side_validation && !offset.nil? && offset < 0
917
945
  raise(
918
946
  ArgumentError,
@@ -952,8 +980,8 @@ module Algolia
952
980
  # @param index [String] Index name. (required)
953
981
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
954
982
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
955
- # @param limit [Integer] Number of items to return. (default to 10)
956
- # @param offset [Integer] Position of the first item to return. (default to 0)
983
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
984
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
957
985
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
958
986
  # @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)
959
987
  # @return [GetSearchesNoResultsResponse]
@@ -1033,8 +1061,8 @@ module Algolia
1033
1061
  # @param index [String] Index name. (required)
1034
1062
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1035
1063
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1036
- # @param limit [Integer] Number of items to return. (default to 10)
1037
- # @param offset [Integer] Position of the first item to return. (default to 0)
1064
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1065
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1038
1066
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1039
1067
  # @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)
1040
1068
  # @return [Http::Response] the response
@@ -1052,6 +1080,20 @@ module Algolia
1052
1080
  raise ArgumentError, "Parameter `index` is required when calling `get_top_countries`."
1053
1081
  end
1054
1082
 
1083
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1084
+ raise(
1085
+ ArgumentError,
1086
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_countries, must be smaller than or equal to 1000."
1087
+ )
1088
+ end
1089
+
1090
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1091
+ raise(
1092
+ ArgumentError,
1093
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_countries, must be smaller than or equal to 1000."
1094
+ )
1095
+ end
1096
+
1055
1097
  if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1056
1098
  raise(
1057
1099
  ArgumentError,
@@ -1091,8 +1133,8 @@ module Algolia
1091
1133
  # @param index [String] Index name. (required)
1092
1134
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1093
1135
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1094
- # @param limit [Integer] Number of items to return. (default to 10)
1095
- # @param offset [Integer] Position of the first item to return. (default to 0)
1136
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1137
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1096
1138
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1097
1139
  # @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)
1098
1140
  # @return [GetTopCountriesResponse]
@@ -1120,8 +1162,8 @@ module Algolia
1120
1162
  # @param search [String] Search query.
1121
1163
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1122
1164
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1123
- # @param limit [Integer] Number of items to return. (default to 10)
1124
- # @param offset [Integer] Position of the first item to return. (default to 0)
1165
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1166
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1125
1167
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1126
1168
  # @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)
1127
1169
  # @return [Http::Response] the response
@@ -1140,6 +1182,20 @@ module Algolia
1140
1182
  raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_attributes`."
1141
1183
  end
1142
1184
 
1185
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1186
+ raise(
1187
+ ArgumentError,
1188
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filter_attributes, must be smaller than or equal to 1000."
1189
+ )
1190
+ end
1191
+
1192
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1193
+ raise(
1194
+ ArgumentError,
1195
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_attributes, must be smaller than or equal to 1000."
1196
+ )
1197
+ end
1198
+
1143
1199
  if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1144
1200
  raise(
1145
1201
  ArgumentError,
@@ -1181,8 +1237,8 @@ module Algolia
1181
1237
  # @param search [String] Search query.
1182
1238
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1183
1239
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1184
- # @param limit [Integer] Number of items to return. (default to 10)
1185
- # @param offset [Integer] Position of the first item to return. (default to 0)
1240
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1241
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1186
1242
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1187
1243
  # @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)
1188
1244
  # @return [GetTopFilterAttributesResponse]
@@ -1221,8 +1277,8 @@ module Algolia
1221
1277
  # @param search [String] Search query.
1222
1278
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1223
1279
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1224
- # @param limit [Integer] Number of items to return. (default to 10)
1225
- # @param offset [Integer] Position of the first item to return. (default to 0)
1280
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1281
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1226
1282
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1227
1283
  # @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)
1228
1284
  # @return [Http::Response] the response
@@ -1246,6 +1302,20 @@ module Algolia
1246
1302
  raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_for_attribute`."
1247
1303
  end
1248
1304
 
1305
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1306
+ raise(
1307
+ ArgumentError,
1308
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be smaller than or equal to 1000."
1309
+ )
1310
+ end
1311
+
1312
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1313
+ raise(
1314
+ ArgumentError,
1315
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be smaller than or equal to 1000."
1316
+ )
1317
+ end
1318
+
1249
1319
  if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1250
1320
  raise(
1251
1321
  ArgumentError,
@@ -1288,8 +1358,8 @@ module Algolia
1288
1358
  # @param search [String] Search query.
1289
1359
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1290
1360
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1291
- # @param limit [Integer] Number of items to return. (default to 10)
1292
- # @param offset [Integer] Position of the first item to return. (default to 0)
1361
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1362
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1293
1363
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1294
1364
  # @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)
1295
1365
  # @return [GetTopFilterForAttributeResponse]
@@ -1329,8 +1399,8 @@ module Algolia
1329
1399
  # @param search [String] Search query.
1330
1400
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1331
1401
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1332
- # @param limit [Integer] Number of items to return. (default to 10)
1333
- # @param offset [Integer] Position of the first item to return. (default to 0)
1402
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1403
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1334
1404
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1335
1405
  # @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)
1336
1406
  # @return [Http::Response] the response
@@ -1349,6 +1419,20 @@ module Algolia
1349
1419
  raise ArgumentError, "Parameter `index` is required when calling `get_top_filters_no_results`."
1350
1420
  end
1351
1421
 
1422
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1423
+ raise(
1424
+ ArgumentError,
1425
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filters_no_results, must be smaller than or equal to 1000."
1426
+ )
1427
+ end
1428
+
1429
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1430
+ raise(
1431
+ ArgumentError,
1432
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filters_no_results, must be smaller than or equal to 1000."
1433
+ )
1434
+ end
1435
+
1352
1436
  if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1353
1437
  raise(
1354
1438
  ArgumentError,
@@ -1390,8 +1474,8 @@ module Algolia
1390
1474
  # @param search [String] Search query.
1391
1475
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1392
1476
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1393
- # @param limit [Integer] Number of items to return. (default to 10)
1394
- # @param offset [Integer] Position of the first item to return. (default to 0)
1477
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1478
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1395
1479
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1396
1480
  # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
1397
1481
  # @return [GetTopFiltersNoResultsResponse]
@@ -1431,8 +1515,8 @@ module Algolia
1431
1515
  # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false)
1432
1516
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1433
1517
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1434
- # @param limit [Integer] Number of items to return. (default to 10)
1435
- # @param offset [Integer] Position of the first item to return. (default to 0)
1518
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1519
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1436
1520
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1437
1521
  # @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)
1438
1522
  # @return [Http::Response] the response
@@ -1453,6 +1537,20 @@ module Algolia
1453
1537
  raise ArgumentError, "Parameter `index` is required when calling `get_top_hits`."
1454
1538
  end
1455
1539
 
1540
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1541
+ raise(
1542
+ ArgumentError,
1543
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_hits, must be smaller than or equal to 1000."
1544
+ )
1545
+ end
1546
+
1547
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1548
+ raise(
1549
+ ArgumentError,
1550
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_hits, must be smaller than or equal to 1000."
1551
+ )
1552
+ end
1553
+
1456
1554
  if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1457
1555
  raise(
1458
1556
  ArgumentError,
@@ -1498,8 +1596,8 @@ module Algolia
1498
1596
  # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false)
1499
1597
  # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1500
1598
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1501
- # @param limit [Integer] Number of items to return. (default to 10)
1502
- # @param offset [Integer] Position of the first item to return. (default to 0)
1599
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1600
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1503
1601
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1504
1602
  # @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)
1505
1603
  # @return [GetTopHitsResponse]
@@ -1541,8 +1639,8 @@ module Algolia
1541
1639
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1542
1640
  # @param order_by [OrderBy] Attribute by which to order the response items. If the &#x60;clickAnalytics&#x60; parameter is false, only &#x60;searchCount&#x60; is available. (default to 'searchCount')
1543
1641
  # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc')
1544
- # @param limit [Integer] Number of items to return. (default to 10)
1545
- # @param offset [Integer] Position of the first item to return. (default to 0)
1642
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1643
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1546
1644
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1547
1645
  # @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)
1548
1646
  # @return [Http::Response] the response
@@ -1564,6 +1662,20 @@ module Algolia
1564
1662
  raise ArgumentError, "Parameter `index` is required when calling `get_top_searches`."
1565
1663
  end
1566
1664
 
1665
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1666
+ raise(
1667
+ ArgumentError,
1668
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_searches, must be smaller than or equal to 1000."
1669
+ )
1670
+ end
1671
+
1672
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1673
+ raise(
1674
+ ArgumentError,
1675
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_searches, must be smaller than or equal to 1000."
1676
+ )
1677
+ end
1678
+
1567
1679
  if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1568
1680
  raise(
1569
1681
  ArgumentError,
@@ -1611,8 +1723,8 @@ module Algolia
1611
1723
  # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1612
1724
  # @param order_by [OrderBy] Attribute by which to order the response items. If the &#x60;clickAnalytics&#x60; parameter is false, only &#x60;searchCount&#x60; is available. (default to 'searchCount')
1613
1725
  # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc')
1614
- # @param limit [Integer] Number of items to return. (default to 10)
1615
- # @param offset [Integer] Position of the first item to return. (default to 0)
1726
+ # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1727
+ # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1616
1728
  # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1617
1729
  # @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)
1618
1730
  # @return [GetTopSearchesResponse]
@@ -93,7 +93,7 @@ module Algolia
93
93
  # - addObject
94
94
  # @param index_name [String] Name of the index on which to perform the operation. (required)
95
95
  # @param object_id [String] Unique record identifier. (required)
96
- # @param body [Object] The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)
96
+ # @param body [Object] The record. A schemaless object with attributes that are useful in the context of search and discovery. (required)
97
97
  # @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)
98
98
  # @return [Http::Response] the response
99
99
  def add_or_update_object_with_http_info(index_name, object_id, body, request_options = {})
@@ -138,7 +138,7 @@ module Algolia
138
138
  # - addObject
139
139
  # @param index_name [String] Name of the index on which to perform the operation. (required)
140
140
  # @param object_id [String] Unique record identifier. (required)
141
- # @param body [Object] The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)
141
+ # @param body [Object] The record. A schemaless object with attributes that are useful in the context of search and discovery. (required)
142
142
  # @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)
143
143
  # @return [UpdatedAtWithObjectIdResponse]
144
144
  def add_or_update_object(index_name, object_id, body, request_options = {})
@@ -422,7 +422,7 @@ module Algolia
422
422
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
423
423
  end
424
424
 
425
- # Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn&#39;t collect data when using &#x60;browse&#x60;. - Records are ranked by attributes and custom ranking. - There&#39;s no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - &#x60;advancedSyntax&#x60;: &#x60;false&#x60; - &#x60;attributesToHighlight&#x60;: &#x60;[]&#x60; - &#x60;attributesToSnippet&#x60;: &#x60;[]&#x60; - &#x60;distinct&#x60;: &#x60;false&#x60; - &#x60;enablePersonalization&#x60;: &#x60;false&#x60; - &#x60;enableRules&#x60;: &#x60;false&#x60; - &#x60;facets&#x60;: &#x60;[]&#x60; - &#x60;getRankingInfo&#x60;: &#x60;false&#x60; - &#x60;ignorePlurals&#x60;: &#x60;false&#x60; - &#x60;optionalFilters&#x60;: &#x60;[]&#x60; - &#x60;typoTolerance&#x60;: &#x60;true&#x60; or &#x60;false&#x60; (&#x60;min&#x60; and &#x60;strict&#x60; is evaluated to &#x60;true&#x60;) If you send these parameters with your browse requests, they&#39;ll be ignored.
425
+ # Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn&#39;t collect data when using &#x60;browse&#x60;. - Records are ranked by attributes and custom ranking. - There&#39;s no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - &#x60;advancedSyntax&#x60;: &#x60;false&#x60; - &#x60;attributesToHighlight&#x60;: &#x60;[]&#x60; - &#x60;attributesToSnippet&#x60;: &#x60;[]&#x60; - &#x60;distinct&#x60;: &#x60;false&#x60; - &#x60;enablePersonalization&#x60;: &#x60;false&#x60; - &#x60;enableRules&#x60;: &#x60;false&#x60; - &#x60;facets&#x60;: &#x60;[]&#x60; - &#x60;getRankingInfo&#x60;: &#x60;false&#x60; - &#x60;ignorePlurals&#x60;: &#x60;false&#x60; - &#x60;optionalFilters&#x60;: &#x60;[]&#x60; - &#x60;typoTolerance&#x60;: &#x60;true&#x60; or &#x60;false&#x60; (&#x60;min&#x60; and &#x60;strict&#x60; evaluate to &#x60;true&#x60;) If you send these parameters with your browse requests, they&#39;ll be ignored.
426
426
  #
427
427
  # Required API Key ACLs:
428
428
  # - browse
@@ -455,7 +455,7 @@ module Algolia
455
455
  @api_client.call_api(:POST, path, new_options)
456
456
  end
457
457
 
458
- # Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`) If you send these parameters with your browse requests, they'll be ignored.
458
+ # Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse requests, they'll be ignored.
459
459
  #
460
460
  # Required API Key ACLs:
461
461
  # - browse
@@ -1580,7 +1580,7 @@ module Algolia
1580
1580
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array<Search::Source>")
1581
1581
  end
1582
1582
 
1583
- # Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [&#x60;search&#x60; operation](#tag/Synonyms/operation/searchSynonyms).
1583
+ # Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [&#x60;search&#x60; operation](#tag/Synonyms/operation/searchSynonyms).
1584
1584
  #
1585
1585
  # Required API Key ACLs:
1586
1586
  # - settings
@@ -1619,7 +1619,7 @@ module Algolia
1619
1619
  @api_client.call_api(:GET, path, new_options)
1620
1620
  end
1621
1621
 
1622
- # Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
1622
+ # Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
1623
1623
  #
1624
1624
  # Required API Key ACLs:
1625
1625
  # - settings
@@ -2030,7 +2030,7 @@ module Algolia
2030
2030
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::MultipleBatchResponse")
2031
2031
  end
2032
2032
 
2033
- # Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn&#39;t exist yet, it&#39;ll be created. **Copy** - Copying a source index that doesn&#39;t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can&#39;t copy the &#x60;enableReRanking&#x60;, &#x60;mode&#x60;, and &#x60;replicas&#x60; settings. - You can&#39;t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn&#39;t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
2033
+ # Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn&#39;t exist yet, it&#39;ll be created. **Copy** - Copying a source index that doesn&#39;t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can&#39;t copy the &#x60;enableReRanking&#x60;, &#x60;mode&#x60;, and &#x60;replicas&#x60; settings. - You can&#39;t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn&#39;t exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
2034
2034
  #
2035
2035
  # Required API Key ACLs:
2036
2036
  # - addObject
@@ -2067,7 +2067,7 @@ module Algolia
2067
2067
  @api_client.call_api(:POST, path, new_options)
2068
2068
  end
2069
2069
 
2070
- # Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
2070
+ # Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
2071
2071
  #
2072
2072
  # Required API Key ACLs:
2073
2073
  # - addObject
@@ -2080,7 +2080,7 @@ module Algolia
2080
2080
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
2081
2081
  end
2082
2082
 
2083
- # Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn&#39;t exist, a new record is added to the index **if** &#x60;createIfNotExists&#x60; is true. - If the index doesn&#39;t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don&#39;t have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it&#39;s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn&#39;t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn&#39;t exist yet, the engine only creates it if you pass an IncrementSet value that&#39;s greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
2083
+ # Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn&#39;t exist, a new record is added to the index **if** &#x60;createIfNotExists&#x60; is true. - If the index doesn&#39;t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don&#39;t have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it&#39;s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn&#39;t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn&#39;t exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
2084
2084
  #
2085
2085
  # Required API Key ACLs:
2086
2086
  # - addObject
@@ -2132,7 +2132,7 @@ module Algolia
2132
2132
  @api_client.call_api(:POST, path, new_options)
2133
2133
  end
2134
2134
 
2135
- # Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value that's greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
2135
+ # Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
2136
2136
  #
2137
2137
  # Required API Key ACLs:
2138
2138
  # - addObject
@@ -2307,7 +2307,7 @@ module Algolia
2307
2307
  # Required API Key ACLs:
2308
2308
  # - addObject
2309
2309
  # @param index_name [String] Name of the index on which to perform the operation. (required)
2310
- # @param body [Object] The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)
2310
+ # @param body [Object] The record. A schemaless object with attributes that are useful in the context of search and discovery. (required)
2311
2311
  # @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)
2312
2312
  # @return [Http::Response] the response
2313
2313
  def save_object_with_http_info(index_name, body, request_options = {})
@@ -2344,7 +2344,7 @@ module Algolia
2344
2344
  # Required API Key ACLs:
2345
2345
  # - addObject
2346
2346
  # @param index_name [String] Name of the index on which to perform the operation. (required)
2347
- # @param body [Object] The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)
2347
+ # @param body [Object] The record. A schemaless object with attributes that are useful in the context of search and discovery. (required)
2348
2348
  # @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)
2349
2349
  # @return [SaveObjectResponse]
2350
2350
  def save_object(index_name, body, request_options = {})
@@ -2616,7 +2616,7 @@ module Algolia
2616
2616
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
2617
2617
  end
2618
2618
 
2619
- # Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
2619
+ # Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
2620
2620
  #
2621
2621
  # Required API Key ACLs:
2622
2622
  # - search
@@ -2648,7 +2648,7 @@ module Algolia
2648
2648
  @api_client.call_api(:POST, path, new_options)
2649
2649
  end
2650
2650
 
2651
- # Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
2651
+ # Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
2652
2652
  #
2653
2653
  # Required API Key ACLs:
2654
2654
  # - search
@@ -2840,7 +2840,7 @@ module Algolia
2840
2840
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchRulesResponse")
2841
2841
  end
2842
2842
 
2843
- # Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [&#x60;browse&#x60; operation](#tag/Search/operation/browse) or increase the &#x60;paginatedLimitedTo&#x60; index setting.
2843
+ # Searches a single index and returns matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [&#x60;browse&#x60; operation](#tag/Search/operation/browse) or increase the &#x60;paginatedLimitedTo&#x60; index setting.
2844
2844
  #
2845
2845
  # Required API Key ACLs:
2846
2846
  # - search
@@ -2873,7 +2873,7 @@ module Algolia
2873
2873
  @api_client.call_api(:POST, path, new_options)
2874
2874
  end
2875
2875
 
2876
- # Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
2876
+ # Searches a single index and returns matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
2877
2877
  #
2878
2878
  # Required API Key ACLs:
2879
2879
  # - search