algolia 3.34.0 → 3.34.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b95250946c2ec0549f3ccb45bc8d6a19798fb718823f6785070670ab9dcb77
-  data.tar.gz: de2118558f108ca16cd821f7e22c616454bbb0fef657ef8768cc529891109b5b
+  metadata.gz: 8189a4e0cfb23cab2ef3d512f074ea026e2a1bd034fb76edad6258cd8670f5f7
+  data.tar.gz: e6c801ad5cd7a3ee902cccd82fbb76196be67baff93da35c5812ce67147f92a5
 SHA512:
-  metadata.gz: f1c66a50bd34bd38336057f4d320f93e66502c4cfb0b108b524c6bb4dc0650fb5d33bcaa3cdf15c302d428b2242135c2e28b6a7a5ee6375404b3dcbd987e62a0
-  data.tar.gz: ab55900d51d0ed5e50236023a71d4b76db9a723584d62fc06eb76ac8f587134857b5bf07d39877a843538e460ce75393c835ef4368a9e75d9d49d1ae9b95c77c
+  metadata.gz: efae6679ac62a8194a5df95e09989fb706d139b79b3550305f31ef82664002c50b28a5b8fa86736f01157f2c88148e60624ead81634c6226e2a57abc2a5c266f
+  data.tar.gz: 979c0aecb5b39fd70e07261d049e707650d2ca764f615f72a360357fa70d1218642f0d46168d7f5601fb233460e5b30958f54369d7f2083147da1d86e514f144

data/.github/workflows/do-not-edit-this-repository.yml

@@ -14,7 +14,7 @@ jobs:
     name: Close PR
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Close PR
         env:

data/.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
       id-token: write
       contents: write
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Install Ruby
         uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.34.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.34.0...3.34.1)
