algolia 3.46.1 → 3.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 328e8475c7136afd5c3ecb2e096a3c7cbeeaccc7fe1f00e46ef1f0d761ba5371
-  data.tar.gz: 6191e28670fce3448e29aa71b1d348ff9fa033e726101e5e7d67a024bd9592e6
+  metadata.gz: 3ecdb659fe529673e571a60a4bbe13dc73c9c6fbe53c950a5c44802f4add29d9
+  data.tar.gz: af9ded4069bb54fa19eb779c543f50bb9d8a42a93bcec851503d9c3bafa93909
 SHA512:
-  metadata.gz: 164520f8480480fd77846475b8fbe0c71d61b9180564f132835ef7d9a7ca471ab82f6737ca354f7bba0d0c4a4b8fcab5149874c5b8fd4a26bef7fb6aba14e26f
-  data.tar.gz: 9e4c5bfd50ce5ec2e98efe1a7fbe55316ff640e542035871085bb92903bbd89d55f8ade740a4ae8a470ee066c102a6c5589fe2fbde8e12610548969075627c6b
+  metadata.gz: 7cbe0d52f1d866d286860249008f8ecfadad93149f241f3e199ea25d2636330e9ce84682e0f181d7036b7f55d28af1cdd5f6c937ce2bbd9ac8afdddc98ae5655
+  data.tar.gz: c2aa1c1e557a956ec9e9e1a5bec99d47999bd0c1738c317caf58edd653431cbbca0ae7c4443938c43c131b9c9e2fe16d4d0e78b5306231125ec31b276d1ddab3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.47.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.46.1...3.47.0)
+
+- [e6d5471f15](https://github.com/algolia/api-clients-automation/commit/e6d5471f15) fix(scripts): avoid swift CTS deadlock when running in docker ([#7146](https://github.com/algolia/api-clients-automation/pull/7146)) by [@Fluf22](https://github.com/Fluf22/)
+- [c2153f09a5](https://github.com/algolia/api-clients-automation/commit/c2153f09a5) fix(specs): remove obsolete index-key copy note ([#7177](https://github.com/algolia/api-clients-automation/pull/7177)) by [@xroche](https://github.com/xroche/)
+- [75e309924e](https://github.com/algolia/api-clients-automation/commit/75e309924e) clients(clients): cache host state only on change ([#7202](https://github.com/algolia/api-clients-automation/pull/7202)) by [@zigzagdev](https://github.com/zigzagdev/)
+- [e7642ce951](https://github.com/algolia/api-clients-automation/commit/e7642ce951) feat(specs): add user metrics to abtesting-v3 timeseries enum ([#7181](https://github.com/algolia/api-clients-automation/pull/7181)) by [@stevenMevans](https://github.com/stevenMevans/)
+
 ## [3.46.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.46.0...3.46.1)
 
 - [f2854eb518](https://github.com/algolia/api-clients-automation/commit/f2854eb518) chore(ci): bump ruby/setup-ruby to v1.329.0 to support Ruby 4.0.7 ([#7142](https://github.com/algolia/api-clients-automation/pull/7142)) by [@Fluf22](https://github.com/Fluf22/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.46.1)
+    algolia (3.47.0)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/api/abtesting_v3_client.rb

@@ -553,7 +553,7 @@ module Algolia
     # @param id [Integer] Unique A/B test identifier. (required)
     # @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 metric [Array<MetricName>] List of metrics to retrieve. If not specified, all metrics are returned.
+    # @param metric [Array<MetricName>] Metrics to retrieve, as a comma-separated list. If not specified, all metrics are returned.
     # @param methods [Array<AnalysisMethod>] Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn't change the test configuration or compute missing results. Duplicate values aren't allowed.
     # @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
@@ -574,7 +574,7 @@ module Algolia
       query_params = {}
       query_params[:startDate] = start_date unless start_date.nil?
       query_params[:endDate] = end_date unless end_date.nil?
-      query_params[:metric] = @api_client.build_collection_param(metric, :multi) unless metric.nil?
+      query_params[:metric] = @api_client.build_collection_param(metric, :csv) unless metric.nil?
       query_params[:methods] = @api_client.build_collection_param(methods, :csv) unless methods.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -600,7 +600,7 @@ module Algolia
     # @param id [Integer] Unique A/B test identifier. (required)
     # @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 metric [Array<MetricName>] List of metrics to retrieve. If not specified, all metrics are returned.
+    # @param metric [Array<MetricName>] Metrics to retrieve, as a comma-separated list. If not specified, all metrics are returned.
     # @param methods [Array<AnalysisMethod>] Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn't change the test configuration or compute missing results. Duplicate values aren't allowed.
     # @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 [Timeseries]

data/lib/algolia/api/search_client.rb

@@ -2242,7 +2242,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::MultipleBatchResponse")
     end
 
-    # Copies or moves (renames) an index within the same Algolia application.  Notes: - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it's created. - This operation is resource-intensive.  **Copy**  - If the source index doesn't exist, copying creates a new index with 0 records and default settings. - API keys from the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - For more information, see [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices).  **Move**  - If the source index doesn't exist, moving is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - For more information, see [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices).  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
+    # Copies or moves (renames) an index within the same Algolia application.  Notes: - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it's created. - This operation is resource-intensive.  **Copy**  - If the source index doesn't exist, copying creates a new index with 0 records and default settings. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - For more information, see [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices).  **Move**  - If the source index doesn't exist, moving is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - For more information, see [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices).  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
     #
     # Required API Key ACLs:
     #   - addObject
@@ -2283,7 +2283,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Copies or moves (renames) an index within the same Algolia application.  Notes: - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it's created. - This operation is resource-intensive.  **Copy**  - If the source index doesn't exist, copying creates a new index with 0 records and default settings. - API keys from the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - For more information, see [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices).  **Move**  - If the source index doesn't exist, moving is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - For more information, see [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices).  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
+    # Copies or moves (renames) an index within the same Algolia application.  Notes: - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it's created. - This operation is resource-intensive.  **Copy**  - If the source index doesn't exist, copying creates a new index with 0 records and default settings. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - For more information, see [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices).  **Move**  - If the source index doesn't exist, moving is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - For more information, see [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices).  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
     #
     # Required API Key ACLs:
     #   - addObject

data/lib/algolia/models/abtesting-v3/effect_metric.rb

@@ -13,9 +13,23 @@ module Algolia
       CONVERSION_RATE = "conversionRate".freeze
       PURCHASE_RATE = "purchaseRate".freeze
       NO_RESULTS_RATE = "noResultsRate".freeze
+      ADD_TO_CART_USERS_RATE = "addToCartUsersRate".freeze
+      CLICKED_USERS_RATE = "clickedUsersRate".freeze
+      CONVERTED_USERS_RATE = "convertedUsersRate".freeze
+      PURCHASE_USERS_RATE = "purchaseUsersRate".freeze
 
       def self.all_vars
-        @all_vars ||= [ADD_TO_CART_RATE, CLICK_THROUGH_RATE, CONVERSION_RATE, PURCHASE_RATE, NO_RESULTS_RATE].freeze
+        @all_vars ||= [
+          ADD_TO_CART_RATE,
+          CLICK_THROUGH_RATE,
+          CONVERSION_RATE,
+          PURCHASE_RATE,
+          NO_RESULTS_RATE,
+          ADD_TO_CART_USERS_RATE,
+          CLICKED_USERS_RATE,
+          CONVERTED_USERS_RATE,
+          PURCHASE_USERS_RATE
+        ].freeze
       end
 
       # Builds the enum from string

data/lib/algolia/models/abtesting-v3/estimate_ab_test_response.rb

@@ -11,7 +11,7 @@ module Algolia
       # Estimated number of days needed to reach the sample sizes required for detecting the configured effect. This value is based on historical traffic.
       attr_accessor :duration_days
 
-      # Sample size estimates for each variant. The first element is the control variant. Each element is the estimated number of searches required to achieve the desired statistical significance.
+      # Sample size estimates for each variant. The first element is the control variant. Each element is the estimated number of searches, or users for user-level rates (metrics ending in `UsersRate`), required to achieve the desired statistical significance.
       attr_accessor :sample_sizes
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/abtesting-v3/metric_name.rb

@@ -26,6 +26,22 @@ module Algolia
       REVENUE = "revenue".freeze
       REVENUE_PER_SEARCH = "revenue_per_search".freeze
       AVERAGE_ORDER_VALUE = "average_order_value".freeze
+      CLICKED_USERS_COUNT = "clicked_users_count".freeze
+      CONVERTED_USERS_COUNT = "converted_users_count".freeze
+      ADD_TO_CART_USERS_COUNT = "add_to_cart_users_count".freeze
+      PURCHASE_USERS_COUNT = "purchase_users_count".freeze
+      USERS_WITH_NO_RESULTS_COUNT = "users_with_no_results_count".freeze
+      CLICKED_USERS_RATE = "clicked_users_rate".freeze
+      CONVERTED_USERS_RATE = "converted_users_rate".freeze
+      ADD_TO_CART_USERS_RATE = "add_to_cart_users_rate".freeze
+      PURCHASE_USERS_RATE = "purchase_users_rate".freeze
+      AVG_CLICK_THROUGH_RATE_PER_USER = "avg_click_through_rate_per_user".freeze
+      AVG_CONVERSION_RATE_PER_USER = "avg_conversion_rate_per_user".freeze
+      AVG_PURCHASE_RATE_PER_USER = "avg_purchase_rate_per_user".freeze
+      AVG_ADD_TO_CART_RATE_PER_USER = "avg_add_to_cart_rate_per_user".freeze
+      AVG_CLICK_POSITION_PER_USER = "avg_click_position_per_user".freeze
+      WINSORIZED_REVENUE_PER_USER = "winsorized_revenue_per_user".freeze
+      WINSORIZED_REVENUE_PER_PURCHASER = "winsorized_revenue_per_purchaser".freeze
 
       def self.all_vars
         @all_vars ||= [
@@ -46,7 +62,23 @@ module Algolia
           AVERAGE_CLICK_POSITION,
           REVENUE,
           REVENUE_PER_SEARCH,
-          AVERAGE_ORDER_VALUE
+          AVERAGE_ORDER_VALUE,
+          CLICKED_USERS_COUNT,
+          CONVERTED_USERS_COUNT,
+          ADD_TO_CART_USERS_COUNT,
+          PURCHASE_USERS_COUNT,
+          USERS_WITH_NO_RESULTS_COUNT,
+          CLICKED_USERS_RATE,
+          CONVERTED_USERS_RATE,
+          ADD_TO_CART_USERS_RATE,
+          PURCHASE_USERS_RATE,
+          AVG_CLICK_THROUGH_RATE_PER_USER,
+          AVG_CONVERSION_RATE_PER_USER,
+          AVG_PURCHASE_RATE_PER_USER,
+          AVG_ADD_TO_CART_RATE_PER_USER,
+          AVG_CLICK_POSITION_PER_USER,
+          WINSORIZED_REVENUE_PER_USER,
+          WINSORIZED_REVENUE_PER_PURCHASER
         ].freeze
       end
 

data/lib/algolia/models/abtesting-v3/primary_metric.rb

@@ -13,9 +13,23 @@ module Algolia
       CONVERSION_RATE = "conversion_rate".freeze
       PURCHASE_RATE = "purchase_rate".freeze
       REVENUE_PER_SEARCH = "revenue_per_search".freeze
+      ADD_TO_CART_USERS_RATE = "add_to_cart_users_rate".freeze
+      CLICKED_USERS_RATE = "clicked_users_rate".freeze
+      CONVERTED_USERS_RATE = "converted_users_rate".freeze
+      PURCHASE_USERS_RATE = "purchase_users_rate".freeze
 
       def self.all_vars
-        @all_vars ||= [ADD_TO_CART_RATE, CLICK_THROUGH_RATE, CONVERSION_RATE, PURCHASE_RATE, REVENUE_PER_SEARCH].freeze
+        @all_vars ||= [
+          ADD_TO_CART_RATE,
+          CLICK_THROUGH_RATE,
+          CONVERSION_RATE,
+          PURCHASE_RATE,
+          REVENUE_PER_SEARCH,
+          ADD_TO_CART_USERS_RATE,
+          CLICKED_USERS_RATE,
+          CONVERTED_USERS_RATE,
+          PURCHASE_USERS_RATE
+        ].freeze
       end
 
       # Builds the enum from string

data/lib/algolia/models/abtesting-v3/variant.rb

@@ -11,7 +11,7 @@ module Algolia
       # Description for this variant.
       attr_accessor :description
 
-      # Estimated number of searches required to achieve the desired statistical significance.  The A/B test configuration must include a `minimumDetectableEffect` setting for this number to be included in the response.
+      # Estimated number of searches, or users for user-level rates (metrics ending in `UsersRate`), required to achieve the desired statistical significance.  The A/B test configuration must include a `minimumDetectableEffect` setting for this number to be included in the response.
       attr_accessor :estimated_sample_size
 
       # Index name of the A/B test variant (case-sensitive).

data/lib/algolia/models/search/standard_entries.rb

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module Search
-    # Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values.
+    # Turn off the built-in Algolia stop words for specific languages. Only `stopwords` is supported. The keys of the `stopwords` object are [language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) of languages with a built-in stop-word dictionary.
     class StandardEntries
       # Key-value pair of a language ISO code and a boolean value.
       attr_accessor :plurals

data/lib/algolia/version.rb

@@ -3,5 +3,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 module Algolia
-  VERSION = "3.46.1"
+  VERSION = "3.47.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.46.1
+  version: 3.47.0
 platform: ruby
 authors:
 - https://alg.li/support