suggestgrid 0.1.17.pre.SNAPSHOT → 0.1.27

data/lib/suggest_grid/exceptions/limit_exceeded_error_response_exception.rb

@@ -30,10 +30,10 @@ module SuggestGrid
       begin
         hash = APIHelper.json_deserialize(@context.response.raw_body)
         unbox(hash)
-	  rescue TypeError
-	  end
+      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)

data/lib/suggest_grid/http/auth/basic_auth.rb

@@ -0,0 +1,17 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+require "base64"
+
+module SuggestGrid
+  class BasicAuth
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will be added.
+    def self.apply(http_request)
+      username = Configuration.basic_auth_user_name
+      password = Configuration.basic_auth_password
+      value = Base64.encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers["Authorization"] = header_value
+    end
+  end
+end

data/lib/suggest_grid/http/faraday_client.rb

@@ -0,0 +1,43 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+require 'faraday/http_cache'
+
+module SuggestGrid
+  class FaradayClient < HttpClient
+    # The constructor.
+    def initialize(timeout: nil, cache: false)
+      @connection = Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.adapter Faraday.default_adapter
+        faraday.options[:open_timeout] = timeout if timeout
+      end
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      response = @connection.send(http_request.http_method.downcase, http_request.query_url) do |request| 
+        request.headers = http_request.headers
+        request.body = http_request.parameters
+      end
+
+      return convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+      response = @connection.send(http_request.http_method.downcase, http_request.query_url) do |request| 
+        request.headers = http_request.headers
+        request.body = http_request.parameters
+      end
+
+      return convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response)
+      return HttpResponse.new(response.status, response.headers, response.body)
+    end
+  end
+end

data/lib/suggest_grid/http/http_call_back.rb

@@ -9,8 +9,8 @@ module SuggestGrid
     end
     
     # A controller will call this method after making an HTTP Request.
-    # @param [HttpResponse] The HttpResponse object received from the HttpClient.
-    def on_after_response(http_response)
+    # @param [HttpContext] The HttpContext of the API call.
+    def on_after_response(http_context)
       raise NotImplementedError, "This method needs to be implemented in a child class."
     end
   end

data/lib/suggest_grid/http/http_client.rb

@@ -23,90 +23,60 @@ module SuggestGrid
     # Get a GET HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
     def get(query_url,
-            headers: nil,
-            username: nil,
-            password: nil)
+            headers: {})
       return HttpRequest.new(HttpMethodEnum::GET,
                              query_url,
-                             headers: headers,
-                             username: username,
-                             password: password)
+                             headers: headers)
     end
     
     # Get a POST HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
     def post(query_url,
-             headers: nil,
-             parameters: nil,
-             username: nil,
-             password: nil)
+             headers: {},
+             parameters: {})
       return HttpRequest.new(HttpMethodEnum::POST,
                              query_url,
                              headers: headers,
-                             parameters: parameters,
-                             username: username,
-                             password: password)
+                             parameters: parameters)
     end
     
     # Get a PUT HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
     def put(query_url,
-            headers: nil,
-            parameters: nil,
-            username: nil,
-            password: nil)
+            headers: {},
+            parameters: {})
       return HttpRequest.new(HttpMethodEnum::PUT,
                              query_url,
                              headers: headers,
-                             parameters: parameters,
-                             username: username,
-                             password: password)
+                             parameters: parameters)
     end
     
     # Get a PATCH HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
     def patch(query_url,
-              headers: nil,
-              parameters: nil,
-              username: nil,
-              password: nil)
+              headers: {},
+              parameters: {})
       return HttpRequest.new(HttpMethodEnum::PATCH,
                              query_url,
                              headers: headers,
-                             parameters: parameters,
-                             username: username,
-                             password: password)
+                             parameters: parameters)
     end
     
     # Get a DELETE HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
     def delete(query_url,
-               headers: nil,
-               username: nil,
-               password: nil)
+               headers: {})
       return HttpRequest.new(HttpMethodEnum::DELETE,
                              query_url,
-                             headers: headers,
-                             username: username,
-                             password: password)
+                             headers: headers)
     end
   end
 end

data/lib/suggest_grid/http/http_request.rb

@@ -9,20 +9,36 @@ module SuggestGrid
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [String, Optional] Username for Basic Auth requests.
-    # @param [String, Optional] Password for Basic Auth requests.
     def initialize(http_method,
                    query_url,
-                   headers: nil,
-                   parameters: nil,
-                   username: nil,
-                   password: nil)
+                   headers: {},
+                   parameters: {})
       @http_method = http_method
       @query_url = query_url
       @headers = headers
       @parameters = parameters
-      @username = username
-      @password = password
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+    
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+    
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url, {name => value})
+      @query_url = APIHelper.clean_url(@query_url)
     end
   end
 end

data/lib/suggest_grid/models/actions_response.rb

