suggestgrid 0.3.0 → 0.5.0.rc3

data/lib/suggestgrid/models/bulk_post_response.rb

@@ -1,6 +1,9 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Bulk error response. Returned on all bulk post requests regardless of the
+  # number of erroneous or successful posts.
   class BulkPostResponse < BaseModel
     # Message of the response.
     # @return [String]
@@ -10,13 +13,11 @@ module SuggestGrid
     # @return [List of BulkPostError]
     attr_accessor :errors
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["message"] = "message"
-        @_hash["errors"] = "errors"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['errors'] = 'errors'
       @_hash
     end
 
@@ -26,20 +27,22 @@ module SuggestGrid
       @errors = errors
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       message = hash['message']
       # Parameter is an array, so we need to iterate through it
       errors = nil
-      if hash['errors'] != nil
-        errors = Array.new
-        hash['errors'].each{|structure| errors << (BulkPostError.from_hash(structure) if structure)}
+      unless hash['errors'].nil?
+        errors = []
+        hash['errors'].each do |structure|
+          errors << (BulkPostError.from_hash(structure) if structure)
+        end
       end
 
-      # Create object from extracted values
+      # Create object from extracted values.
       BulkPostResponse.new(message,
                            errors)
     end

data/lib/suggestgrid/models/get_recommended_items_body.rb

@@ -1,12 +1,16 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Query for recommended items.
   class GetRecommendedItemsBody < BaseModel
-    # The type of the query. Recommendations will be calculated based on actions of this type.
+    # The type of the query. Recommendations will be calculated based on actions
+    # of this type.
     # @return [String]
     attr_accessor :type
 
-    # The types of the query. Exactly one of type or types parameters must be provided.
+    # The types of the query. Exactly one of type or types parameters must be
+    # provided.
     # @return [List of String]
     attr_accessor :types
 
@@ -14,15 +18,18 @@ module SuggestGrid
     # @return [String]
     attr_accessor :user_id
 
-    # The user ids of the query. Exactly one of user id or user ids parameters must be provided.
+    # 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
 
-    # The number of most recommended items to be skipped from the response. Defaults to 0.
+    # The number of most recommended items to be skipped from the response.
+    # Defaults to 0.
     # @return [Integer]
     attr_accessor :from
 
-    # The number of items requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
+    # The number of items requested. Defaults to 10. Must be between 1 and
+    # 10,000 inclusive.
     # @return [Integer]
     attr_accessor :size
 
@@ -40,7 +47,9 @@ module SuggestGrid
     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).
+    # Filter structure is defined in [the filter parameter
+    # documentation](http://www.suggestgrid.com/docs/advanced-features#filters-p
+    # arameter).
     # @return [Array<String, Boolean>]
     attr_accessor :filter
 
@@ -48,22 +57,20 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :except
 
-    # A mapping from model property names to API property names
+    # 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["from"] = "from"
-        @_hash["size"] = "size"
-        @_hash["similar_item_id"] = "similar_item_id"
-        @_hash["similar_item_ids"] = "similar_item_ids"
-        @_hash["fields"] = "fields"
-        @_hash["filter"] = "filter"
-        @_hash["except"] = "except"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['types'] = 'types'
+      @_hash['user_id'] = 'user_id'
+      @_hash['user_ids'] = 'user_ids'
+      @_hash['from'] = 'from'
+      @_hash['size'] = 'size'
+      @_hash['similar_item_id'] = 'similar_item_id'
+      @_hash['similar_item_ids'] = 'similar_item_ids'
+      @_hash['fields'] = 'fields'
+      @_hash['filter'] = 'filter'
+      @_hash['except'] = 'except'
       @_hash
     end
 
@@ -91,11 +98,11 @@ module SuggestGrid
       @except = except
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       type = hash['type']
       types = hash['types']
       user_id = hash['user_id']
