algolia 3.0.0.alpha.2 → 3.0.0.alpha.5

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

@@ -7,36 +7,38 @@ 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
-      # Can contain 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.
+      # 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.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
       attr_accessor :event_subtype
 
-      # Name of the Algolia index.
+      # The name of an Algolia index.
       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
 
-      # List of object identifiers for items of an Algolia index.
+      # The object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # Extra information about the records involved in the event—for example, to add price and quantities of purchased products.  If provided, must be the same length as `objectIDs`.
-      attr_accessor :object_data
+      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+      attr_accessor :user_token
+
+      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      attr_accessor :authenticated_user_token
 
-      # If you include pricing information in the `objectData` parameter, you must also specify the currency as ISO-4217 currency code, such as USD or EUR.
+      # Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
       attr_accessor :currency
 
-      # Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
-      attr_accessor :user_token
+      # 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
 
-      # Time 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.
+      # 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.
       attr_accessor :timestamp
 
-      # User token for authenticated users.
-      attr_accessor :authenticated_user_token
+      attr_accessor :value
 
       class EnumAttributeValidator
         attr_reader :datatype
@@ -69,11 +71,12 @@ module Algolia
           :index => :index,
           :query_id => :queryID,
           :object_ids => :objectIDs,
-          :object_data => :objectData,
-          :currency => :currency,
           :user_token => :userToken,
+          :authenticated_user_token => :authenticatedUserToken,
+          :currency => :currency,
+          :object_data => :objectData,
           :timestamp => :timestamp,
-          :authenticated_user_token => :authenticatedUserToken
+          :value => :value
         }
       end
 
@@ -91,11 +94,12 @@ module Algolia
           :index => :String,
           :query_id => :String,
           :object_ids => :'Array<String>',
-          :object_data => :'Array<ObjectDataAfterSearch>',
-          :currency => :String,
           :user_token => :String,
+          :authenticated_user_token => :String,
+          :currency => :String,
+          :object_data => :'Array<ObjectDataAfterSearch>',
           :timestamp => :Integer,
-          :authenticated_user_token => :String
+          :value => :Value
         }
       end
 
@@ -159,28 +163,32 @@ module Algolia
           self.object_ids = nil
         end
 
-        if attributes.key?(:object_data)
-          if (value = attributes[:object_data]).is_a?(Array)
-            self.object_data = value
-          end
+        if attributes.key?(:user_token)
+          self.user_token = attributes[:user_token]
+        else
+          self.user_token = nil
+        end
+
+        if attributes.key?(:authenticated_user_token)
+          self.authenticated_user_token = attributes[:authenticated_user_token]
         end
 
         if attributes.key?(:currency)
           self.currency = attributes[:currency]
         end
 
-        if attributes.key?(:user_token)
-          self.user_token = attributes[:user_token]
-        else
-          self.user_token = nil
+        if attributes.key?(:object_data)
+          if (value = attributes[:object_data]).is_a?(Array)
+            self.object_data = value
+          end
         end
 
         if attributes.key?(:timestamp)
           self.timestamp = attributes[:timestamp]
         end
 
-        if attributes.key?(:authenticated_user_token)
-          self.authenticated_user_token = attributes[:authenticated_user_token]
+        if attributes.key?(:value)
+          self.value = attributes[:value]
         end
       end
 
@@ -271,6 +279,47 @@ module Algolia
         @user_token = user_token
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] authenticated_user_token Value to be assigned
+      def authenticated_user_token=(authenticated_user_token)
+        if authenticated_user_token.nil?
+          raise ArgumentError, 'authenticated_user_token cannot be nil'
+        end
+
+        if authenticated_user_token.to_s.length > 129
+          raise ArgumentError, 'invalid value for "authenticated_user_token", the character length must be smaller than or equal to 129.'
+        end
+
+        if authenticated_user_token.to_s.length < 1
+          raise ArgumentError, 'invalid value for "authenticated_user_token", the character length must be great than or equal to 1.'
+        end
+
+        pattern = %r{[a-zA-Z0-9_=/+-]{1,129}}
+        if authenticated_user_token !~ pattern
+          raise ArgumentError, "invalid value for \"authenticated_user_token\", must conform to the pattern #{pattern}."
+        end
+
+        @authenticated_user_token = authenticated_user_token
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] object_data Value to be assigned
+      def object_data=(object_data)
+        if object_data.nil?
+          raise ArgumentError, 'object_data cannot be nil'
+        end
+
+        if object_data.length > 20
+          raise ArgumentError, 'invalid value for "object_data", number of items must be less than or equal to 20.'
+        end
+
+        if object_data.length < 1
+          raise ArgumentError, 'invalid value for "object_data", number of items must be greater than or equal to 1.'
+        end
+
+        @object_data = object_data
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -283,11 +332,12 @@ module Algolia
           index == other.index &&
           query_id == other.query_id &&
           object_ids == other.object_ids &&
-          object_data == other.object_data &&
-          currency == other.currency &&
           user_token == other.user_token &&
