algolia 3.0.0.beta.6 → 3.0.0.beta.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b052211b4a0ecb74c42f11d50147460cf98a1aae441095e4c421800d611c1f0c
-  data.tar.gz: ce30bdefbd8703da5fc943ebdd24126874c05ad78368212e19e70138eea52f9e
+  metadata.gz: df1df29d4bb320313ff2e7f0c05a4b76a3d6188b9f08a692af7403dc6d99472b
+  data.tar.gz: 9b18848ff6241cde6f18523aa706303a4c74c4ec067631c922eecadc28d4c0be
 SHA512:
-  metadata.gz: 735dc36265137ffee7456a8cd0cfeb5c6607e56c71bb7595b9c113780661d24d48c2f9f37c8053dc9f5928097beb925a6211107c08f2a01d664e101c5795a346
-  data.tar.gz: ca760e5f13736c3ea825087a46bc9cc4013c98223700c5d140a412eac63559c746d62ca3d07aed6fef9663cf89ad0a349f9e627cd3fdea3608a70d619bdc470e
+  metadata.gz: 78c85cc136bdf8d52e43bc14a98c1c7ed54b0c0aa79ebf064610b0a658cb1eca4ec895fc31afbef3f7a8f618303336e339a09b82decc9c2fd2e4d5e91fd1978e
+  data.tar.gz: e13c8fcbc458cbaf053f88e3ccf6e87c1744d6dc91947f62a443b3d73aa3c254dc5ccc14adfe8b33c1648a50cd64ecef96f3b6a9975f4d66eb3c0767c5064bbb

data/.github/workflows/release.yml

@@ -24,4 +24,4 @@ jobs:
           ruby-version: 3.2.2
           bundler-cache: true
 
