converted_object_ids.rb in algolia-3.0.0.alpha.13

- old
+ new
@@ -5,27 +5,27 @@
 
 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
         attr_reader :datatype
         attr_reader :allowable_values