+          authenticated_user_token == other.authenticated_user_token &&
+          currency == other.currency &&
+          object_data == other.object_data &&
           timestamp == other.timestamp &&
-          authenticated_user_token == other.authenticated_user_token
+          value == other.value
       end
 
       # @see the `==` method
@@ -299,7 +349,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [event_name, event_type, event_subtype, index, query_id, object_ids, object_data, currency, user_token, timestamp, authenticated_user_token].hash
+        [event_name, event_type, event_subtype, index, query_id, object_ids, user_token, authenticated_user_token, currency, object_data, timestamp, value].hash
       end
 
       # Builds the object from hash

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

@@ -7,26 +7,26 @@ module Algolia
   module Insights
     # Use this event to track when users click facet filters in your user interface.
     class ClickedFilters
-      # Can contain 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.
+      # 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.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # Name of the Algolia index.
+      # The name of an Algolia index.
       attr_accessor :index
 
       # Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
       attr_accessor :filters
 
-      # Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
       attr_accessor :user_token
 
-      # Time 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
-
-      # User token for authenticated users.
+      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
       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.
+      attr_accessor :timestamp
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -57,8 +57,8 @@ module Algolia
           :index => :index,
           :filters => :filters,
           :user_token => :userToken,
-          :timestamp => :timestamp,
-          :authenticated_user_token => :authenticatedUserToken
+          :authenticated_user_token => :authenticatedUserToken,
+          :timestamp => :timestamp
         }
       end
 
@@ -75,8 +75,8 @@ module Algolia
           :index => :String,
           :filters => :'Array<String>',
           :user_token => :String,
-          :timestamp => :Integer,
-          :authenticated_user_token => :String
+          :authenticated_user_token => :String,
+          :timestamp => :Integer
         }
       end
 
@@ -134,13 +134,13 @@ module Algolia
           self.user_token = nil
         end
 
-        if attributes.key?(:timestamp)
-          self.timestamp = attributes[:timestamp]
-        end
-
         if attributes.key?(:authenticated_user_token)
           self.authenticated_user_token = attributes[:authenticated_user_token]
         end
+
+        if attributes.key?(:timestamp)
+          self.timestamp = attributes[:timestamp]
+        end
       end
 
       # Custom attribute writer method with validation
@@ -207,6 +207,29 @@ module Algolia
         @user_token = user_token
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] authenticated_user_token Value to be assigned
+      def authenticated_user_token=(authenticated_user_token)
+        if authenticated_user_token.nil?
+          raise ArgumentError, 'authenticated_user_token cannot be nil'
+        end
+
+        if authenticated_user_token.to_s.length > 129
+          raise ArgumentError, 'invalid value for "authenticated_user_token", the character length must be smaller than or equal to 129.'
+        end
+
+        if authenticated_user_token.to_s.length < 1
+          raise ArgumentError, 'invalid value for "authenticated_user_token", the character length must be great than or equal to 1.'
+        end
+
+        pattern = %r{[a-zA-Z0-9_=/+-]{1,129}}
+        if authenticated_user_token !~ pattern
+          raise ArgumentError, "invalid value for \"authenticated_user_token\", must conform to the pattern #{pattern}."
+        end
+
+        @authenticated_user_token = authenticated_user_token
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -218,8 +241,8 @@ module Algolia
           index == other.index &&
           filters == other.filters &&
           user_token == other.user_token &&
-          timestamp == other.timestamp &&
-          authenticated_user_token == other.authenticated_user_token
+          authenticated_user_token == other.authenticated_user_token &&
+          timestamp == other.timestamp
       end
 
       # @see the `==` method
@@ -231,7 +254,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [event_name, event_type, index, filters, user_token, timestamp, authenticated_user_token].hash
+        [event_name, event_type, index, filters, user_token, authenticated_user_token, timestamp].hash
       end
 
       # Builds the object from hash

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

@@ -7,21 +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
-      # Can contain 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.
+      # 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.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # Name of the Algolia index.
+      # The name of an Algolia index.
       attr_accessor :index
 
-      # List of object identifiers for items of an Algolia index.
+      # The object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
       attr_accessor :user_token
 
-      # Time 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.
+      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+      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.
       attr_accessor :timestamp
 
       class EnumAttributeValidator
@@ -54,6 +57,7 @@ module Algolia
           :index => :index,
           :object_ids => :objectIDs,
           :user_token => :userToken,
+          :authenticated_user_token => :authenticatedUserToken,
           :timestamp => :timestamp
         }
       end
@@ -71,6 +75,7 @@ module Algolia
           :index => :String,
           :object_ids => :'Array<String>',
           :user_token => :String,
+          :authenticated_user_token => :String,
           :timestamp => :Integer
         }
       end
@@ -129,6 +134,10 @@ module Algolia
           self.user_token = nil
         end
 
+        if attributes.key?(:authenticated_user_token)
+          self.authenticated_user_token = attributes[:authenticated_user_token]
+        end
+
         if attributes.key?(:timestamp)
           self.timestamp = attributes[:timestamp]
         end
