algolia 3.2.4 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a64b03510c49811a05ef303caf8bcd6eefa1dbde3def6a8c325d85a317afa5f
-  data.tar.gz: 4079a9e13e59c35c65b3d803f2c5c9567d424233987e65619d2ffc4f021c454c
+  metadata.gz: a1a84f43853e0a3c466d7971914aa53e83f0e810f5c1ca1679d7b6d18e3424f9
+  data.tar.gz: 682e034e5401f005d65bd0bdc5585787069759dae9a58f579c343346c6992387
 SHA512:
-  metadata.gz: defbab9d5e25a2a9645ece5eca9a8749ac97f9c260cfcc754872d96e6f2615ace9e68302390018ca664714c293289694980d123b508cdacf1c81d6d62ba982d0
-  data.tar.gz: 9598a0efd52bfbf8b25d3948bcde4944a7b3c6e4aca1c98493f5091feb2c76055ccd5e8812a88d09d4d5711b39515e49063a07163b19b9a6e6e7c080e119d441
+  metadata.gz: fd10a9f1f46127786c68a0de24ff0d016c15647b9cfbb94a627905eb7702dd59130a18e2ccfdfdf95b4f363eff555bc0e28836a47fb6d9df9449e1de0728733a
+  data.tar.gz: 5b32ece4710592b5a28f87031de3eaae1e1c11e5449e13a79882b90268fd7f6c3fcf4588d57c0a4f301edf96c3887f1d0ddcba3b382b663098117e0f223460a2

data/.github/workflows/issue.yml

@@ -31,7 +31,7 @@ jobs:
               },
               body: JSON.stringify({
                 fields: {
-                  description: `Issue created by ${context.actor} at [${context.payload.issue.html_url}](${context.payload.issue.html_url}) \n\n${body}`,
+                  description: `Issue created by ${context.actor} at ${context.payload.issue.html_url} \n\n${body}`,
                   issuetype: {
                     id: '10001'
                   },

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.3.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.2.4...3.3.0)
+
+- [2c65a8d11](https://github.com/algolia/api-clients-automation/commit/2c65a8d11) feat(clients): helper to switch API key in use ([#3616](https://github.com/algolia/api-clients-automation/pull/3616)) by [@Fluf22](https://github.com/Fluf22/)
+- [f126366dc](https://github.com/algolia/api-clients-automation/commit/f126366dc) fix(specs): note on Analytics API server ([#3650](https://github.com/algolia/api-clients-automation/pull/3650)) by [@kai687](https://github.com/kai687/)
+- [3d02b3164](https://github.com/algolia/api-clients-automation/commit/3d02b3164) feat(clients): add helper to check if an index exists ([#3646](https://github.com/algolia/api-clients-automation/pull/3646)) by [@millotp](https://github.com/millotp/)
+- [a36746d65](https://github.com/algolia/api-clients-automation/commit/a36746d65) fix(specs): note on insights API server ([#3649](https://github.com/algolia/api-clients-automation/pull/3649)) by [@kai687](https://github.com/kai687/)
+- [1f53716c6](https://github.com/algolia/api-clients-automation/commit/1f53716c6) fix(specs): don't extend $ref objects ([#3623](https://github.com/algolia/api-clients-automation/pull/3623)) by [@kai687](https://github.com/kai687/)
+
 ## [3.2.4](https://github.com/algolia/algoliasearch-client-ruby/compare/3.2.3...3.2.4)
 
 - [a9405b168](https://github.com/algolia/api-clients-automation/commit/a9405b168) fix(specs): usage api ([#3624](https://github.com/algolia/api-clients-automation/pull/3624)) by [@kai687](https://github.com/kai687/)

data/Gemfile.lock

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

data/lib/algolia/api/abtesting_client.rb

@@ -39,6 +39,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # Creates a new A/B test.
     #
     # Required API Key ACLs:

data/lib/algolia/api/analytics_client.rb

@@ -39,6 +39,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # This method allow you to send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)

data/lib/algolia/api/ingestion_client.rb

@@ -39,6 +39,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # Creates a new authentication resource.
     #
     # Required API Key ACLs:

data/lib/algolia/api/insights_client.rb

@@ -39,6 +39,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # This method allow you to send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)

data/lib/algolia/api/monitoring_client.rb

@@ -24,6 +24,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # This method allow you to send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)

data/lib/algolia/api/personalization_client.rb

@@ -39,6 +39,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # This method allow you to send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)

data/lib/algolia/api/query_suggestions_client.rb

@@ -39,6 +39,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
     #
     # Required API Key ACLs:

data/lib/algolia/api/recommend_client.rb

@@ -32,6 +32,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # This method allow you to send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)

data/lib/algolia/api/search_client.rb

@@ -35,6 +35,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # Creates a new API key with specific permissions and restrictions.
     #
     # Required API Key ACLs:
@@ -3532,5 +3540,17 @@ module Algolia
         move_operation_response: move_operation_response
       )
     end
+
+    def index_exists?(index_name)
+      begin
+        get_settings(index_name)
+      rescue AlgoliaHttpError => e
+        return false if e.code == 404
+
+        raise e
+      end
+
+      true
+    end
   end
 end

data/lib/algolia/api/usage_client.rb

@@ -24,6 +24,14 @@ module Algolia
       new(config)
     end
 
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+    end
+
     # This method allow you to send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)

data/lib/algolia/api_client.rb

@@ -20,6 +20,10 @@ module Algolia
       @@default ||= ApiClient.new
     end
 
+    def set_client_api_key(api_key)
+      @config.set_client_api_key(api_key)
+    end
+
     # Call an API with given options.
     #
     # @return [Http::Response] the response.

data/lib/algolia/configuration.rb

@@ -44,6 +44,11 @@ module Algolia
       yield(self) if block_given?
     end
 
+    def set_client_api_key(api_key)
+      @api_key = api_key
+      @header_params["X-Algolia-API-Key"] = api_key
+    end
+
     # The default Configuration object.
     def self.default
       @@default ||= Configuration.new

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.2.4".freeze
+  VERSION = "3.3.0".freeze
 end

metadata

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