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

data/lib/algolia/models/ingestion/streaming_utils_input.rb

@@ -0,0 +1,199 @@
+# 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.
+
+require 'date'
+require 'time'
+
+module Algolia
+  module Ingestion
+    # The input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
+    class StreamingUtilsInput
+      attr_accessor :mapping
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :mapping => :mapping
+        }
+      end
+
+      # Returns all the JSON keys this model knows about
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :mapping => :MappingInput
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([])
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::StreamingUtilsInput` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::StreamingUtilsInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          end
+
+          h[k.to_sym] = v
+        end
+
+        if attributes.key?(:mapping)
+          self.mapping = attributes[:mapping]
+        else
+          self.mapping = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          mapping == other.mapping
+      end
+
+      # @see the `==` method
+      # @param [Object] Object to be compared
+      def eql?(other)
+        self == other
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code
+      def hash
+        [mapping].hash
+      end
+
+      # Builds the object from hash
+      # @param [Hash] attributes Model attributes in the form of hash
+      # @return [Object] Returns the model itself
+      def self.build_from_hash(attributes)
+        return nil unless attributes.is_a?(Hash)
+
+        attributes = attributes.transform_keys(&:to_sym)
+        transformed_hash = {}
+        types_mapping.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = nil
+          elsif type =~ /\AArray<(.*)>/i
+            # check to ensure the input is an array given that the attribute
+            # is documented as an array but the input is not
+            if attributes[attribute_map[key]].is_a?(Array)
+              transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
+          end
+        end
+        new(transformed_hash)
+      end
+
+      # Deserializes the data based on type
+      # @param string type Data type
+      # @param string value Value to be deserialized
+      # @return [Object] Deserialized data
+      def self._deserialize(type, value)
+        case type.to_sym
+        when :Time
+          Time.parse(value)
+        when :Date
+          Date.parse(value)
+        when :String
+          value.to_s
+        when :Integer
+          value.to_i
+        when :Float
+          value.to_f
+        when :Boolean
+          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+            true
+          else
+            false
+          end
+        when :Object
+          # generic object (usually a Hash), return directly
+          value
+        when /\AArray<(?<inner_type>.+)>\z/
+          inner_type = Regexp.last_match[:inner_type]
+          value.map { |v| _deserialize(inner_type, v) }
+        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+          k_type = Regexp.last_match[:k_type]
+          v_type = Regexp.last_match[:v_type]
+          {}.tap do |hash|
+            value.each do |k, v|
+              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+            end
+          end
+        else # model
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::Ingestion.const_get(type)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        end
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      # @return [Hash] Returns the object in the form of hash
+      def to_body
+        to_hash
+      end
+
+      def to_json(*_args)
+        to_hash.to_json
+      end
+
+      # Returns the object in the form of hash
+      # @return [Hash] Returns the object in the form of hash
+      def to_hash
+        hash = {}
+        self.class.attribute_map.each_pair do |attr, param|
+          value = send(attr)
+          if value.nil?
+            is_nullable = self.class.openapi_nullable.include?(attr)
+            next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+          end
+
+          hash[param] = _to_hash(value)
+        end
+        hash
+      end
+
+      # Outputs non-array value in the form of hash
+      # For object, use to_hash. Otherwise, just return the value
+      # @param [Object] value Any valid value
+      # @return [Hash] Returns the value in the form of hash
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.compact.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to? :to_hash
+          value.to_hash
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/algolia/models/ingestion/task_create_trigger.rb

@@ -12,6 +12,7 @@ module Algolia
           [
             :OnDemandTriggerInput,
             :ScheduleTriggerInput,
+            :StreamingTrigger,
             :SubscriptionTrigger
           ]
         end

data/lib/algolia/models/ingestion/task_input.rb

@@ -11,7 +11,8 @@ module Algolia
         def openapi_one_of
           [
             :OnDemandDateUtilsInput,
-            :ScheduleDateUtilsInput
+            :ScheduleDateUtilsInput,
+            :StreamingUtilsInput
           ]
         end
 

data/lib/algolia/models/ingestion/trigger.rb

@@ -12,6 +12,7 @@ module Algolia
           [
             :OnDemandTrigger,
             :ScheduleTrigger,
+            :StreamingTrigger,
             :SubscriptionTrigger
           ]
         end

data/lib/algolia/models/ingestion/trigger_type.rb

@@ -9,9 +9,10 @@ module Algolia
       ON_DEMAND = "onDemand".freeze
       SCHEDULE = "schedule".freeze
       SUBSCRIPTION = "subscription".freeze
+      STREAMING = "streaming".freeze
 
       def self.all_vars
-        @all_vars ||= [ON_DEMAND, SCHEDULE, SUBSCRIPTION].freeze
+        @all_vars ||= [ON_DEMAND, SCHEDULE, SUBSCRIPTION, STREAMING].freeze
       end
 
       # Builds the enum from string

data/lib/algolia/models/insights/added_to_cart_object_ids.rb

@@ -7,23 +7,23 @@ module Algolia
   module Insights
     # Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.  To track add-to-cart events related to Algolia requests, use the \"Added to cart object IDs after search\" event.
     class AddedToCartObjectIDs
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
       attr_accessor :event_subtype
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
-      # The object IDs of the records that are part of the event.
+      # Object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
       # Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
@@ -32,7 +32,7 @@ module Algolia
       # Extra information about the records involved in a purchase or add-to-cart event.  If specified, it must have the same length as `objectIDs`.
       attr_accessor :object_data
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       attr_accessor :value

data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb

@@ -7,26 +7,26 @@ module Algolia
   module Insights
     # Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event.
     class AddedToCartObjectIDsAfterSearch
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
       attr_accessor :event_subtype
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
       # Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.
       attr_accessor :query_id
 
-      # The object IDs of the records that are part of the event.
+      # Object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
       # Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
@@ -35,7 +35,7 @@ module Algolia
       # Extra information about the records involved in a purchase or add-to-cart events.  If provided, it must be the same length as `objectIDs`.
       attr_accessor :object_data
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       attr_accessor :value

data/lib/algolia/models/insights/clicked_filters.rb

@@ -7,24 +7,24 @@ module Algolia
   module Insights
     # Use this event to track when users click facet filters in your user interface.
     class ClickedFilters
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
-      # Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
+      # Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
       attr_accessor :filters
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       class EnumAttributeValidator

data/lib/algolia/models/insights/clicked_object_ids.rb

@@ -7,24 +7,24 @@ module Algolia
   module Insights
     # Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.  To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event.
     class ClickedObjectIDs
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
-      # The object IDs of the records that are part of the event.
+      # Object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       class EnumAttributeValidator

data/lib/algolia/models/insights/clicked_object_ids_after_search.rb

@@ -7,30 +7,30 @@ module Algolia
   module Insights
     # Click event after an Algolia request.  Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event.
     class ClickedObjectIDsAfterSearch
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
-      # The object IDs of the records that are part of the event.
+      # Object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # The position of the clicked item the search results.  The first search result has a position of 1 (not 0). You must provide 1 `position` for each `objectID`.
+      # Position of the clicked item the search results.  You must provide 1 `position` for each `objectID`.
       attr_accessor :positions
 
       # Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.
       attr_accessor :query_id
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       class EnumAttributeValidator

data/lib/algolia/models/insights/converted_filters.rb

@@ -6,24 +6,24 @@ require 'time'
 module Algolia
   module Insights
     class ConvertedFilters
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
-      # Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
+      # Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
       attr_accessor :filters
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       class EnumAttributeValidator

data/lib/algolia/models/insights/converted_object_ids.rb

@@ -7,24 +7,24 @@ module Algolia
   module Insights
     # Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.  To track conversion events related to Algolia requests, use the \"Converted object IDs after search\" event.
     class ConvertedObjectIDs
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
-      # The object IDs of the records that are part of the event.
+      # Object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       class EnumAttributeValidator

data/lib/algolia/models/insights/converted_object_ids_after_search.rb

@@ -7,27 +7,27 @@ module Algolia
   module Insights
     # Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart.  If you're building your category pages with Algolia, you'll also use this event.
     class ConvertedObjectIDsAfterSearch
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
-      # The object IDs of the records that are part of the event.
+      # Object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
       # Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.
       attr_accessor :query_id
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       class EnumAttributeValidator

data/lib/algolia/models/insights/discount.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Insights
-    # The absolute value of the discount for this product, in units of `currency`.
+    # Absolute value of the discount for this product, in units of `currency`.
     module Discount
       class << self
         # List of class defined in oneOf (OpenAPI v3)

data/lib/algolia/models/insights/insights_events.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Insights
     class InsightsEvents
-      # List of click and conversion events.  An event is an object representing a user interaction. Events have attributes that describe the interaction, such as an event name, a type, or a user token.  **All** events must be valid, otherwise the API returns an error.
+      # Click and conversion events.  **All** events must be valid, otherwise the API returns an error.
       attr_accessor :events
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/insights/object_data.rb

@@ -8,7 +8,7 @@ module Algolia
     class ObjectData
       attr_accessor :price
 
-      # The quantity of a product that has been purchased or added to the cart. The total value of a purchase is the sum of `quantity` multiplied with the `price` for each purchased item.
+      # Quantity of a product that has been purchased or added to the cart. The total purchase value is the sum of `quantity` multiplied with the `price` for each purchased item.
       attr_accessor :quantity
 
       attr_accessor :discount

data/lib/algolia/models/insights/object_data_after_search.rb

@@ -11,7 +11,7 @@ module Algolia
 
       attr_accessor :price
 
-      # The quantity of a product that has been purchased or added to the cart. The total value of a purchase is the sum of `quantity` multiplied with the `price` for each purchased item.
+      # Quantity of a product that has been purchased or added to the cart. The total purchase value is the sum of `quantity` multiplied with the `price` for each purchased item.
       attr_accessor :quantity
 
       attr_accessor :discount

data/lib/algolia/models/insights/price.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Insights
-    # The total price of a product, including any discounts, in units of `currency`.
+    # Total price of a product, including any discounts, in units of `currency`.
     module Price
       class << self
         # List of class defined in oneOf (OpenAPI v3)

data/lib/algolia/models/insights/purchased_object_ids.rb

@@ -7,23 +7,23 @@ module Algolia
   module Insights
     # Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.  To track purchase events related to Algolia requests, use the \"Purchased object IDs after search\" event.
     class PurchasedObjectIDs
-      # The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
       attr_accessor :event_subtype
 
-      # The name of an Algolia index.
+      # Index name to which the event's items belong.
       attr_accessor :index
 
-      # The object IDs of the records that are part of the event.
+      # Object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :authenticated_user_token
 
       # Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
@@ -32,7 +32,7 @@ module Algolia
       # Extra information about the records involved in a purchase or add-to-cart event.  If specified, it must have the same length as `objectIDs`.
       attr_accessor :object_data
 
-      # The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+      # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       attr_accessor :value