algolia 3.24.0 → 3.26.0

data/lib/algolia/api/ingestion_client.rb

@@ -2086,6 +2086,7 @@ module Algolia
     # @param page [Integer] Page number of the paginated API response.
     # @param sort [TransformationSortKeys] Property by which to sort the list of transformations. (default to 'createdAt')
     # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
+    # @param type [TransformationType] Whether to filter the list of transformations by the type of transformation.
     # @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 [Http::Response] the response
     def list_transformations_with_http_info(
@@ -2093,6 +2094,7 @@ module Algolia
       page = nil,
       sort = nil,
       order = nil,
+      type = nil,
       request_options = {}
     )
       path = "/1/transformations"
@@ -2101,6 +2103,7 @@ module Algolia
       query_params[:page] = page unless page.nil?
       query_params[:sort] = sort unless sort.nil?
       query_params[:order] = order unless order.nil?
+      query_params[:type] = type unless type.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
@@ -2128,10 +2131,18 @@ module Algolia
     # @param page [Integer] Page number of the paginated API response.
     # @param sort [TransformationSortKeys] Property by which to sort the list of transformations. (default to 'createdAt')
     # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
+    # @param type [TransformationType] Whether to filter the list of transformations by the type of transformation.
     # @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 [ListTransformationsResponse]
-    def list_transformations(items_per_page = nil, page = nil, sort = nil, order = nil, request_options = {})
-      response = list_transformations_with_http_info(items_per_page, page, sort, order, request_options)
+    def list_transformations(
+      items_per_page = nil,
+      page = nil,
+      sort = nil,
+      order = nil,
+      type = nil,
+      request_options = {}
+    )
+      response = list_transformations_with_http_info(items_per_page, page, sort, order, type, request_options)
       @api_client.deserialize(
         response.body,
         request_options[:debug_return_type] || "Ingestion::ListTransformationsResponse"
@@ -2206,7 +2217,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
     end
 
-    # Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
+    # Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -2249,7 +2260,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
+    # Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -2265,6 +2276,52 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
     end
 
+    # Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+
+    # @param task_id [String] Unique identifier of a task. (required)
+    # @param task_replace [TaskReplace]  (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 [Http::Response] the response
+    def replace_task_with_http_info(task_id, task_replace, request_options = {})
+      # verify the required parameter 'task_id' is set
+      if @api_client.config.client_side_validation && task_id.nil?
+        raise ArgumentError, "Parameter `task_id` is required when calling `replace_task`."
+      end
+      # verify the required parameter 'task_replace' is set
+      if @api_client.config.client_side_validation && task_replace.nil?
+        raise ArgumentError, "Parameter `task_replace` is required when calling `replace_task`."
+      end
+
+      path = "/2/tasks/{taskID}".sub("{" + "taskID" + "}", Transport.encode_uri(task_id.to_s))
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(task_replace)
+
+      new_options = request_options.merge(
+        :operation => :"IngestionClient.replace_task",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:PUT, path, new_options)
+    end
+
+    # Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+
+    # @param task_id [String] Unique identifier of a task. (required)
+    # @param task_replace [TaskReplace]  (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 [TaskUpdateResponse]
+    def replace_task(task_id, task_replace, request_options = {})
+      response = replace_task_with_http_info(task_id, task_replace, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskUpdateResponse")
+    end
+
     # Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
     #
     # Required API Key ACLs:
@@ -3046,7 +3103,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::SourceUpdateResponse")
     end
 
-    # Updates a task by its ID.
+    # Partially updates a task by its ID.
 
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdate]  (required)
@@ -3081,7 +3138,7 @@ module Algolia
       @api_client.call_api(:PATCH, path, new_options)
     end
 
-    # Updates a task by its ID.
+    # Partially updates a task by its ID.
 
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdate]  (required)

data/lib/algolia/api/search_client.rb

@@ -1503,9 +1503,10 @@ module Algolia
     # Required API Key ACLs:
     #   - settings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
