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

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

@@ -7,36 +7,35 @@ module Algolia
   module Insights
     # Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event.
     class PurchasedObjectIDsAfterSearch
-      # 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
@@ -67,13 +66,13 @@ module Algolia
           :event_type => :eventType,
           :event_subtype => :eventSubtype,
           :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
 
@@ -89,13 +88,13 @@ module Algolia
           :event_type => :ConversionEvent,
           :event_subtype => :PurchaseEvent,
           :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
 
@@ -145,12 +144,6 @@ module Algolia
           self.index = nil
         end
 
-        if attributes.key?(:query_id)
-          self.query_id = attributes[:query_id]
-        else
-          self.query_id = nil
-        end
-
         if attributes.key?(:object_ids)
           if (value = attributes[:object_ids]).is_a?(Array)
             self.object_ids = value
@@ -159,28 +152,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
 
@@ -207,29 +204,6 @@ module Algolia
         @event_name = event_name
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] query_id Value to be assigned
-      def query_id=(query_id)
-        if query_id.nil?
-          raise ArgumentError, 'query_id cannot be nil'
-        end
-
-        if query_id.to_s.length > 32
-          raise ArgumentError, 'invalid value for "query_id", the character length must be smaller than or equal to 32.'
-        end
-
-        if query_id.to_s.length < 32
-          raise ArgumentError, 'invalid value for "query_id", the character length must be great than or equal to 32.'
-        end
-
-        pattern = /[0-9a-f]{32}/
-        if query_id !~ pattern
-          raise ArgumentError, "invalid value for \"query_id\", must conform to the pattern #{pattern}."
-        end
-
-        @query_id = query_id
-      end
-
       # Custom attribute writer method with validation
       # @param [Object] object_ids Value to be assigned
       def object_ids=(object_ids)
@@ -271,6 +245,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)
@@ -281,13 +296,13 @@ module Algolia
           event_type == other.event_type &&
           event_subtype == other.event_subtype &&
           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 +314,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, object_ids, user_token, authenticated_user_token, currency, object_data, timestamp, value].hash
       end
 
       # Builds the object from hash

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

@@ -0,0 +1,97 @@
+# 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 Insights
+    # Total monetary value of this event in units of `currency`.
+    module Value
+      class << self
+        # List of class defined in oneOf (OpenAPI v3)
+        def openapi_one_of
+          [
+            :Float,
+            :String
+          ]
+        end
+
+        # Builds the object
+        # @param [Mixed] Data to be matched against the list of oneOf items
+        # @return [Object] Returns the model or the data itself
+        def build(data)
+          # Go through the list of oneOf items and attempt to identify the appropriate one.
+          # Note:
+          # - We do not attempt to check whether exactly one item matches.
+          # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+          #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+          # - TODO: scalar values are de facto behaving as if they were nullable.
+          # - TODO: logging when debugging is set.
+          openapi_one_of.each do |klass|
+            next if klass == :AnyType # "nullable: true"
+
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+
+          openapi_one_of.include?(:AnyType) ? data : nil
+        end
+
+        private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        # NOTE: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when 'Boolean'
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when 'Float'
+            return data if data.instance_of?(Float)
+          when 'Integer'
+            return data if data.instance_of?(Integer)
+          when 'Time'
+            return Time.parse(data)
+          when 'Date'
+            return Date.parse(data)
+          when 'String'
+            return data if data.instance_of?(String)
+          when 'Object' # "type: object"
+            return data if data.instance_of?(Hash)
+          when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+          when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+          else # model
+            const = Algolia.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of) # nested oneOf model
+                model = const.build(data)
+              else
+                # raise if data contains keys that are not known to the model
+                raise unless (data.keys - const.acceptable_attributes).empty?
+
+                model = const.build_from_hash(data)
+              end
+
+              return model if model
+            end
+          end
+
+          raise # if no match by now, raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+      end
+    end
+  end
+end

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

@@ -7,26 +7,26 @@ module Algolia
   module Insights
     # Use this method to capture active filters. For example, when browsing a category page, users see content filtered on that specific category.
     class ViewedFilters
-      # 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/viewed_object_ids.rb

@@ -7,26 +7,26 @@ module Algolia
   module Insights
     # Use this event to track when users viewed items in the search results.
     class ViewedObjectIDs
-      # 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.
-      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,
           :object_ids => :objectIDs,
           :user_token => :userToken,
-          :timestamp => :timestamp,
-          :authenticated_user_token => :authenticatedUserToken
+          :authenticated_user_token => :authenticatedUserToken,
+          :timestamp => :timestamp
         }
       end
 
@@ -75,8 +75,8 @@ module Algolia
           :index => :String,
           :object_ids => :'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 &&
           object_ids == other.object_ids &&
           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, object_ids, user_token, timestamp, authenticated_user_token].hash
+        [event_name, event_type, index, object_ids, user_token, authenticated_user_token, timestamp].hash
       end
 
       # Builds the object from hash

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha.2
+  version: 3.0.0.alpha.5
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -113,6 +113,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".openapi-generator-ignore"
+- ".openapi-generator/FILES"
+- ".openapi-generator/VERSION"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -321,6 +327,7 @@ files:
 - lib/algolia/models/insights/purchase_event.rb
 - lib/algolia/models/insights/purchased_object_ids.rb
 - lib/algolia/models/insights/purchased_object_ids_after_search.rb
+- lib/algolia/models/insights/value.rb
 - lib/algolia/models/insights/view_event.rb
 - lib/algolia/models/insights/viewed_filters.rb
 - lib/algolia/models/insights/viewed_object_ids.rb
@@ -654,7 +661,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API