algolia 3.35.1 → 3.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7319119e646ce2ddd4ae9c3752f51e2c43c9b749692366b39923e76739d35a3
-  data.tar.gz: b0a4f259d562b26a79823bd7a88e7609012a542e92c40ebe92446594fa50e7d4
+  metadata.gz: ae127d06f4d82e06e99b2697521f170d54e77851e47dc1e3b63014000914eb6e
+  data.tar.gz: cbaea35422d64b83c629bd92bd7e978fee9da387de753674e56bd10bfb8d428f
 SHA512:
-  metadata.gz: 41c7e5e8a0886a04a85e57c22284c691b7c5fd4a99bcd48735ec689c67f0e56338d95a5217a0a0d3551c483ac7f1b7fae0e5a3e7bd5cf5cd9dbebf5bd3b1439f
-  data.tar.gz: 4cae09ffbd9b1d8bbbd4b07846f1f0ed773db05534a6f7a4639412a95ad6753fe340439892e272bfa709dbb2e137f88e1c34dd29e69180d34799c4b79aa47e86
+  metadata.gz: 734675dad4d3917bb2670bf4de13d2f4e7dae27e381987c95128eb5d2a6fb79255bfb866654fe9dd4cc3bc79da00938db29d112620aab1d9c2e0d9720ec67288
+  data.tar.gz: ac63fcdc27e5162fcd044b0f4936e92c9dea875d4ddb1f7a510c1ca6985336a4d824fab90780ec5d96206176c1814d0feae3b061d141f244c6350e574fdfe760

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [3.36.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.35.1...3.36.0)
+
+- [93c834fee](https://github.com/algolia/api-clients-automation/commit/93c834fee) feat(specs): add optional feedID to composition result set ([#5991](https://github.com/algolia/api-clients-automation/pull/5991)) by [@gavinwade12](https://github.com/gavinwade12/)
+- [9aafd690b](https://github.com/algolia/api-clients-automation/commit/9aafd690b) fix(specs): invalid API format for multi feed in Comp API ([#5993](https://github.com/algolia/api-clients-automation/pull/5993)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+
 ## [3.35.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.35.0...3.35.1)
 
 - [46be49a3f](https://github.com/algolia/api-clients-automation/commit/46be49a3f) docs(specs): align with style guides ([#5930](https://github.com/algolia/api-clients-automation/pull/5930)) by [@kai687](https://github.com/kai687/)

data/Gemfile.lock

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

data/lib/algolia/models/composition/feed_injection.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+# 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 Composition
+    # Feed formatted as an injection.
+    class FeedInjection
+      attr_accessor :injection
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :injection => :injection
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :injection => :"Injection"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          []
+        )
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::FeedInjection` initialize method"
+          )
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) { |(k, v), h|
+          if (!self.class.attribute_map.key?(k.to_sym))
+            raise(
+              ArgumentError,
+              "`#{k}` is not a valid attribute in `Algolia::FeedInjection`. 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
+        }
+
+        if attributes.key?(:injection)
+          self.injection = attributes[:injection]
+        else
+          self.injection = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if self.equal?(other)
+        self.class == other.class &&
+          injection == other.injection
+      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
+        [injection].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
+          # model
+        else
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::Composition.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

data/lib/algolia/models/composition/multifeed.rb

@@ -25,7 +25,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :feeds => :"Hash<String, Injection>",
+          :feeds => :"Hash<String, FeedInjection>",
           :feeds_order => :"Array<String>"
         }
       end

data/lib/algolia/models/composition/search_results_item.rb

@@ -104,6 +104,9 @@ module Algolia
       # The search query string.
       attr_accessor :query
 
+      # The ID of the feed.
+      attr_accessor :feed_id
+
       attr_accessor :compositions
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -142,6 +145,7 @@ module Algolia
           :page => :page,
           :params => :params,
           :query => :query,
+          :feed_id => :feedID,
           :compositions => :compositions
         }
       end
@@ -182,6 +186,7 @@ module Algolia
           :page => :"Integer",
           :params => :"String",
           :query => :"String",
+          :feed_id => :"String",
           :compositions => :"Hash<String, ResultsCompositionInfoResponse>"
         }
       end
@@ -367,6 +372,10 @@ module Algolia
           self.query = attributes[:query]
         end
 
+        if attributes.key?(:feed_id)
+          self.feed_id = attributes[:feed_id]
+        end
+
         if attributes.key?(:compositions)
           if (value = attributes[:compositions]).is_a?(Hash)
             self.compositions = value
@@ -414,6 +423,7 @@ module Algolia
           page == other.page &&
           params == other.params &&
           query == other.query &&
+          feed_id == other.feed_id &&
           compositions == other.compositions
       end
 
@@ -460,6 +470,7 @@ module Algolia
           page,
           params,
           query,
+          feed_id,
           compositions
         ].hash
       end

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.35.1"
+  VERSION = "3.36.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.35.1
+  version: 3.36.0
 platform: ruby
 authors:
 - https://alg.li/support
@@ -301,6 +301,7 @@ files:
 - lib/algolia/models/composition/facet_hits.rb
 - lib/algolia/models/composition/facet_ordering.rb
 - lib/algolia/models/composition/facet_stats.rb
+- lib/algolia/models/composition/feed_injection.rb
 - lib/algolia/models/composition/get_task_response.rb
 - lib/algolia/models/composition/highlight_result.rb
 - lib/algolia/models/composition/highlight_result_option.rb