algolia 3.0.0.beta.14 → 3.0.0.beta.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b4c1bf1ec0ae78a66401213ff5ad43cbe5af1eb876e3f869954e7970f9e2d7
-  data.tar.gz: 30161fea26f09f5a8651297ad0d785231ca8477c09cb6bd948ff4c66fa9f72eb
+  metadata.gz: 2168d288b3c9cccca0d1926fc96f335d268c91ebdcea70702710fbcd83dd1ae0
+  data.tar.gz: 826a6c524fe2be4e9ee48ba7b37ea42ac3ffd8652ec9ac6e5c8407d56ec3bfbf
 SHA512:
-  metadata.gz: e61a29d8f4887039452dac0d97c7e1c307665f1162d6065e3ba15617130ddee08af68a0d7bc8cc87c726aaa42cddaebcb117c1e8e4e52c4272cfa190e73235a3
-  data.tar.gz: fab57401cf66f5871fd0298cea6248880097e9b85c7d4aa8fb7ddbfa733fb206547ffe27f2eb7c1d37382ee4f748295a0d2fda5e5a5510f08d85409065e6fddb
+  metadata.gz: f720f425044bc5e12c38684d498b4a16480daa6537f4dda2070ac9227adb9b19822d854254896213cd15690fd85cb0468af63b867b6e719e8aebd73ab0f033e4
+  data.tar.gz: d839249f4f7b8f47f6d0e610db42ac02cf83db06a3fa062dbfee8166bb239aa8bfcf80237df1007b54b0b28690431f4af2818cc10c29fef3655167fa3174da6b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.0.0.beta.16](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.15...3.0.0.beta.16)
+
+- [4c052002e](https://github.com/algolia/api-clients-automation/commit/4c052002e) feat(specs): recursive snippets and highlights result ([#3497](https://github.com/algolia/api-clients-automation/pull/3497)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.0.0.beta.15](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.14...3.0.0.beta.15)
+
+- [7d2ab99ce](https://github.com/algolia/api-clients-automation/commit/7d2ab99ce) feat(specs): add authentications to ingestion transformations ([#3494](https://github.com/algolia/api-clients-automation/pull/3494)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [3.0.0.beta.14](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.13...3.0.0.beta.14)
 
 - [2c6147ee7](https://github.com/algolia/api-clients-automation/commit/2c6147ee7) feat(specs): add generate code endpoint to ingestion specs ([#3489](https://github.com/algolia/api-clients-automation/pull/3489)) by [@shortcuts](https://github.com/shortcuts/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.beta.14)
+    algolia (3.0.0.beta.16)
       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

@@ -2877,7 +2877,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::SourceWatchResponse")
     end
 
-    # Try a transformation.
+    # Try a transformation before creating it.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -2911,7 +2911,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Try a transformation.
+    # Try a transformation before creating it.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -2928,6 +2928,72 @@ module Algolia
       )
     end
 
+    # Try a transformation before updating it.
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
+    # @param transformation_id [String] Unique identifier of a transformation. (required)
+    # @param transformation_try [TransformationTry]  (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 try_transformation_before_update_with_http_info(transformation_id, transformation_try, request_options = {})
+      # verify the required parameter 'transformation_id' is set
+      if @api_client.config.client_side_validation && transformation_id.nil?
+        raise(
+          ArgumentError,
+          "Parameter `transformation_id` is required when calling `try_transformation_before_update`."
+        )
+      end
+      # verify the required parameter 'transformation_try' is set
+      if @api_client.config.client_side_validation && transformation_try.nil?
+        raise(
+          ArgumentError,
+          "Parameter `transformation_try` is required when calling `try_transformation_before_update`."
+        )
+      end
+
+      path = "/1/transformations/{transformationID}/try".sub(
+        "{" + "transformationID" + "}",
+        Transport.encode_uri(transformation_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(transformation_try)
+
+      new_options = request_options.merge(
+        :operation => :"IngestionClient.try_transformation_before_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Try a transformation before updating it.
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
+    # @param transformation_id [String] Unique identifier of a transformation. (required)
+    # @param transformation_try [TransformationTry]  (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 [TransformationTryResponse]
+    def try_transformation_before_update(transformation_id, transformation_try, request_options = {})
+      response = try_transformation_before_update_with_http_info(transformation_id, transformation_try, request_options)
+      @api_client.deserialize(
+        response.body,
+        request_options[:debug_return_type] || "Ingestion::TransformationTryResponse"
+      )
+    end
+
     # Updates an authentication resource.
     #
     # Required API Key ACLs:

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

@@ -9,6 +9,9 @@ module Algolia
       # Universally unique identifier (UUID) of a transformation.
       attr_accessor :transformation_id
 
+      # The authentications associated for the current transformation.
+      attr_accessor :authentication_ids
+
       # The source code of the transformation.
       attr_accessor :code
 
@@ -28,6 +31,7 @@ module Algolia
       def self.attribute_map
         {
           :transformation_id => :transformationID,
+          :authentication_ids => :authenticationIDs,
           :code => :code,
           :name => :name,
           :description => :description,
@@ -45,6 +49,7 @@ module Algolia
       def self.types_mapping
         {
           :transformation_id => :"String",
+          :authentication_ids => :"Array<String>",
           :code => :"String",
           :name => :"String",
           :description => :"String",
@@ -89,6 +94,12 @@ module Algolia
           self.transformation_id = nil
         end
 
+        if attributes.key?(:authentication_ids)
+          if (value = attributes[:authentication_ids]).is_a?(Array)
+            self.authentication_ids = value
+          end
+        end
+
         if attributes.key?(:code)
           self.code = attributes[:code]
         else
@@ -122,6 +133,7 @@ module Algolia
         return true if self.equal?(other)
         self.class == other.class &&
           transformation_id == other.transformation_id &&
+          authentication_ids == other.authentication_ids &&
           code == other.code &&
           name == other.name &&
           description == other.description &&
@@ -138,7 +150,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [transformation_id, code, name, description, created_at, updated_at].hash
+        [transformation_id, authentication_ids, code, name, description, created_at, updated_at].hash
       end
 
       # Builds the object from hash

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

@@ -16,12 +16,16 @@ module Algolia
       # A descriptive name for your transformation of what it does.
       attr_accessor :description
 
+      # The authentications associated for the current transformation.
+      attr_accessor :authentication_ids
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :code => :code,
           :name => :name,
-          :description => :description
+          :description => :description,
+          :authentication_ids => :authenticationIDs
         }
       end
 
@@ -35,7 +39,8 @@ module Algolia
         {
           :code => :"String",
           :name => :"String",
-          :description => :"String"
+          :description => :"String",
+          :authentication_ids => :"Array<String>"
         }
       end
 
@@ -84,6 +89,12 @@ module Algolia
         if attributes.key?(:description)
           self.description = attributes[:description]
         end
+
+        if attributes.key?(:authentication_ids)
+          if (value = attributes[:authentication_ids]).is_a?(Array)
+            self.authentication_ids = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -93,7 +104,8 @@ module Algolia
         self.class == other.class &&
           code == other.code &&
           name == other.name &&
-          description == other.description
+          description == other.description &&
+          authentication_ids == other.authentication_ids
       end
 
       # @see the `==` method
@@ -105,7 +117,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [code, name, description].hash
+        [code, name, description, authentication_ids].hash
       end
 
       # Builds the object from hash

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

@@ -12,11 +12,14 @@ module Algolia
       # The record to apply the given code to.
       attr_accessor :sample_record
 
+      attr_accessor :authentications
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :code => :code,
-          :sample_record => :sampleRecord
+          :sample_record => :sampleRecord,
+          :authentications => :authentications
         }
       end
 
@@ -29,7 +32,8 @@ module Algolia
       def self.types_mapping
         {
           :code => :"String",
-          :sample_record => :"Object"
+          :sample_record => :"Object",
+          :authentications => :"Array<AuthenticationCreate>"
         }
       end
 
@@ -74,6 +78,12 @@ module Algolia
         else
           self.sample_record = nil
         end
+
+        if attributes.key?(:authentications)
+          if (value = attributes[:authentications]).is_a?(Array)
+            self.authentications = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -82,7 +92,8 @@ module Algolia
         return true if self.equal?(other)
         self.class == other.class &&
           code == other.code &&
-          sample_record == other.sample_record
+          sample_record == other.sample_record &&
+          authentications == other.authentications
       end
 
       # @see the `==` method
@@ -94,7 +105,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [code, sample_record].hash
+        [code, sample_record, authentications].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/highlight_result.rb

@@ -11,6 +11,7 @@ module Algolia
         def openapi_one_of
           [
             :"Array<HighlightResultOption>",
+            :"Hash<String, HighlightResult>",
             :"Hash<String, HighlightResultOption>",
             :"HighlightResultOption"
           ]

data/lib/algolia/models/recommend/snippet_result.rb

@@ -11,6 +11,7 @@ module Algolia
         def openapi_one_of
           [
             :"Array<SnippetResultOption>",
+            :"Hash<String, SnippetResult>",
             :"Hash<String, SnippetResultOption>",
             :"SnippetResultOption"
           ]

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

@@ -11,6 +11,7 @@ module Algolia
         def openapi_one_of
           [
             :"Array<HighlightResultOption>",
+            :"Hash<String, HighlightResult>",
             :"Hash<String, HighlightResultOption>",
             :"HighlightResultOption"
           ]

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

@@ -11,6 +11,7 @@ module Algolia
         def openapi_one_of
           [
             :"Array<SnippetResultOption>",
+            :"Hash<String, SnippetResult>",
             :"Hash<String, SnippetResultOption>",
             :"SnippetResultOption"
           ]

data/lib/algolia/version.rb

@@ -1,5 +1,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.0.0.beta.14".freeze
+  VERSION = "3.0.0.beta.16".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.14
+  version: 3.0.0.beta.16
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday