algolia 3.0.0.beta.12 → 3.0.0.beta.14

data/lib/algolia/models/ingestion/run_source_payload.rb

@@ -0,0 +1,269 @@
+# 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 Ingestion
+    class RunSourcePayload
+      # List of index names to include in reidexing/update.
+      attr_accessor :index_to_include
+
+      # List of index names to exclude in reidexing/update.
+      attr_accessor :index_to_exclude
+
+      # List of entityID to update.
+      attr_accessor :entity_ids
+
+      attr_accessor :entity_type
+
+      class EnumAttributeValidator
+        attr_reader :datatype
+        attr_reader :allowable_values
+
+        def initialize(datatype, allowable_values)
+          @allowable_values = allowable_values.map do |value|
+            case datatype.to_s
+            when /Integer/i
+              value.to_i
+            when /Float/i
+              value.to_f
+            else
+              value
+            end
+          end
+        end
+
+        def valid?(value)
+          !value || allowable_values.include?(value)
+        end
+      end
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :index_to_include => :indexToInclude,
+          :index_to_exclude => :indexToExclude,
+          :entity_ids => :entityIDs,
+          :entity_type => :entityType
+        }
+      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
+        {
+          :index_to_include => :"Array<String>",
+          :index_to_exclude => :"Array<String>",
+          :entity_ids => :"Array<String>",
+          :entity_type => :"EntityType"
+        }
+      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::RunSourcePayload` 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::RunSourcePayload`. 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_to_include)
+          if (value = attributes[:index_to_include]).is_a?(Array)
+            self.index_to_include = value
+          end
+        end
+
+        if attributes.key?(:index_to_exclude)
+          if (value = attributes[:index_to_exclude]).is_a?(Array)
+            self.index_to_exclude = value
+          end
+        end
+
+        if attributes.key?(:entity_ids)
+          if (value = attributes[:entity_ids]).is_a?(Array)
+            self.entity_ids = value
+          end
+        end
+
+        if attributes.key?(:entity_type)
+          self.entity_type = attributes[:entity_type]
+        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_to_include == other.index_to_include &&
+          index_to_exclude == other.index_to_exclude &&
+          entity_ids == other.entity_ids &&
+          entity_type == other.entity_type
+      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_to_include, index_to_exclude, entity_ids, entity_type].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::Ingestion.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/ingestion/run_source_response.rb

@@ -0,0 +1,228 @@
+# 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 Ingestion
+    class RunSourceResponse
+      # Map of taskID sent for reindex with the corresponding runID.
+      attr_accessor :task_with_run_id
+
+      # Date of creation in RFC 3339 format.
+      attr_accessor :created_at
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :task_with_run_id => :taskWithRunID,
+          :created_at => :createdAt
+        }
+      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
+        {
+          :task_with_run_id => :"Hash<String, String>",
+          :created_at => :"String"
+        }
+      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::RunSourceResponse` 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::RunSourceResponse`. 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?(:task_with_run_id)
+          if (value = attributes[:task_with_run_id]).is_a?(Hash)
+            self.task_with_run_id = value
+          end
+        else
+          self.task_with_run_id = nil
+        end
+
+        if attributes.key?(:created_at)
+          self.created_at = attributes[:created_at]
+        else
+          self.created_at = 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 &&
+          task_with_run_id == other.task_with_run_id &&
+          created_at == other.created_at
+      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
+        [task_with_run_id, created_at].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::Ingestion.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/ingestion/{destination_index_prefix.rb → transformation_models.rb}

@@ -5,14 +5,14 @@ require "time"
 
 module Algolia
   module Ingestion
-    class DestinationIndexPrefix
-      # String added to the beginning of all indices created by this destination.
-      attr_accessor :index_prefix
+    # List of available AI models for transformation purposes.
+    class TransformationModels
+      attr_accessor :llms
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :index_prefix => :indexPrefix
+          :llms => :llms
         }
       end
 
@@ -24,7 +24,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :index_prefix => :"String"
+          :llms => :"Array<Model>"
         }
       end
 
@@ -41,7 +41,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::DestinationIndexPrefix` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::TransformationModels` initialize method"
           )
         end
 
@@ -50,7 +50,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::DestinationIndexPrefix`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::TransformationModels`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -58,10 +58,12 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:index_prefix)
-          self.index_prefix = attributes[:index_prefix]
+        if attributes.key?(:llms)
+          if (value = attributes[:llms]).is_a?(Array)
+            self.llms = value
+          end
         else
-          self.index_prefix = nil
+          self.llms = nil
         end
       end
 
@@ -70,7 +72,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          index_prefix == other.index_prefix
+          llms == other.llms
       end
 
       # @see the `==` method
@@ -82,7 +84,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_prefix].hash
+        [llms].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/transformation_search.rb

@@ -6,12 +6,12 @@ require "time"
 module Algolia
   module Ingestion
     class TransformationSearch
-      attr_accessor :transformations_ids
+      attr_accessor :transformation_ids
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :transformations_ids => :transformationsIDs
+          :transformation_ids => :transformationIDs
         }
       end
 
@@ -23,7 +23,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :transformations_ids => :"Array<String>"
+          :transformation_ids => :"Array<String>"
         }
       end
 
@@ -57,12 +57,10 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:transformations_ids)
-          if (value = attributes[:transformations_ids]).is_a?(Array)
-            self.transformations_ids = value
+        if attributes.key?(:transformation_ids)
+          if (value = attributes[:transformation_ids]).is_a?(Array)
+            self.transformation_ids = value
           end
-        else
-          self.transformations_ids = nil
         end
       end
 
@@ -71,7 +69,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          transformations_ids == other.transformations_ids
+          transformation_ids == other.transformation_ids
       end
 
       # @see the `==` method
@@ -83,7 +81,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [transformations_ids].hash
+        [transformation_ids].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/search/dictionary_entry.rb

@@ -23,6 +23,8 @@ module Algolia
 
       attr_accessor :state
 
+      attr_accessor :type
+
       attr_accessor :additional_properties
 
       class EnumAttributeValidator
@@ -55,7 +57,8 @@ module Algolia
           :word => :word,
           :words => :words,
           :decomposition => :decomposition,
-          :state => :state
+          :state => :state,
+          :type => :type
         }
       end
 
@@ -72,7 +75,8 @@ module Algolia
           :word => :"String",
           :words => :"Array<String>",
           :decomposition => :"Array<String>",
-          :state => :"DictionaryEntryState"
+          :state => :"DictionaryEntryState",
+          :type => :"DictionaryEntryType"
         }
       end
 
@@ -123,6 +127,10 @@ module Algolia
           self.state = attributes[:state]
         end
 
+        if attributes.key?(:type)
+          self.type = attributes[:type]
+        end
+
         # add extra attribute to additional_properties
         self.additional_properties ||= {}
         self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
@@ -138,7 +146,8 @@ module Algolia
           word == other.word &&
           words == other.words &&
           decomposition == other.decomposition &&
-          state == other.state
+          state == other.state &&
+          type == other.type
       end
 
       # @see the `==` method
@@ -150,7 +159,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [object_id, language, word, words, decomposition, state].hash
+        [object_id, language, word, words, decomposition, state, type].hash
       end
 
       # Builds the object from hash