algolia 3.17.0 → 3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 521adda141013797559fd8a63d02d994dee5f1a27b34c48bbab39662b91bd881
-  data.tar.gz: 3eda8b67c4f45021d8f568c8982e5123b1812150e655aea093fe0beb1f29f32d
+  metadata.gz: 9cfef852f09fa892158dfa5646a677e6f5bd6a47aa649d79fe72e300585a69a2
+  data.tar.gz: 56d4eaeff8861511b24bb147044242d50db46efdf8316c2948507eae857d7574
 SHA512:
-  metadata.gz: 1b545493edbbf9c2a00917a13bd5fa5f2bc976a32133c712492d66d18a715bcb10a9e483fcd252c954ca67f7c191ff781e0581060461c2cff1b09f8917eda610
-  data.tar.gz: 2f6a075730cba33eb21bbdced80c7c2f99242f356535f713bfe4acfa9f4bdad1edbd4671a5c8dfcae16beeaed757c53b259865b830ed7ee5457a4570d071c6dd
+  metadata.gz: 3d7b274ed915307ed33e727e98d8203be3b1617bd12fa5969e6db593079616ead2de5ce062e8fc17c605e64777c6da7695eb5b92bfaa3305598032f33c61e9fe
+  data.tar.gz: 4b0149c96e2a05b5c8cbca0d336fadb398fa28e939909526c0d340d841a9ede02b79dc3695084f465d004412450448e56dbac727d40fe6d5e8f6f8b867c6b083

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [3.18.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.17.0...3.18.0)
+
+- [835daccb48](https://github.com/algolia/api-clients-automation/commit/835daccb48) feat(specs): add with transformation helpers ([#4931](https://github.com/algolia/api-clients-automation/pull/4931)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [3.17.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.16.0...3.17.0)
 
 - [9db03b532b](https://github.com/algolia/api-clients-automation/commit/9db03b532b) fix(specs): typo ([#4854](https://github.com/algolia/api-clients-automation/pull/4854)) by [@kai687](https://github.com/kai687/)

data/Gemfile.lock

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

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

@@ -14,13 +14,13 @@ module Algolia
       # Universally unique identifier (UUID) of an event.
       attr_accessor :event_id
 
-      # when used with discovering or validating sources, the sampled data of your source is returned.
+      # This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.
       attr_accessor :data
 
-      # in case of error, observability events will be added to the response, if any.
+      # in case of error, observability events will be added to the response.
       attr_accessor :events
 
-      # a message describing the outcome of a validate run.
+      # a message describing the outcome of the operation that has been ran (push, discover or validate) run.
       attr_accessor :message
 
       # Date of creation in RFC 3339 format.

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

@@ -0,0 +1,281 @@
+# 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 Search
+    # An event describe a step of the task execution flow..
+    class Event
+      # Universally unique identifier (UUID) of an event.
+      attr_accessor :event_id
+
+      # Universally unique identifier (UUID) of a task run.
+      attr_accessor :run_id
+
+      attr_accessor :status
+
+      attr_accessor :type
+
+      # The extracted record batch size.
+      attr_accessor :batch_size
+
+      attr_accessor :data
+
+      # Date of publish RFC 3339 format.
+      attr_accessor :published_at
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :event_id => :eventID,
+          :run_id => :runID,
+          :status => :status,
+          :type => :type,
+          :batch_size => :batchSize,
+          :data => :data,
+          :published_at => :publishedAt
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :event_id => :"String",
+          :run_id => :"String",
+          :status => :"EventStatus",
+          :type => :"EventType",
+          :batch_size => :"Integer",
+          :data => :"Hash<String, Object>",
+          :published_at => :"String"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          [
+            :status,
+            :data
+          ]
+        )
+      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::Event` 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::Event`. 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?(:event_id)
+          self.event_id = attributes[:event_id]
+        else
+          self.event_id = nil
+        end
+
+        if attributes.key?(:run_id)
+          self.run_id = attributes[:run_id]
+        else
+          self.run_id = nil
+        end
+
+        if attributes.key?(:status)
+          self.status = attributes[:status]
+        else
+          self.status = nil
+        end
+
+        if attributes.key?(:type)
+          self.type = attributes[:type]
+        else
+          self.type = nil
+        end
+
+        if attributes.key?(:batch_size)
+          self.batch_size = attributes[:batch_size]
+        else
+          self.batch_size = nil
+        end
+
+        if attributes.key?(:data)
+          if (value = attributes[:data]).is_a?(Hash)
+            self.data = value
+          end
+        end
+
+        if attributes.key?(:published_at)
+          self.published_at = attributes[:published_at]
+        else
+          self.published_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 &&
+          event_id == other.event_id &&
+          run_id == other.run_id &&
+          status == other.status &&
+          type == other.type &&
+          batch_size == other.batch_size &&
+          data == other.data &&
+          published_at == other.published_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
+        [event_id, run_id, status, type, batch_size, data, published_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::Search.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/search/event_status.rb

@@ -0,0 +1,38 @@
+# 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 Search
+    class EventStatus
+      CREATED = "created".freeze
+      STARTED = "started".freeze
+      RETRIED = "retried".freeze
+      FAILED = "failed".freeze
+      SUCCEEDED = "succeeded".freeze
+      CRITICAL = "critical".freeze
+
+      def self.all_vars
+        @all_vars ||= [CREATED, STARTED, RETRIED, FAILED, SUCCEEDED, CRITICAL].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if EventStatus.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #EventStatus"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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 Search
+    class EventType
+      FETCH = "fetch".freeze
+      RECORD = "record".freeze
+      LOG = "log".freeze
+      TRANSFORM = "transform".freeze
+
+      def self.all_vars
+        @all_vars ||= [FETCH, RECORD, LOG, TRANSFORM].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if EventType.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #EventType"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,265 @@
+# 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 Search
+    class WatchResponse
+      # Universally unique identifier (UUID) of a task run.
+      attr_accessor :run_id
+
+      # Universally unique identifier (UUID) of an event.
+      attr_accessor :event_id
+
+      # This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.
+      attr_accessor :data
+
+      # in case of error, observability events will be added to the response.
+      attr_accessor :events
+
+      # a message describing the outcome of the operation that has been ran (push, discover or validate) run.
+      attr_accessor :message
+
+      # 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
+        {
+          :run_id => :runID,
+          :event_id => :eventID,
+          :data => :data,
+          :events => :events,
+          :message => :message,
+          :created_at => :createdAt
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :run_id => :"String",
+          :event_id => :"String",
+          :data => :"Array<Object>",
+          :events => :"Array<Event>",
+          :message => :"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::WatchResponse` 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::WatchResponse`. 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?(:run_id)
+          self.run_id = attributes[:run_id]
+        else
+          self.run_id = nil
+        end
+
+        if attributes.key?(:event_id)
+          self.event_id = attributes[:event_id]
+        end
+
+        if attributes.key?(:data)
+          if (value = attributes[:data]).is_a?(Array)
+            self.data = value
+          end
+        end
+
+        if attributes.key?(:events)
+          if (value = attributes[:events]).is_a?(Array)
+            self.events = value
+          end
+        end
+
+        if attributes.key?(:message)
+          self.message = attributes[:message]
+        end
+
+        if attributes.key?(:created_at)
+          self.created_at = attributes[:created_at]
+        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 &&
+          run_id == other.run_id &&
+          event_id == other.event_id &&
+          data == other.data &&
+          events == other.events &&
+          message == other.message &&
+          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
+        [run_id, event_id, data, events, message, 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::Search.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/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.17.0"
+  VERSION = "3.18.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 3.18.0
 platform: ruby
 authors:
 - https://alg.li/support
@@ -626,6 +626,9 @@ files:
 - lib/algolia/models/search/edit.rb
 - lib/algolia/models/search/edit_type.rb
 - lib/algolia/models/search/error_base.rb
+- lib/algolia/models/search/event.rb
+- lib/algolia/models/search/event_status.rb
+- lib/algolia/models/search/event_type.rb
 - lib/algolia/models/search/exact_on_single_word_query.rb
 - lib/algolia/models/search/exhaustive.rb
 - lib/algolia/models/search/facet_filters.rb
@@ -735,6 +738,7 @@ files:
 - lib/algolia/models/search/user_hit.rb
 - lib/algolia/models/search/user_id.rb
 - lib/algolia/models/search/value.rb
+- lib/algolia/models/search/watch_response.rb
 - lib/algolia/models/search/widgets.rb
 - lib/algolia/transport/call_type.rb
 - lib/algolia/transport/echo_requester.rb