algolia 3.10.2 → 3.12.0

data/lib/algolia/api/composition_client.rb

@@ -0,0 +1,174 @@
+# 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.
+
+module Algolia
+  class CompositionClient
+    attr_accessor :api_client
+
+    def initialize(config = nil)
+      raise "`config` is missing." if config.nil?
+      raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
+      raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
+
+      @api_client = Algolia::ApiClient.new(config)
+    end
+
+    def self.create(app_id, api_key, opts = {})
+      hosts = []
+      hosts << Transport::StatefulHost.new("#{app_id}-dsn.algolia.net", accept: CallType::READ)
+      hosts << Transport::StatefulHost.new("#{app_id}.algolia.net", accept: CallType::WRITE)
+
+      hosts += 1
+        .upto(3)
+        .map do |i|
+          Transport::StatefulHost.new("#{app_id}-#{i}.algolianet.com", accept: CallType::READ | CallType::WRITE)
+        end
+        .shuffle
+
+      config = Algolia::Configuration.new(app_id, api_key, hosts, "Composition", opts)
+      create_with_config(config)
+    end
+
+    def self.create_with_config(config)
+      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)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
+    end
+
+    # Runs a query on a single composition and returns matching results.
+    #
+    # Required API Key ACLs:
+    #   - search
+    # @param composition_id [String] Unique Composition ObjectID. (required)
+    # @param request_body [RequestBody]  (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 search_with_http_info(composition_id, request_body, request_options = {})
+      # verify the required parameter 'composition_id' is set
+      if @api_client.config.client_side_validation && composition_id.nil?
+        raise ArgumentError, "Parameter `composition_id` is required when calling `search`."
+      end
+      # verify the required parameter 'request_body' is set
+      if @api_client.config.client_side_validation && request_body.nil?
+        raise ArgumentError, "Parameter `request_body` is required when calling `search`."
+      end
+
+      path = "/1/compositions/{compositionID}/run".sub(
+        "{" + "compositionID" + "}",
+        Transport.encode_uri(composition_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(request_body)
+
+      new_options = request_options.merge(
+        :operation => :"CompositionClient.search",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => true
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Runs a query on a single composition and returns matching results.
+    #
+    # Required API Key ACLs:
+    #   - search
+    # @param composition_id [String] Unique Composition ObjectID. (required)
+    # @param request_body [RequestBody]  (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 [SearchResponse]
+    def search(composition_id, request_body, request_options = {})
+      response = search_with_http_info(composition_id, request_body, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Composition::SearchResponse")
+    end
+
+    # Searches for values of a specified facet attribute on the composition's main source's index.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.
+    #
+    # Required API Key ACLs:
+    #   - search
+    # @param composition_id [String] Unique Composition ObjectID. (required)
+    # @param facet_name [String] Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.  (required)
+    # @param search_for_facet_values_request [SearchForFacetValuesRequest]
+    # @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 search_for_facet_values_with_http_info(
+      composition_id,
+      facet_name,
+      search_for_facet_values_request = nil,
+      request_options = {}
+    )
+      # verify the required parameter 'composition_id' is set
+      if @api_client.config.client_side_validation && composition_id.nil?
+        raise ArgumentError, "Parameter `composition_id` is required when calling `search_for_facet_values`."
+      end
+      # verify the required parameter 'facet_name' is set
+      if @api_client.config.client_side_validation && facet_name.nil?
+        raise ArgumentError, "Parameter `facet_name` is required when calling `search_for_facet_values`."
+      end
+
+      path = "/1/compositions/{compositionID}/facets/{facetName}/query"
+        .sub("{" + "compositionID" + "}", Transport.encode_uri(composition_id.to_s))
+        .sub("{" + "facetName" + "}", Transport.encode_uri(facet_name.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(search_for_facet_values_request)
+
+      new_options = request_options.merge(
+        :operation => :"CompositionClient.search_for_facet_values",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => true
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Searches for values of a specified facet attribute on the composition's main source's index.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.
+    #
+    # Required API Key ACLs:
+    #   - search
+    # @param composition_id [String] Unique Composition ObjectID. (required)
+    # @param facet_name [String] Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.  (required)
+    # @param search_for_facet_values_request [SearchForFacetValuesRequest]
+    # @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 [SearchForFacetValuesResponse]
+    def search_for_facet_values(composition_id, facet_name, search_for_facet_values_request = nil, request_options = {})
+      response = search_for_facet_values_with_http_info(
+        composition_id,
+        facet_name,
+        search_for_facet_values_request,
+        request_options
+      )
+      @api_client.deserialize(
+        response.body,
+        request_options[:debug_return_type] || "Composition::SearchForFacetValuesResponse"
+      )
+    end
+
+  end
+end

data/lib/algolia/api/ingestion_client.rb

@@ -1,3 +1,5 @@
+# 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.
 
 module Algolia
@@ -39,7 +41,7 @@ module Algolia
 
       hosts <<
         Transport::StatefulHost.new(
-          "data.{region}.algolia.com".sub!("{region}", region),
+          "data.{region}.algolia.com".sub("{region}", region),
           accept: CallType::READ | CallType::WRITE
         )
 
@@ -1862,6 +1864,7 @@ module Algolia
     # @param source_type [Array<SourceType>] Filters the tasks with the specified source type.
     # @param destination_id [Array<String>] Destination IDs for filtering the list of tasks.
     # @param trigger_type [Array<TriggerType>] Type of task trigger for filtering the list of tasks.
+    # @param with_email_notifications [Boolean] If specified, the response only includes tasks with notifications.email.enabled set to this value.
     # @param sort [TaskSortKeys] Property by which to sort the list of tasks. (default to 'createdAt')
     # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
     # @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)
@@ -1875,6 +1878,7 @@ module Algolia
       source_type = nil,
       destination_id = nil,
       trigger_type = nil,
+      with_email_notifications = nil,
       sort = nil,
       order = nil,
       request_options = {}
@@ -1892,6 +1896,7 @@ module Algolia
       end
 
       query_params[:triggerType] = @api_client.build_collection_param(trigger_type, :csv) unless trigger_type.nil?
+      query_params[:withEmailNotifications] = with_email_notifications unless with_email_notifications.nil?
       query_params[:sort] = sort unless sort.nil?
       query_params[:order] = order unless order.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -1925,6 +1930,7 @@ module Algolia
     # @param source_type [Array<SourceType>] Filters the tasks with the specified source type.
     # @param destination_id [Array<String>] Destination IDs for filtering the list of tasks.
     # @param trigger_type [Array<TriggerType>] Type of task trigger for filtering the list of tasks.
+    # @param with_email_notifications [Boolean] If specified, the response only includes tasks with notifications.email.enabled set to this value.
     # @param sort [TaskSortKeys] Property by which to sort the list of tasks. (default to 'createdAt')
     # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
     # @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)
@@ -1938,6 +1944,7 @@ module Algolia
       source_type = nil,
       destination_id = nil,
       trigger_type = nil,
+      with_email_notifications = nil,
       sort = nil,
       order = nil,
       request_options = {}
@@ -1951,6 +1958,7 @@ module Algolia
         source_type,
         destination_id,
         trigger_type,
+        with_email_notifications,
         sort,
         order,
         request_options
@@ -2152,6 +2160,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
       request_options[:timeout] ||= 180000
+      request_options[:connect_timeout] ||= 180000
 
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(push_task_payload)
 
@@ -2616,7 +2625,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array<Ingestion::Transformation>")
     end
 
-    # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
+    # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -2637,6 +2646,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
       request_options[:timeout] ||= 180000
+      request_options[:connect_timeout] ||= 180000
 
       post_body = request_options[:debug_body]
 
@@ -2651,7 +2661,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
+    # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -3116,6 +3126,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
       request_options[:timeout] ||= 180000
+      request_options[:connect_timeout] ||= 180000
 
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_create)
 
@@ -3170,6 +3181,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
       request_options[:timeout] ||= 180000
+      request_options[:connect_timeout] ||= 180000
 
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_update)
 

data/lib/algolia/api/insights_client.rb

@@ -1,3 +1,5 @@
+# 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.
 
 module Algolia
@@ -39,7 +41,7 @@ module Algolia
 
       hosts <<
         Transport::StatefulHost.new(
-          region.nil? ? "insights.algolia.io" : "insights.{region}.algolia.io".sub!("{region}", region),
+          region.nil? ? "insights.algolia.io" : "insights.{region}.algolia.io".sub("{region}", region),
           accept: CallType::READ | CallType::WRITE
         )
 

data/lib/algolia/api/monitoring_client.rb

@@ -1,3 +1,5 @@
+# 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.
 
 module Algolia

data/lib/algolia/api/personalization_client.rb

@@ -1,3 +1,5 @@
+# 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.
 
 module Algolia
@@ -39,7 +41,7 @@ module Algolia
 
       hosts <<
         Transport::StatefulHost.new(
-          "personalization.{region}.algolia.com".sub!("{region}", region),
+          "personalization.{region}.algolia.com".sub("{region}", region),
           accept: CallType::READ | CallType::WRITE
         )
 

data/lib/algolia/api/query_suggestions_client.rb

@@ -1,3 +1,5 @@
+# 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.
 
 module Algolia
@@ -39,7 +41,7 @@ module Algolia
 
       hosts <<
         Transport::StatefulHost.new(
-          "query-suggestions.{region}.algolia.com".sub!("{region}", region),
+          "query-suggestions.{region}.algolia.com".sub("{region}", region),
           accept: CallType::READ | CallType::WRITE
         )
 

data/lib/algolia/api/recommend_client.rb

@@ -1,3 +1,5 @@
+# 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.
 
 module Algolia
@@ -287,10 +289,10 @@ module Algolia
     #   - editSettings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
-    # @param object_id [String] Unique record identifier. (required)
+    # @param algolia_object_id [String] Unique record identifier. (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 delete_recommend_rule_with_http_info(index_name, model, object_id, request_options = {})
+    def delete_recommend_rule_with_http_info(index_name, model, algolia_object_id, 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 `delete_recommend_rule`."
@@ -299,15 +301,15 @@ module Algolia
       if @api_client.config.client_side_validation && model.nil?
         raise ArgumentError, "Parameter `model` is required when calling `delete_recommend_rule`."
       end
-      # verify the required parameter 'object_id' is set
-      if @api_client.config.client_side_validation && object_id.nil?
-        raise ArgumentError, "Parameter `object_id` is required when calling `delete_recommend_rule`."
+      # verify the required parameter 'algolia_object_id' is set
+      if @api_client.config.client_side_validation && algolia_object_id.nil?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_recommend_rule`."
       end
 
       path = "/1/indexes/{indexName}/{model}/recommend/rules/{objectID}"
         .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
         .sub("{" + "model" + "}", Transport.encode_uri(model.to_s))
-        .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
+        .sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -332,11 +334,11 @@ module Algolia
     #   - editSettings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
-    # @param object_id [String] Unique record identifier. (required)
+    # @param algolia_object_id [String] Unique record identifier. (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 [DeletedAtResponse]
-    def delete_recommend_rule(index_name, model, object_id, request_options = {})
-      response = delete_recommend_rule_with_http_info(index_name, model, object_id, request_options)
+    def delete_recommend_rule(index_name, model, algolia_object_id, request_options = {})
+      response = delete_recommend_rule_with_http_info(index_name, model, algolia_object_id, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Recommend::DeletedAtResponse")
     end
 
@@ -346,10 +348,10 @@ module Algolia
     #   - settings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
-    # @param object_id [String] Unique record identifier. (required)
+    # @param algolia_object_id [String] Unique record identifier. (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 get_recommend_rule_with_http_info(index_name, model, object_id, request_options = {})
+    def get_recommend_rule_with_http_info(index_name, model, algolia_object_id, 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_recommend_rule`."
@@ -358,15 +360,15 @@ module Algolia
       if @api_client.config.client_side_validation && model.nil?
         raise ArgumentError, "Parameter `model` is required when calling `get_recommend_rule`."
       end
-      # verify the required parameter 'object_id' is set
-      if @api_client.config.client_side_validation && object_id.nil?
-        raise ArgumentError, "Parameter `object_id` is required when calling `get_recommend_rule`."
+      # verify the required parameter 'algolia_object_id' is set
+      if @api_client.config.client_side_validation && algolia_object_id.nil?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_recommend_rule`."
       end
 
       path = "/1/indexes/{indexName}/{model}/recommend/rules/{objectID}"
         .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
         .sub("{" + "model" + "}", Transport.encode_uri(model.to_s))
-        .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
+        .sub("{" + "objectID" + "}", Transport.encode_uri(algolia_object_id.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -391,11 +393,11 @@ module Algolia
     #   - settings
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).  (required)
-    # @param object_id [String] Unique record identifier. (required)
+    # @param algolia_object_id [String] Unique record identifier. (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 [RecommendRule]
-    def get_recommend_rule(index_name, model, object_id, request_options = {})
-      response = get_recommend_rule_with_http_info(index_name, model, object_id, request_options)
+    def get_recommend_rule(index_name, model, algolia_object_id, request_options = {})
+      response = get_recommend_rule_with_http_info(index_name, model, algolia_object_id, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Recommend::RecommendRule")
     end