suggestgrid 0.1.15.pre.SNAPSHOT → 0.1.17.pre.SNAPSHOT

data/lib/suggest_grid/models/get_recommended_users_body.rb

@@ -1,49 +1,74 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class GetRecommendedUsersBody
-    # TODO: Write general description for this method
+  class GetRecommendedUsersBody < BaseModel
+    # The type of the query.
     # @return [String]
     attr_accessor :type
 
-    # TODO: Write general description for this method
+    # The types of the query. Exactly one of type or types parameters must be provided.
     # @return [String]
     attr_accessor :types
 
-    # TODO: Write general description for this method
+    # The item id of the query.
     # @return [String]
     attr_accessor :item_id
 
-    # TODO: Write general description for this method
+    # The item ids of the query. Exactly one of item id or item ids parameters must be provided.
     # @return [List of String]
     attr_accessor :item_ids
 
-    # TODO: Write general description for this method
+    # The number of users asked to return in the response.
     # @return [Integer]
     attr_accessor :size
 
-    # TODO: Write general description for this method
+    # Similar user that the response should be similar to.
     # @return [String]
     attr_accessor :similar_user_id
 
-    # TODO: Write general description for this method
+    # Similar users that the response should be similar to.
+    # At most one of similar user and similar users parameters can be provided.
+    # @return [String]
+    attr_accessor :similar_user_ids
+
+    # The metadata fields that are to be included in returned users.
     # @return [List of String]
     attr_accessor :fields
 
-    # TODO: Write general description for this method
+    # Contraints on the returned users or items. 
+    # Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/concepts#filters-parameter).
     # @return [Object]
     attr_accessor :filter
 
-    # These ids will not be included in the response.
+    # These user ids that will not be included in the response.
     # @return [List of String]
     attr_accessor :except
 
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["type"] = "type"
+        @hash["types"] = "types"
+        @hash["item_id"] = "item_id"
+        @hash["item_ids"] = "item_ids"
+        @hash["size"] = "size"
+        @hash["similar_user_id"] = "similar_user_id"
+        @hash["similar_user_ids"] = "similar_user_ids"
+        @hash["fields"] = "fields"
+        @hash["filter"] = "filter"
+        @hash["except"] = "except"
+      end
+      @hash
+    end
+
     def initialize(type = nil,
                    types = nil,
                    item_id = nil,
                    item_ids = nil,
                    size = nil,
                    similar_user_id = nil,
+                   similar_user_ids = nil,
                    fields = nil,
                    filter = nil,
                    except = nil)
@@ -53,16 +78,10 @@ module SuggestGrid
       @item_ids = item_ids
       @size = size
       @similar_user_id = similar_user_id
+      @similar_user_ids = similar_user_ids
       @fields = fields
       @filter = filter
       @except = except
-
-    end
-
-    # Creates JSON of the curent object
-    def to_json(options = {})
-      hash = key_map
-      hash.to_json(options)
     end
 
     # Creates an instance of the object from a hash
@@ -77,9 +96,11 @@ module SuggestGrid
         item_ids = hash["item_ids"]
         size = hash["size"]
         similar_user_id = hash["similar_user_id"]
+        similar_user_ids = hash["similar_user_ids"]
         fields = hash["fields"]
         filter = hash["filter"]
         except = hash["except"]
+
         # Create object from extracted values
         GetRecommendedUsersBody.new(type,
                                     types,
@@ -87,25 +108,11 @@ module SuggestGrid
                                     item_ids,
                                     size,
                                     similar_user_id,
+                                    similar_user_ids,
                                     fields,
                                     filter,
                                     except)
       end
     end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['type'] = type
-      hash['types'] = types
-      hash['item_id'] = item_id
-      hash['item_ids'] = item_ids
-      hash['size'] = size
-      hash['similar_user_id'] = similar_user_id
-      hash['fields'] = fields
-      hash['filter'] = filter
-      hash['except'] = except
-      hash
-    end
   end
 end

data/lib/suggest_grid/models/get_similar_items_body.rb

@@ -1,39 +1,56 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class GetSimilarItemsBody
-    # TODO: Write general description for this method
+  class GetSimilarItemsBody < BaseModel
+    # The type of the query.
     # @return [String]
     attr_accessor :type
 
-    # TODO: Write general description for this method
+    # The types of the query. Exactly one of type or types parameters must be provided.
     # @return [String]
     attr_accessor :types
 
-    # Get similar items to given item id. Either item id or item ids must be provided.
+    # The item id of the query. Get similar items to given item id. Either item id or item ids must be provided.
     # @return [String]
     attr_accessor :item_id
 
-    # Get similar items to given item ids. Either item id or item ids must be provided.
+    # The item ids of the query. Exactly one of item id or item ids parameters must be provided. Get similar items to given item ids. Either item id or item ids must be provided.
     # @return [List of String]
     attr_accessor :item_ids
 
