algolia 3.0.0.beta.10 → 3.0.0.beta.12

data/lib/algolia/api/query_suggestions_client.rb

@@ -428,13 +428,10 @@ module Algolia
     #   - settings
     # @param index_name [String] Query Suggestions index name. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [GetConfigStatus200Response]
+    # @return [ConfigStatus]
     def get_config_status(index_name, request_options = {})
       response = get_config_status_with_http_info(index_name, request_options)
-      @api_client.deserialize(
-        response.body,
-        request_options[:debug_return_type] || "QuerySuggestions::GetConfigStatus200Response"
-      )
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "QuerySuggestions::ConfigStatus")
     end
 
     # Retrieves the logs for a single Query Suggestions index.
@@ -475,13 +472,10 @@ module Algolia
     #   - settings
     # @param index_name [String] Query Suggestions index name. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [GetLogFile200Response]
+    # @return [LogFile]
     def get_log_file(index_name, request_options = {})
       response = get_log_file_with_http_info(index_name, request_options)
-      @api_client.deserialize(
-        response.body,
-        request_options[:debug_return_type] || "QuerySuggestions::GetLogFile200Response"
-      )
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "QuerySuggestions::LogFile")
     end
 
     # Updates a QuerySuggestions configuration.

data/lib/algolia/api/search_client.rb

@@ -1389,10 +1389,10 @@ module Algolia
     # @param object_id [String] Unique record identifier. (required)
     # @param attributes_to_retrieve [Array<String>] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  &#x60;objectID&#x60; is always retrieved.  Attributes included in &#x60;unretrievableAttributes&#x60; won&#39;t be retrieved unless the request is authenticated with the admin API key.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [Hash<String, String>]
+    # @return [Object]
     def get_object(index_name, object_id, attributes_to_retrieve = nil, request_options = {})
       response = get_object_with_http_info(index_name, object_id, attributes_to_retrieve, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Hash<String, String>")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Object")
     end
 
     # Retrieves one or more records, potentially from different indices.  Records are returned in the same order as the requests.
@@ -1529,10 +1529,10 @@ module Algolia
     #   - search
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [IndexSettings]
+    # @return [SettingsResponse]
     def get_settings(index_name, request_options = {})
       response = get_settings_with_http_info(index_name, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::IndexSettings")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SettingsResponse")
     end
 
     # Retrieves all allowed IP addresses with access to your application.

data/lib/algolia/api/usage_client.rb

@@ -275,7 +275,7 @@ module Algolia
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. (required)
     # @param granularity [Granularity] Granularity of the aggregated metrics.  - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days.  (default to 'daily')
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [GetUsage200Response]
+    # @return [IndexUsage]
     def get_index_usage(statistic, index_name, start_date, end_date, granularity = nil, request_options = {})
       response = get_index_usage_with_http_info(
         statistic,
@@ -285,7 +285,7 @@ module Algolia
         granularity,
         request_options
       )
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Usage::GetUsage200Response")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Usage::IndexUsage")
     end
 
     # Retrieves usage statistics evaluated over a specified period.
@@ -339,10 +339,10 @@ module Algolia
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. (required)
     # @param granularity [Granularity] Granularity of the aggregated metrics.  - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days.  (default to 'daily')
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [GetUsage200Response]
+    # @return [IndexUsage]
     def get_usage(statistic, start_date, end_date, granularity = nil, request_options = {})
       response = get_usage_with_http_info(statistic, start_date, end_date, granularity, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Usage::GetUsage200Response")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Usage::IndexUsage")
     end
 
   end

data/lib/algolia/error.rb

@@ -10,6 +10,16 @@ module Algolia
   # Used when hosts are unreachable
   #
   class AlgoliaUnreachableHostError < AlgoliaError
+    attr_reader :errors
+
+    def initialize(message, errors = [])
+      errors.last&.tap do |last_error|
+        message += " Last error for #{last_error[:host]}: #{last_error[:error]}"
+      end
+
+      super(message)
+      @errors = errors
+    end
   end
 
   # An exception class raised when the REST API returns an error.

data/lib/algolia/logger_helper.rb

@@ -5,8 +5,17 @@ module Algolia
     # @param debug_file [nil|String] file used to output the logs
     #
     def self.create(debug_file = nil)
-      file = debug_file || (ENV["ALGOLIA_DEBUG"] ? File.new("debug.log", "a+") : $stderr)
-      instance = ::Logger.new(file)
+      file = debug_file
+
+      if file.nil? && ENV["ALGOLIA_DEBUG"]
+        begin
+          file = File.new("debug.log", "a+")
+        rescue Errno::EACCES, Errno::ENOENT => e
+          puts("Failed to open debug.log: #{e.message}. Falling back to $stderr.")
+        end
+      end
+
+      instance = ::Logger.new(file || $stderr)
       instance.progname = "algolia"
       instance
     end

