algolia 3.0.0.alpha.14 → 3.0.0.alpha.16

data/lib/algolia/models/query-suggestions/languages.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module QuerySuggestions
-    # Set the language for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
+    # Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
     module Languages
       class << self
         # List of class defined in oneOf (OpenAPI v3)

data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb

@@ -12,13 +12,12 @@ module Algolia
 
       attr_accessor :languages
 
-      # Patterns to exclude from query suggestions.
       attr_accessor :exclude
 
-      # Turn on personalized query suggestions.
+      # Whether to turn on personalized query suggestions.
       attr_accessor :enable_personalization
 
-      # Allow suggestions with special characters.
+      # Whether to include suggestions with special characters.
       attr_accessor :allow_special_characters
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb

@@ -5,17 +5,12 @@ require 'time'
 
 module Algolia
   module QuerySuggestions
+    # API response for retrieving Query Suggestions configurations.
     class QuerySuggestionsConfigurationResponse
-      # API key used to read from your source index.
-      attr_accessor :source_indices_api_key
+      # Algolia application ID to which this Query Suggestions configuration belongs.
+      attr_accessor :app_id
 
-      # API key used to write and configure your Query Suggestions index.
-      attr_accessor :suggestions_indices_api_key
-
-      # API key used to read from external Algolia indices.
-      attr_accessor :external_indices_api_key
-
-      # Query Suggestions index name.
+      # Name of the Query Suggestions index.
       attr_accessor :index_name
 
       # Algolia indices from which to get the popular searches for query suggestions.
@@ -23,21 +18,18 @@ module Algolia
 
       attr_accessor :languages
 
-      # Patterns to exclude from query suggestions.
       attr_accessor :exclude
 
-      # Turn on personalized query suggestions.
+      # Whether to turn on personalized query suggestions.
       attr_accessor :enable_personalization
 
-      # Allow suggestions with special characters.
+      # Whether to include suggestions with special characters.
       attr_accessor :allow_special_characters
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :source_indices_api_key => :sourceIndicesAPIKey,
-          :suggestions_indices_api_key => :suggestionsIndicesAPIKey,
-          :external_indices_api_key => :externalIndicesAPIKey,
+          :app_id => :appID,
           :index_name => :indexName,
           :source_indices => :sourceIndices,
           :languages => :languages,
@@ -55,9 +47,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :source_indices_api_key => :String,
-          :suggestions_indices_api_key => :String,
-          :external_indices_api_key => :String,
+          :app_id => :String,
           :index_name => :String,
           :source_indices => :'Array<SourceIndex>',
           :languages => :Languages,
@@ -77,7 +67,7 @@ module Algolia
       # List of class defined in allOf (OpenAPI v3)
       def self.openapi_all_of
         [
-          :BaseQuerySuggestionsConfigurationResponse,
+          :AppID,
           :QuerySuggestionsConfigurationWithIndex
         ]
       end
@@ -99,16 +89,10 @@ module Algolia
           h[k.to_sym] = v
         end
 
-        if attributes.key?(:source_indices_api_key)
-          self.source_indices_api_key = attributes[:source_indices_api_key]
-        end
-
-        if attributes.key?(:suggestions_indices_api_key)
-          self.suggestions_indices_api_key = attributes[:suggestions_indices_api_key]
-        end
-
-        if attributes.key?(:external_indices_api_key)
-          self.external_indices_api_key = attributes[:external_indices_api_key]
+        if attributes.key?(:app_id)
+          self.app_id = attributes[:app_id]
+        else
+          self.app_id = nil
         end
 
         if attributes.key?(:index_name)
@@ -127,20 +111,28 @@ module Algolia
 
         if attributes.key?(:languages)
           self.languages = attributes[:languages]
+        else
+          self.languages = nil
         end
 
         if attributes.key?(:exclude)
           if (value = attributes[:exclude]).is_a?(Array)
             self.exclude = value
           end
+        else
+          self.exclude = nil
         end
 
         if attributes.key?(:enable_personalization)
           self.enable_personalization = attributes[:enable_personalization]
