algolia 3.10.2 → 3.12.0

data/lib/algolia/models/analytics/top_country.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -20,11 +22,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_hit.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -6,7 +8,7 @@ require "time"
 module Algolia
   module Analytics
     class TopHit
-      # Object ID of a record that's returned as a search result.
+      # Object ID of a record returned as a search result.
       attr_accessor :hit
 
       # Number of occurrences.
@@ -20,11 +22,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_hit_with_analytics.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -6,16 +8,16 @@ require "time"
 module Algolia
   module Analytics
     class TopHitWithAnalytics
-      # Object ID of a record that's returned as a search result.
+      # Object ID of a record returned as a search result.
       attr_accessor :hit
 
       # Number of occurrences.
       attr_accessor :count
 
-      # Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :click_through_rate
 
-      # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :conversion_rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
@@ -40,11 +42,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -6,16 +8,16 @@ require "time"
 module Algolia
   module Analytics
     class TopHitWithRevenueAnalytics
-      # Object ID of a record that's returned as a search result.
+      # Object ID of a record returned as a search result.
       attr_accessor :hit
 
       # Number of occurrences.
       attr_accessor :count
 
-      # Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :click_through_rate
 
-      # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :conversion_rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
@@ -27,19 +29,19 @@ module Algolia
       # Number of conversions from this search.
       attr_accessor :conversion_count
 
-      # Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :add_to_cart_rate
 
       # Number of add-to-cart events from this search.
       attr_accessor :add_to_cart_count
 
-      # Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :purchase_rate
 
       # Number of purchase events from this search.
       attr_accessor :purchase_count
 
-      # Revenue associated with this search, broken-down by currencies.
+      # Revenue associated with this search: broken down by currency.
       attr_accessor :currencies
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -60,11 +62,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_hits_response.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -16,11 +18,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -16,11 +18,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -16,11 +18,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_search.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -24,11 +26,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_search_with_analytics.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -12,7 +14,7 @@ module Algolia
       # Number of searches.
       attr_accessor :count
 
-      # Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :click_through_rate
 
       # Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
@@ -21,7 +23,7 @@ module Algolia
       # List of positions in the search results and clicks associated with this search.
       attr_accessor :click_positions
 
-      # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :conversion_rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
@@ -52,11 +54,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -12,7 +14,7 @@ module Algolia
       # Number of searches.
       attr_accessor :count
 
-      # Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :click_through_rate
 
       # Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
@@ -21,7 +23,7 @@ module Algolia
       # List of positions in the search results and clicks associated with this search.
       attr_accessor :click_positions
 
-      # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :conversion_rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
@@ -36,16 +38,16 @@ module Algolia
       # Number of results (hits).
       attr_accessor :nb_hits
 
-      # Revenue associated with this search, broken-down by currencies.
+      # Revenue associated with this search: broken down by currency.
       attr_accessor :currencies
 
-      # Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :add_to_cart_rate
 
       # Number of add-to-cart events from this search.
       attr_accessor :add_to_cart_count
 
-      # Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      # Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :purchase_rate
 
       # Number of purchase events from this search.
