algolia 3.23.0 → 3.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fff1502a30fce45ad42d7166299524a573e06053f830fa1f18651e541e4dbdb
-  data.tar.gz: 76b07e570220ca1cb5afd4ce7c82d103f83cc40dbb0a52aeccfdfa341689d4bf
+  metadata.gz: 1404975c1e5ba8114c39898c74721f95f8e5c20f9eb9d823c12257dff41808cc
+  data.tar.gz: 49e83567a7b8792318599f9615a3332aaa390a3a8796f2b8500d0c613df5338f
 SHA512:
-  metadata.gz: c423ef6ca5a1b550eb3f54668e42df002f9e4355e0db592274814e21ea1670660c24a64cce4352580877cd0ace43d623aba790efaacec671e4a5ac3ee9abdb83
-  data.tar.gz: 017a0a4378f8d441486bc6fc9a94b254a0a02d692362bf89c063e4f3f4df1f8e00bf3a4aa4080307477f8444a1760a2d55d65335b8786c2cc80356390f85355d
+  metadata.gz: fd8fd30e11c95742f37123615223560666119959ad070b024a9aee73f9fca725fe0745d239900a7a4c85a37d5ab4050c16ffafe33eb16f23e4b6a15b4aaeaaa0
+  data.tar.gz: b2471b57a54330686b9fdf52e40f7999015d81e23befd8d712ec0f21f91c98e64f644ed22c3eb97e56f6cd6260002d484fadcafb7a5085273209f617976c12a1

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [3.25.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.24.0...3.25.0)
+
+- [8f4abf3a1](https://github.com/algolia/api-clients-automation/commit/8f4abf3a1) fix(specs): Cross-reference filerPromotes to relevant guide ([#5279](https://github.com/algolia/api-clients-automation/pull/5279)) by [@gazconroy](https://github.com/gazconroy/)
+- [1f4a3a9f7](https://github.com/algolia/api-clients-automation/commit/1f4a3a9f7) feat(specs): add put task endpoint to ingestion api ([#5281](https://github.com/algolia/api-clients-automation/pull/5281)) by [@shortcuts](https://github.com/shortcuts/)
+- [08e9d1888](https://github.com/algolia/api-clients-automation/commit/08e9d1888) fix(specs): add getVersion parameter to getSettings ([#5254](https://github.com/algolia/api-clients-automation/pull/5254)) by [@millotp](https://github.com/millotp/)
+- [f4eee1c4a](https://github.com/algolia/api-clients-automation/commit/f4eee1c4a) chore(website): exclude schema from generated variables file ([#5306](https://github.com/algolia/api-clients-automation/pull/5306)) by [@Fluf22](https://github.com/Fluf22/)
+- [2fa0389f8](https://github.com/algolia/api-clients-automation/commit/2fa0389f8) fix(clients): link to support/help center on unreachable hosts ([#5305](https://github.com/algolia/api-clients-automation/pull/5305)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.24.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.23.0...3.24.0)
+
+- [48672036c1](https://github.com/algolia/api-clients-automation/commit/48672036c1) refactor(specs): mutualise code between Search API & Comp API for search query parameters ([#5125](https://github.com/algolia/api-clients-automation/pull/5125)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [99f8174c7d](https://github.com/algolia/api-clients-automation/commit/99f8174c7d) feat(specs): add fields for metadata in composition injectedItems ([#5241](https://github.com/algolia/api-clients-automation/pull/5241)) by [@gavinwade12](https://github.com/gavinwade12/)
+- [ff178d8118](https://github.com/algolia/api-clients-automation/commit/ff178d8118) feat(specs): abtests stopped at ([#5275](https://github.com/algolia/api-clients-automation/pull/5275)) by [@stevenMevans](https://github.com/stevenMevans/)
+
 ## [3.23.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.22.1...3.23.0)
 
 - [050aacef17](https://github.com/algolia/api-clients-automation/commit/050aacef17) chore(deps): dependencies 2025-07-28 ([#5161](https://github.com/algolia/api-clients-automation/pull/5161)) by [@algolia-bot](https://github.com/algolia-bot/)

data/Gemfile.lock

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

data/lib/algolia/api/ingestion_client.rb

@@ -2265,6 +2265,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 +3092,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 +3127,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
 

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

@@ -30,6 +30,9 @@ module Algolia
       # End date and time of the A/B test, in RFC 3339 format.
       attr_accessor :end_at
 
+      # Date and time when the A/B test was stopped, in RFC 3339 format.
+      attr_accessor :stopped_at
+
       # A/B test name.
       attr_accessor :name
 
@@ -52,6 +55,7 @@ module Algolia
           :updated_at => :updatedAt,
           :created_at => :createdAt,
           :end_at => :endAt,
+          :stopped_at => :stoppedAt,
           :name => :name,
           :status => :status,
           :variants => :variants,
@@ -71,6 +75,7 @@ module Algolia
           :updated_at => :"String",
           :created_at => :"String",
           :end_at => :"String",
+          :stopped_at => :"String",
           :name => :"String",
           :status => :"Status",
           :variants => :"Array<Variant>",
@@ -86,7 +91,8 @@ module Algolia
             :conversion_significance,
             :add_to_cart_significance,
             :purchase_significance,
-            :revenue_significance
+            :revenue_significance,
+            :stopped_at
           ]
         )
       end
@@ -157,6 +163,10 @@ module Algolia
           self.end_at = nil
         end
 
+        if attributes.key?(:stopped_at)
+          self.stopped_at = attributes[:stopped_at]
+        end
+
         if attributes.key?(:name)
           self.name = attributes[:name]
         else
@@ -196,6 +206,7 @@ module Algolia
           updated_at == other.updated_at &&
           created_at == other.created_at &&
           end_at == other.end_at &&
+          stopped_at == other.stopped_at &&
           name == other.name &&
           status == other.status &&
           variants == other.variants &&
@@ -221,6 +232,7 @@ module Algolia
           updated_at,
           created_at,
           end_at,
+          stopped_at,
           name,
           status,
           variants,

data/lib/algolia/models/abtesting-v3/ab_test.rb

@@ -20,6 +20,9 @@ module Algolia
       # End date and time of the A/B test, in RFC 3339 format.
       attr_accessor :end_at
 
+      # Date and time when the A/B test was stopped, in RFC 3339 format.
+      attr_accessor :stopped_at
+
       # A/B test name.
       attr_accessor :name
 
@@ -40,6 +43,7 @@ module Algolia
           :updated_at => :updatedAt,
           :created_at => :createdAt,
           :end_at => :endAt,
+          :stopped_at => :stoppedAt,
           :name => :name,
           :status => :status,
           :variants => :variants,
@@ -55,6 +59,7 @@ module Algolia
           :updated_at => :"String",
           :created_at => :"String",
           :end_at => :"String",
+          :stopped_at => :"String",
           :name => :"String",
           :status => :"Status",
           :variants => :"Array<Variant>",
@@ -66,7 +71,9 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new(
-          []
+          [
+            :stopped_at
+          ]
         )
       end
 
@@ -114,6 +121,10 @@ module Algolia
           self.end_at = nil
         end
 
+        if attributes.key?(:stopped_at)
+          self.stopped_at = attributes[:stopped_at]
+        end
+
         if attributes.key?(:name)
           self.name = attributes[:name]
         else
@@ -152,6 +163,7 @@ module Algolia
           updated_at == other.updated_at &&
           created_at == other.created_at &&
           end_at == other.end_at &&
+          stopped_at == other.stopped_at &&
           name == other.name &&
           status == other.status &&
           variants == other.variants &&
@@ -168,7 +180,18 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [ab_test_id, updated_at, created_at, end_at, name, status, variants, configuration, migrated_ab_test_id].hash
+        [
+          ab_test_id,
+          updated_at,
+          created_at,
+          end_at,
+          stopped_at,
+          name,
+          status,
+          variants,
+          configuration,
+          migrated_ab_test_id
+        ].hash
       end
 
       # Builds the object from hash

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

@@ -0,0 +1,212 @@
+# 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 ExternalInjectedItem
+      attr_accessor :items
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :items => :items
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :items => :"Array<ExternalInjection>"
+        }
+      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::ExternalInjectedItem` 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::ExternalInjectedItem`. 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?(:items)
+          if (value = attributes[:items]).is_a?(Array)
+            self.items = value
+          end
+        else
+          self.items = 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 &&
+          items == other.items
+      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
+        [items].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::Composition.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