@@ -0,0 +1,58 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class ActionsResponse < BaseModel
+    # The number of actions in the response.
+    # @return [Long]
+    attr_accessor :count
+
+    # The total number of actions.
+    # @return [Long]
+    attr_accessor :total_count
+
+    # The total number of actions.
+    # @return [List of Action]
+    attr_accessor :actions
+
+    # 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["actions"] = "actions"
+      end
+      @hash
+    end
+
+    def initialize(count = nil,
+                   total_count = nil,
+                   actions = nil)
+      @count = count
+      @total_count = total_count
+      @actions = actions
+    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
+        count = hash["count"]
+        total_count = hash["total_count"]
+        # Parameter is an array, so we need to iterate through it
+        actions = nil
+        if hash["actions"] != nil
+          actions = Array.new
+          hash["actions"].each{|structure| actions << (Action.from_hash(structure) if structure)}
+        end
+
+        # Create object from extracted values
+        ActionsResponse.new(count,
+                            total_count,
+                            actions)
+      end
+    end
+  end
+end

data/lib/suggest_grid/models/{schema_error_response.rb → bulk_post_error.rb}

@@ -1,7 +1,7 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
-  class SchemaErrorResponse < BaseModel
+  class BulkPostError < BaseModel
     # Message of the response.
     # @return [String]
     attr_accessor :message
@@ -44,9 +44,9 @@ module SuggestGrid
         error = hash["error"]
 
         # Create object from extracted values
-        SchemaErrorResponse.new(message,
-                                value,
-                                error)
+        BulkPostError.new(message,
+                          value,
+                          error)
       end
     end
   end

data/lib/suggest_grid/models/bulk_post_response.rb

@@ -0,0 +1,49 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class BulkPostResponse < BaseModel
+    # Message of the response.
+    # @return [String]
+    attr_accessor :message
+
+    # Message of the response.
+    # @return [List of BulkPostError]
+    attr_accessor :errors
+
+    # 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
+    end
+
+    def initialize(message = nil,
+                   errors = nil)
+      @message = message
+      @errors = errors
+    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"]
+        # 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)}
+        end
+
+        # Create object from extracted values
+        BulkPostResponse.new(message,
+                             errors)
+      end
+    end
+  end
+end

data/lib/suggest_grid/models/get_recommended_items_body.rb

@@ -18,7 +18,11 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :user_ids
 
-    # The number of users asked to return in the response.
+    # The number of most recommended items to be skipped.
+    # @return [Integer]
+    attr_accessor :from
+
+    # The number of items asked to return in the response.
     # @return [Integer]
     attr_accessor :size
 
@@ -31,16 +35,16 @@ module SuggestGrid
     # @return [String]
     attr_accessor :similar_item_ids
 
-    # The metadata fields that are to be included in returned users.
+    # The metadata fields that are to be included in returned items.
     # @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/concepts#filters-parameter).
+    # 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]
     attr_accessor :filter
 
-    # These user ids that will not be included in the response.
+    # These item ids that will not be included in the response.
     # @return [List of String]
     attr_accessor :except
 
@@ -52,6 +56,7 @@ module SuggestGrid
         @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"
@@ -66,6 +71,7 @@ module SuggestGrid
                    types = nil,
                    user_id = nil,
                    user_ids = nil,
+                   from = nil,
                    size = nil,
                    similar_item_id = nil,
                    similar_item_ids = nil,
@@ -76,6 +82,7 @@ module SuggestGrid
       @types = types
       @user_id = user_id
       @user_ids = user_ids
+      @from = from
       @size = size
       @similar_item_id = similar_item_id
       @similar_item_ids = similar_item_ids
@@ -94,6 +101,7 @@ module SuggestGrid
         types = hash["types"]
         user_id = hash["user_id"]
         user_ids = hash["user_ids"]
+        from = hash["from"]
         size = hash["size"]
         similar_item_id = hash["similar_item_id"]
         similar_item_ids = hash["similar_item_ids"]
@@ -106,6 +114,7 @@ module SuggestGrid
                                     types,
                                     user_id,
                                     user_ids,
+                                    from,
                                     size,
                                     similar_item_id,
                                     similar_item_ids,

data/lib/suggest_grid/models/get_recommended_users_body.rb

@@ -18,6 +18,10 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :item_ids
 
+    # The number of most recommended items to be skipped.
+    # @return [Integer]
+    attr_accessor :from
+
     # The number of users asked to return in the response.
     # @return [Integer]
     attr_accessor :size
@@ -35,8 +39,8 @@ module SuggestGrid
     # @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/concepts#filters-parameter).
+    # 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]
     attr_accessor :filter
 
@@ -52,6 +56,7 @@ module SuggestGrid
         @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"
@@ -66,6 +71,7 @@ module SuggestGrid
                    types = nil,
                    item_id = nil,
                    item_ids = nil,
+                   from = nil,
                    size = nil,
                    similar_user_id = nil,
                    similar_user_ids = nil,