data/lib/algolia/models/abtesting/{filter_effects_empty_search.rb → empty_search_filter.rb}

@@ -6,7 +6,7 @@ require "time"
 module Algolia
   module Abtesting
     # Empty searches removed from the A/B test as a result of configuration settings.
-    class FilterEffectsEmptySearch
+    class EmptySearchFilter
       # Number of users removed from the A/B test.
       attr_accessor :users_count
 
@@ -47,7 +47,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::FilterEffectsEmptySearch` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::EmptySearchFilter` initialize method"
           )
         end
 
@@ -56,7 +56,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::FilterEffectsEmptySearch`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::EmptySearchFilter`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/abtesting/filter_effects.rb

@@ -27,8 +27,8 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :outliers => :"FilterEffectsOutliers",
-          :empty_search => :"FilterEffectsEmptySearch"
+          :outliers => :"OutliersFilter",
+          :empty_search => :"EmptySearchFilter"
         }
       end
 

data/lib/algolia/models/abtesting/{filter_effects_outliers.rb → outliers_filter.rb}

@@ -6,7 +6,7 @@ require "time"
 module Algolia
   module Abtesting
     # Outliers removed from the A/B test as a result of configuration settings.
-    class FilterEffectsOutliers
+    class OutliersFilter
       # Number of users removed from the A/B test.
       attr_accessor :users_count
 
@@ -47,7 +47,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::FilterEffectsOutliers` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::OutliersFilter` initialize method"
           )
         end
 
@@ -56,7 +56,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::FilterEffectsOutliers`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::OutliersFilter`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/analytics/{click_positions_inner.rb → click_position.rb}

@@ -6,7 +6,7 @@ require "time"
 module Algolia
   module Analytics
     # Click position.
-    class ClickPositionsInner
+    class ClickPosition
       # Range of positions in the search results, using the pattern `[start,end]`.  For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
       attr_accessor :position
 
@@ -47,7 +47,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::ClickPositionsInner` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::ClickPosition` initialize method"
           )
         end
 
@@ -56,7 +56,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::ClickPositionsInner`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::ClickPosition`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

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

@@ -24,7 +24,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :positions => :"Array<ClickPositionsInner>"
+          :positions => :"Array<ClickPosition>"
         }
       end
 

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

@@ -64,7 +64,7 @@ module Algolia
           :count => :"Integer",
           :click_through_rate => :"Float",
           :average_click_position => :"Float",
-          :click_positions => :"Array<ClickPositionsInner>",
+          :click_positions => :"Array<ClickPosition>",
           :conversion_rate => :"Float",
           :tracked_search_count => :"Integer",
           :click_count => :"Integer",

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

@@ -84,7 +84,7 @@ module Algolia
           :count => :"Integer",
           :click_through_rate => :"Float",
           :average_click_position => :"Float",
-          :click_positions => :"Array<ClickPositionsInner>",
+          :click_positions => :"Array<ClickPosition>",
           :conversion_rate => :"Float",
           :tracked_search_count => :"Integer",
           :click_count => :"Integer",

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

@@ -0,0 +1,45 @@
+# 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 Action
+      ADD_OBJECT = "addObject".freeze
+      UPDATE_OBJECT = "updateObject".freeze
+      PARTIAL_UPDATE_OBJECT = "partialUpdateObject".freeze
+      PARTIAL_UPDATE_OBJECT_NO_CREATE = "partialUpdateObjectNoCreate".freeze
+      DELETE_OBJECT = "deleteObject".freeze
+      DELETE = "delete".freeze
+      CLEAR = "clear".freeze
+
+      def self.all_vars
+        @all_vars ||= [
+          ADD_OBJECT,
+          UPDATE_OBJECT,
+          PARTIAL_UPDATE_OBJECT,
+          PARTIAL_UPDATE_OBJECT_NO_CREATE,
+          DELETE_OBJECT,
+          DELETE,
+          CLEAR
+        ].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 Action.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #Action"
+      end
+    end
+  end
+end

data/lib/algolia/models/{search/search_for_hits_options.rb → ingestion/batch_request.rb}

@@ -4,12 +4,12 @@ require "date"
 require "time"
 
 module Algolia
-  module Search
-    class SearchForHitsOptions
-      # Index name (case-sensitive).
-      attr_accessor :index_name
+  module Ingestion
+    class BatchRequest
+      attr_accessor :action
 
-      attr_accessor :type
+      # Operation arguments (varies with specified `action`).
+      attr_accessor :body
 
       class EnumAttributeValidator
         attr_reader :datatype