-      - uses: rubygems/release-gem@v1
+      - uses: rubygems/release-gem@612653d273a73bdae1df8453e090060bb4db5f31

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [3.0.0.beta.8](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.7...3.0.0.beta.8)
+
+- [9776cb3ba](https://github.com/algolia/api-clients-automation/commit/9776cb3ba) feat(specs): add redirect to renderingContent ([#3296](https://github.com/algolia/api-clients-automation/pull/3296)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.0.0.beta.7](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.6...3.0.0.beta.7)
+
+- [95e4c1e17](https://github.com/algolia/api-clients-automation/commit/95e4c1e17) chore(ruby): scope to last commit ([#3266](https://github.com/algolia/api-clients-automation/pull/3266)) by [@shortcuts](https://github.com/shortcuts/)
+- [8e98407c1](https://github.com/algolia/api-clients-automation/commit/8e98407c1) fix(clients): update ingestion transformations description and fix taggroups ([#3265](https://github.com/algolia/api-clients-automation/pull/3265)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [3.0.0.beta.6](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.5...3.0.0.beta.6)
 
 - [e5cfcf0c4](https://github.com/algolia/api-clients-automation/commit/e5cfcf0c4) feat(clients): generate common LICENSE ([#3258](https://github.com/algolia/api-clients-automation/pull/3258)) by [@shortcuts](https://github.com/shortcuts/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.beta.6)
+    algolia (3.0.0.beta.8)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
       net-http-persistent

data/lib/algolia/api/ingestion_client.rb

@@ -1934,7 +1934,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceWatchResponse')
     end
 
-    # Searches for transformations.
+    # Try a transformation.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -1968,7 +1968,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Searches for transformations.
+    # Try a transformation.
     #
     # Required API Key ACLs:
     #   - addObject

data/lib/algolia/api/query_suggestions_client.rb

@@ -37,13 +37,13 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param query_suggestions_configuration_with_index [QuerySuggestionsConfigurationWithIndex]  (required)
+    # @param configuration_with_index [ConfigurationWithIndex]  (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 create_config_with_http_info(query_suggestions_configuration_with_index, request_options = {})
-      # verify the required parameter 'query_suggestions_configuration_with_index' is set
-      if @api_client.config.client_side_validation && query_suggestions_configuration_with_index.nil?
-        raise ArgumentError, "Parameter `query_suggestions_configuration_with_index` is required when calling `create_config`."
+    def create_config_with_http_info(configuration_with_index, request_options = {})
+      # verify the required parameter 'configuration_with_index' is set
+      if @api_client.config.client_side_validation && configuration_with_index.nil?
+        raise ArgumentError, "Parameter `configuration_with_index` is required when calling `create_config`."
       end
 
       path = '/1/configs'
@@ -52,7 +52,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
 
-      post_body = request_options[:debug_body] || @api_client.object_to_http_body(query_suggestions_configuration_with_index)
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(configuration_with_index)
 
       new_options = request_options.merge(
         :operation => :'QuerySuggestionsClient.create_config',
@@ -69,11 +69,11 @@ module Algolia
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param query_suggestions_configuration_with_index [QuerySuggestionsConfigurationWithIndex]  (required)
+    # @param configuration_with_index [ConfigurationWithIndex]  (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 [BaseResponse]
-    def create_config(query_suggestions_configuration_with_index, request_options = {})
-      response = create_config_with_http_info(query_suggestions_configuration_with_index, request_options)
+    def create_config(configuration_with_index, request_options = {})
+      response = create_config_with_http_info(configuration_with_index, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
     end
 
@@ -328,10 +328,10 @@ module Algolia
     # Required API Key ACLs:
     #   - settings
     # @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 [Array<QuerySuggestionsConfigurationResponse>]
+    # @return [Array<ConfigurationResponse>]
     def get_all_configs(request_options = {})
       response = get_all_configs_with_http_info(request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<QuerySuggestions::QuerySuggestionsConfigurationResponse>')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<QuerySuggestions::ConfigurationResponse>')
     end
 
     # Retrieves a single Query Suggestions configuration by its index name.
@@ -372,10 +372,10 @@ module Algolia
     #   - settings
     # @param index_name [String] Query Suggestions index name. (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 [QuerySuggestionsConfigurationResponse]
+    # @return [ConfigurationResponse]
     def get_config(index_name, request_options = {})
       response = get_config_with_http_info(index_name, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::QuerySuggestionsConfigurationResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::ConfigurationResponse')
     end
 
     # Reports the status of a Query Suggestions index.
@@ -471,17 +471,17 @@ module Algolia
     # Required API Key ACLs:
     #   - editSettings
     # @param index_name [String] Query Suggestions index name. (required)
-    # @param query_suggestions_configuration [QuerySuggestionsConfiguration]  (required)
+    # @param configuration [Configuration]  (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 update_config_with_http_info(index_name, query_suggestions_configuration, request_options = {})
+    def update_config_with_http_info(index_name, configuration, request_options = {})
       # verify the required parameter 'index_name' is set
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `update_config`."
       end
-      # verify the required parameter 'query_suggestions_configuration' is set
-      if @api_client.config.client_side_validation && query_suggestions_configuration.nil?
-        raise ArgumentError, "Parameter `query_suggestions_configuration` is required when calling `update_config`."
+      # verify the required parameter 'configuration' is set
+      if @api_client.config.client_side_validation && configuration.nil?
+        raise ArgumentError, "Parameter `configuration` is required when calling `update_config`."
       end
 
       path = '/1/configs/{indexName}'.sub('{' + 'indexName' + '}', Transport.encode_uri(index_name.to_s))
@@ -490,7 +490,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
 
-      post_body = request_options[:debug_body] || @api_client.object_to_http_body(query_suggestions_configuration)
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(configuration)
 
       new_options = request_options.merge(
         :operation => :'QuerySuggestionsClient.update_config',
@@ -508,11 +508,11 @@ module Algolia
     # Required API Key ACLs:
     #   - editSettings
     # @param index_name [String] Query Suggestions index name. (required)
-    # @param query_suggestions_configuration [QuerySuggestionsConfiguration]  (required)
+    # @param configuration [Configuration]  (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 [BaseResponse]
-    def update_config(index_name, query_suggestions_configuration, request_options = {})
-      response = update_config_with_http_info(index_name, query_suggestions_configuration, request_options)
+    def update_config(index_name, configuration, request_options = {})
+      response = update_config_with_http_info(index_name, configuration, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
     end
   end

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

@@ -0,0 +1,258 @@
+# 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.
+
+require 'date'
+require 'time'
+
+module Algolia
+  module QuerySuggestions
+    # Query Suggestions configuration.
+    class Configuration
+      # Algolia indices from which to get the popular searches for query suggestions.
+      attr_accessor :source_indices
+
+      attr_accessor :languages
+
+      attr_accessor :exclude
+
+      # Whether to turn on personalized query suggestions.
+      attr_accessor :enable_personalization
+
+      # 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 => :sourceIndices,
+          :languages => :languages,
+          :exclude => :exclude,
+          :enable_personalization => :enablePersonalization,
+          :allow_special_characters => :allowSpecialCharacters
+        }
+      end
+
+      # Returns all the JSON keys this model knows about
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :source_indices => :'Array<SourceIndex>',
+          :languages => :Languages,
+          :exclude => :'Array<String>',
+          :enable_personalization => :Boolean,
+          :allow_special_characters => :Boolean
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([
+                  :exclude
+                ])
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Configuration` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::Configuration`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          end
+
+          h[k.to_sym] = v
+        end
+
+        if attributes.key?(:source_indices)
+          if (value = attributes[:source_indices]).is_a?(Array)
+            self.source_indices = value
+          end
+        else
+          self.source_indices = nil
+        end
+
+        if attributes.key?(:languages)
+          self.languages = attributes[:languages]
+        end
+
+        if attributes.key?(:exclude)
+          if (value = attributes[:exclude]).is_a?(Array)
+            self.exclude = value
+          end
+        end
+
+        if attributes.key?(:enable_personalization)
+          self.enable_personalization = attributes[:enable_personalization]
+        end
+
+        if attributes.key?(:allow_special_characters)
+          self.allow_special_characters = attributes[:allow_special_characters]
+        end
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] source_indices Value to be assigned
+      def source_indices=(source_indices)
+        if source_indices.nil?
+          raise ArgumentError, 'source_indices cannot be nil'
+        end
+
+        if source_indices.length < 1
+          raise ArgumentError, 'invalid value for "source_indices", number of items must be greater than or equal to 1.'
+        end
+
+        @source_indices = source_indices
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          source_indices == other.source_indices &&
+          languages == other.languages &&
+          exclude == other.exclude &&
+          enable_personalization == other.enable_personalization &&
+          allow_special_characters == other.allow_special_characters
+      end
+
+      # @see the `==` method
+      # @param [Object] Object to be compared
+      def eql?(other)
+        self == other
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code
+      def hash
+        [source_indices, languages, exclude, enable_personalization, allow_special_characters].hash
+      end
+
+      # Builds the object from hash
+      # @param [Hash] attributes Model attributes in the form of hash
+      # @return [Object] Returns the model itself
+      def self.build_from_hash(attributes)
+        return nil unless attributes.is_a?(Hash)
+
+        attributes = attributes.transform_keys(&:to_sym)
+        transformed_hash = {}
+        types_mapping.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = nil
+          elsif type =~ /\AArray<(.*)>/i
+            # check to ensure the input is an array given that the attribute
+            # is documented as an array but the input is not
+            if attributes[attribute_map[key]].is_a?(Array)
+              transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
+          end
+        end
+        new(transformed_hash)
+      end
+
+      # Deserializes the data based on type
+      # @param string type Data type
+      # @param string value Value to be deserialized
+      # @return [Object] Deserialized data
+      def self._deserialize(type, value)
+        case type.to_sym
+        when :Time
+          Time.parse(value)
+        when :Date
+          Date.parse(value)
+        when :String
+          value.to_s
+        when :Integer
+          value.to_i
+        when :Float
+          value.to_f
+        when :Boolean
+          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+            true
+          else
+            false
+          end
+        when :Object
+          # generic object (usually a Hash), return directly
+          value
+        when /\AArray<(?<inner_type>.+)>\z/
+          inner_type = Regexp.last_match[:inner_type]
+          value.map { |v| _deserialize(inner_type, v) }
+        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+          k_type = Regexp.last_match[:k_type]
+          v_type = Regexp.last_match[:v_type]
+          {}.tap do |hash|
+            value.each do |k, v|
+              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+            end
+          end
+        else # model
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::QuerySuggestions.const_get(type)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        end
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      # @return [Hash] Returns the object in the form of hash
+      def to_body
+        to_hash
+      end
+
+      def to_json(*_args)
+        to_hash.to_json
+      end
+
+      # Returns the object in the form of hash
+      # @return [Hash] Returns the object in the form of hash
+      def to_hash
+        hash = {}
+        self.class.attribute_map.each_pair do |attr, param|
+          value = send(attr)
+          if value.nil?
+            is_nullable = self.class.openapi_nullable.include?(attr)
+            next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+          end
+
+          hash[param] = _to_hash(value)
+        end
+        hash
+      end
+
+      # Outputs non-array value in the form of hash
+      # For object, use to_hash. Otherwise, just return the value
+      # @param [Object] value Any valid value
+      # @return [Hash] Returns the value in the form of hash
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.compact.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to? :to_hash
+          value.to_hash
+        else
+          value
+        end
+      end
+    end
+  end
+end