+        else
+          self.enable_personalization = nil
         end
 
         if attributes.key?(:allow_special_characters)
           self.allow_special_characters = attributes[:allow_special_characters]
+        else
+          self.allow_special_characters = nil
         end
       end
 
@@ -164,9 +156,7 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          source_indices_api_key == other.source_indices_api_key &&
-          suggestions_indices_api_key == other.suggestions_indices_api_key &&
-          external_indices_api_key == other.external_indices_api_key &&
+          app_id == other.app_id &&
           index_name == other.index_name &&
           source_indices == other.source_indices &&
           languages == other.languages &&
@@ -184,8 +174,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [source_indices_api_key, suggestions_indices_api_key, external_indices_api_key, index_name, source_indices, languages, exclude, enable_personalization,
-         allow_special_characters].hash
+        [app_id, index_name, source_indices, languages, exclude, enable_personalization, allow_special_characters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb

@@ -7,32 +7,31 @@ module Algolia
   module QuerySuggestions
     # Query Suggestions configuration.
     class QuerySuggestionsConfigurationWithIndex
-      # Query Suggestions index name.
-      attr_accessor :index_name
-
       # Algolia indices from which to get the popular searches for query suggestions.
       attr_accessor :source_indices
 
       attr_accessor :languages
 
-      # Patterns to exclude from query suggestions.
       attr_accessor :exclude
 
-      # Turn on personalized query suggestions.
+      # Whether to turn on personalized query suggestions.
       attr_accessor :enable_personalization
 
-      # Allow suggestions with special characters.
+      # Whether to include suggestions with special characters.
       attr_accessor :allow_special_characters
 
+      # Name of the Query Suggestions index.
+      attr_accessor :index_name
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :index_name => :indexName,
           :source_indices => :sourceIndices,
           :languages => :languages,
           :exclude => :exclude,
           :enable_personalization => :enablePersonalization,
-          :allow_special_characters => :allowSpecialCharacters
+          :allow_special_characters => :allowSpecialCharacters,
+          :index_name => :indexName
         }
       end
 
@@ -44,12 +43,12 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :index_name => :String,
           :source_indices => :'Array<SourceIndex>',
           :languages => :Languages,
           :exclude => :'Array<String>',
           :enable_personalization => :Boolean,
-          :allow_special_characters => :Boolean
+          :allow_special_characters => :Boolean,
+          :index_name => :String
         }
       end
 
@@ -63,7 +62,6 @@ module Algolia
       # List of class defined in allOf (OpenAPI v3)
       def self.openapi_all_of
         [
-          :BaseQuerySuggestionsConfigurationWithIndex,
           :QuerySuggestionsConfiguration
         ]
       end
@@ -85,12 +83,6 @@ module Algolia
           h[k.to_sym] = v
         end
 
-        if attributes.key?(:index_name)
-          self.index_name = attributes[:index_name]
-        else
-          self.index_name = nil
-        end
-
         if attributes.key?(:source_indices)
           if (value = attributes[:source_indices]).is_a?(Array)
             self.source_indices = value
@@ -116,6 +108,12 @@ module Algolia
         if attributes.key?(:allow_special_characters)
           self.allow_special_characters = attributes[:allow_special_characters]
         end
+
+        if attributes.key?(:index_name)
+          self.index_name = attributes[:index_name]
+        else
+          self.index_name = nil
+        end
       end
 
       # Custom attribute writer method with validation
@@ -138,12 +136,12 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          index_name == other.index_name &&
           source_indices == other.source_indices &&
           languages == other.languages &&
           exclude == other.exclude &&
           enable_personalization == other.enable_personalization &&
-          allow_special_characters == other.allow_special_characters
+          allow_special_characters == other.allow_special_characters &&
+          index_name == other.index_name
       end
 
       # @see the `==` method
@@ -155,7 +153,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, source_indices, languages, exclude, enable_personalization, allow_special_characters].hash
+        [source_indices, languages, exclude, enable_personalization, allow_special_characters, index_name].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/query-suggestions/source_index.rb

