suggestgrid 0.1.27 → 0.1.30

data/lib/suggest_grid/models/action.rb

@@ -18,6 +18,10 @@ module SuggestGrid
     # @return [Float]
     attr_accessor :rating
 
+    # The optional UNIX epoch timestamp of the action. Defaults to the current timestamp.
+    # @return [Long]
+    attr_accessor :timestamp
+
     # A mapping from model property names to API property names
     def self.names
       if @hash.nil?
@@ -26,6 +30,7 @@ module SuggestGrid
         @hash["user_id"] = "user_id"
         @hash["item_id"] = "item_id"
         @hash["rating"] = "rating"
+        @hash["timestamp"] = "timestamp"
       end
       @hash
     end
@@ -33,11 +38,17 @@ module SuggestGrid
     def initialize(type = nil,
                    user_id = nil,
                    item_id = nil,
-                   rating = nil)
+                   rating = nil,
+                   timestamp = nil,
+                   additional_properties = {})
       @type = type
       @user_id = user_id
       @item_id = item_id
       @rating = rating
+      @timestamp = timestamp
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -50,12 +61,18 @@ module SuggestGrid
         user_id = hash["user_id"]
         item_id = hash["item_id"]
         rating = hash["rating"]
+        timestamp = hash["timestamp"]
+
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
 
         # Create object from extracted values
         Action.new(type,
                    user_id,
                    item_id,
-                   rating)
+                   rating,
+                   timestamp,
+                   hash)
       end
     end
   end

data/lib/suggest_grid/models/actions_response.rb

@@ -27,10 +27,14 @@ module SuggestGrid
 
     def initialize(count = nil,
                    total_count = nil,
-                   actions = nil)
+                   actions = nil,
+                   additional_properties = {})
       @count = count
       @total_count = total_count
       @actions = actions
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -48,10 +52,14 @@ module SuggestGrid
           hash["actions"].each{|structure| actions << (Action.from_hash(structure) if structure)}
         end
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         ActionsResponse.new(count,
                             total_count,
-                            actions)
+                            actions,
+                            hash)
       end
     end
   end

data/lib/suggest_grid/models/base_model.rb

@@ -28,5 +28,22 @@ module SuggestGrid
       hash = to_hash
       hash.to_json(options)
     end
+
+    # Use to allow additional model properties
+    def method_missing(method_sym, *arguments, &block)
+      method = method_sym.to_s
+      if method.end_with? '='
+        instance_variable_set("@%s" % [method.chomp('=')], arguments.first)
+      elsif instance_variable_defined?("@#{method}") && arguments.empty?
+        instance_variable_get("@#{method}")
+      else
+        super
+      end
+    end
+
+    # Override for additional model properties
+    def respond_to?(method_sym, include_private=false)
+      instance_variable_defined?("@#{method_sym}") ? true : super
+    end
   end
 end

data/lib/suggest_grid/models/bulk_post_error.rb

@@ -27,10 +27,14 @@ module SuggestGrid
 
     def initialize(message = nil,
                    value = nil,
-                   error = nil)
+                   error = nil,
+                   additional_properties = {})
       @message = message
       @value = value
       @error = error
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -43,10 +47,14 @@ module SuggestGrid
         value = hash["value"]
         error = hash["error"]
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         BulkPostError.new(message,
                           value,
-                          error)
+                          error,
+                          hash)
       end
     end
   end

data/lib/suggest_grid/models/bulk_post_response.rb

@@ -21,9 +21,13 @@ module SuggestGrid
     end
 
     def initialize(message = nil,
-                   errors = nil)
+                   errors = nil,
+                   additional_properties = {})
       @message = message
       @errors = errors
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -40,9 +44,13 @@ module SuggestGrid
           hash["errors"].each{|structure| errors << (BulkPostError.from_hash(structure) if structure)}
         end
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         BulkPostResponse.new(message,
-                             errors)
+                             errors,
+                             hash)
       end
     end
   end

