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

data/lib/suggest_grid/exceptions/detailed_error_response_exception.rb

@@ -0,0 +1,42 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class DetailedErrorResponseException < APIException
+    # Message of the response.
+    # @return [String]
+    attr_accessor :error_text
+
+    # Description of the response.
+    # @return [String]
+    attr_accessor :error_description
+
+    # URI of the response for more details.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # Specific details of the response.
+    # @return [String]
+    attr_accessor :error_details
+
+    # The constructor.
+    # @param [String] The reason for raising an exception
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason, context)
+      begin
+        hash = APIHelper.json_deserialize(@context.response.raw_body)
+        unbox(hash)
+	  rescue TypeError
+	  end
+    end
+	
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the response body.
+    def unbox(hash)
+      @error_text = hash["error_text"]
+      @error_description = hash["error_description"]
+      @error_uri = hash["error_uri"]
+      @error_details = hash["error_details"]
+    end
+  end
+end

data/lib/suggest_grid/exceptions/error_response_exception.rb

@@ -0,0 +1,37 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class ErrorResponseException < APIException
+    # Message of the response.
+    # @return [String]
+    attr_accessor :error_text
+
+    # Description of the response.
+    # @return [String]
+    attr_accessor :error_description
+
+    # URI of the response for more details.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] The reason for raising an exception
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason, context)
+      begin
+        hash = APIHelper.json_deserialize(@context.response.raw_body)
+        unbox(hash)
+	  rescue TypeError
+	  end
+    end
+	
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the response body.
+    def unbox(hash)
+      @error_text = hash["error_text"]
+      @error_description = hash["error_description"]
+      @error_uri = hash["error_uri"]
+    end
+  end
+end

data/lib/suggest_grid/exceptions/limit_exceeded_error_response_exception.rb

@@ -0,0 +1,47 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class LimitExceededErrorResponseException < APIException
+    # Message of the response.
+    # @return [String]
+    attr_accessor :error_text
+
+    # Description of the response.
+    # @return [String]
+    attr_accessor :error_description
+
+    # URI of the response for more details.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The quantity used by the account.
+    # @return [Integer]
+    attr_accessor :used
+
+    # The limit quantity of the account.
+    # @return [Integer]
+    attr_accessor :limit
+
+    # The constructor.
+    # @param [String] The reason for raising an exception
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason, context)
+      begin
+        hash = APIHelper.json_deserialize(@context.response.raw_body)
+        unbox(hash)
+	  rescue TypeError
+	  end
+    end
+	
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the response body.
+    def unbox(hash)
+      @error_text = hash["error_text"]
+      @error_description = hash["error_description"]
+      @error_uri = hash["error_uri"]
+      @used = hash["used"]
+      @limit = hash["limit"]
+    end
+  end
+end

data/lib/suggest_grid/models/action.rb

@@ -1,7 +1,7 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class Action
+  class Action < BaseModel
     # The type that the action belongs to.
     # @return [String]
     attr_accessor :type
@@ -14,10 +14,22 @@ module SuggestGrid
     # @return [String]
     attr_accessor :item_id
 