-    # Get similar items to given item ids. Either item id or item ids must be provided.
+    # The number of users asked to return in the response.
     # @return [Integer]
     attr_accessor :size
 
-    # Get similar items to given item ids. Either item id or item ids must be provided.
+    # The metadata fields that are to be included in returned users.
     # @return [List of String]
     attr_accessor :fields
 
-    # Get similar items to given item ids. Either item id or item ids must be provided.
+    # Contraints on the returned users or items. 
+    # Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/concepts#filters-parameter).
     # @return [Object]
     attr_accessor :filter
 
-    # These ids will not be included in the response.
+    # These user ids that will not be included in the response.
     # @return [List of String]
     attr_accessor :except
 
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["type"] = "type"
+        @hash["types"] = "types"
+        @hash["item_id"] = "item_id"
+        @hash["item_ids"] = "item_ids"
+        @hash["size"] = "size"
+        @hash["fields"] = "fields"
+        @hash["filter"] = "filter"
+        @hash["except"] = "except"
+      end
+      @hash
+    end
+
     def initialize(type = nil,
                    types = nil,
                    item_id = nil,
@@ -50,13 +67,6 @@ module SuggestGrid
       @fields = fields
       @filter = filter
       @except = except
-
-    end
-
-    # Creates JSON of the curent object
-    def to_json(options = {})
-      hash = key_map
-      hash.to_json(options)
     end
 
     # Creates an instance of the object from a hash
@@ -73,6 +83,7 @@ module SuggestGrid
         fields = hash["fields"]
         filter = hash["filter"]
         except = hash["except"]
+
         # Create object from extracted values
         GetSimilarItemsBody.new(type,
                                 types,
@@ -84,19 +95,5 @@ module SuggestGrid
                                 except)
       end
     end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['type'] = type
-      hash['types'] = types
-      hash['item_id'] = item_id
-      hash['item_ids'] = item_ids
-      hash['size'] = size
-      hash['fields'] = fields
-      hash['filter'] = filter
-      hash['except'] = except
-      hash
-    end
   end
 end

data/lib/suggest_grid/models/get_similar_users_body.rb

@@ -1,39 +1,56 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class GetSimilarUsersBody
-    # TODO: Write general description for this method
+  class GetSimilarUsersBody < BaseModel
+    # The type of the query.
     # @return [String]
     attr_accessor :type
 
-    # TODO: Write general description for this method
+    # The types of the query. Exactly one of type or types parameters must be provided.
     # @return [String]
     attr_accessor :types
 
-    # TODO: Write general description for this method
+    # The user id of the query.
     # @return [String]
     attr_accessor :user_id
 
-    # TODO: Write general description for this method
+    # The user ids of the query. Exactly one of user id or user ids parameters must be provided.
     # @return [List of String]
     attr_accessor :user_ids
 
-    # TODO: Write general description for this method
+    # The number of users asked to return in the response.
     # @return [Integer]
     attr_accessor :size
 
-    # TODO: Write general description for this method
+    # The metadata fields that are to be included in returned users.
     # @return [List of String]
     attr_accessor :fields
 
-    # TODO: Write general description for this method
+    # Contraints on the returned users or items. 
+    # Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/concepts#filters-parameter).
     # @return [Object]
     attr_accessor :filter
 
-    # These ids will not be included in the response.
+    # These user ids that will not be included in the response.
     # @return [List of String]
     attr_accessor :except
 
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["type"] = "type"
+        @hash["types"] = "types"
+        @hash["user_id"] = "user_id"
+        @hash["user_ids"] = "user_ids"
+        @hash["size"] = "size"
+        @hash["fields"] = "fields"
+        @hash["filter"] = "filter"
+        @hash["except"] = "except"
+      end
+      @hash
+    end
+
     def initialize(type = nil,
                    types = nil,
                    user_id = nil,
@@ -50,13 +67,6 @@ module SuggestGrid
       @fields = fields
       @filter = filter
       @except = except
-
-    end
-
-    # Creates JSON of the curent object
-    def to_json(options = {})
-      hash = key_map
-      hash.to_json(options)
     end
 
     # Creates an instance of the object from a hash
@@ -73,6 +83,7 @@ module SuggestGrid
         fields = hash["fields"]
         filter = hash["filter"]
         except = hash["except"]
+
         # Create object from extracted values
         GetSimilarUsersBody.new(type,
                                 types,
@@ -84,19 +95,5 @@ module SuggestGrid
                                 except)
       end
     end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['type'] = type
-      hash['types'] = types
-      hash['user_id'] = user_id
-      hash['user_ids'] = user_ids
-      hash['size'] = size
-      hash['fields'] = fields
-      hash['filter'] = filter
-      hash['except'] = except
-      hash
-    end
   end
 end

data/lib/suggest_grid/models/get_type_response.rb

@@ -1,20 +1,22 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class GetTypeResponse
-    # Either 'implicit' or 'explicit'
+  class GetTypeResponse < BaseModel
+    # Rating type of the type that is either implicit or explicit.
     # @return [String]
     attr_accessor :rating
 
-    def initialize(rating = nil)
-      @rating = rating
-
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["rating"] = "rating"
+      end
+      @hash
     end
 
-    # Creates JSON of the curent object
-    def to_json(options = {})
-      hash = key_map
-      hash.to_json(options)
+    def initialize(rating = nil)
+      @rating = rating
     end
 
     # Creates an instance of the object from a hash
@@ -24,16 +26,10 @@ module SuggestGrid
       else
         # Extract variables from the hash
         rating = hash["rating"]
+
         # Create object from extracted values
         GetTypeResponse.new(rating)
       end
     end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['rating'] = rating
-      hash
-    end
   end
 end

data/lib/suggest_grid/models/get_types_response.rb

@@ -1,7 +1,7 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class GetTypesResponse
+  class GetTypesResponse < BaseModel
     # The list of type names
     # @return [List of String]
     attr_accessor :types
@@ -10,17 +10,20 @@ module SuggestGrid
     # @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)
       @types = types
       @status = status
-
-    end
-
-    # Creates JSON of the curent object
-    def to_json(options = {})
-      hash = key_map
-      hash.to_json(options)
     end
 
     # Creates an instance of the object from a hash
@@ -31,18 +34,11 @@ module SuggestGrid
         # Extract variables from the hash
         types = hash["types"]
         status = hash["status"]
+
         # Create object from extracted values
         GetTypesResponse.new(types,
                              status)
       end
     end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['types'] = types
-      hash['status'] = status
-      hash
-    end
   end
 end

data/lib/suggest_grid/models/items_response.rb

@@ -1,7 +1,7 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class ItemsResponse
+  class ItemsResponse < BaseModel
     # The number of items in the response.
     # @return [Long]
     attr_accessor :count
@@ -10,17 +10,20 @@ module SuggestGrid
     # @return [List of Metadata]
     attr_accessor :items
 
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["count"] = "count"
+        @hash["items"] = "items"
+      end
+      @hash
+    end
+
     def initialize(count = nil,
                    items = nil)
       @count = count
       @items = items
-
-    end
-
-    # Creates JSON of the curent object
-    def to_json(options = {})
-      hash = key_map
-      hash.to_json(options)
     end
 
     # Creates an instance of the object from a hash
@@ -36,18 +39,11 @@ module SuggestGrid
           items = Array.new
           hash["items"].each{|structure| items << (Metadata.from_hash(structure) if structure)}
         end
+
         # Create object from extracted values
         ItemsResponse.new(count,
                           items)
       end
     end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['count'] = count
-      hash['items'] = items ? items.map(&:key_map) : nil
-      hash
-    end
   end
 end

data/lib/suggest_grid/models/message_response.rb

@@ -1,20 +1,22 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class MessageResponse
+  class MessageResponse < BaseModel
     # Message of the response.
     # @return [String]
     attr_accessor :message
 
-    def initialize(message = nil)
-      @message = message
-
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["message"] = "message"
+      end
+      @hash
     end
 
-    # Creates JSON of the curent object
-    def to_json(options = {})
-      hash = key_map
-      hash.to_json(options)
+    def initialize(message = nil)
+      @message = message
     end
 
     # Creates an instance of the object from a hash
@@ -24,16 +26,10 @@ module SuggestGrid
       else
         # Extract variables from the hash
         message = hash["message"]
+
         # Create object from extracted values
         MessageResponse.new(message)
       end
     end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['message'] = message
-      hash
-    end
   end
 end

data/lib/suggest_grid/models/metadata.rb

@@ -1,39 +1,34 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
-
-module SuggestGrid
-  class Metadata
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :id
-
-    def initialize(id = nil)
-      @id = id
-
-    end
-
-    # Creates JSON of the curent object
-    def to_json(options = {})
-      hash = key_map
-      hash.to_json(options)
-    end
-
-    # Creates an instance of the object from a hash
-    def self.from_hash(hash)
-      if hash == nil
-        nil
-      else
-        # Extract variables from the hash
-        id = hash["id"]
-        # Create object from extracted values
-        Metadata.new(id)
-      end
-    end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['id'] = id
-      hash
-    end
-  end
-end
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class Metadata < BaseModel
+    # The id of the user or the item that the metadata is associated with.
+    # Id parameter is necessary for all metadata.
+    #  attr_accessor :id
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = self.instance_variables.inject({}) { |h, (k, v)| h[k] = k; h }
+      end
+      @hash
+    end
+
+    def initialize(props = {})
+        props.each do |name, value|
+            instance_variable_set("@#{name}", value)
+            singleton_class.class_eval { attr_accessor name }
+        end
+    end
+
+    # Creates an instance of the object from a hash
+    def self.from_hash(hash)
+      if hash == nil
+        nil
+      else
+        # Create object from extracted values
+        Metadata.new(hash)
+      end
+    end
+  end
+end