data/lib/suggest_grid/models/delete_success_response.rb

@@ -6,16 +6,16 @@ module SuggestGrid
     # @return [String]
     attr_accessor :message
 
-    # The number of records found for the delete query.
-    # @return [Integer]
+    # The number of records found.
+    # @return [Long]
     attr_accessor :found
 
-    # The number of records deleted for the delete query.
-    # @return [Integer]
+    # The number of records deleted.
+    # @return [Long]
     attr_accessor :deleted
 
-    # The number of records found but not deleted for the delete query.
-    # @return [Integer]
+    # The number of records failed to be deleted.
+    # @return [Long]
     attr_accessor :failed
 
     # A mapping from model property names to API property names
@@ -33,11 +33,15 @@ module SuggestGrid
     def initialize(message = nil,
                    found = nil,
                    deleted = nil,
-                   failed = nil)
+                   failed = nil,
+                   additional_properties = {})
       @message = message
       @found = found
       @deleted = deleted
       @failed = failed
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -51,11 +55,15 @@ module SuggestGrid
         deleted = hash["deleted"]
         failed = hash["failed"]
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         DeleteSuccessResponse.new(message,
                                   found,
                                   deleted,
-                                  failed)
+                                  failed,
+                                  hash)
       end
     end
   end

data/lib/suggest_grid/models/get_recommended_items_body.rb

@@ -2,7 +2,7 @@
 
 module SuggestGrid
   class GetRecommendedItemsBody < BaseModel
-    # The type of the query.
+    # The type of the query. Recommendations will be calculated based on actions of this type.
     # @return [String]
     attr_accessor :type
 
@@ -18,11 +18,11 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :user_ids
 
-    # The number of most recommended items to be skipped.
+    # The number of most recommended items to be skipped from the response. Defaults to 0.
     # @return [Integer]
     attr_accessor :from
 
-    # The number of items asked to return in the response.
+    # The number of items requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
     # @return [Integer]
     attr_accessor :size
 
@@ -32,16 +32,16 @@ module SuggestGrid
 
     # Similar items that the response should be similar to.
     # At most one of similar item and similar items parameters can be provided.
-    # @return [String]
+    # @return [List of String]
     attr_accessor :similar_item_ids
 
-    # The metadata fields that are to be included in returned items.
+    # The metadata fields to be included in returned item objects.
     # @return [List of String]
     attr_accessor :fields
 
     # Contraints on the returned users or items.
     # Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/advanced-features#filters-parameter).
-    # @return [Object]
+    # @return [Array<String, Boolean>]
     attr_accessor :filter
 
     # These item ids that will not be included in the response.
@@ -77,7 +77,8 @@ module SuggestGrid
                    similar_item_ids = nil,
                    fields = nil,
                    filter = nil,
-                   except = nil)
+                   except = nil,
+                   additional_properties = {})
       @type = type
       @types = types
       @user_id = user_id
@@ -89,6 +90,9 @@ module SuggestGrid
       @fields = fields
       @filter = filter
       @except = except
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -109,6 +113,9 @@ module SuggestGrid
         filter = hash["filter"]
         except = hash["except"]
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         GetRecommendedItemsBody.new(type,
                                     types,
@@ -120,7 +127,8 @@ module SuggestGrid
                                     similar_item_ids,
                                     fields,
                                     filter,
-                                    except)
+                                    except,
+                                    hash)
       end
     end
   end

data/lib/suggest_grid/models/get_recommended_users_body.rb

@@ -2,7 +2,7 @@
 
 module SuggestGrid
   class GetRecommendedUsersBody < BaseModel
-    # The type of the query.
+    # The type of the query. Recommendations will be calculated based on actions of this type.
     # @return [String]
     attr_accessor :type
 
@@ -18,11 +18,11 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :item_ids
 
-    # The number of most recommended items to be skipped.
+    # The number of most recommended items to be skipped from the response. Defaults to 0.
     # @return [Integer]
     attr_accessor :from
 
