algolia 3.37.1 → 3.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba68c4db4558693366a3a03e5791f8a3319a65cd999eeb06384af77835908dd
-  data.tar.gz: ee5f89ee90d38548f080073ee7b2317f8f122b46dc4e27b14881459c29c1fa1f
+  metadata.gz: 04aeeacff2c4802f3be4f34616b67c94dda8985d3c3d8826b5f14e3dfd2331dd
+  data.tar.gz: bc1e57a05b971a50815a216fc8766e7c5d8d2b7361991d0c0644375e1cb88814
 SHA512:
-  metadata.gz: 06e52b23d46d08296c9f65bde34a4fce7e7f5f3eb9f06b841578371847d5d81d8f392c8f6ace00ebdfd98b5de987233d590b71af5ac43505e7869307c9ab5729
-  data.tar.gz: 394e21acd70914592158b1e301201728e7429e9da0376689ddb6b94c2642811a4855824c0f1f3dfc215a7be3e89c4a7400de1aae0311c355b42b70d887f38d6c
+  metadata.gz: a87390e2e06bd7d0bf3fab4ba0d01d0c9192cd425b16f94fdcebca0af41022fcf85c16cc8a30a987065a262c5d52a2645ccaf943c973e39a1e77eb3612df5470
+  data.tar.gz: 510cb212c879552f742247000e36b9fe91e5ff069fb9d69858b92608152f2fd47700dab3e0fee2e8bdcde0cb1824f6b2858c110c6d6333ecb90bf6a157cbdc30

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [3.38.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.37.1...3.38.0)
+
+BREAKING CHANGES: this minor version includes breaking changes in the Composition API. See below for more details.
+
+- [39ea2c5cb3](https://github.com/algolia/api-clients-automation/commit/39ea2c5cb3) refactor(specs): split injection schema ([#6224](https://github.com/algolia/api-clients-automation/pull/6224)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [544091a5f2](https://github.com/algolia/api-clients-automation/commit/544091a5f2) feat(specs): introduce recommend source in Comp API client ([#6227](https://github.com/algolia/api-clients-automation/pull/6227)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [f73d69aae4](https://github.com/algolia/api-clients-automation/commit/f73d69aae4) fix(specs): clarify getIndexingTime ([#6276](https://github.com/algolia/api-clients-automation/pull/6276)) by [@kai687](https://github.com/kai687/)
+- [e48d5c4bbf](https://github.com/algolia/api-clients-automation/commit/e48d5c4bbf) feat(specs): query categorization ([#6258](https://github.com/algolia/api-clients-automation/pull/6258)) by [@eric-zaharia](https://github.com/eric-zaharia/)
+
 ## [3.37.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.37.0...3.37.1)
 
 - [16b17eea7b](https://github.com/algolia/api-clients-automation/commit/16b17eea7b) fix(clients): add discriminator fields for InjectedItemSource oneOf ([#6170](https://github.com/algolia/api-clients-automation/pull/6170)) by [@eric-zaharia](https://github.com/eric-zaharia/)

data/Gemfile.lock

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

data/lib/algolia/api/monitoring_client.rb

@@ -343,7 +343,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Monitoring::IncidentsResponse")
     end
 
-    # Retrieves average times for indexing operations for selected clusters.
+    # Retrieves indexing latency metrics for selected clusters.  This endpoint is intended for infrastructure-level monitoring and availability checks. The returned value reflects latency measured on Algolia's internal monitoring index and is reported in milliseconds.  This metric isn't intended to represent the indexing performance of an individual application or index. To measure when an indexing operation has completed for your application, use the `waitTask` method.
 
     # @param clusters [String] Subset of clusters, separated by commas. (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)
@@ -373,7 +373,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Retrieves average times for indexing operations for selected clusters.
+    # Retrieves indexing latency metrics for selected clusters.  This endpoint is intended for infrastructure-level monitoring and availability checks. The returned value reflects latency measured on Algolia's internal monitoring index and is reported in milliseconds.  This metric isn't intended to represent the indexing performance of an individual application or index. To measure when an indexing operation has completed for your application, use the `waitTask` method.
 
     # @param clusters [String] Subset of clusters, separated by commas. (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)

data/lib/algolia/models/composition/{external.rb → injected_item_external.rb}

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module Composition
-    class External
+    class InjectedItemExternal
       # Composition Index name.
       attr_accessor :index
 
@@ -44,7 +44,10 @@ module Algolia
       # @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::External` initialize method"
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::InjectedItemExternal` initialize method"
+          )
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
@@ -52,7 +55,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::External`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::InjectedItemExternal`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/composition/{external_source.rb → injected_item_external_source.rb}

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     # Injected items will originate from externally provided objectIDs (that must exist in the index) given at runtime in the run request payload.
-    class ExternalSource
+    class InjectedItemExternalSource
       attr_accessor :external
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -28,7 +28,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :external => :"External"
+          :external => :"InjectedItemExternal"
         }
       end
 
@@ -45,7 +45,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::ExternalSource` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::InjectedItemExternalSource` initialize method"
           )
         end
 
@@ -54,7 +54,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::ExternalSource`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::InjectedItemExternalSource`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

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

@@ -0,0 +1,216 @@
+# 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
+    # Injected items will originate from a recommendation request performed on the specified index.
+    class InjectedItemRecommendSource
+      attr_accessor :recommend
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :recommend => :recommend
+        }
+      end
+
+      # Returns the keys that uniquely identify this oneOf variant when present
+      def self.discriminator_attributes
+        [
+          :recommend
+        ]
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :recommend => :"Recommend"
+        }
+      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::InjectedItemRecommendSource` 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::InjectedItemRecommendSource`. 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?(:recommend)
+          self.recommend = attributes[:recommend]
+        else
+          self.recommend = 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 &&
+          recommend == other.recommend
+      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
+        [recommend].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/{search.rb → injected_item_search.rb}

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module Composition
-    class Search
+    class InjectedItemSearch
       # Composition Index name.
       attr_accessor :index
 
@@ -40,7 +40,10 @@ module Algolia
       # @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::Search` initialize method"
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::InjectedItemSearch` initialize method"
+          )
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
@@ -48,7 +51,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::Search`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::InjectedItemSearch`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/composition/{search_source.rb → injected_item_search_source.rb}

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     # Injected items will originate from a search request performed on the specified index.
-    class SearchSource
+    class InjectedItemSearchSource
       attr_accessor :search
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -28,7 +28,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :search => :"Search"
+          :search => :"InjectedItemSearch"
         }
       end
 
@@ -45,7 +45,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::SearchSource` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::InjectedItemSearchSource` initialize method"
           )
         end
 
@@ -54,7 +54,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::SearchSource`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::InjectedItemSearchSource`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

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

@@ -12,8 +12,9 @@ module Algolia
       # List of class defined in oneOf (OpenAPI v3)
         def openapi_one_of
           [
-            :"ExternalSource",
-            :"SearchSource"
+            :"InjectedItemExternalSource",
+            :"InjectedItemRecommendSource",
+            :"InjectedItemSearchSource"
           ]
         end
 

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

@@ -27,8 +27,8 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :main => :"Main",
-          :injected_items => :"Array<InjectedItem>",
+          :main => :"InjectionMain",
+          :injected_items => :"Array<InjectionInjectedItem>",
           :deduplication => :"Deduplication"
         }
       end

data/lib/algolia/models/composition/{injected_item.rb → injection_injected_item.rb}

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module Composition
-    class InjectedItem
+    class InjectionInjectedItem
       # injected Item unique identifier.
       attr_accessor :key
 
@@ -54,7 +54,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::InjectedItem` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::InjectionInjectedItem` initialize method"
           )
         end
 
@@ -63,7 +63,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::InjectedItem`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::InjectionInjectedItem`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/composition/{main.rb → injection_main.rb}

@@ -7,7 +7,8 @@ require "time"
 
 module Algolia
   module Composition
-    class Main
+    # Main defines the organic result set of the injection.
+    class InjectionMain
       attr_accessor :source
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,7 +21,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :source => :"CompositionSource"
+          :source => :"InjectionMainSource"
         }
       end
 
@@ -35,7 +36,10 @@ module Algolia
       # @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::Main` initialize method"
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::InjectionMain` initialize method"
+          )
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
@@ -43,7 +47,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::Main`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::InjectionMain`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -53,8 +57,6 @@ module Algolia
 
         if attributes.key?(:source)
           self.source = attributes[:source]
-        else
-          self.source = nil
         end
       end