@@ -10,16 +10,14 @@ module Algolia
       # Name of the Algolia index to use as source for query suggestions.
       attr_accessor :index_name
 
-      # If true, Query Suggestions uses all replicas of the primary index to find popular searches. If false, only the primary index is used.
+      # If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.
       attr_accessor :replicas
 
-      # [Analytics tags](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) for filtering the popular searches.
       attr_accessor :analytics_tags
 
-      # Facets to use as top categories with your suggestions.  If provided, Query Suggestions adds the top facet values to each suggestion.
       attr_accessor :facets
 
-      # Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` hits to be included in the Query Suggestions index.
+      # Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` search results to be included in the Query Suggestions index.
       attr_accessor :min_hits
 
       # Minimum letters required to be included as a suggestion.  A search query must be at least `minLetters` long to be included in the Query Suggestions index.
@@ -27,7 +25,6 @@ module Algolia
 
       attr_accessor :generate
 
-      # Algolia indices with popular searches to use as query suggestions.  Records of these indices must have these attributes:    - `query`: search query which will be added as a suggestion   - `count`: measure of popularity of that search query  For example, you can export popular searches from an external analytics tool, such as Google Analytics or Adobe Analytics, and feed this data into an external Algolia index. You can use this external index to generate query suggestions until your Algolia analytics has collected enough data.
       attr_accessor :external
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -68,6 +65,7 @@ module Algolia
         Set.new([
                   :analytics_tags,
                   :facets,
+                  :generate,
                   :external
                 ])
       end

data/lib/algolia/version.rb

@@ -1,5 +1,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.0.0.alpha.14'.freeze
+  VERSION = '3.0.0.alpha.16'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha.14
+  version: 3.0.0.alpha.16
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -146,7 +146,7 @@ files:
 - lib/algolia/models/abtesting/ab_tests_variant_search_params.rb
 - lib/algolia/models/abtesting/add_ab_tests_request.rb
 - lib/algolia/models/abtesting/add_ab_tests_variant.rb
-- lib/algolia/models/abtesting/currencies_value.rb
+- lib/algolia/models/abtesting/currency.rb
 - lib/algolia/models/abtesting/custom_search_params.rb
 - lib/algolia/models/abtesting/error_base.rb
 - lib/algolia/models/abtesting/filter_effects.rb
@@ -154,18 +154,31 @@ files:
 - lib/algolia/models/abtesting/filter_effects_outliers.rb
 - lib/algolia/models/abtesting/list_ab_tests_response.rb
 - lib/algolia/models/abtesting/variant.rb
-- lib/algolia/models/analytics/average_click_event.rb
-- lib/algolia/models/analytics/click_position.rb
-- lib/algolia/models/analytics/click_through_rate_event.rb
-- lib/algolia/models/analytics/conversion_rate_event.rb
+- lib/algolia/models/analytics/click_positions_inner.rb
+- lib/algolia/models/analytics/currencies_value.rb
+- lib/algolia/models/analytics/daily_add_to_cart_rates.rb
+- lib/algolia/models/analytics/daily_average_clicks.rb
+- lib/algolia/models/analytics/daily_click_through_rates.rb
+- lib/algolia/models/analytics/daily_conversion_rates.rb
+- lib/algolia/models/analytics/daily_no_click_rates.rb
+- lib/algolia/models/analytics/daily_no_results_rates.rb
+- lib/algolia/models/analytics/daily_purchase_rates.rb
+- lib/algolia/models/analytics/daily_revenue.rb
+- lib/algolia/models/analytics/daily_searches.rb
+- lib/algolia/models/analytics/daily_searches_no_clicks.rb
+- lib/algolia/models/analytics/daily_searches_no_results.rb
+- lib/algolia/models/analytics/daily_users.rb
 - lib/algolia/models/analytics/direction.rb
 - lib/algolia/models/analytics/error_base.rb