-    # The optional rating, if the type is explicit.
+    # The optional rating given by the user, if the type is explicit.
     # @return [Float]
     attr_accessor :rating
 
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["type"] = "type"
+        @hash["user_id"] = "user_id"
+        @hash["item_id"] = "item_id"
+        @hash["rating"] = "rating"
+      end
+      @hash
+    end
+
     def initialize(type = nil,
                    user_id = nil,
                    item_id = nil,
@@ -26,13 +38,6 @@ module SuggestGrid
       @user_id = user_id
       @item_id = item_id
       @rating = rating
-
-    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
@@ -45,6 +50,7 @@ module SuggestGrid
         user_id = hash["user_id"]
         item_id = hash["item_id"]
         rating = hash["rating"]
+
         # Create object from extracted values
         Action.new(type,
                    user_id,
@@ -52,15 +58,5 @@ module SuggestGrid
                    rating)
       end
     end
-
-    # Defines the key map for json serialization
-    def key_map
-      hash = {}
-      hash['type'] = type
-      hash['user_id'] = user_id
-      hash['item_id'] = item_id
-      hash['rating'] = rating
-      hash
-    end
   end
 end

data/lib/suggest_grid/models/base_model.rb

@@ -0,0 +1,32 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class BaseModel
+    # Returns a Hash representation of the current object
+    def to_hash
+      hash = {}
+      self.instance_variables.each do |name|
+        value = self.instance_variable_get(name)
+        name = name[1..-1]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        if value.instance_of? Array
+          hash[key] = value.map{|v| v.kind_of?(BaseModel) ? v.to_hash : v}
+        elsif value.instance_of? Hash
+          hash[key] = {}
+          value.each do |k, v|
+            hash[key][k] = v.kind_of?(BaseModel) ? v.to_hash : v
+          end
+        else
+          hash[key] = value.kind_of?(BaseModel) ? value.to_hash : value
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/suggest_grid/models/count_response.rb

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

data/lib/suggest_grid/models/delete_error_response.rb

@@ -0,0 +1,80 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class DeleteErrorResponse < BaseModel
+    # Message of the response.
+    # @return [String]
+    attr_accessor :error_text
+
+    # Description of the response.
+    # @return [String]
+    attr_accessor :error_description
+
+    # URI of the response for more details.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The number of records found for the delete query.
+    # @return [Integer]
+    attr_accessor :found
+
+    # The number of records deleted for the delete query.
+    # @return [Integer]
+    attr_accessor :deleted
+
+    # The number of records found but not deleted for the delete query.
+    # @return [Integer]
+    attr_accessor :failed
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["error_text"] = "error_text"
+        @hash["error_description"] = "error_description"
+        @hash["error_uri"] = "error_uri"
+        @hash["found"] = "found"
+        @hash["deleted"] = "deleted"
+        @hash["failed"] = "failed"
+      end
+      @hash
+    end
+
+    def initialize(error_text = nil,
+                   error_description = nil,
+                   error_uri = nil,
+                   found = nil,
+                   deleted = nil,
+                   failed = nil)
+      @error_text = error_text
+      @error_description = error_description
+      @error_uri = error_uri
+      @found = found
+      @deleted = deleted
+      @failed = failed
+    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
+        error_text = hash["error_text"]
+        error_description = hash["error_description"]
+        error_uri = hash["error_uri"]
+        found = hash["found"]
+        deleted = hash["deleted"]
+        failed = hash["failed"]
+
+        # Create object from extracted values
+        DeleteErrorResponse.new(error_text,
+                                error_description,
+                                error_uri,
+                                found,
+                                deleted,
+                                failed)
+      end
+    end
+  end
+end

data/lib/suggest_grid/models/delete_success_response.rb

@@ -0,0 +1,62 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class DeleteSuccessResponse < BaseModel
+    # Message of the response.
+    # @return [String]
+    attr_accessor :message
+
+    # The number of records found for the delete query.
+    # @return [Integer]
+    attr_accessor :found
+
+    # The number of records deleted for the delete query.
+    # @return [Integer]
+    attr_accessor :deleted
+
+    # The number of records found but not deleted for the delete query.
+    # @return [Integer]
+    attr_accessor :failed
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["message"] = "message"
+        @hash["found"] = "found"
+        @hash["deleted"] = "deleted"
+        @hash["failed"] = "failed"
+      end
+      @hash
+    end
+
+    def initialize(message = nil,
+                   found = nil,
+                   deleted = nil,
+                   failed = nil)
+      @message = message
+      @found = found
+      @deleted = deleted
+      @failed = failed
+    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
+        message = hash["message"]
+        found = hash["found"]
+        deleted = hash["deleted"]
+        failed = hash["failed"]
+
+        # Create object from extracted values
+        DeleteSuccessResponse.new(message,
+                                  found,
+                                  deleted,
+                                  failed)
+      end
+    end
+  end
+end

data/lib/suggest_grid/models/get_recommended_items_body.rb

@@ -1,49 +1,74 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class GetRecommendedItemsBody
-    # TODO: Write general description for this method
+  class GetRecommendedItemsBody < 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
+    # Similar item that the response should be similar to.
     # @return [String]
     attr_accessor :similar_item_id
 
-    # TODO: Write general description for this method
+    # Similar items that the response should be similar to.
+    # At most one of similar item and similar items parameters can be provided.
+    # @return [String]
+    attr_accessor :similar_item_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["user_id"] = "user_id"
+        @hash["user_ids"] = "user_ids"
+        @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
+    end
+
     def initialize(type = nil,
                    types = nil,
                    user_id = nil,
                    user_ids = nil,
                    size = nil,
                    similar_item_id = nil,
+                   similar_item_ids = nil,
                    fields = nil,
                    filter = nil,
                    except = nil)
@@ -53,16 +78,10 @@ module SuggestGrid
       @user_ids = user_ids
       @size = size
       @similar_item_id = similar_item_id
+      @similar_item_ids = similar_item_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
         user_ids = hash["user_ids"]
         size = hash["size"]
         similar_item_id = hash["similar_item_id"]
+        similar_item_ids = hash["similar_item_ids"]
         fields = hash["fields"]
         filter = hash["filter"]
         except = hash["except"]
+
         # Create object from extracted values
         GetRecommendedItemsBody.new(type,
                                     types,
@@ -87,25 +108,11 @@ module SuggestGrid
                                     user_ids,
                                     size,
                                     similar_item_id,
+                                    similar_item_ids,
                                     fields,
                                     filter,
                                     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['similar_item_id'] = similar_item_id
-      hash['fields'] = fields
-      hash['filter'] = filter
-      hash['except'] = except
-      hash
-    end
   end
 end