@@ -198,6 +207,29 @@ module Algolia
         @user_token = user_token
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] authenticated_user_token Value to be assigned
+      def authenticated_user_token=(authenticated_user_token)
+        if authenticated_user_token.nil?
+          raise ArgumentError, 'authenticated_user_token cannot be nil'
+        end
+
+        if authenticated_user_token.to_s.length > 129
+          raise ArgumentError, 'invalid value for "authenticated_user_token", the character length must be smaller than or equal to 129.'
+        end
+
+        if authenticated_user_token.to_s.length < 1
+          raise ArgumentError, 'invalid value for "authenticated_user_token", the character length must be great than or equal to 1.'
+        end
+
+        pattern = %r{[a-zA-Z0-9_=/+-]{1,129}}
+        if authenticated_user_token !~ pattern
+          raise ArgumentError, "invalid value for \"authenticated_user_token\", must conform to the pattern #{pattern}."
+        end
+
+        @authenticated_user_token = authenticated_user_token
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -209,6 +241,7 @@ module Algolia
           index == other.index &&
           object_ids == other.object_ids &&
           user_token == other.user_token &&
+          authenticated_user_token == other.authenticated_user_token &&
           timestamp == other.timestamp
       end
 
@@ -221,7 +254,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [event_name, event_type, index, object_ids, user_token, timestamp].hash
+        [event_name, event_type, index, object_ids, user_token, authenticated_user_token, timestamp].hash
       end
 
       # Builds the object from hash

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

@@ -7,32 +7,32 @@ 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
-      # Can contain 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.
+      # 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.
       attr_accessor :event_name
 
       attr_accessor :event_type
 
-      # Name of the Algolia index.
+      # The name of an Algolia index.
       attr_accessor :index
 
-      # List of object identifiers for items of an Algolia index.
+      # The object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # Position of the clicked objects in the search results.  The first search result has a position of 1 (not 0). You must provide 1 `position` for each `objectID`.
+      # 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`.
       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
 
-      # Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+      # An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
       attr_accessor :user_token
 
-      # Time 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
-
-      # User token for authenticated users.
+      # An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
       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.
+      attr_accessor :timestamp
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -65,8 +65,8 @@ module Algolia
           :positions => :positions,
           :query_id => :queryID,
           :user_token => :userToken,
-          :timestamp => :timestamp,
-          :authenticated_user_token => :authenticatedUserToken
+          :authenticated_user_token => :authenticatedUserToken,
+          :timestamp => :timestamp
         }
       end
 
@@ -85,8 +85,8 @@ module Algolia
           :positions => :'Array<Integer>',
           :query_id => :String,
           :user_token => :String,
-          :timestamp => :Integer,
-          :authenticated_user_token => :String
+          :authenticated_user_token => :String,
+          :timestamp => :Integer
         }
       end
 
@@ -158,13 +158,13 @@ module Algolia
           self.user_token = nil
         end
 
-        if attributes.key?(:timestamp)
-          self.timestamp = attributes[:timestamp]
-        end
-
         if attributes.key?(:authenticated_user_token)
           self.authenticated_user_token = attributes[:authenticated_user_token]
         end
+
+        if attributes.key?(:timestamp)
+          self.timestamp = attributes[:timestamp]
+        end
       end
 
       # Custom attribute writer method with validation
@@ -272,6 +272,29 @@ module Algolia
         @user_token = user_token
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] authenticated_user_token Value to be assigned
+      def authenticated_user_token=(authenticated_user_token)
+        if authenticated_user_token.nil?
+          raise ArgumentError, 'authenticated_user_token cannot be nil'
+        end
+
+        if authenticated_user_token.to_s.length > 129
+          raise ArgumentError, 'invalid value for "authenticated_user_token", the character length must be smaller than or equal to 129.'
+        end
+
+        if authenticated_user_token.to_s.length < 1
+          raise ArgumentError, 'invalid value for "authenticated_user_token", the character length must be great than or equal to 1.'
+        end
+
+        pattern = %r{[a-zA-Z0-9_=/+-]{1,129}}
+        if authenticated_user_token !~ pattern
+          raise ArgumentError, "invalid value for \"authenticated_user_token\", must conform to the pattern #{pattern}."
+        end
+
+        @authenticated_user_token = authenticated_user_token
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -285,8 +308,8 @@ module Algolia
           positions == other.positions &&
           query_id == other.query_id &&
           user_token == other.user_token &&
-          timestamp == other.timestamp &&
-          authenticated_user_token == other.authenticated_user_token
+          authenticated_user_token == other.authenticated_user_token &&
+          timestamp == other.timestamp
       end
 
       # @see the `==` method
@@ -298,7 +321,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [event_name, event_type, index, object_ids, positions, query_id, user_token, timestamp, authenticated_user_token].hash
+        [event_name, event_type, index, object_ids, positions, query_id, user_token, authenticated_user_token, timestamp].hash
       end
 
       # Builds the object from hash