algolia 3.0.0.alpha.16 → 3.0.0.alpha.18

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

@@ -12,7 +12,7 @@ module Algolia
 
       attr_accessor :event_type
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
@@ -24,7 +24,7 @@ module Algolia
       # 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
 
-      # 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, measured in milliseconds since the Unix epoch. 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

@@ -12,7 +12,7 @@ module Algolia
 
       attr_accessor :event_type
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Object IDs of the records that are part of the event.
@@ -24,7 +24,7 @@ module Algolia
       # 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
 
-      # 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, measured in milliseconds since the Unix epoch. 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

@@ -12,7 +12,7 @@ module Algolia
 
       attr_accessor :event_type
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Object IDs of the records that are part of the event.
@@ -30,7 +30,7 @@ module Algolia
       # 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
 
-      # 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, measured in milliseconds since the Unix epoch. 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

@@ -11,7 +11,7 @@ module Algolia
 
       attr_accessor :event_type
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
@@ -23,7 +23,7 @@ module Algolia
       # 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
 
-      # 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, measured in milliseconds since the Unix epoch. 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

@@ -12,7 +12,7 @@ module Algolia
 
       attr_accessor :event_type
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Object IDs of the records that are part of the event.
@@ -24,7 +24,7 @@ module Algolia
       # 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
 
-      # 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, measured in milliseconds since the Unix epoch. 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

@@ -12,7 +12,7 @@ module Algolia
 
       attr_accessor :event_type
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Object IDs of the records that are part of the event.
@@ -27,7 +27,7 @@ module Algolia
       # 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
 
-      # 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, measured in milliseconds since the Unix epoch. 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/purchased_object_ids.rb

@@ -14,7 +14,7 @@ module Algolia
 
       attr_accessor :event_subtype
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Object IDs of the records that are part of the event.
@@ -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
 
-      # 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, measured in milliseconds since the Unix epoch. 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/purchased_object_ids_after_search.rb

@@ -14,7 +14,7 @@ module Algolia
 
       attr_accessor :event_subtype
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Object IDs of the records that are part of the event.
@@ -32,7 +32,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
 
-      # 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, measured in milliseconds since the Unix epoch. 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/viewed_filters.rb

@@ -12,7 +12,7 @@ module Algolia
 
       attr_accessor :event_type
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
@@ -24,7 +24,7 @@ module Algolia
       # 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
 
-      # 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, measured in milliseconds since the Unix epoch. 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/viewed_object_ids.rb

@@ -12,7 +12,7 @@ module Algolia
 
       attr_accessor :event_type
 
-      # Index name to which the event's items belong.
+      # Index name (case-sensitive) to which the event's items belong.
       attr_accessor :index
 
       # Object IDs of the records that are part of the event.
@@ -24,7 +24,7 @@ module Algolia
       # 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
 
-      # 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, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
       attr_accessor :timestamp
 
       class EnumAttributeValidator

data/lib/algolia/models/monitoring/incidents_inner.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Monitoring
     class IncidentsInner
-      # Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+      # Timestamp, measured in milliseconds since the Unix epoch.
       attr_accessor :t
 
       attr_accessor :v

data/lib/algolia/models/monitoring/probes_metric.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Monitoring
     class ProbesMetric
-      # Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+      # Timestamp, measured in milliseconds since the Unix epoch.
       attr_accessor :t
 
       # Value of the metric.

data/lib/algolia/models/monitoring/time_inner.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Monitoring
     class TimeInner
-      # Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+      # Timestamp, measured in milliseconds since the Unix epoch.
       attr_accessor :t
 
       # Time in ms.

data/lib/algolia/models/personalization/delete_user_profile_response.rb

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Personalization
     class DeleteUserProfileResponse
-      # userToken representing the user for which to fetch the Personalization profile.
+      # Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # A date until which the data can safely be considered as deleted for the given user. Any data received after the `deletedUntil` date will start building a new user profile.
+      # Date and time when the user profile can be safely considered to be deleted. Any events received after the `deletedUntil` date start a new user profile.
       attr_accessor :deleted_until
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/personalization/event_scoring.rb

@@ -6,15 +6,36 @@ require 'time'
 module Algolia
   module Personalization
     class EventScoring
-      # The score for the event.
+      # Event score.
       attr_accessor :score
 
-      # The name of the event.
+      # Event name.
       attr_accessor :event_name
 
-      # The type of the event.
       attr_accessor :event_type
 
+      class EnumAttributeValidator
+        attr_reader :datatype
+        attr_reader :allowable_values
+
+        def initialize(datatype, allowable_values)
+          @allowable_values = allowable_values.map do |value|
+            case datatype.to_s
+            when /Integer/i
+              value.to_i
+            when /Float/i
+              value.to_f
+            else
+              value
+            end
+          end
+        end
+
+        def valid?(value)
+          !value || allowable_values.include?(value)
+        end
+      end
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -34,7 +55,7 @@ module Algolia
         {
           :score => :Integer,
           :event_name => :String,
-          :event_type => :String
+          :event_type => :EventType
         }
       end
 

