algolia 3.4.0 → 3.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/Gemfile.lock +1 -1
- data/lib/algolia/api/abtesting_client.rb +0 -7
- data/lib/algolia/api/analytics_client.rb +32 -88
- data/lib/algolia/api/ingestion_client.rb +2 -170
- data/lib/algolia/api/insights_client.rb +0 -22
- data/lib/algolia/api/monitoring_client.rb +11 -11
- data/lib/algolia/api/search_client.rb +19 -74
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +0 -18
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +0 -18
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +0 -18
- data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +0 -18
- data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +0 -18
- data/lib/algolia/models/abtesting/variant.rb +0 -18
- data/lib/algolia/models/analytics/click_position.rb +0 -32
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +0 -28
- data/lib/algolia/models/analytics/daily_average_clicks.rb +0 -24
- data/lib/algolia/models/analytics/daily_click_through_rates.rb +0 -28
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +0 -28
- data/lib/algolia/models/analytics/daily_no_click_rates.rb +0 -32
- data/lib/algolia/models/analytics/daily_no_results_rates.rb +0 -18
- data/lib/algolia/models/analytics/daily_purchase_rates.rb +0 -14
- data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +0 -14
- data/lib/algolia/models/analytics/daily_searches_no_results.rb +0 -14
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +0 -28
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +0 -24
- data/lib/algolia/models/analytics/get_click_positions_response.rb +0 -18
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +0 -28
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +0 -28
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +0 -32
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +0 -18
- data/lib/algolia/models/analytics/get_purchase_rate_response.rb +0 -14
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +0 -56
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +0 -98
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +0 -90
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +0 -132
- data/lib/algolia/models/ingestion/event.rb +0 -14
- data/lib/algolia/models/ingestion/pagination.rb +0 -60
- data/lib/algolia/models/ingestion/run.rb +0 -18
- data/lib/algolia/models/ingestion/source_csv.rb +0 -21
- data/lib/algolia/models/ingestion/task.rb +0 -18
- data/lib/algolia/models/ingestion/task_create.rb +0 -18
- data/lib/algolia/models/ingestion/task_create_v1.rb +0 -18
- data/lib/algolia/models/ingestion/task_update.rb +0 -18
- data/lib/algolia/models/ingestion/task_update_v1.rb +0 -18
- data/lib/algolia/models/ingestion/task_v1.rb +0 -18
- data/lib/algolia/models/ingestion/transformation.rb +1 -1
- data/lib/algolia/models/ingestion/transformation_create.rb +1 -1
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +0 -123
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +0 -149
- data/lib/algolia/models/insights/clicked_filters.rb +0 -105
- data/lib/algolia/models/insights/clicked_object_ids.rb +0 -105
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +0 -149
- data/lib/algolia/models/insights/converted_filters.rb +0 -105
- data/lib/algolia/models/insights/converted_object_ids.rb +0 -105
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +0 -131
- data/lib/algolia/models/insights/insights_events.rb +0 -18
- data/lib/algolia/models/insights/object_data_after_search.rb +0 -26
- data/lib/algolia/models/insights/purchased_object_ids.rb +0 -123
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +0 -123
- data/lib/algolia/models/insights/viewed_filters.rb +0 -105
- data/lib/algolia/models/insights/viewed_object_ids.rb +0 -105
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +0 -18
- data/lib/algolia/models/query-suggestions/configuration.rb +0 -17
- data/lib/algolia/models/query-suggestions/configuration_response.rb +0 -17
- data/lib/algolia/models/query-suggestions/configuration_with_index.rb +0 -17
- data/lib/algolia/models/query-suggestions/source_index.rb +0 -28
- data/lib/algolia/models/recommend/banner.rb +218 -0
- data/lib/algolia/models/{query-suggestions/base_query_suggestions_configuration_response.rb → recommend/banner_image.rb} +31 -38
- data/lib/algolia/models/{query-suggestions/base_query_suggestions_configuration_with_index.rb → recommend/banner_image_url.rb} +23 -23
- data/lib/algolia/models/{query-suggestions/get_config_status200_response.rb → recommend/banner_link.rb} +13 -53
- data/lib/algolia/models/recommend/bought_together_query.rb +0 -36
- data/lib/algolia/models/recommend/condition.rb +0 -15
- data/lib/algolia/models/recommend/consequence.rb +0 -28
- data/lib/algolia/models/recommend/fallback_params.rb +8 -100
- data/lib/algolia/models/recommend/looking_similar_query.rb +0 -36
- data/lib/algolia/models/recommend/numeric_filters.rb +1 -1
- data/lib/algolia/models/recommend/promote_consequence_object.rb +0 -14
- data/lib/algolia/models/recommend/ranking_info.rb +0 -112
- data/lib/algolia/models/recommend/recommend_hit.rb +0 -18
- data/lib/algolia/models/recommend/recommend_search_params.rb +8 -100
- data/lib/algolia/models/recommend/recommendations_results.rb +0 -61
- data/lib/algolia/models/recommend/recommended_for_you_query.rb +0 -36
- data/lib/algolia/models/recommend/related_query.rb +0 -36
- data/lib/algolia/models/recommend/rendering_content.rb +14 -5
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +0 -50
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +0 -14
- data/lib/algolia/models/recommend/trending_facet_hit.rb +0 -18
- data/lib/algolia/models/recommend/trending_facets_query.rb +0 -36
- data/lib/algolia/models/recommend/trending_items_query.rb +0 -36
- data/lib/algolia/models/recommend/typo_tolerance.rb +1 -1
- data/lib/algolia/models/recommend/widgets.rb +212 -0
- data/lib/algolia/models/search/api_key.rb +1 -1
- data/lib/algolia/models/search/banner.rb +218 -0
- data/lib/algolia/models/{query-suggestions/get_log_file200_response.rb → search/banner_image.rb} +21 -61
- data/lib/algolia/models/search/banner_image_url.rb +212 -0
- data/lib/algolia/models/search/banner_link.rb +212 -0
- data/lib/algolia/models/search/browse_params_object.rb +4 -132
- data/lib/algolia/models/search/browse_response.rb +0 -61
- data/lib/algolia/models/search/condition.rb +0 -15
- data/lib/algolia/models/search/consequence.rb +0 -28
- data/lib/algolia/models/search/consequence_params.rb +4 -132
- data/lib/algolia/models/search/delete_by_params.rb +1 -1
- data/lib/algolia/models/search/get_api_key_response.rb +1 -1
- data/lib/algolia/models/search/index_settings.rb +7 -85
- data/lib/algolia/models/search/log.rb +0 -34
- data/lib/algolia/models/search/numeric_filters.rb +1 -1
- data/lib/algolia/models/search/promote_object_ids.rb +0 -14
- data/lib/algolia/models/search/ranking_info.rb +0 -112
- data/lib/algolia/models/search/rendering_content.rb +14 -5
- data/lib/algolia/models/search/rule.rb +0 -18
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +0 -32
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +0 -14
- data/lib/algolia/models/search/search_for_facet_values_request.rb +0 -14
- data/lib/algolia/models/search/search_for_facets.rb +4 -132
- data/lib/algolia/models/search/search_for_hits.rb +4 -132
- data/lib/algolia/models/search/search_params_object.rb +4 -132
- data/lib/algolia/models/search/search_response.rb +0 -61
- data/lib/algolia/models/search/search_rules_params.rb +0 -32
- data/lib/algolia/models/search/search_synonyms_params.rb +0 -32
- data/lib/algolia/models/search/search_user_ids_params.rb +0 -32
- data/lib/algolia/models/search/search_user_ids_response.rb +0 -32
- data/lib/algolia/models/search/settings_response.rb +7 -85
- data/lib/algolia/models/search/typo_tolerance.rb +1 -1
- data/lib/algolia/models/search/user_hit.rb +0 -15
- data/lib/algolia/models/search/user_id.rb +0 -15
- data/lib/algolia/models/search/widgets.rb +212 -0
- data/lib/algolia/version.rb +1 -1
- metadata +12 -9
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +0 -276
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +0 -316
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +0 -295
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5951dab150232853689a45534049c7ffb99d79971aeda7169a3578350cf42260
|
|
4
|
+
data.tar.gz: 3a3fe188b233e96b31396909ff99a5a5aa2168c43e7129a5655e0775cb26ea0a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 79075e4e73c306652e3d2dcc108f4fbd02a23db702389c5e759f3253be9cf8f64f30e6eb1a5b463d48f42d46ece034b5d457393419b915a26d6bdbf530072b5e
|
|
7
|
+
data.tar.gz: d1c426190bb2317252e66596de800475e21faac2d030c1dbfe457f4cb23df52cb6960f09eeef309636889f59ef0f086c4ce3ae510f15d18796c46058db1c9f58
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
## [3.5.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.0...3.5.1)
|
|
2
|
+
|
|
3
|
+
- [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/)
|
|
4
|
+
- [f516d0243](https://github.com/algolia/api-clients-automation/commit/f516d0243) fix(specs): Typos in API descriptions ([#3932](https://github.com/algolia/api-clients-automation/pull/3932)) by [@gazconroy](https://github.com/gazconroy/)
|
|
5
|
+
- [ee6c043ef](https://github.com/algolia/api-clients-automation/commit/ee6c043ef) fix(clients): remove all client side validation expect null check ([#3936](https://github.com/algolia/api-clients-automation/pull/3936)) by [@millotp](https://github.com/millotp/)
|
|
6
|
+
- [434c99f80](https://github.com/algolia/api-clients-automation/commit/434c99f80) fix(specs): use the read transporter for browse ([#3938](https://github.com/algolia/api-clients-automation/pull/3938)) by [@millotp](https://github.com/millotp/)
|
|
7
|
+
- [45d433d0a](https://github.com/algolia/api-clients-automation/commit/45d433d0a) fix(specs): correct type for banners [skip-bc] ([#3939](https://github.com/algolia/api-clients-automation/pull/3939)) by [@millotp](https://github.com/millotp/)
|
|
8
|
+
|
|
9
|
+
## [3.5.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.4.0...3.5.0)
|
|
10
|
+
|
|
11
|
+
- [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/)
|
|
12
|
+
- [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/)
|
|
13
|
+
- [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/)
|
|
14
|
+
- [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/)
|
|
15
|
+
|
|
1
16
|
## [3.4.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.3.4...3.4.0)
|
|
2
17
|
|
|
3
18
|
- [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
|
@@ -372,13 +372,6 @@ module Algolia
|
|
|
372
372
|
index_suffix = nil,
|
|
373
373
|
request_options = {}
|
|
374
374
|
)
|
|
375
|
-
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
|
376
|
-
raise(
|
|
377
|
-
ArgumentError,
|
|
378
|
-
"invalid value for \"\"offset\"\" when calling AbtestingClient.list_ab_tests, must be greater than or equal to 0."
|
|
379
|
-
)
|
|
380
|
-
end
|
|
381
|
-
|
|
382
375
|
path = "/2/abtests"
|
|
383
376
|
query_params = {}
|
|
384
377
|
query_params[:offset] = offset unless offset.nil?
|
|
@@ -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 `YYYY-MM-DD` format.
|
|
802
802
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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 `offset` 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 `limit` 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 `OR` and `AND`. 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,13 +819,6 @@ 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 && !offset.nil? && offset < 0
|
|
823
|
-
raise(
|
|
824
|
-
ArgumentError,
|
|
825
|
-
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_clicks, must be greater than or equal to 0."
|
|
826
|
-
)
|
|
827
|
-
end
|
|
828
|
-
|
|
829
822
|
path = "/2/searches/noClicks"
|
|
830
823
|
query_params = {}
|
|
831
824
|
query_params[:index] = index
|
|
@@ -858,8 +851,8 @@ module Algolia
|
|
|
858
851
|
# @param index [String] Index name. (required)
|
|
859
852
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
860
853
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
854
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
855
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
863
856
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
864
857
|
# @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
858
|
# @return [GetSearchesNoClicksResponse]
|
|
@@ -894,8 +887,8 @@ module Algolia
|
|
|
894
887
|
# @param index [String] Index name. (required)
|
|
895
888
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
896
889
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
890
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
891
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
899
892
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
900
893
|
# @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
894
|
# @return [Http::Response] the response
|
|
@@ -913,13 +906,6 @@ module Algolia
|
|
|
913
906
|
raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_results`."
|
|
914
907
|
end
|
|
915
908
|
|
|
916
|
-
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
|
917
|
-
raise(
|
|
918
|
-
ArgumentError,
|
|
919
|
-
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_results, must be greater than or equal to 0."
|
|
920
|
-
)
|
|
921
|
-
end
|
|
922
|
-
|
|
923
909
|
path = "/2/searches/noResults"
|
|
924
910
|
query_params = {}
|
|
925
911
|
query_params[:index] = index
|
|
@@ -952,8 +938,8 @@ module Algolia
|
|
|
952
938
|
# @param index [String] Index name. (required)
|
|
953
939
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
954
940
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
941
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
942
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
957
943
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
958
944
|
# @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
945
|
# @return [GetSearchesNoResultsResponse]
|
|
@@ -1033,8 +1019,8 @@ module Algolia
|
|
|
1033
1019
|
# @param index [String] Index name. (required)
|
|
1034
1020
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1035
1021
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1022
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1023
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1038
1024
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1039
1025
|
# @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
1026
|
# @return [Http::Response] the response
|
|
@@ -1052,13 +1038,6 @@ module Algolia
|
|
|
1052
1038
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_countries`."
|
|
1053
1039
|
end
|
|
1054
1040
|
|
|
1055
|
-
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
|
1056
|
-
raise(
|
|
1057
|
-
ArgumentError,
|
|
1058
|
-
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_countries, must be greater than or equal to 0."
|
|
1059
|
-
)
|
|
1060
|
-
end
|
|
1061
|
-
|
|
1062
1041
|
path = "/2/countries"
|
|
1063
1042
|
query_params = {}
|
|
1064
1043
|
query_params[:index] = index
|
|
@@ -1091,8 +1070,8 @@ module Algolia
|
|
|
1091
1070
|
# @param index [String] Index name. (required)
|
|
1092
1071
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1093
1072
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1073
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1074
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1096
1075
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1097
1076
|
# @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
1077
|
# @return [GetTopCountriesResponse]
|
|
@@ -1120,8 +1099,8 @@ module Algolia
|
|
|
1120
1099
|
# @param search [String] Search query.
|
|
1121
1100
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1122
1101
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1102
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1103
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1125
1104
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1126
1105
|
# @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
1106
|
# @return [Http::Response] the response
|
|
@@ -1140,13 +1119,6 @@ module Algolia
|
|
|
1140
1119
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_attributes`."
|
|
1141
1120
|
end
|
|
1142
1121
|
|
|
1143
|
-
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
|
1144
|
-
raise(
|
|
1145
|
-
ArgumentError,
|
|
1146
|
-
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_attributes, must be greater than or equal to 0."
|
|
1147
|
-
)
|
|
1148
|
-
end
|
|
1149
|
-
|
|
1150
1122
|
path = "/2/filters"
|
|
1151
1123
|
query_params = {}
|
|
1152
1124
|
query_params[:index] = index
|
|
@@ -1181,8 +1153,8 @@ module Algolia
|
|
|
1181
1153
|
# @param search [String] Search query.
|
|
1182
1154
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1183
1155
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1156
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1157
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1186
1158
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1187
1159
|
# @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
1160
|
# @return [GetTopFilterAttributesResponse]
|
|
@@ -1221,8 +1193,8 @@ module Algolia
|
|
|
1221
1193
|
# @param search [String] Search query.
|
|
1222
1194
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1223
1195
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1196
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1197
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1226
1198
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1227
1199
|
# @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
1200
|
# @return [Http::Response] the response
|
|
@@ -1246,13 +1218,6 @@ module Algolia
|
|
|
1246
1218
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_for_attribute`."
|
|
1247
1219
|
end
|
|
1248
1220
|
|
|
1249
|
-
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
|
1250
|
-
raise(
|
|
1251
|
-
ArgumentError,
|
|
1252
|
-
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be greater than or equal to 0."
|
|
1253
|
-
)
|
|
1254
|
-
end
|
|
1255
|
-
|
|
1256
1221
|
path = "/2/filters/{attribute}".sub("{" + "attribute" + "}", Transport.encode_uri(attribute.to_s))
|
|
1257
1222
|
query_params = {}
|
|
1258
1223
|
query_params[:index] = index
|
|
@@ -1288,8 +1253,8 @@ module Algolia
|
|
|
1288
1253
|
# @param search [String] Search query.
|
|
1289
1254
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1290
1255
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1256
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1257
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1293
1258
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1294
1259
|
# @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
1260
|
# @return [GetTopFilterForAttributeResponse]
|
|
@@ -1329,8 +1294,8 @@ module Algolia
|
|
|
1329
1294
|
# @param search [String] Search query.
|
|
1330
1295
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1331
1296
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1297
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1298
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1334
1299
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1335
1300
|
# @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
1301
|
# @return [Http::Response] the response
|
|
@@ -1349,13 +1314,6 @@ module Algolia
|
|
|
1349
1314
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_filters_no_results`."
|
|
1350
1315
|
end
|
|
1351
1316
|
|
|
1352
|
-
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
|
1353
|
-
raise(
|
|
1354
|
-
ArgumentError,
|
|
1355
|
-
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filters_no_results, must be greater than or equal to 0."
|
|
1356
|
-
)
|
|
1357
|
-
end
|
|
1358
|
-
|
|
1359
1317
|
path = "/2/filters/noResults"
|
|
1360
1318
|
query_params = {}
|
|
1361
1319
|
query_params[:index] = index
|
|
@@ -1390,8 +1348,8 @@ module Algolia
|
|
|
1390
1348
|
# @param search [String] Search query.
|
|
1391
1349
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1392
1350
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1351
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1352
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1395
1353
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1396
1354
|
# @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
1355
|
# @return [GetTopFiltersNoResultsResponse]
|
|
@@ -1431,8 +1389,8 @@ module Algolia
|
|
|
1431
1389
|
# @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
1390
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1433
1391
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1392
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1393
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1436
1394
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1437
1395
|
# @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
1396
|
# @return [Http::Response] the response
|
|
@@ -1453,13 +1411,6 @@ module Algolia
|
|
|
1453
1411
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_hits`."
|
|
1454
1412
|
end
|
|
1455
1413
|
|
|
1456
|
-
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
|
1457
|
-
raise(
|
|
1458
|
-
ArgumentError,
|
|
1459
|
-
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_hits, must be greater than or equal to 0."
|
|
1460
|
-
)
|
|
1461
|
-
end
|
|
1462
|
-
|
|
1463
1414
|
path = "/2/hits"
|
|
1464
1415
|
query_params = {}
|
|
1465
1416
|
query_params[:index] = index
|
|
@@ -1498,8 +1449,8 @@ module Algolia
|
|
|
1498
1449
|
# @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
1450
|
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1500
1451
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` 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)
|
|
1452
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1453
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1503
1454
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1504
1455
|
# @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
1456
|
# @return [GetTopHitsResponse]
|
|
@@ -1541,8 +1492,8 @@ module Algolia
|
|
|
1541
1492
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1542
1493
|
# @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount')
|
|
1543
1494
|
# @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)
|
|
1495
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1496
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1546
1497
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1547
1498
|
# @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
1499
|
# @return [Http::Response] the response
|
|
@@ -1564,13 +1515,6 @@ module Algolia
|
|
|
1564
1515
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_searches`."
|
|
1565
1516
|
end
|
|
1566
1517
|
|
|
1567
|
-
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
|
1568
|
-
raise(
|
|
1569
|
-
ArgumentError,
|
|
1570
|
-
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_searches, must be greater than or equal to 0."
|
|
1571
|
-
)
|
|
1572
|
-
end
|
|
1573
|
-
|
|
1574
1518
|
path = "/2/searches"
|
|
1575
1519
|
query_params = {}
|
|
1576
1520
|
query_params[:index] = index
|
|
@@ -1611,8 +1555,8 @@ module Algolia
|
|
|
1611
1555
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1612
1556
|
# @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount')
|
|
1613
1557
|
# @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)
|
|
1558
|
+
# @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
|
|
1559
|
+
# @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
|
|
1616
1560
|
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1617
1561
|
# @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
1562
|
# @return [GetTopSearchesResponse]
|
|
@@ -1386,27 +1386,6 @@ module Algolia
|
|
|
1386
1386
|
order = nil,
|
|
1387
1387
|
request_options = {}
|
|
1388
1388
|
)
|
|
1389
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
|
1390
|
-
raise(
|
|
1391
|
-
ArgumentError,
|
|
1392
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_authentications, must be smaller than or equal to 100."
|
|
1393
|
-
)
|
|
1394
|
-
end
|
|
1395
|
-
|
|
1396
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
|
1397
|
-
raise(
|
|
1398
|
-
ArgumentError,
|
|
1399
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_authentications, must be greater than or equal to 1."
|
|
1400
|
-
)
|
|
1401
|
-
end
|
|
1402
|
-
|
|
1403
|
-
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
|
1404
|
-
raise(
|
|
1405
|
-
ArgumentError,
|
|
1406
|
-
"invalid value for \"\"page\"\" when calling IngestionClient.list_authentications, must be greater than or equal to 1."
|
|
1407
|
-
)
|
|
1408
|
-
end
|
|
1409
|
-
|
|
1410
1389
|
path = "/1/authentications"
|
|
1411
1390
|
query_params = {}
|
|
1412
1391
|
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
|
@@ -1487,27 +1466,6 @@ module Algolia
|
|
|
1487
1466
|
order = nil,
|
|
1488
1467
|
request_options = {}
|
|
1489
1468
|
)
|
|
1490
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
|
1491
|
-
raise(
|
|
1492
|
-
ArgumentError,
|
|
1493
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_destinations, must be smaller than or equal to 100."
|
|
1494
|
-
)
|
|
1495
|
-
end
|
|
1496
|
-
|
|
1497
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
|
1498
|
-
raise(
|
|
1499
|
-
ArgumentError,
|
|
1500
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_destinations, must be greater than or equal to 1."
|
|
1501
|
-
)
|
|
1502
|
-
end
|
|
1503
|
-
|
|
1504
|
-
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
|
1505
|
-
raise(
|
|
1506
|
-
ArgumentError,
|
|
1507
|
-
"invalid value for \"\"page\"\" when calling IngestionClient.list_destinations, must be greater than or equal to 1."
|
|
1508
|
-
)
|
|
1509
|
-
end
|
|
1510
|
-
|
|
1511
1469
|
path = "/1/destinations"
|
|
1512
1470
|
query_params = {}
|
|
1513
1471
|
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
|
@@ -1578,7 +1536,7 @@ module Algolia
|
|
|
1578
1536
|
)
|
|
1579
1537
|
end
|
|
1580
1538
|
|
|
1581
|
-
# Retrieves a list of events for a task run, identified by
|
|
1539
|
+
# Retrieves a list of events for a task run, identified by its ID.
|
|
1582
1540
|
#
|
|
1583
1541
|
# Required API Key ACLs:
|
|
1584
1542
|
# - addObject
|
|
@@ -1612,27 +1570,6 @@ module Algolia
|
|
|
1612
1570
|
raise ArgumentError, "Parameter `run_id` is required when calling `list_events`."
|
|
1613
1571
|
end
|
|
1614
1572
|
|
|
1615
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
|
1616
|
-
raise(
|
|
1617
|
-
ArgumentError,
|
|
1618
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_events, must be smaller than or equal to 100."
|
|
1619
|
-
)
|
|
1620
|
-
end
|
|
1621
|
-
|
|
1622
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
|
1623
|
-
raise(
|
|
1624
|
-
ArgumentError,
|
|
1625
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_events, must be greater than or equal to 1."
|
|
1626
|
-
)
|
|
1627
|
-
end
|
|
1628
|
-
|
|
1629
|
-
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
|
1630
|
-
raise(
|
|
1631
|
-
ArgumentError,
|
|
1632
|
-
"invalid value for \"\"page\"\" when calling IngestionClient.list_events, must be greater than or equal to 1."
|
|
1633
|
-
)
|
|
1634
|
-
end
|
|
1635
|
-
|
|
1636
1573
|
path = "/1/runs/{runID}/events".sub("{" + "runID" + "}", Transport.encode_uri(run_id.to_s))
|
|
1637
1574
|
query_params = {}
|
|
1638
1575
|
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
|
@@ -1660,7 +1597,7 @@ module Algolia
|
|
|
1660
1597
|
@api_client.call_api(:GET, path, new_options)
|
|
1661
1598
|
end
|
|
1662
1599
|
|
|
1663
|
-
# Retrieves a list of events for a task run, identified by
|
|
1600
|
+
# Retrieves a list of events for a task run, identified by its ID.
|
|
1664
1601
|
#
|
|
1665
1602
|
# Required API Key ACLs:
|
|
1666
1603
|
# - addObject
|
|
@@ -1733,27 +1670,6 @@ module Algolia
|
|
|
1733
1670
|
end_date = nil,
|
|
1734
1671
|
request_options = {}
|
|
1735
1672
|
)
|
|
1736
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
|
1737
|
-
raise(
|
|
1738
|
-
ArgumentError,
|
|
1739
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_runs, must be smaller than or equal to 100."
|
|
1740
|
-
)
|
|
1741
|
-
end
|
|
1742
|
-
|
|
1743
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
|
1744
|
-
raise(
|
|
1745
|
-
ArgumentError,
|
|
1746
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_runs, must be greater than or equal to 1."
|
|
1747
|
-
)
|
|
1748
|
-
end
|
|
1749
|
-
|
|
1750
|
-
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
|
1751
|
-
raise(
|
|
1752
|
-
ArgumentError,
|
|
1753
|
-
"invalid value for \"\"page\"\" when calling IngestionClient.list_runs, must be greater than or equal to 1."
|
|
1754
|
-
)
|
|
1755
|
-
end
|
|
1756
|
-
|
|
1757
1673
|
path = "/1/runs"
|
|
1758
1674
|
query_params = {}
|
|
1759
1675
|
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
|
@@ -1849,27 +1765,6 @@ module Algolia
|
|
|
1849
1765
|
order = nil,
|
|
1850
1766
|
request_options = {}
|
|
1851
1767
|
)
|
|
1852
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
|
1853
|
-
raise(
|
|
1854
|
-
ArgumentError,
|
|
1855
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_sources, must be smaller than or equal to 100."
|
|
1856
|
-
)
|
|
1857
|
-
end
|
|
1858
|
-
|
|
1859
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
|
1860
|
-
raise(
|
|
1861
|
-
ArgumentError,
|
|
1862
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_sources, must be greater than or equal to 1."
|
|
1863
|
-
)
|
|
1864
|
-
end
|
|
1865
|
-
|
|
1866
|
-
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
|
1867
|
-
raise(
|
|
1868
|
-
ArgumentError,
|
|
1869
|
-
"invalid value for \"\"page\"\" when calling IngestionClient.list_sources, must be greater than or equal to 1."
|
|
1870
|
-
)
|
|
1871
|
-
end
|
|
1872
|
-
|
|
1873
1768
|
path = "/1/sources"
|
|
1874
1769
|
query_params = {}
|
|
1875
1770
|
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
|
@@ -1962,27 +1857,6 @@ module Algolia
|
|
|
1962
1857
|
order = nil,
|
|
1963
1858
|
request_options = {}
|
|
1964
1859
|
)
|
|
1965
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
|
1966
|
-
raise(
|
|
1967
|
-
ArgumentError,
|
|
1968
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_tasks, must be smaller than or equal to 100."
|
|
1969
|
-
)
|
|
1970
|
-
end
|
|
1971
|
-
|
|
1972
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
|
1973
|
-
raise(
|
|
1974
|
-
ArgumentError,
|
|
1975
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_tasks, must be greater than or equal to 1."
|
|
1976
|
-
)
|
|
1977
|
-
end
|
|
1978
|
-
|
|
1979
|
-
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
|
1980
|
-
raise(
|
|
1981
|
-
ArgumentError,
|
|
1982
|
-
"invalid value for \"\"page\"\" when calling IngestionClient.list_tasks, must be greater than or equal to 1."
|
|
1983
|
-
)
|
|
1984
|
-
end
|
|
1985
|
-
|
|
1986
1860
|
path = "/2/tasks"
|
|
1987
1861
|
query_params = {}
|
|
1988
1862
|
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
|
@@ -2087,27 +1961,6 @@ module Algolia
|
|
|
2087
1961
|
order = nil,
|
|
2088
1962
|
request_options = {}
|
|
2089
1963
|
)
|
|
2090
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
|
2091
|
-
raise(
|
|
2092
|
-
ArgumentError,
|
|
2093
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_tasks_v1, must be smaller than or equal to 100."
|
|
2094
|
-
)
|
|
2095
|
-
end
|
|
2096
|
-
|
|
2097
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
|
2098
|
-
raise(
|
|
2099
|
-
ArgumentError,
|
|
2100
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_tasks_v1, must be greater than or equal to 1."
|
|
2101
|
-
)
|
|
2102
|
-
end
|
|
2103
|
-
|
|
2104
|
-
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
|
2105
|
-
raise(
|
|
2106
|
-
ArgumentError,
|
|
2107
|
-
"invalid value for \"\"page\"\" when calling IngestionClient.list_tasks_v1, must be greater than or equal to 1."
|
|
2108
|
-
)
|
|
2109
|
-
end
|
|
2110
|
-
|
|
2111
1964
|
path = "/1/tasks"
|
|
2112
1965
|
query_params = {}
|
|
2113
1966
|
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
|
@@ -2202,27 +2055,6 @@ module Algolia
|
|
|
2202
2055
|
order = nil,
|
|
2203
2056
|
request_options = {}
|
|
2204
2057
|
)
|
|
2205
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
|
2206
|
-
raise(
|
|
2207
|
-
ArgumentError,
|
|
2208
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_transformations, must be smaller than or equal to 100."
|
|
2209
|
-
)
|
|
2210
|
-
end
|
|
2211
|
-
|
|
2212
|
-
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
|
2213
|
-
raise(
|
|
2214
|
-
ArgumentError,
|
|
2215
|
-
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_transformations, must be greater than or equal to 1."
|
|
2216
|
-
)
|
|
2217
|
-
end
|
|
2218
|
-
|
|
2219
|
-
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
|
2220
|
-
raise(
|
|
2221
|
-
ArgumentError,
|
|
2222
|
-
"invalid value for \"\"page\"\" when calling IngestionClient.list_transformations, must be greater than or equal to 1."
|
|
2223
|
-
)
|
|
2224
|
-
end
|
|
2225
|
-
|
|
2226
2058
|
path = "/1/transformations"
|
|
2227
2059
|
query_params = {}
|
|
2228
2060
|
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
|
@@ -234,28 +234,6 @@ module Algolia
|
|
|
234
234
|
raise ArgumentError, "Parameter `user_token` is required when calling `delete_user_token`."
|
|
235
235
|
end
|
|
236
236
|
|
|
237
|
-
if @api_client.config.client_side_validation && user_token.to_s.length > 129
|
|
238
|
-
raise(
|
|
239
|
-
ArgumentError,
|
|
240
|
-
"invalid value for \"user_token\" when calling InsightsClient.delete_user_token, the character length must be smaller than or equal to 129."
|
|
241
|
-
)
|
|
242
|
-
end
|
|
243
|
-
|
|
244
|
-
if @api_client.config.client_side_validation && user_token.to_s.length < 1
|
|
245
|
-
raise(
|
|
246
|
-
ArgumentError,
|
|
247
|
-
"invalid value for \"user_token\" when calling InsightsClient.delete_user_token, the character length must be great than or equal to 1."
|
|
248
|
-
)
|
|
249
|
-
end
|
|
250
|
-
|
|
251
|
-
pattern = /[a-zA-Z0-9_=\/+-]{1,129}/
|
|
252
|
-
if @api_client.config.client_side_validation && user_token !~ pattern
|
|
253
|
-
raise(
|
|
254
|
-
ArgumentError,
|
|
255
|
-
"invalid value for 'user_token' when calling InsightsClient.delete_user_token, must conform to the pattern #{pattern}."
|
|
256
|
-
)
|
|
257
|
-
end
|
|
258
|
-
|
|
259
237
|
path = "/1/usertokens/{userToken}".sub("{" + "userToken" + "}", Transport.encode_uri(user_token.to_s))
|
|
260
238
|
query_params = {}
|
|
261
239
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|