@@ -36,8 +36,8 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :index_name => :indexName,
-          :type => :type
+          :action => :action,
+          :body => :body
         }
       end
 
@@ -49,8 +49,8 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :index_name => :"String",
-          :type => :"SearchTypeDefault"
+          :action => :"Action",
+          :body => :"Object"
         }
       end
 
@@ -67,7 +67,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::SearchForHitsOptions` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::BatchRequest` initialize method"
           )
         end
 
@@ -76,7 +76,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::SearchForHitsOptions`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::BatchRequest`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -84,14 +84,16 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:index_name)
-          self.index_name = attributes[:index_name]
+        if attributes.key?(:action)
+          self.action = attributes[:action]
         else
-          self.index_name = nil
+          self.action = nil
         end
 
-        if attributes.key?(:type)
-          self.type = attributes[:type]
+        if attributes.key?(:body)
+          self.body = attributes[:body]
+        else
+          self.body = nil
         end
       end
 
@@ -100,8 +102,8 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          index_name == other.index_name &&
-          type == other.type
+          action == other.action &&
+          body == other.body
       end
 
       # @see the `==` method
@@ -113,7 +115,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, type].hash
+        [action, body].hash
       end
 
       # Builds the object from hash
@@ -182,7 +184,7 @@ module Algolia
           # model
         else
           # models (e.g. Pet) or oneOf
-          klass = Algolia::Search.const_get(type)
+          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

data/lib/algolia/models/ingestion/{source_shopify_base.rb → batch_write_params.rb}

@@ -5,14 +5,14 @@ require "time"
 
 module Algolia
   module Ingestion
-    class SourceShopifyBase
-      # URL of the Shopify store.
-      attr_accessor :shop_url
+    # Batch parameters.
+    class BatchWriteParams
+      attr_accessor :requests
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :shop_url => :shopURL
+          :requests => :requests
         }
       end
 
@@ -24,7 +24,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :shop_url => :"String"
+          :requests => :"Array<BatchRequest>"
         }
       end
 
@@ -41,7 +41,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::SourceShopifyBase` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::BatchWriteParams` 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::SourceShopifyBase`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::BatchWriteParams`. 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?(:shop_url)
-          self.shop_url = attributes[:shop_url]
+        if attributes.key?(:requests)
+          if (value = attributes[:requests]).is_a?(Array)
+            self.requests = value
+          end
         else
-          self.shop_url = nil
+          self.requests = nil
         end
       end
 
@@ -70,7 +72,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          shop_url == other.shop_url
+          requests == other.requests
       end
 
       # @see the `==` method
@@ -82,7 +84,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [shop_url].hash
+        [requests].hash
       end
 
       # Builds the object from hash

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

@@ -5,6 +5,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # The selected streams of a singer or airbyte connector.
     class DockerStreamsInput
       attr_accessor :streams
 

data/lib/algolia/models/{recommend/recommendations_hits.rb → ingestion/list_tasks_response_v1.rb}

@@ -4,14 +4,18 @@ require "date"
 require "time"
 
 module Algolia
-  module Recommend
-    class RecommendationsHits
-      attr_accessor :hits
+  module Ingestion
+    # Configured tasks and pagination information.
+    class ListTasksResponseV1
+      attr_accessor :tasks
+
+      attr_accessor :pagination
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :hits => :hits
+          :tasks => :tasks,
+          :pagination => :pagination
         }
       end
 
@@ -23,7 +27,8 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :hits => :"Array<RecommendationsHit>"
+          :tasks => :"Array<TaskV1>",
+          :pagination => :"Pagination"
         }
       end
 
@@ -40,7 +45,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::RecommendationsHits` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::ListTasksResponseV1` initialize method"
           )
         end
 
@@ -49,7 +54,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::RecommendationsHits`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::ListTasksResponseV1`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -57,12 +62,18 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:hits)
-          if (value = attributes[:hits]).is_a?(Array)
-            self.hits = value
+        if attributes.key?(:tasks)
+          if (value = attributes[:tasks]).is_a?(Array)
+            self.tasks = value
           end
         else
-          self.hits = nil
+          self.tasks = nil
+        end
+
+        if attributes.key?(:pagination)
+          self.pagination = attributes[:pagination]
+        else
+          self.pagination = nil
         end
       end
 
@@ -71,7 +82,8 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          hits == other.hits
+          tasks == other.tasks &&
+          pagination == other.pagination
       end
 
       # @see the `==` method
@@ -83,7 +95,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [hits].hash
+        [tasks, pagination].hash
       end
 
       # Builds the object from hash
@@ -152,7 +164,7 @@ module Algolia
           # model
         else
           # models (e.g. Pet) or oneOf
-          klass = Algolia::Recommend.const_get(type)
+          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