-    # The number of users asked to return in the response.
+    # The number of users requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
     # @return [Integer]
     attr_accessor :size
 
@@ -32,16 +32,16 @@ module SuggestGrid
 
     # Similar users that the response should be similar to.
     # At most one of similar user and similar users parameters can be provided.
-    # @return [String]
+    # @return [List of String]
     attr_accessor :similar_user_ids
 
-    # The metadata fields that are to be included in returned users.
+    # The metadata fields to be included in returned user objects.
     # @return [List of String]
     attr_accessor :fields
 
     # Contraints on the returned users or items.
     # Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/advanced-features#filters-parameter).
-    # @return [Object]
+    # @return [Array<String, Boolean>]
     attr_accessor :filter
 
     # These user ids that will not be included in the response.
@@ -77,7 +77,8 @@ module SuggestGrid
                    similar_user_ids = nil,
                    fields = nil,
                    filter = nil,
-                   except = nil)
+                   except = nil,
+                   additional_properties = {})
       @type = type
       @types = types
       @item_id = item_id
@@ -89,6 +90,9 @@ module SuggestGrid
       @fields = fields
       @filter = filter
       @except = except
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -109,6 +113,9 @@ module SuggestGrid
         filter = hash["filter"]
         except = hash["except"]
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         GetRecommendedUsersBody.new(type,
                                     types,
@@ -120,7 +127,8 @@ module SuggestGrid
                                     similar_user_ids,
                                     fields,
                                     filter,
-                                    except)
+                                    except,
+                                    hash)
       end
     end
   end

data/lib/suggest_grid/models/get_similar_items_body.rb

@@ -2,7 +2,7 @@
 
 module SuggestGrid
   class GetSimilarItemsBody < BaseModel
-    # The type of the query.
+    # The type of the query. Similarities will be calculated based on actions of this type.
     # @return [String]
     attr_accessor :type
 
@@ -18,21 +18,21 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :item_ids
 
-    # The number of most similar items to be skipped.
+    # The number of most similar items to be skipped from the response. Defaults to 0.
     # @return [Integer]
     attr_accessor :from
 
-    # The number of items asked to return in the response.
+    # The number of items requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
     # @return [Integer]
     attr_accessor :size
 
-    # The metadata fields that are to be included in returned items.
+    # The metadata fields to be included in returned item objects.
     # @return [List of String]
     attr_accessor :fields
 
     # Contraints on the returned users or items.
     # Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/advanced-features#filters-parameter).
-    # @return [Object]
+    # @return [Array<String, Boolean>]
     attr_accessor :filter
 
     # These item ids that will not be included in the response.
@@ -64,7 +64,8 @@ module SuggestGrid
                    size = nil,
                    fields = nil,
                    filter = nil,
-                   except = nil)
+                   except = nil,
+                   additional_properties = {})
       @type = type
       @types = types
       @item_id = item_id
@@ -74,6 +75,9 @@ module SuggestGrid
       @fields = fields
       @filter = filter
       @except = except
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -92,6 +96,9 @@ module SuggestGrid
         filter = hash["filter"]
         except = hash["except"]
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         GetSimilarItemsBody.new(type,
                                 types,
@@ -101,7 +108,8 @@ module SuggestGrid
                                 size,
                                 fields,
                                 filter,
-                                except)
+                                except,
+                                hash)
       end
     end
   end

data/lib/suggest_grid/models/get_similar_users_body.rb

@@ -2,7 +2,7 @@
 
 module SuggestGrid
   class GetSimilarUsersBody < BaseModel
-    # The type of the query.
+    # The type of the query. Similarities will be calculated based on actions of this type.
     # @return [String]
     attr_accessor :type
 
@@ -18,21 +18,21 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :user_ids
 
-    # The number of most similar users to be skipped.
+    # The number of most similar users to be skipped from the response. Defaults to 0.
     # @return [Integer]
     attr_accessor :from
 
