algolia 3.0.0.beta.5 → 3.0.0.beta.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7841f068eb004a49c57459769fc18f10f98714b3229b63f4223839e9d3e15ea6
-  data.tar.gz: 6f72cc44d5c858418ae7deed49ad2eaf86458fac3e08b2710e40207dd3f1b5ab
+  metadata.gz: b052211b4a0ecb74c42f11d50147460cf98a1aae441095e4c421800d611c1f0c
+  data.tar.gz: ce30bdefbd8703da5fc943ebdd24126874c05ad78368212e19e70138eea52f9e
 SHA512:
-  metadata.gz: 91fe14b759af3f8d02e351294d97e447b98c71489820e819f9665fb25ce1d7a640c046ea4657fcc87435c5ed9f9c8688277774b5a6c5ace91804912b5a0d8d2d
-  data.tar.gz: fa78f348f10ae77b918a52b14768bfd52dedc504710fed6133908015724f27904739552e54403d571f3123f19b8f73722d094eea5e1fe48fd80af615e4931c4f
+  metadata.gz: 735dc36265137ffee7456a8cd0cfeb5c6607e56c71bb7595b9c113780661d24d48c2f9f37c8053dc9f5928097beb925a6211107c08f2a01d664e101c5795a346
+  data.tar.gz: ca760e5f13736c3ea825087a46bc9cc4013c98223700c5d140a412eac63559c746d62ca3d07aed6fef9663cf89ad0a349f9e627cd3fdea3608a70d619bdc470e

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [3.0.0.beta.6](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.5...3.0.0.beta.6)
+
+- [e5cfcf0c4](https://github.com/algolia/api-clients-automation/commit/e5cfcf0c4) feat(clients): generate common LICENSE ([#3258](https://github.com/algolia/api-clients-automation/pull/3258)) by [@shortcuts](https://github.com/shortcuts/)
+- [47dd4bb5b](https://github.com/algolia/api-clients-automation/commit/47dd4bb5b) fix(clients): update README snippets and contributing guides ([#3257](https://github.com/algolia/api-clients-automation/pull/3257)) by [@shortcuts](https://github.com/shortcuts/)
+- [7a90e4532](https://github.com/algolia/api-clients-automation/commit/7a90e4532) feat(clients): add `saveObjects`, `deleteObjects` and `partialUpdateObjects` helpers ([#3180](https://github.com/algolia/api-clients-automation/pull/3180)) by [@shortcuts](https://github.com/shortcuts/)
+- [5dbdb91e9](https://github.com/algolia/api-clients-automation/commit/5dbdb91e9) fix(specs): virtual is a fetchedIndex props ([#3255](https://github.com/algolia/api-clients-automation/pull/3255)) by [@shortcuts](https://github.com/shortcuts/)
+- [0a6277937](https://github.com/algolia/api-clients-automation/commit/0a6277937) fix(specs): add virtual index settings and update renderingContent ([#3254](https://github.com/algolia/api-clients-automation/pull/3254)) by [@shortcuts](https://github.com/shortcuts/)
+- [536a348f1](https://github.com/algolia/api-clients-automation/commit/536a348f1) fix(clients): chunked batch helper size property consistency ([#3253](https://github.com/algolia/api-clients-automation/pull/3253)) by [@Fluf22](https://github.com/Fluf22/)
+
 ## [3.0.0.beta.5](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.4...3.0.0.beta.5)
 
 - [b7ae19f2b](https://github.com/algolia/api-clients-automation/commit/b7ae19f2b) feat(specs): add transformations endpoints to ingestion ([#3215](https://github.com/algolia/api-clients-automation/pull/3215)) by [@shortcuts](https://github.com/shortcuts/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.beta.5)
+    algolia (3.0.0.beta.6)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
       net-http-persistent

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-Present Algolia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -51,12 +51,12 @@ For full documentation, visit the **[Algolia Ruby API Client](https://www.algoli
 
 ## ❓ Troubleshooting
 
-Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client.
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
 
-## Upgrade from V1 to V2
+## Contributing
 
-If you were using the v1 and wish to update to v2, please follow our [Upgrade Guide](upgrade_guide.md)
+This repository hosts the code of the generated Algolia API client for Ruby, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
 
 ## 📄 License
 
-Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).
+The Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE).

data/lib/algolia/api/search_client.rb

@@ -3178,6 +3178,64 @@ module Algolia
       valid_until - now
     end
 
+    # Helper: Saves the given array of objects in the given index. The `chunked_batch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+    #
+    # @param index_name [String]: The `index_name` to save `objects` in.
+    # @param objects [Array]: The array of `objects` to store in the given Algolia `indexName`.
+    # @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 [BatchResponse]
+    #
+    def save_objects(index_name, objects, request_options = {})
+      chunked_batch(
+        index_name,
+        objects,
+        Search::Action::ADD_OBJECT,
+        false,
+        1000,
+        request_options
+      )
+    end
+
+    # Helper: Deletes every records for the given objectIDs. The `chunked_batch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
+    #
+    # @param index_name [String]: The `index_name` to delete `object_ids` from.
+    # @param object_ids [Array]: The object_ids to delete.
+    # @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 [BatchResponse]
+    #
+    def delete_objects(index_name, object_ids, request_options = {})
+      chunked_batch(
+        index_name,
+        object_ids.map { |id| { "objectID" => id } },
+        Search::Action::DELETE_OBJECT,
+        false,
+        1000,
+        request_options
+      )
+    end
+
+    # Helper: Replaces object content of all the given objects according to their respective `object_id` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+    #
+    # @param index_name [String]: The `index_name` to delete `object_ids` from.
+    # @param objects [Array]: The objects to partially update.
+    # @param create_if_not_exists [Boolean]: To be provided if non-existing objects are passed, otherwise, the call will fail.
+    # @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 [BatchResponse]
+    #
+    def partial_update_objects(index_name, objects, create_if_not_exists, request_options = {})
+      chunked_batch(
+        index_name,
+        objects,
+        create_if_not_exists ? Search::Action::PARTIAL_UPDATE_OBJECT : Search::Action::PARTIAL_UPDATE_OBJECT_NO_CREATE,
+        false,
+        1000,
+        request_options
+      )
+    end
+
     # Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
     #
     # @param index_name [String] the `index_name` where the operation will be performed.

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

@@ -11,6 +11,9 @@ module Algolia
 
       attr_accessor :sort_remaining_by
 
+      # Hide facet values.
+      attr_accessor :hide
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -37,7 +40,8 @@ module Algolia
       def self.attribute_map
         {
           :order => :order,
-          :sort_remaining_by => :sortRemainingBy
+          :sort_remaining_by => :sortRemainingBy,
+          :hide => :hide
         }
       end
 
@@ -50,7 +54,8 @@ module Algolia
       def self.types_mapping
         {
           :order => :'Array<String>',
-          :sort_remaining_by => :SortRemainingBy
+          :sort_remaining_by => :SortRemainingBy,
+          :hide => :'Array<String>'
         }
       end
 
@@ -85,6 +90,12 @@ module Algolia
         if attributes.key?(:sort_remaining_by)
           self.sort_remaining_by = attributes[:sort_remaining_by]
         end
+
+        if attributes.key?(:hide)
+          if (value = attributes[:hide]).is_a?(Array)
+            self.hide = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -94,7 +105,8 @@ module Algolia
 
         self.class == other.class &&
           order == other.order &&
-          sort_remaining_by == other.sort_remaining_by
+          sort_remaining_by == other.sort_remaining_by &&
+          hide == other.hide
       end
 
       # @see the `==` method
@@ -106,7 +118,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [order, sort_remaining_by].hash
+        [order, sort_remaining_by, hide].hash
       end
 
       # Builds the object from hash

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

@@ -39,6 +39,9 @@ module Algolia
       # Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
       attr_accessor :replicas
 
+      # Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).
+      attr_accessor :virtual
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -52,7 +55,8 @@ module Algolia
           :number_of_pending_tasks => :numberOfPendingTasks,
           :pending_task => :pendingTask,
           :primary => :primary,
-          :replicas => :replicas
+          :replicas => :replicas,
+          :virtual => :virtual
         }
       end
 
@@ -74,7 +78,8 @@ module Algolia
           :number_of_pending_tasks => :Integer,
           :pending_task => :Boolean,
           :primary => :String,
-          :replicas => :'Array<String>'
+          :replicas => :'Array<String>',
+          :virtual => :Boolean
         }
       end
 
@@ -163,6 +168,10 @@ module Algolia
             self.replicas = value
           end
         end
+
+        if attributes.key?(:virtual)
+          self.virtual = attributes[:virtual]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -181,7 +190,8 @@ module Algolia
           number_of_pending_tasks == other.number_of_pending_tasks &&
           pending_task == other.pending_task &&
           primary == other.primary &&
-          replicas == other.replicas
+          replicas == other.replicas &&
+          virtual == other.virtual
       end
 
       # @see the `==` method
@@ -193,7 +203,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [name, created_at, updated_at, entries, data_size, file_size, last_build_time_s, number_of_pending_tasks, pending_task, primary, replicas].hash
+        [name, created_at, updated_at, entries, data_size, file_size, last_build_time_s, number_of_pending_tasks, pending_task, primary, replicas, virtual].hash
       end
 
       # Builds the object from hash

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

@@ -11,6 +11,9 @@ module Algolia
 
       attr_accessor :sort_remaining_by
 
+      # Hide facet values.
+      attr_accessor :hide
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -37,7 +40,8 @@ module Algolia
       def self.attribute_map
         {
           :order => :order,
-          :sort_remaining_by => :sortRemainingBy
+          :sort_remaining_by => :sortRemainingBy,
+          :hide => :hide
         }
       end
 
@@ -50,7 +54,8 @@ module Algolia
       def self.types_mapping
         {
           :order => :'Array<String>',
-          :sort_remaining_by => :SortRemainingBy
+          :sort_remaining_by => :SortRemainingBy,
+          :hide => :'Array<String>'
         }
       end
 
@@ -85,6 +90,12 @@ module Algolia
         if attributes.key?(:sort_remaining_by)
           self.sort_remaining_by = attributes[:sort_remaining_by]
         end
+
+        if attributes.key?(:hide)
+          if (value = attributes[:hide]).is_a?(Array)
+            self.hide = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -94,7 +105,8 @@ module Algolia
 
         self.class == other.class &&
           order == other.order &&
-          sort_remaining_by == other.sort_remaining_by
+          sort_remaining_by == other.sort_remaining_by &&
+          hide == other.hide
       end
 
       # @see the `==` method
@@ -106,7 +118,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [order, sort_remaining_by].hash
+        [order, sort_remaining_by, hide].hash
       end
 
       # Builds the object from hash

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.5'.freeze
+  VERSION = '3.0.0.beta.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.5
+  version: 3.0.0.beta.6
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,13 +114,11 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/release.yml"
 - ".gitignore"
-- ".openapi-generator-ignore"
-- ".openapi-generator/FILES"
-- ".openapi-generator/VERSION"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - algolia.gemspec

data/.openapi-generator/FILES

@@ -1,11 +0,0 @@
-lib/algolia/api/usage_client.rb
-lib/algolia/models/usage/error_base.rb
-lib/algolia/models/usage/get_usage200_response.rb
-lib/algolia/models/usage/get_usage200_response_statistics_inner.rb
-lib/algolia/models/usage/get_usage400_response.rb
-lib/algolia/models/usage/get_usage400_response_error.rb
-lib/algolia/models/usage/get_usage400_response_error_errors_inner.rb
-lib/algolia/models/usage/granularity.rb
-lib/algolia/models/usage/statistic.rb
-lib/algolia/models/usage/statistic_value.rb
-lib/algolia/version.rb

data/.openapi-generator/VERSION

@@ -1 +0,0 @@
-7.6.0

data/.openapi-generator-ignore

@@ -1,23 +0,0 @@
-# OpenAPI Generator Ignore
-# Generated by openapi-generator https://github.com/openapitools/openapi-generator
-
-# Use this file to prevent files from being overwritten by the generator.
-# The patterns follow closely to .gitignore or .dockerignore.
-
-# As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
-#ApiClient.cs
-
-# You can match any string of characters against a directory, file or extension with a single asterisk (*):
-#foo/*/qux
-# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
-
-# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
-#foo/**/qux
-# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
-
-# You can also negate patterns with an exclamation (!).
-# For example, you can ignore all files in a docs folder with the file extension .md:
-#docs/*.md
-# Then explicitly reverse the ignore rule for a single file:
-#!docs/README.md