+    # @param get_version [Integer] When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility. (default to 1)
     # @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 [Http::Response] the response
-    def get_settings_with_http_info(index_name, request_options = {})
+    def get_settings_with_http_info(index_name, get_version = nil, request_options = {})
       # verify the required parameter 'index_name' is set
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `get_settings`."
@@ -1513,6 +1514,7 @@ module Algolia
 
       path = "/1/indexes/{indexName}/settings".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
+      query_params[:getVersion] = get_version unless get_version.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
@@ -1535,10 +1537,11 @@ module Algolia
     # Required API Key ACLs:
     #   - settings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
+    # @param get_version [Integer] When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility. (default to 1)
     # @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 [SettingsResponse]
-    def get_settings(index_name, request_options = {})
-      response = get_settings_with_http_info(index_name, request_options)
+    def get_settings(index_name, get_version = nil, request_options = {})
+      response = get_settings_with_http_info(index_name, get_version, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SettingsResponse")
     end
 
@@ -3269,7 +3272,8 @@ module Algolia
     def browse_rules(index_name, search_rules_params = Search::SearchRulesParams.new, request_options = {}, &block)
       search_rules_params = api_client.object_to_hash(search_rules_params)
 
-      search_rules_params[:hitsPerPage] = 1000 unless search_rules_params.key?(:hitsPerPage)
+      search_rules_params[:page] ||= 0
+      search_rules_params[:hitsPerPage] ||= 1000
 
       rules = []
       loop do
@@ -3303,7 +3307,8 @@ module Algolia
     )
       search_synonyms_params = api_client.object_to_hash(search_synonyms_params)
 
-      search_synonyms_params[:hitsPerPage] = 1000 unless search_synonyms_params.key?(:hitsPerPage)
+      search_synonyms_params[:page] ||= 0
+      search_synonyms_params[:hitsPerPage] ||= 1000
 
       synonyms = []
       loop do

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require "date"
+require "time"
+
+module Algolia
+  module Composition
+    class Action
+      UPSERT = "upsert".freeze
+      DELETE = "delete".freeze
+
+      def self.all_vars
+        @all_vars ||= [UPSERT, DELETE].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/composition/advanced_syntax_features.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require "date"
+require "time"
+
+module Algolia
+  module Composition
+    class AdvancedSyntaxFeatures
+      EXACT_PHRASE = "exactPhrase".freeze
+      EXCLUDE_WORDS = "excludeWords".freeze
+
+      def self.all_vars
+        @all_vars ||= [EXACT_PHRASE, EXCLUDE_WORDS].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 AdvancedSyntaxFeatures.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #AdvancedSyntaxFeatures"
+      end
+    end
+  end
+end

data/lib/algolia/models/composition/alternatives_as_exact.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 Composition
+    class AlternativesAsExact
+      IGNORE_PLURALS = "ignorePlurals".freeze
+      SINGLE_WORD_SYNONYM = "singleWordSynonym".freeze
+      MULTI_WORDS_SYNONYM = "multiWordsSynonym".freeze
+      IGNORE_CONJUGATIONS = "ignoreConjugations".freeze
+
+      def self.all_vars
+        @all_vars ||= [IGNORE_PLURALS, SINGLE_WORD_SYNONYM, MULTI_WORDS_SYNONYM, IGNORE_CONJUGATIONS].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 AlternativesAsExact.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #AlternativesAsExact"
+      end
+    end
+  end
+end

data/lib/algolia/models/composition/anchoring.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 Composition
+    class Anchoring
+      IS = "is".freeze
+      STARTS_WITH = "startsWith".freeze
+      ENDS_WITH = "endsWith".freeze
+      CONTAINS = "contains".freeze
+
+      def self.all_vars
+        @all_vars ||= [IS, STARTS_WITH, ENDS_WITH, CONTAINS].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 Anchoring.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #Anchoring"
+      end
+    end
+  end
+end