@@ -76,6 +82,7 @@ module SuggestGrid
       @types = types
       @item_id = item_id
       @item_ids = item_ids
+      @from = from
       @size = size
       @similar_user_id = similar_user_id
       @similar_user_ids = similar_user_ids
@@ -94,6 +101,7 @@ module SuggestGrid
         types = hash["types"]
         item_id = hash["item_id"]
         item_ids = hash["item_ids"]
+        from = hash["from"]
         size = hash["size"]
         similar_user_id = hash["similar_user_id"]
         similar_user_ids = hash["similar_user_ids"]
@@ -106,6 +114,7 @@ module SuggestGrid
                                     types,
                                     item_id,
                                     item_ids,
+                                    from,
                                     size,
                                     similar_user_id,
                                     similar_user_ids,

data/lib/suggest_grid/models/get_similar_items_body.rb

@@ -18,20 +18,24 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :item_ids
 
-    # The number of users asked to return in the response.
+    # The number of most similar items to be skipped.
+    # @return [Integer]
+    attr_accessor :from
+
+    # The number of items asked to return in the response.
     # @return [Integer]
     attr_accessor :size
 
-    # The metadata fields that are to be included in returned users.
+    # The metadata fields that are to be included in returned items.
     # @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/concepts#filters-parameter).
+    # 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]
     attr_accessor :filter
 
-    # These user ids that will not be included in the response.
+    # These item ids that will not be included in the response.
     # @return [List of String]
     attr_accessor :except
 
@@ -43,6 +47,7 @@ module SuggestGrid
         @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"
@@ -55,6 +60,7 @@ module SuggestGrid
                    types = nil,
                    item_id = nil,
                    item_ids = nil,
+                   from = nil,
                    size = nil,
                    fields = nil,
                    filter = nil,
@@ -63,6 +69,7 @@ module SuggestGrid
       @types = types
       @item_id = item_id
       @item_ids = item_ids
+      @from = from
       @size = size
       @fields = fields
       @filter = filter
@@ -79,6 +86,7 @@ module SuggestGrid
         types = hash["types"]
         item_id = hash["item_id"]
         item_ids = hash["item_ids"]
+        from = hash["from"]
         size = hash["size"]
         fields = hash["fields"]
         filter = hash["filter"]
@@ -89,6 +97,7 @@ module SuggestGrid
                                 types,
                                 item_id,
                                 item_ids,
+                                from,
                                 size,
                                 fields,
                                 filter,

data/lib/suggest_grid/models/get_similar_users_body.rb

@@ -18,6 +18,10 @@ module SuggestGrid
     # @return [List of String]
     attr_accessor :user_ids
 
+    # The number of most similar users to be skipped.
+    # @return [Integer]
+    attr_accessor :from
+
     # The number of users asked to return in the response.
     # @return [Integer]
     attr_accessor :size
@@ -26,8 +30,8 @@ module SuggestGrid
     # @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/concepts#filters-parameter).
+    # 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]
     attr_accessor :filter
 
@@ -43,6 +47,7 @@ module SuggestGrid
         @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"
@@ -55,6 +60,7 @@ module SuggestGrid
                    types = nil,
                    user_id = nil,
                    user_ids = nil,
+                   from = nil,
                    size = nil,
                    fields = nil,
                    filter = nil,
@@ -63,6 +69,7 @@ module SuggestGrid
       @types = types
       @user_id = user_id
       @user_ids = user_ids
+      @from = from
       @size = size
       @fields = fields
       @filter = filter
@@ -79,6 +86,7 @@ module SuggestGrid
         types = hash["types"]
         user_id = hash["user_id"]
         user_ids = hash["user_ids"]
+        from = hash["from"]
         size = hash["size"]
         fields = hash["fields"]
         filter = hash["filter"]
@@ -89,6 +97,7 @@ module SuggestGrid
                                 types,
                                 user_id,
                                 user_ids,
+                                from,
                                 size,
                                 fields,
                                 filter,

data/lib/suggest_grid/models/items_response.rb

@@ -6,7 +6,11 @@ module SuggestGrid
     # @return [Long]
     attr_accessor :count
 
-    # The number of items in the response.
+    # The total number of items available.
+    # @return [Long]
+    attr_accessor :total_count
+
+    # The total number of items available.
     # @return [List of Metadata]
     attr_accessor :items
 
@@ -15,14 +19,17 @@ module SuggestGrid
       if @hash.nil?
         @hash = {}
         @hash["count"] = "count"
+        @hash["total_count"] = "total_count"
         @hash["items"] = "items"
       end
       @hash
     end
 
     def initialize(count = nil,
+                   total_count = nil,
                    items = nil)
       @count = count
+      @total_count = total_count
       @items = items
     end
 
@@ -33,6 +40,7 @@ module SuggestGrid
       else
         # 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
@@ -42,6 +50,7 @@ module SuggestGrid
 
         # Create object from extracted values
         ItemsResponse.new(count,
+                          total_count,
                           items)
       end
     end