+- lib/algolia/models/analytics/get_add_to_cart_rate_response.rb
 - lib/algolia/models/analytics/get_average_click_position_response.rb
 - lib/algolia/models/analytics/get_click_positions_response.rb
 - lib/algolia/models/analytics/get_click_through_rate_response.rb
-- lib/algolia/models/analytics/get_conversation_rate_response.rb
+- lib/algolia/models/analytics/get_conversion_rate_response.rb
 - lib/algolia/models/analytics/get_no_click_rate_response.rb
 - lib/algolia/models/analytics/get_no_results_rate_response.rb
+- lib/algolia/models/analytics/get_purchase_rate_response.rb
+- lib/algolia/models/analytics/get_revenue.rb
 - lib/algolia/models/analytics/get_searches_count_response.rb
 - lib/algolia/models/analytics/get_searches_no_clicks_response.rb
 - lib/algolia/models/analytics/get_searches_no_results_response.rb
@@ -181,22 +194,21 @@ files:
 - lib/algolia/models/analytics/get_top_hits_response.rb
 - lib/algolia/models/analytics/get_top_searches_response.rb
 - lib/algolia/models/analytics/get_users_count_response.rb
-- lib/algolia/models/analytics/no_click_rate_event.rb
-- lib/algolia/models/analytics/no_results_rate_event.rb
+- lib/algolia/models/analytics/operator.rb
 - lib/algolia/models/analytics/order_by.rb
-- lib/algolia/models/analytics/search_event.rb
-- lib/algolia/models/analytics/search_no_click_event.rb
-- lib/algolia/models/analytics/search_no_result_event.rb
 - lib/algolia/models/analytics/top_country.rb
 - lib/algolia/models/analytics/top_hit.rb
 - lib/algolia/models/analytics/top_hit_with_analytics.rb
+- lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb
 - lib/algolia/models/analytics/top_hits_response.rb
 - lib/algolia/models/analytics/top_hits_response_with_analytics.rb
+- lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb
 - lib/algolia/models/analytics/top_search.rb
 - lib/algolia/models/analytics/top_search_with_analytics.rb
+- lib/algolia/models/analytics/top_search_with_revenue_analytics.rb
 - lib/algolia/models/analytics/top_searches_response.rb
 - lib/algolia/models/analytics/top_searches_response_with_analytics.rb
-- lib/algolia/models/analytics/user_with_date.rb
+- lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb
 - lib/algolia/models/ingestion/action_type.rb
 - lib/algolia/models/ingestion/auth_algolia.rb
 - lib/algolia/models/ingestion/auth_algolia_partial.rb
@@ -249,6 +261,7 @@ files:
 - lib/algolia/models/ingestion/list_sources_response.rb
 - lib/algolia/models/ingestion/list_tasks_response.rb
 - lib/algolia/models/ingestion/mapping_field_directive.rb
+- lib/algolia/models/ingestion/mapping_format_schema.rb
 - lib/algolia/models/ingestion/mapping_input.rb
 - lib/algolia/models/ingestion/mapping_kit_action.rb
 - lib/algolia/models/ingestion/mapping_type_csv.rb
@@ -340,7 +353,7 @@ files:
 - lib/algolia/models/insights/viewed_filters.rb
 - lib/algolia/models/insights/viewed_object_ids.rb
 - lib/algolia/models/monitoring/error_base.rb
-- lib/algolia/models/monitoring/get_inventory403_response.rb
+- lib/algolia/models/monitoring/get_servers403_response.rb
 - lib/algolia/models/monitoring/incident.rb
 - lib/algolia/models/monitoring/incidents_inner.rb
 - lib/algolia/models/monitoring/incidents_response.rb
@@ -368,6 +381,7 @@ files:
 - lib/algolia/models/personalization/get_user_token_response.rb
 - lib/algolia/models/personalization/personalization_strategy_params.rb
 - lib/algolia/models/personalization/set_personalization_strategy_response.rb
+- lib/algolia/models/query-suggestions/app_id.rb
 - lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb
 - lib/algolia/models/query-suggestions/base_query_suggestions_configuration_with_index.rb
 - lib/algolia/models/query-suggestions/base_response.rb