algolia 3.0.0.alpha.12 → 3.0.0.alpha.13

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

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Search
     class SearchRulesResponse
-      # Fetched rules.
+      # Rules that matched the search criteria.
       attr_accessor :hits
 
-      # Number of fetched rules.
+      # Number of rules that matched the search criteria.
       attr_accessor :nb_hits
 
       # Current page.

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

@@ -6,12 +6,12 @@ require 'time'
 module Algolia
   module Search
     class SearchSynonymsParams
-      # Text to search for in an index.
+      # Search query.
       attr_accessor :query
 
       attr_accessor :type
 
-      # Page to retrieve (the first page is `0`, not `1`).
+      # Page of search results to retrieve.
       attr_accessor :page
 
       # Number of hits per page.
@@ -103,6 +103,20 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] page Value to be assigned
+      def page=(page)
+        if page.nil?
+          raise ArgumentError, 'page cannot be nil'
+        end
+
+        if page < 0
+          raise ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
+        end
+
+        @page = page
+      end
+
       # Custom attribute writer method with validation
       # @param [Object] hits_per_page Value to be assigned
       def hits_per_page=(hits_per_page)

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

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Search
     class SearchSynonymsResponse
-      # Synonym objects.
+      # Matching synonyms.
       attr_accessor :hits
 
-      # Number of hits the search query matched.
+      # Number of results (hits).
       attr_accessor :nb_hits
 
       attr_accessor :additional_properties

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

@@ -13,7 +13,7 @@ module Algolia
       # Cluster name.
       attr_accessor :cluster_name
 
-      # Page to retrieve (the first page is `0`, not `1`).
+      # Page of search results to retrieve.
       attr_accessor :page
 
       # Number of hits per page.
@@ -85,6 +85,20 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] page Value to be assigned
+      def page=(page)
+        if page.nil?
+          raise ArgumentError, 'page cannot be nil'
+        end
+
+        if page < 0
+          raise ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
+        end
+
+        @page = page
+      end
+
       # Custom attribute writer method with validation
       # @param [Object] hits_per_page Value to be assigned
       def hits_per_page=(hits_per_page)

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

@@ -10,10 +10,10 @@ module Algolia
       # User objects that match the query.
       attr_accessor :hits
 
-      # Number of hits the search query matched.
+      # Number of results (hits).
       attr_accessor :nb_hits
 
-      # Page to retrieve (the first page is `0`, not `1`).
+      # Page of search results to retrieve.
       attr_accessor :page
 
       # Maximum number of hits per page.
@@ -104,6 +104,20 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] page Value to be assigned
+      def page=(page)
+        if page.nil?
+          raise ArgumentError, 'page cannot be nil'
+        end
+
+        if page < 0
+          raise ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
+        end
+
+        @page = page
+      end
+
       # Custom attribute writer method with validation
       # @param [Object] hits_per_page Value to be assigned
       def hits_per_page=(hits_per_page)

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

@@ -8,19 +8,19 @@ module Algolia
     class SecuredAPIKeyRestrictions
       attr_accessor :search_params
 
-      # Filters that apply to every search made with the secured API key. You can add extra filters at search time with the filters query parameter. For example, if you set the filter group:admin on your generated API key, and you add groups:press OR groups:visitors with the filters query parameter, your final search filter is equivalent to groups:admin AND (groups:press OR groups:visitors).
+      # Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
       attr_accessor :filters
 
-      # Unix timestamp used to set the expiration date of the API key.
+      # Timestamp in [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time) when the API key should expire.
       attr_accessor :valid_until
 
-      # Index names that can be queried.
+      # Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
       attr_accessor :restrict_indices
 
-      # IPv4 network allowed to use the generated key. Use this to protect against API key leaking and reuse. You can only provide a single source, but you can specify a range of IPs (for example, 192.168.1.0/24).
+      # IP network that are allowed to use this key.  You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
       attr_accessor :restrict_sources
 
-      # Unique user IP address. This can be useful when you want to impose a rate limit on specific users. By default, rate limits are set based on the IP address. This can become an issue when several users search from the same IP address. To avoid this, you can set a unique userToken for each user when generating their API key. This lets you restrict each user to a maximum number of API calls per hour, even if they share their IP with another user. Specifying the userToken in a secured API key is also a good security practice as it ensures users don't change it. Many features like Analytics, Personalization, and Dynamic Re-ranking rely on the authenticity of user identifiers. Setting the userToken at the API key level ensures that downstream services work as expected and prevents abuse.
+      # Pseudonymous user identifier to restrict usage of this API key to specific users.  By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
       attr_accessor :user_token
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,9 +5,9 @@ require 'time'
 
 module Algolia
   module Search