@@ -108,7 +115,7 @@ module SuggestGrid
       filter = hash['filter']
       except = hash['except']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       GetRecommendedItemsBody.new(type,
                                   types,
                                   user_id,

data/lib/suggestgrid/models/get_recommended_users_body.rb

@@ -1,12 +1,16 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Query for recommended users.
   class GetRecommendedUsersBody < BaseModel
-    # The type of the query. Recommendations will be calculated based on actions of this type.
+    # The type of the query. Recommendations will be calculated based on actions
+    # of this type.
     # @return [String]
     attr_accessor :type
 
-    # The types of the query. Exactly one of type or types parameters must be provided.
+    # The types of the query. Exactly one of type or types parameters must be
+    # provided.
     # @return [List of String]
     attr_accessor :types
 
@@ -14,15 +18,18 @@ module SuggestGrid
     # @return [String]
     attr_accessor :item_id
 
-    # The item ids of the query. Exactly one of item id or item ids parameters must be provided.
+    # 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
 
-    # The number of most recommended items to be skipped from the response. Defaults to 0.
+    # The number of most recommended items to be skipped from the response.
+    # Defaults to 0.
     # @return [Integer]
     attr_accessor :from
 
-    # The number of users requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
+    # The number of users requested. Defaults to 10. Must be between 1 and
+    # 10,000 inclusive.
     # @return [Integer]
     attr_accessor :size
 
@@ -40,7 +47,9 @@ module SuggestGrid
     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).
+    # Filter structure is defined in [the filter parameter
+    # documentation](http://www.suggestgrid.com/docs/advanced-features#filters-p
+    # arameter).
     # @return [Array<String, Boolean>]
     attr_accessor :filter
 
@@ -48,22 +57,20 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :except
 
-    # A mapping from model property names to API property names
+    # 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["from"] = "from"
-        @_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 = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['types'] = 'types'
+      @_hash['item_id'] = 'item_id'
+      @_hash['item_ids'] = 'item_ids'
+      @_hash['from'] = 'from'
+      @_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'
       @_hash
     end
 
@@ -91,11 +98,11 @@ module SuggestGrid
       @except = except
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       type = hash['type']
       types = hash['types']
       item_id = hash['item_id']
@@ -108,7 +115,7 @@ module SuggestGrid
       filter = hash['filter']
       except = hash['except']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       GetRecommendedUsersBody.new(type,
                                   types,
                                   item_id,

data/lib/suggestgrid/models/get_similar_items_body.rb

@@ -1,28 +1,37 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Query for similar items.
   class GetSimilarItemsBody < BaseModel
-    # The type of the query. Similarities will be calculated based on actions of this type.
+    # The type of the query. Similarities will be calculated based on actions of
+    # this type.
     # @return [String]
     attr_accessor :type
 
-    # The types of the query. Exactly one of type or types parameters must be provided.
+    # The types of the query. Exactly one of type or types parameters must be
+    # provided.
     # @return [List of String]
     attr_accessor :types
 
-    # The item id of the query. 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
 
-    # 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.
+    # 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
 
-    # The number of most similar items to be skipped from the response. Defaults to 0.
+    # The number of most similar items to be skipped from the response. Defaults
+    # to 0.
     # @return [Integer]
     attr_accessor :from
 
-    # The number of items requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
+    # The number of items requested. Defaults to 10. Must be between 1 and
+    # 10,000 inclusive.
     # @return [Integer]
     attr_accessor :size
 
@@ -31,7 +40,9 @@ module SuggestGrid
     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).
+    # Filter structure is defined in [the filter parameter
+    # documentation](http://www.suggestgrid.com/docs/advanced-features#filters-p
+    # arameter).
     # @return [Array<String, Boolean>]
     attr_accessor :filter
 
@@ -39,20 +50,18 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :except
 
-    # A mapping from model property names to API property names
+    # 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["from"] = "from"
-        @_hash["size"] = "size"
-        @_hash["fields"] = "fields"
-        @_hash["filter"] = "filter"
-        @_hash["except"] = "except"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['types'] = 'types'
+      @_hash['item_id'] = 'item_id'
+      @_hash['item_ids'] = 'item_ids'
+      @_hash['from'] = 'from'
+      @_hash['size'] = 'size'
+      @_hash['fields'] = 'fields'
+      @_hash['filter'] = 'filter'
+      @_hash['except'] = 'except'
       @_hash
     end
 
@@ -76,11 +85,11 @@ module SuggestGrid
       @except = except
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       type = hash['type']
       types = hash['types']
       item_id = hash['item_id']