+
+- [54606b3b2](https://github.com/algolia/api-clients-automation/commit/54606b3b2) refactor(specs): extract `results` field in a dedicated directory ([#5739](https://github.com/algolia/api-clients-automation/pull/5739)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [3296a5033](https://github.com/algolia/api-clients-automation/commit/3296a5033) chore(deps): dependencies 2025-11-24 ([#5653](https://github.com/algolia/api-clients-automation/pull/5653)) by [@algolia-bot](https://github.com/algolia-bot/)
+- [5dabdc540](https://github.com/algolia/api-clients-automation/commit/5dabdc540) refactor(specs): re-organise response for Composition API ([#5744](https://github.com/algolia/api-clients-automation/pull/5744)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [3d86676b0](https://github.com/algolia/api-clients-automation/commit/3d86676b0) fix(specs): update list with NLU permissions ([#5769](https://github.com/algolia/api-clients-automation/pull/5769)) by [@MarioAlexandruDan](https://github.com/MarioAlexandruDan/)
+
 ## [3.34.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.33.0...3.34.0)
 
 - [5335918a5](https://github.com/algolia/api-clients-automation/commit/5335918a5) chore(scripts): update the jira action ([#5678](https://github.com/algolia/api-clients-automation/pull/5678)) by [@millotp](https://github.com/millotp/)

data/Gemfile.lock

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

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

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     class CompositionRunAppliedRules
-      # Unique record identifier.
+      # The objectID of the applied composition rule on this query.
       attr_accessor :algolia_object_id
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     class CompositionRunSearchResponse
-      # Unique record identifier.
+      # The objectID of the composition which generated this result set.
       attr_accessor :algolia_object_id
 
       attr_accessor :applied_rules

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

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     class ResultsInjectedItemAppliedRulesInfoResponse
-      # Unique record identifier.
+      # The objectID of the applied index level rule on this injected group.
       attr_accessor :algolia_object_id
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -8,6 +8,7 @@ require "time"
 module Algolia
   module Composition
     class ResultsInjectedItemInfoResponse
+      # The key of the injected group.
       attr_accessor :key
 
       attr_accessor :applied_rules

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

@@ -83,8 +83,11 @@ module Algolia
       # Whether automatic events collection is enabled for the application.
       attr_accessor :_automatic_insights
 
-      # Page of search results to retrieve.
-      attr_accessor :page
+      # Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+      attr_accessor :hits
+
+      # Number of hits returned per page.
+      attr_accessor :hits_per_page
 
       # Number of results (hits).
       attr_accessor :nb_hits
@@ -92,18 +95,15 @@ module Algolia
       # Number of pages of results.
       attr_accessor :nb_pages
 
-      # Number of hits per page.
-      attr_accessor :hits_per_page
-
-      # Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
-      attr_accessor :hits
-
-      # Search query.
-      attr_accessor :query
+      # The current page of the results.
+      attr_accessor :page
 
       # URL-encoded string of all search parameters.
       attr_accessor :params
 
+      # The search query string.
+      attr_accessor :query
+
       attr_accessor :compositions
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -135,13 +135,13 @@ module Algolia
           :user_data => :userData,
           :query_id => :queryID,
           :_automatic_insights => :_automaticInsights,
-          :page => :page,
+          :hits => :hits,
+          :hits_per_page => :hitsPerPage,
           :nb_hits => :nbHits,
           :nb_pages => :nbPages,
-          :hits_per_page => :hitsPerPage,
-          :hits => :hits,
-          :query => :query,
+          :page => :page,
           :params => :params,
+          :query => :query,
           :compositions => :compositions
         }
       end
@@ -175,13 +175,13 @@ module Algolia
           :user_data => :"Object",
           :query_id => :"String",
           :_automatic_insights => :"Boolean",
-          :page => :"Integer",
+          :hits => :"Array<Hit>",
+          :hits_per_page => :"Integer",
           :nb_hits => :"Integer",
           :nb_pages => :"Integer",
-          :hits_per_page => :"Integer",
-          :hits => :"Array<Hit>",
-          :query => :"String",
+          :page => :"Integer",
           :params => :"String",
+          :query => :"String",
           :compositions => :"Hash<String, ResultsCompositionInfoResponse>"
         }
       end
@@ -200,8 +200,7 @@ module Algolia
         [
           :"BaseSearchResponse",
           :"ResultsCompositionsResponse",
-          :"SearchHits",
-          :"SearchPagination"
+          :"SearchFields"
         ]
       end
 
@@ -338,10 +337,18 @@ module Algolia
           self._automatic_insights = attributes[:_automatic_insights]
         end
 
-        if attributes.key?(:page)
-          self.page = attributes[:page]
+        if attributes.key?(:hits)
+          if (value = attributes[:hits]).is_a?(Array)
+            self.hits = value
+          end
         else
-          self.page = nil
+          self.hits = nil
+        end
+
+        if attributes.key?(:hits_per_page)
+          self.hits_per_page = attributes[:hits_per_page]
+        else
+          self.hits_per_page = nil
         end
 
         if attributes.key?(:nb_hits)
@@ -356,18 +363,16 @@ module Algolia
           self.nb_pages = nil
         end
 
-        if attributes.key?(:hits_per_page)
-          self.hits_per_page = attributes[:hits_per_page]
+        if attributes.key?(:page)
+          self.page = attributes[:page]
         else
-          self.hits_per_page = nil
+          self.page = nil
         end
 
-        if attributes.key?(:hits)
-          if (value = attributes[:hits]).is_a?(Array)
-            self.hits = value
-          end
+        if attributes.key?(:params)
+          self.params = attributes[:params]
         else
-          self.hits = nil
+          self.params = nil
         end
 
         if attributes.key?(:query)
@@ -376,12 +381,6 @@ module Algolia
           self.query = nil
         end
 
-        if attributes.key?(:params)
-          self.params = attributes[:params]
-        else
-          self.params = nil
-        end
-
         if attributes.key?(:compositions)
           if (value = attributes[:compositions]).is_a?(Hash)
             self.compositions = value
@@ -422,13 +421,13 @@ module Algolia
           user_data == other.user_data &&
           query_id == other.query_id &&
           _automatic_insights == other._automatic_insights &&
-          page == other.page &&
+          hits == other.hits &&
+          hits_per_page == other.hits_per_page &&
           nb_hits == other.nb_hits &&
           nb_pages == other.nb_pages &&
-          hits_per_page == other.hits_per_page &&
-          hits == other.hits &&
-          query == other.query &&
+          page == other.page &&
           params == other.params &&
+          query == other.query &&
           compositions == other.compositions
       end
 
@@ -468,13 +467,13 @@ module Algolia
           user_data,
           query_id,
           _automatic_insights,
-          page,
+          hits,
+          hits_per_page,
           nb_hits,
           nb_pages,
-          hits_per_page,
-          hits,
-          query,
+          page,
           params,
+          query,
           compositions
         ].hash
       end

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

@@ -23,6 +23,14 @@ module Algolia
       SEE_UNRETRIEVABLE_ATTRIBUTES = "seeUnretrievableAttributes".freeze
       SETTINGS = "settings".freeze
       USAGE = "usage".freeze
+      NLU_WRITE_PROJECT = "nluWriteProject".freeze
+      NLU_READ_PROJECT = "nluReadProject".freeze
+      NLU_WRITE_ENTITY = "nluWriteEntity".freeze
+      NLU_READ_ENTITY = "nluReadEntity".freeze
+      NLU_WRITE_INTENT = "nluWriteIntent".freeze
+      NLU_READ_INTENT = "nluReadIntent".freeze
+      NLU_PREDICTION = "nluPrediction".freeze
+      NLU_READ_ANSWERS = "nluReadAnswers".freeze
 
       def self.all_vars
         @all_vars ||= [
@@ -40,7 +48,15 @@ module Algolia
           SEARCH,
           SEE_UNRETRIEVABLE_ATTRIBUTES,
           SETTINGS,
-          USAGE
+          USAGE,
+          NLU_WRITE_PROJECT,
+          NLU_READ_PROJECT,
+          NLU_WRITE_ENTITY,
+          NLU_READ_ENTITY,
+          NLU_WRITE_INTENT,
+          NLU_READ_INTENT,
+          NLU_PREDICTION,
+          NLU_READ_ANSWERS
         ].freeze
       end
 

data/lib/algolia/version.rb

@@ -3,5 +3,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.34.0"
+  VERSION = "3.34.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.34.0
+  version: 3.34.1
 platform: ruby
 authors:
 - https://alg.li/support