-    # Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+    # Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
     class SemanticSearch
-      # Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+      # Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
       attr_accessor :event_sources
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,9 +5,9 @@ require 'time'
 
 module Algolia
   module Search
-    # Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+    # Snippets that show the context around a matching search query.
     class SnippetResultOption
-      # Markup text with `facetQuery` matches highlighted.
+      # Highlighted attribute value, including HTML tags.
       attr_accessor :value
 
       attr_accessor :match_level

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Search
-    # [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
+    # Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`.
     module TagFilters
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Search
     class TimeRange
-      # Lower bound of the time range (Unix timestamp).
+      # When the rule should start to be active, in Unix epoch time.
       attr_accessor :from
 
-      # Upper bound of the time range (Unix timestamp).
+      # When the rule should stop to be active, in Unix epoch time.
       attr_accessor :_until
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Search
-    # Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+    # Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
     module TypoTolerance
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -7,7 +7,7 @@ module Algolia
   module Search
     # Response, taskID, and update timestamp.
     class UpdatedAtResponse
-      # Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the `task` operation and this `taskID`.
+      # Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
       attr_accessor :task_id
 
       # Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.

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

@@ -7,13 +7,13 @@ module Algolia
   module Search
     # Response, taskID, unique object identifier, and an update timestamp.
     class UpdatedAtWithObjectIdResponse
-      # Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the `task` operation and this `taskID`.
+      # Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
       attr_accessor :task_id
 
       # Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
       attr_accessor :updated_at
 
-      # Unique object identifier.
+      # Unique record identifier.
       attr_accessor :object_id
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,13 +6,13 @@ require 'time'
 module Algolia
   module Search
     class UpdatedRuleResponse
-      # Unique object identifier.
+      # Unique identifier of a rule object.
       attr_accessor :object_id
 
       # Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
       attr_accessor :updated_at
 
-      # Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the `task` operation and this `taskID`.
+      # Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
       attr_accessor :task_id
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Search
     class UserHit
-      # userID of the user.
+      # User ID.
       attr_accessor :user_id
 
       # Cluster name.

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

@@ -7,7 +7,7 @@ module Algolia
   module Search
     # Unique user ID.
     class UserId
-      # userID of the user.
+      # User ID.
       attr_accessor :user_id
 
       # Cluster to which the user is assigned.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Search
     class Value
-      # Pinned order of facet lists.
+      # Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
       attr_accessor :order
 
       attr_accessor :sort_remaining_by

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.alpha.12'.freeze
+  VERSION = '3.0.0.alpha.13'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha.12
+  version: 3.0.0.alpha.13
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-05 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -284,6 +284,7 @@ files:
 - lib/algolia/models/ingestion/source_create_response.rb
 - lib/algolia/models/ingestion/source_csv.rb
 - lib/algolia/models/ingestion/source_docker.rb
+- lib/algolia/models/ingestion/source_ga4_big_query_export.rb
 - lib/algolia/models/ingestion/source_input.rb
 - lib/algolia/models/ingestion/source_json.rb
 - lib/algolia/models/ingestion/source_search.rb
@@ -294,6 +295,9 @@ files:
 - lib/algolia/models/ingestion/source_update_docker.rb
 - lib/algolia/models/ingestion/source_update_input.rb
 - lib/algolia/models/ingestion/source_update_response.rb
+- lib/algolia/models/ingestion/streaming_trigger.rb
+- lib/algolia/models/ingestion/streaming_trigger_type.rb
+- lib/algolia/models/ingestion/streaming_utils_input.rb
 - lib/algolia/models/ingestion/subscription_trigger.rb
 - lib/algolia/models/ingestion/subscription_trigger_type.rb
 - lib/algolia/models/ingestion/task.rb
@@ -587,6 +591,7 @@ files:
 - lib/algolia/models/search/save_synonym_response.rb
 - lib/algolia/models/search/scope_type.rb
 - lib/algolia/models/search/search_dictionary_entries_params.rb
+- lib/algolia/models/search/search_dictionary_entries_response.rb
 - lib/algolia/models/search/search_for_facet_values_request.rb
 - lib/algolia/models/search/search_for_facet_values_response.rb
 - lib/algolia/models/search/search_for_facets.rb