@@ -91,7 +100,7 @@ module SuggestGrid
       filter = hash['filter']
       except = hash['except']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       GetSimilarItemsBody.new(type,
                               types,
                               item_id,

data/lib/suggestgrid/models/get_similar_users_body.rb

@@ -1,12 +1,16 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Query for similar users.
   class GetSimilarUsersBody < BaseModel
-    # The type of the query. Similarities will be calculated based on actions of this type.
+    # The type of the query. Similarities will be calculated based on actions of
+    # this type.
     # @return [String]
     attr_accessor :type
 
-    # The types of the query. Exactly one of type or types parameters must be provided.
+    # The types of the query. Exactly one of type or types parameters must be
+    # provided.
     # @return [List of String]
     attr_accessor :types
 
@@ -14,15 +18,18 @@ module SuggestGrid
     # @return [String]
     attr_accessor :user_id
 
-    # The user ids of the query. Exactly one of user id or user ids parameters must be provided.
+    # 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
 
-    # The number of most similar users to be skipped from the response. Defaults to 0.
+    # The number of most similar users to be skipped from the response. Defaults
+    # to 0.
     # @return [Integer]
     attr_accessor :from
 
-    # The number of users requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
+    # The number of users requested. Defaults to 10. Must be between 1 and
+    # 10,000 inclusive.
     # @return [Integer]
     attr_accessor :size
 
@@ -31,7 +38,9 @@ module SuggestGrid
     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).
+    # Filter structure is defined in [the filter parameter
+    # documentation](http://www.suggestgrid.com/docs/advanced-features#filters-p
+    # arameter).
     # @return [Array<String, Boolean>]
     attr_accessor :filter
 
@@ -39,20 +48,18 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :except
 
-    # A mapping from model property names to API property names
+    # 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["from"] = "from"
-        @_hash["size"] = "size"
-        @_hash["fields"] = "fields"
-        @_hash["filter"] = "filter"
-        @_hash["except"] = "except"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['types'] = 'types'
+      @_hash['user_id'] = 'user_id'
+      @_hash['user_ids'] = 'user_ids'
+      @_hash['from'] = 'from'
+      @_hash['size'] = 'size'
+      @_hash['fields'] = 'fields'
+      @_hash['filter'] = 'filter'
+      @_hash['except'] = 'except'
       @_hash
     end
 
@@ -76,11 +83,11 @@ module SuggestGrid
       @except = except
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       type = hash['type']
       types = hash['types']
       user_id = hash['user_id']
@@ -91,7 +98,7 @@ module SuggestGrid
       filter = hash['filter']
       except = hash['except']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       GetSimilarUsersBody.new(type,
                               types,
                               user_id,

data/lib/suggestgrid/models/get_type_response.rb

@@ -1,17 +1,17 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Get type details response.
   class GetTypeResponse < BaseModel
     # Rating type of the type that is either implicit or explicit.
     # @return [String]
     attr_accessor :rating
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["rating"] = "rating"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['rating'] = 'rating'
       @_hash
     end
 
@@ -19,14 +19,14 @@ module SuggestGrid
       @rating = rating
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       rating = hash['rating']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       GetTypeResponse.new(rating)
     end
   end

data/lib/suggestgrid/models/get_types_response.rb

@@ -1,17 +1,17 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Type names response.
   class GetTypesResponse < BaseModel
     # The list of type names
     # @return [List of String]
     attr_accessor :types
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["types"] = "types"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['types'] = 'types'
       @_hash
     end
 
@@ -19,14 +19,14 @@ module SuggestGrid
       @types = types
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       types = hash['types']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       GetTypesResponse.new(types)
     end
   end

data/lib/suggestgrid/models/items_response.rb

@@ -1,6 +1,8 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Get items response.
   class ItemsResponse < BaseModel
     # The number of items in the response.
     # @return [Long]
@@ -14,14 +16,12 @@ module SuggestGrid
     # @return [List of Metadata]
     attr_accessor :items
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["count"] = "count"
-        @_hash["total_count"] = "total_count"
-        @_hash["items"] = "items"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['total_count'] = 'total_count'
+      @_hash['items'] = 'items'
       @_hash
     end
 
@@ -33,21 +33,23 @@ module SuggestGrid
       @items = items
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       count = hash['count']
       total_count = hash['total_count']
       # Parameter is an array, so we need to iterate through it
       items = nil
-      if hash['items'] != nil
-        items = Array.new
-        hash['items'].each{|structure| items << (Metadata.from_hash(structure) if structure)}
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Metadata.from_hash(structure) if structure)
+        end
       end
 
-      # Create object from extracted values
+      # Create object from extracted values.
       ItemsResponse.new(count,
                         total_count,
                         items)