algolia 3.0.0.alpha.16 → 3.0.0.alpha.17

data/lib/algolia/api/analytics_client.rb

@@ -215,8 +215,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -254,8 +254,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetAddToCartRateResponse]
@@ -269,8 +269,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -308,8 +308,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetAverageClickPositionResponse]
@@ -323,8 +323,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -362,8 +362,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetClickPositionsResponse]
@@ -377,8 +377,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -416,8 +416,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetClickThroughRateResponse]
@@ -431,8 +431,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -470,8 +470,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetConversionRateResponse]
@@ -485,8 +485,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -524,8 +524,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetNoClickRateResponse]
@@ -539,8 +539,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -578,8 +578,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetNoResultsRateResponse]
@@ -593,8 +593,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -632,8 +632,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetPurchaseRateResponse]
@@ -647,8 +647,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -686,8 +686,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetRevenue]
@@ -701,8 +701,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -740,8 +740,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetSearchesCountResponse]
@@ -755,8 +755,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -801,8 +801,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -818,8 +818,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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,8 +864,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -926,8 +926,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -972,8 +972,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -990,8 +990,8 @@ module Algolia
     #   - analytics
     # @param index [String] Index name. (required)
     # @param search [String] Search query.
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -1038,8 +1038,8 @@ module Algolia
     #   - analytics
     # @param index [String] Index name. (required)
     # @param search [String] Search query.
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -1057,8 +1057,8 @@ module Algolia
     # @param attribute [String] Attribute name. (required)
     # @param index [String] Index name. (required)
     # @param search [String] Search query.
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -1110,8 +1110,8 @@ module Algolia
     # @param attribute [String] Attribute name. (required)
     # @param index [String] Index name. (required)
     # @param search [String] Search query.
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -1128,8 +1128,8 @@ module Algolia
     #   - analytics
     # @param index [String] Index name. (required)
     # @param search [String] Search query.
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -1176,8 +1176,8 @@ module Algolia
     #   - analytics
     # @param index [String] Index name. (required)
     # @param search [String] Search query.
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -1196,8 +1196,8 @@ module Algolia
     # @param search [String] Search query.
     # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
     # @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)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -1249,8 +1249,8 @@ module Algolia
     # @param search [String] Search query.
     # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
     # @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)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @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/).
@@ -1269,8 +1269,8 @@ module Algolia
     # @param index [String] Index name. (required)
     # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
     # @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)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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')
     # @param direction [Direction] Sorting direction of the results: ascending or descending.  (default to 'asc')
     # @param limit [Integer] Number of items to return. (default to 10)
@@ -1324,8 +1324,8 @@ module Algolia
     # @param index [String] Index name. (required)
     # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
     # @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)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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')
     # @param direction [Direction] Sorting direction of the results: ascending or descending.  (default to 'asc')
     # @param limit [Integer] Number of items to return. (default to 10)
@@ -1344,8 +1344,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [Http::Response] the response
@@ -1383,8 +1383,8 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param index [String] Index name. (required)
-    # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze.
-    # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze.
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @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/).
     # @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)
     # @return [GetUsersCountResponse]

data/lib/algolia/api/recommend_client.rb

@@ -205,12 +205,12 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    # Deletes a Recommend rule from a recommendation scenario.
     #
     # Required API Key ACLs:
     #   - editSettings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
-    # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
+    # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param object_id [String] Unique record identifier. (required)
     # @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)
     # @return [Http::Response] the response
@@ -249,12 +249,12 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    # Deletes a Recommend rule from a recommendation scenario.
     #
     # Required API Key ACLs:
     #   - editSettings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
-    # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
+    # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param object_id [String] Unique record identifier. (required)
     # @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)
     # @return [DeletedAtResponse]
@@ -263,12 +263,12 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::DeletedAtResponse')
     end
 
-    # Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    # Retrieves a Recommend rule that you previously created in the Algolia dashboard.
     #
     # Required API Key ACLs:
     #   - settings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
-    # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
+    # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param object_id [String] Unique record identifier. (required)
     # @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)
     # @return [Http::Response] the response
@@ -307,27 +307,27 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    # Retrieves a Recommend rule that you previously created in the Algolia dashboard.
     #
     # Required API Key ACLs:
     #   - settings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
-    # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
+    # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param object_id [String] Unique record identifier. (required)
     # @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)
-    # @return [RuleResponse]
+    # @return [RecommendRule]
     def get_recommend_rule(index_name, model, object_id, request_options = {})
       response = get_recommend_rule_with_http_info(index_name, model, object_id, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::RuleResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::RecommendRule')
     end
 
-    # Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
+    # Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
     #
     # Required API Key ACLs:
     #   - editSettings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
-    # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
-    # @param task_id [Integer] Unique identifier of a task. Numeric value (up to 64bits). (required)
+    # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
+    # @param task_id [Integer] Unique task identifier. (required)
     # @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)
     # @return [Http::Response] the response
     def get_recommend_status_with_http_info(index_name, model, task_id, request_options = {})
@@ -365,13 +365,13 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
+    # Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
     #
     # Required API Key ACLs:
     #   - editSettings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
-    # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
-    # @param task_id [Integer] Unique identifier of a task. Numeric value (up to 64bits). (required)
+    # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
+    # @param task_id [Integer] Unique task identifier. (required)
     # @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)
     # @return [GetRecommendTaskResponse]
     def get_recommend_status(index_name, model, task_id, request_options = {})
@@ -379,7 +379,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::GetRecommendTaskResponse')
     end
 
-    # Returns results from either recommendation or trending models:    - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models   - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
+    # Retrieves recommendations from selected AI models.
     #
     # Required API Key ACLs:
     #   - search
@@ -411,7 +411,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Returns results from either recommendation or trending models:    - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models   - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
+    # Retrieves recommendations from selected AI models.
     #
     # Required API Key ACLs:
     #   - search
@@ -423,12 +423,12 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Recommend::GetRecommendationsResponse')
     end
 
-    # List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    # Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
     #
     # Required API Key ACLs:
     #   - settings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
-    # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
+    # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param search_recommend_rules_params [SearchRecommendRulesParams]
     # @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)
     # @return [Http::Response] the response
@@ -462,12 +462,12 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+    # Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
     #
     # Required API Key ACLs:
     #   - settings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
-    # @param model [RecommendModels] [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
+    # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
     # @param search_recommend_rules_params [SearchRecommendRulesParams]
     # @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)
     # @return [SearchRecommendRulesResponse]