-    # The number of users asked to return in the response.
+    # The number of users requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
     # @return [Integer]
     attr_accessor :size
 
-    # The metadata fields that are to be included in returned users.
+    # The metadata fields to be included in returned user objects.
     # @return [List of String]
     attr_accessor :fields
 
     # Contraints on the returned users or items.
     # Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/advanced-features#filters-parameter).
-    # @return [Object]
+    # @return [Array<String, Boolean>]
     attr_accessor :filter
 
     # These user ids that will not be included in the response.
@@ -64,7 +64,8 @@ module SuggestGrid
                    size = nil,
                    fields = nil,
                    filter = nil,
-                   except = nil)
+                   except = nil,
+                   additional_properties = {})
       @type = type
       @types = types
       @user_id = user_id
@@ -74,6 +75,9 @@ module SuggestGrid
       @fields = fields
       @filter = filter
       @except = except
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -92,6 +96,9 @@ module SuggestGrid
         filter = hash["filter"]
         except = hash["except"]
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         GetSimilarUsersBody.new(type,
                                 types,
@@ -101,7 +108,8 @@ module SuggestGrid
                                 size,
                                 fields,
                                 filter,
-                                except)
+                                except,
+                                hash)
       end
     end
   end

data/lib/suggest_grid/models/get_type_response.rb

@@ -15,8 +15,12 @@ module SuggestGrid
       @hash
     end
 
-    def initialize(rating = nil)
+    def initialize(rating = nil,
+                   additional_properties = {})
       @rating = rating
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -27,8 +31,12 @@ module SuggestGrid
         # Extract variables from the hash
         rating = hash["rating"]
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
-        GetTypeResponse.new(rating)
+        GetTypeResponse.new(rating,
+                            hash)
       end
     end
   end

data/lib/suggest_grid/models/get_types_response.rb

@@ -6,24 +6,21 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :types
 
-    # Status code of the response. It is not 2XX.
-    # @return [Integer]
-    attr_accessor :status
-
     # A mapping from model property names to API property names
     def self.names
       if @hash.nil?
         @hash = {}
         @hash["types"] = "types"
-        @hash["status"] = "status"
       end
       @hash
     end
 
     def initialize(types = nil,
-                   status = nil)
+                   additional_properties = {})
       @types = types
-      @status = status
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -33,11 +30,13 @@ module SuggestGrid
       else
         # Extract variables from the hash
         types = hash["types"]
-        status = hash["status"]
+
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
 
         # Create object from extracted values
         GetTypesResponse.new(types,
-                             status)
+                             hash)
       end
     end
   end

data/lib/suggest_grid/models/items_response.rb

@@ -27,10 +27,14 @@ module SuggestGrid
 
     def initialize(count = nil,
                    total_count = nil,
-                   items = nil)
+                   items = nil,
+                   additional_properties = {})
       @count = count
       @total_count = total_count
       @items = items
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -48,10 +52,14 @@ module SuggestGrid
           hash["items"].each{|structure| items << (Metadata.from_hash(structure) if structure)}
         end
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
         ItemsResponse.new(count,
                           total_count,
-                          items)
+                          items,
+                          hash)
       end
     end
   end

data/lib/suggest_grid/models/message_response.rb

@@ -15,8 +15,12 @@ module SuggestGrid
       @hash
     end
 
-    def initialize(message = nil)
+    def initialize(message = nil,
+                   additional_properties = {})
       @message = message
+
+      # Add additional model properties to the instance
+      additional_properties.each {|name, value| instance_variable_set("@#{name}", value)}
     end
 
     # Creates an instance of the object from a hash
@@ -27,8 +31,12 @@ module SuggestGrid
         # Extract variables from the hash
         message = hash["message"]
 
+        # Clean out expected properties from Hash
+        names.values.each {|k| hash.delete(k)}
+
         # Create object from extracted values
-        MessageResponse.new(message)
+        MessageResponse.new(message,
+                            hash)
       end
     end
   end