algolia 3.45.0 → 3.46.1

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

@@ -8,19 +8,19 @@ require "time"
 module Algolia
   module Composition
     class InjectedItemExternal
-      # Composition Index name.
+      # Algolia index used to retrieve records.
       attr_accessor :index
 
-      attr_accessor :params
-
       attr_accessor :ordering
 
+      attr_accessor :params
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :index => :index,
-          :params => :params,
-          :ordering => :ordering
+          :ordering => :ordering,
+          :params => :params
         }
       end
 
@@ -28,8 +28,8 @@ module Algolia
       def self.types_mapping
         {
           :index => :"String",
-          :params => :"BaseInjectionQueryParameters",
-          :ordering => :"ExternalOrdering"
+          :ordering => :"ExternalOrdering",
+          :params => :"BaseInjectionQueryParameters"
         }
       end
 
@@ -40,6 +40,13 @@ module Algolia
         )
       end
 
+      # List of class defined in allOf (OpenAPI v3)
+      def self.openapi_all_of
+        [
+          :"BaseExternalSource"
+        ]
+      end
+
       # Initializes the object
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})
@@ -69,13 +76,13 @@ module Algolia
           self.index = nil
         end
 
-        if attributes.key?(:params)
-          self.params = attributes[:params]
-        end
-
         if attributes.key?(:ordering)
           self.ordering = attributes[:ordering]
         end
+
+        if attributes.key?(:params)
+          self.params = attributes[:params]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -84,8 +91,8 @@ module Algolia
         return true if self.equal?(other)
         self.class == other.class &&
           index == other.index &&
-          params == other.params &&
-          ordering == other.ordering
+          ordering == other.ordering &&
+          params == other.params
       end
 
       # @see the `==` method
@@ -97,7 +104,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index, params, ordering].hash
+        [index, ordering, params].hash
       end
 
       # Builds the object from hash

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

@@ -0,0 +1,258 @@
+# 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
+    class InjectedItemExternalProvider
+      # Algolia index used to fetch the records.
+      attr_accessor :index
+
+      # Identifier of the external provider configuration.
+      attr_accessor :configuration_id
+
+      # Default values for the configuration placeholders that are not reserved Composition placeholders.
+      attr_accessor :configuration_params
+
+      attr_accessor :ordering
+
+      attr_accessor :params
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :index => :index,
+          :configuration_id => :configurationID,
+          :configuration_params => :configurationParams,
+          :ordering => :ordering,
+          :params => :params
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :index => :"String",
+          :configuration_id => :"String",
+          :configuration_params => :"Hash<String, Object>",
+          :ordering => :"ExternalProviderOrdering",
+          :params => :"BaseInjectionQueryParameters"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          []
+        )
+      end
+
+      # List of class defined in allOf (OpenAPI v3)
+      def self.openapi_all_of
+        [
+          :"BaseExternalProviderSource"
+        ]
+      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::InjectedItemExternalProvider` 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::InjectedItemExternalProvider`. 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?(:index)
+          self.index = attributes[:index]
+        else
+          self.index = nil
+        end
+
+        if attributes.key?(:configuration_id)
+          self.configuration_id = attributes[:configuration_id]
+        else
+          self.configuration_id = nil
+        end
+
+        if attributes.key?(:configuration_params)
+          if (value = attributes[:configuration_params]).is_a?(Hash)
+            self.configuration_params = value
+          end
+        end
+
+        if attributes.key?(:ordering)
+          self.ordering = attributes[:ordering]
+        end
+
+        if attributes.key?(:params)
+          self.params = attributes[:params]
+        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 &&
+          index == other.index &&
+          configuration_id == other.configuration_id &&
+          configuration_params == other.configuration_params &&
+          ordering == other.ordering &&
+          params == other.params
+      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
+        [index, configuration_id, configuration_params, ordering, params].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.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/injected_item_external_provider_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 request to an external provider configuration.
+    class InjectedItemExternalProviderSource
+      attr_accessor :external_provider
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :external_provider => :externalProvider
+        }
+      end
+
+      # Returns the keys that uniquely identify this oneOf variant when present
+      def self.discriminator_attributes
+        [
+          :externalProvider
+        ]
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :external_provider => :"InjectedItemExternalProvider"
+        }
+      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::InjectedItemExternalProviderSource` 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::InjectedItemExternalProviderSource`. 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?(:external_provider)
+          self.external_provider = attributes[:external_provider]
+        else
+          self.external_provider = 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 &&
+          external_provider == other.external_provider
+      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
+        [external_provider].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.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/injected_item_hits_metadata.rb

@@ -9,7 +9,7 @@ module Algolia
   module Composition
     # Adds the provided metadata to each injected hit via an `_extra` attribute.
     class InjectedItemHitsMetadata
-      # When true, the `_injectedItemKey` field is set in the `_extra` object of each affected hit.
+      # When true, each affected hit's `_extra` object includes an `_injectedItemKey` field identifying the injectedItem that inserted it. Defaults to false, meaning hits don't include `_injectedItemKey`. To identify injected hits without this flag, define your own key-value pairs in `extra`.
       attr_accessor :add_item_key
 
       # The user-defined key-value pairs that will be placed in the `_extra` field of each affected hit.

data/lib/algolia/models/composition/{recommend.rb → injected_item_recommend.rb}

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module Composition
-    class Recommend
+    class InjectedItemRecommend
       # Index to retrieve recommendations from.
       attr_accessor :index_name
 
@@ -49,13 +49,20 @@ module Algolia
         )
       end
 
+      # List of class defined in allOf (OpenAPI v3)
+      def self.openapi_all_of
+        [
+          :"BaseRecommendSource"
+        ]
+      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::Recommend` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::InjectedItemRecommend` initialize method"
           )
         end
 
@@ -64,7 +71,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::Recommend`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::InjectedItemRecommend`. 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

@@ -28,7 +28,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :recommend => :"Recommend"
+          :recommend => :"InjectedItemRecommend"
         }
       end
 

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

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     class InjectedItemSearch
-      # Composition Index name.
+      # Algolia index used to retrieve records.
       attr_accessor :index
 
       attr_accessor :params
@@ -36,6 +36,13 @@ module Algolia
         )
       end
 
+      # List of class defined in allOf (OpenAPI v3)
+      def self.openapi_all_of
+        [
+          :"BaseSearchSource"
+        ]
+      end
+
       # Initializes the object
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})

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

@@ -12,6 +12,7 @@ module Algolia
       # List of class defined in oneOf (OpenAPI v3)
         def openapi_one_of
           [
+            :"InjectedItemExternalProviderSource",
             :"InjectedItemExternalSource",
             :"InjectedItemRecommendSource",
             :"InjectedItemSearchSource"