@@ -72,11 +74,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_searches_response.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -16,11 +18,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -16,11 +18,6 @@ module Algolia
         }
       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
         {

data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb

@@ -1,3 +1,5 @@
+# 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"
@@ -16,11 +18,6 @@ module Algolia
         }
       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
         {

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

@@ -0,0 +1,110 @@
+# 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
+    # Precision of a coordinate-based search in meters to group results with similar distances.  The Geo ranking criterion considers all matches within the same range of distances to be equal.
+    module AroundPrecision
+      class << self
+      # List of class defined in oneOf (OpenAPI v3)
+        def openapi_one_of
+          [
+            :"Array<Range>",
+            :"Integer"
+          ]
+        end
+
+        # Builds the object
+        # @param [Mixed] Data to be matched against the list of oneOf items
+        # @return [Object] Returns the model or the data itself
+        def build(data)
+          # Go through the list of oneOf items and attempt to identify the appropriate one.
+          # Note:
+          # - We do not attempt to check whether exactly one item matches.
+          # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+          #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+          # - TODO: scalar values are de facto behaving as if they were nullable.
+          # - TODO: logging when debugging is set.
+          openapi_one_of.each do |klass|
+            begin
+              # "nullable: true"
+              next if klass == :AnyType
+              typed_data = find_and_cast_into_type(klass, data)
+              return typed_data if typed_data
+              # rescue all errors so we keep iterating even if the current item lookup raises
+            rescue
+            end
+          end
+
+          openapi_one_of.include?(:AnyType) ? data : nil
+        end
+
+        private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when "Boolean"
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when "Float"
+            return data if data.instance_of?(Float)
+          when "Integer"
+            return data if data.instance_of?(Integer)
+          when "Time"
+            return Time.parse(data)
+          when "Date"
+            return Date.parse(data)
+          when "String"
+            return data if data.instance_of?(String)
+            # "type: object"
+          when "Object"
+            return data if data.instance_of?(Hash)
+            # "type: array"
+          when /\AArray<(?<sub_type>.+)>\z/
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+            # "type: object" with "additionalProperties: { ... }"
+          when /\AHash<String, (?<sub_type>.+)>\z/
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+            # model
+          else
+            const = Algolia::Composition.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of)
+                # nested oneOf model
+                model = const.build(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
+              else
+                # maybe it's an enum, or doens't have discriminators
+                model = const.build_from_hash(data)
+              end
+
+              return model if model
+            end
+          end
+
+          # if no match by now, raise
+          raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,110 @@
+# 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
+    # Maximum radius for a search around a central location.  This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
+    module AroundRadius
+      class << self
+      # List of class defined in oneOf (OpenAPI v3)
+        def openapi_one_of
+          [
+            :"AroundRadiusAll",
+            :"Integer"
+          ]
+        end
+
+        # Builds the object
+        # @param [Mixed] Data to be matched against the list of oneOf items
+        # @return [Object] Returns the model or the data itself
+        def build(data)
+          # Go through the list of oneOf items and attempt to identify the appropriate one.
+          # Note:
+          # - We do not attempt to check whether exactly one item matches.
+          # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+          #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+          # - TODO: scalar values are de facto behaving as if they were nullable.
+          # - TODO: logging when debugging is set.
+          openapi_one_of.each do |klass|
+            begin
+              # "nullable: true"
+              next if klass == :AnyType
+              typed_data = find_and_cast_into_type(klass, data)
+              return typed_data if typed_data
+              # rescue all errors so we keep iterating even if the current item lookup raises
+            rescue
+            end
+          end
+
+          openapi_one_of.include?(:AnyType) ? data : nil
+        end
+
+        private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when "Boolean"
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when "Float"
+            return data if data.instance_of?(Float)
+          when "Integer"
+            return data if data.instance_of?(Integer)
+          when "Time"
+            return Time.parse(data)
+          when "Date"
+            return Date.parse(data)
+          when "String"
+            return data if data.instance_of?(String)
+            # "type: object"
+          when "Object"
+            return data if data.instance_of?(Hash)
+            # "type: array"
+          when /\AArray<(?<sub_type>.+)>\z/
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+            # "type: object" with "additionalProperties: { ... }"
+          when /\AHash<String, (?<sub_type>.+)>\z/
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+            # model
+          else
+            const = Algolia::Composition.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of)
+                # nested oneOf model
+                model = const.build(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
+              else
+                # maybe it's an enum, or doens't have discriminators
+                model = const.build_from_hash(data)
+              end
+
+              return model if model
+            end
+          end
+
+          # if no match by now, raise
+          raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+      end
+    end
+
+  end
+end

data/lib/algolia/models/{ingestion/docker_registry.rb → composition/around_radius_all.rb}

@@ -1,16 +1,17 @@
+# 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 Ingestion
-    class DockerRegistry
-      DOCKERHUB = "dockerhub".freeze
-      GHCR = "ghcr".freeze
+  module Composition
+    class AroundRadiusAll
+      ALL = "all".freeze
 
       def self.all_vars
-        @all_vars ||= [DOCKERHUB, GHCR].freeze
+        @all_vars ||= [ALL].freeze
       end
 
       # Builds the enum from string
@@ -24,8 +25,8 @@ module Algolia
       # @param [String] The enum value in the form of the string
       # @return [String] The enum value
       def build_from_hash(value)
-        return value if DockerRegistry.all_vars.include?(value)
-        raise "Invalid ENUM value #{value} for class #DockerRegistry"
+        return value if AroundRadiusAll.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #AroundRadiusAll"
       end
     end
   end