data/lib/algolia/models/personalization/event_type.rb

@@ -0,0 +1,34 @@
+# 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 Personalization
+    class EventType
+      CLICK = "click".freeze
+      CONVERSION = "conversion".freeze
+      VIEW = "view".freeze
+
+      def self.all_vars
+        @all_vars ||= [CLICK, CONVERSION, VIEW].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if EventType.all_vars.include?(value)
+
+        raise "Invalid ENUM value #{value} for class #EventType"
+      end
+    end
+  end
+end

data/lib/algolia/models/personalization/facet_scoring.rb

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Personalization
     class FacetScoring
-      # The score for the event.
+      # Event score.
       attr_accessor :score
 
-      # The name of the facet.
+      # Facet attribute name.
       attr_accessor :facet_name
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/personalization/get_user_token_response.rb

@@ -6,13 +6,13 @@ require 'time'
 module Algolia
   module Personalization
     class GetUserTokenResponse
-      # userToken representing the user for which to fetch the Personalization profile.
+      # Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # Date of last event update. (ISO-8601 format).
+      # Date and time of the last event from this user, in RFC 3339 format.
       attr_accessor :last_event_at
 
-      # The userToken scores.
+      # Scores for different facet values.  Scores represent the user affinity for a user profile towards specific facet values, given the personalization strategy and past events.
       attr_accessor :scores
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/personalization/personalization_strategy_params.rb

@@ -6,13 +6,13 @@ require 'time'
 module Algolia
   module Personalization
     class PersonalizationStrategyParams
-      # Scores associated with the events.
+      # Scores associated with each event.  The higher the scores, the higher the impact of those events on the personalization of search results.
       attr_accessor :event_scoring
 
-      # Scores associated with the facets.
+      # Scores associated with each facet.  The higher the scores, the higher the impact of those events on the personalization of search results.
       attr_accessor :facet_scoring
 
-      # The impact that personalization has on search results: a number between 0 (personalization disabled) and 100 (personalization fully enabled).
+      # Impact of personalization on the search results.  If set to 0, personalization has no impact on the search results.
       attr_accessor :personalization_impact
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -83,6 +83,24 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] personalization_impact Value to be assigned
+      def personalization_impact=(personalization_impact)
+        if personalization_impact.nil?
+          raise ArgumentError, 'personalization_impact cannot be nil'
+        end
+
+        if personalization_impact > 100
+          raise ArgumentError, 'invalid value for "personalization_impact", must be smaller than or equal to 100.'
+        end
+
+        if personalization_impact < 0
+          raise ArgumentError, 'invalid value for "personalization_impact", must be greater than or equal to 0.'
+        end
+
+        @personalization_impact = personalization_impact
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

data/lib/algolia/models/query-suggestions/get_config_status200_response.rb

@@ -6,16 +6,16 @@ require 'time'
 module Algolia
   module QuerySuggestions
     class GetConfigStatus200Response
-      # Name of the Query Suggestions index.
+      # Name of the Query Suggestions index (case-sensitive).
       attr_accessor :index_name
 
       # Whether the creation or update of the Query Suggestions index is in progress.
       attr_accessor :is_running
 
-      # Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last built.
+      # Date and time when the Query Suggestions index was last built, in RFC 3339 format.
       attr_accessor :last_built_at
 
-      # Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last updated successfully.
+      # Date and time when the Query Suggestions index was last updated successfully.
       attr_accessor :last_successful_built_at
 
       # Duration of the last successful build in seconds.

data/lib/algolia/models/query-suggestions/get_log_file200_response.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module QuerySuggestions
     class GetLogFile200Response
-      # Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+      # Date and time of the log entry, in RFC 3339 format.
       attr_accessor :timestamp
 
       attr_accessor :level

data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb

@@ -10,7 +10,7 @@ module Algolia
       # Algolia application ID to which this Query Suggestions configuration belongs.
       attr_accessor :app_id
 
-      # Name of the Query Suggestions index.
+      # Name of the Query Suggestions index (case-sensitive).
       attr_accessor :index_name
 
       # Algolia indices from which to get the popular searches for query suggestions.

data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb

@@ -20,7 +20,7 @@ module Algolia
       # Whether to include suggestions with special characters.
       attr_accessor :allow_special_characters
 
-      # Name of the Query Suggestions index.
+      # Name of the Query Suggestions index (case-sensitive).
       attr_accessor :index_name
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/query-suggestions/source_index.rb

@@ -7,7 +7,7 @@ module Algolia
   module QuerySuggestions
     # Configuration of an Algolia index for Query Suggestions.
     class SourceIndex
-      # Name of the Algolia index to use as source for query suggestions.
+      # Name of the Algolia index (case-sensitive) to use as source for query suggestions.
       attr_accessor :index_name
 
       # If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.