suggestgrid 0.3.0 → 0.5.0.rc3

data/lib/suggestgrid/models/message_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
+  # Basic response with a message for success responses.
   class MessageResponse < BaseModel
     # Message of the response.
     # @return [String]
     attr_accessor :message
 
-    # 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"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
       @_hash
     end
 
@@ -19,14 +19,14 @@ module SuggestGrid
       @message = message
     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']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       MessageResponse.new(message)
     end
   end

data/lib/suggestgrid/models/metadata.rb

@@ -1,30 +1,31 @@
-# 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
+  # Metadata of a user or an item. Id parameter is required for all metadata.
+  # Metadata may have other parameters with string, number, or boolean values.
   class Metadata < BaseModel
     # The id of the metadata of a user or an item.
     # @return [String]
     attr_accessor :id
 
-    # 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["id"] = "id"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
       @_hash
     end
 
     def initialize(hash)
       if !hash['id']
-        hash['id'] = nil
+        hash['id'] = nilc
       end
       hash.each { |name, value|
         instance_variable_set("@#{name}", value)
       }
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       Metadata.new(hash)
     end

data/lib/suggestgrid/models/type_request_body.rb

@@ -1,17 +1,18 @@
-# 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
+  # Options for creating a type.
   class TypeRequestBody < BaseModel
-    # The rating type of the type. Could be "explicit" or "implicit", where "implicit" is the default.
+    # The rating type of the type. Could be "explicit" or "implicit", where
+    # "implicit" is the default.
     # @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 +20,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.
       TypeRequestBody.new(rating)
     end
   end

data/lib/suggestgrid/models/users_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 users response.
   class UsersResponse < BaseModel
     # The number of users in the response.
     # @return [Long]
@@ -14,14 +16,12 @@ module SuggestGrid
     # @return [List of Metadata]
     attr_accessor :users
 
-    # 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["users"] = "users"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['total_count'] = 'total_count'
+      @_hash['users'] = 'users'
       @_hash
     end
 
@@ -33,21 +33,23 @@ module SuggestGrid
       @users = users
     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
       users = nil
-      if hash['users'] != nil
-        users = Array.new
-        hash['users'].each{|structure| users << (Metadata.from_hash(structure) if structure)}
+      unless hash['users'].nil?
+        users = []
+        hash['users'].each do |structure|
+          users << (Metadata.from_hash(structure) if structure)
+        end
       end
 
-      # Create object from extracted values
+      # Create object from extracted values.
       UsersResponse.new(count,
                         total_count,
                         users)

data/lib/suggestgrid/suggestgrid_client.rb

@@ -1,46 +1,48 @@
-# 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 ).
 
 require 'uri'
 
 module SuggestGrid
+  #  suggest_grid client class.
   class SuggestGridClient
-    # Singleton access to type controller
-    # @return [TypeController] Returns the controller instance
+    # Singleton access to type controller.
+    # @return [TypeController] Returns the controller instance.
     def type
       TypeController.instance
     end
 
-    # Singleton access to action controller
-    # @return [ActionController] Returns the controller instance
+    # Singleton access to action controller.
+    # @return [ActionController] Returns the controller instance.
     def action
       ActionController.instance
     end
 
-    # Singleton access to metadata controller
-    # @return [MetadataController] Returns the controller instance
+    # Singleton access to metadata controller.
+    # @return [MetadataController] Returns the controller instance.
     def metadata
       MetadataController.instance
     end
 
-    # Singleton access to recommendation controller
-    # @return [RecommendationController] Returns the controller instance
+    # Singleton access to recommendation controller.
+    # @return [RecommendationController] Returns the controller instance.
     def recommendation
       RecommendationController.instance
     end
 
-    # Singleton access to similarity controller
-    # @return [SimilarityController] Returns the controller instance
+    # Singleton access to similarity controller.
+    # @return [SimilarityController] Returns the controller instance.
     def similarity
       SimilarityController.instance
     end
 
-    # Returns the configuration class for easy access
-    # @return [Configuration] Returns the actual configuration class
+    # Returns the configuration class for easy access.
+    # @return [Configuration] Returns the actual configuration class.
     def config
       Configuration
     end
 
-    # Initializer with authentication and configuration parameters
+    # Initializer with authentication and configuration parameters.
     def initialize(connection_url)
       uri = URI(connection_url)
       Configuration.base_uri = "#{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}"

data/lib/suggestgrid.rb

@@ -1,4 +1,5 @@
-# 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 ).
 require 'date'
 require 'json'
 require 'faraday'
@@ -38,9 +39,9 @@ require_relative 'suggestgrid/models/items_response.rb'
 
 # Exceptions
 require_relative 'suggestgrid/exceptions/api_exception.rb'
-require_relative 'suggestgrid/exceptions/error_response_error_exception.rb'
-require_relative 'suggestgrid/exceptions/limit_exceeded_error_response_error_exception.rb'
-require_relative 'suggestgrid/exceptions/detailed_error_response_error_exception.rb'
+require_relative 'suggestgrid/exceptions/error_response.rb'
+require_relative 'suggestgrid/exceptions/limit_exceeded_error_response.rb'
+require_relative 'suggestgrid/exceptions/detailed_error_response.rb'
 
 require_relative 'suggestgrid/configuration.rb'
 

data/spec/swagger.yaml

@@ -2,7 +2,7 @@ swagger: '2.0'
 
 info:
   title: SuggestGrid
-  version: 0.3.0
+  version: 0.5.0-rc.3
   description: Personalization made Simple
   x-codegen-settings:
     appendContentHeaders: true
@@ -81,9 +81,9 @@ tags:
       - delete_item
       - delete_all_items
   - name: recommendation
-    description: Recommnedation Methods
+    description: Recommendation Methods
     x-docs-text: |
-      Recommnedation methods are for getting recommended items for users, or recommended users for items.
+      Recommendation methods are for getting recommended items for users, or recommended users for items.
       Refer to [recommendations](http://www.suggestgrid.com/docs/recommendations) for an overview.
     x-methods:
       - get_recommended_users

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suggestgrid
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0.rc3
 platform: ruby
 authors:
 - SuggestGrid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -110,9 +110,9 @@ files:
 - lib/suggestgrid/controllers/similarity_controller.rb
 - lib/suggestgrid/controllers/type_controller.rb
 - lib/suggestgrid/exceptions/api_exception.rb
-- lib/suggestgrid/exceptions/detailed_error_response_error_exception.rb
-- lib/suggestgrid/exceptions/error_response_error_exception.rb
-- lib/suggestgrid/exceptions/limit_exceeded_error_response_error_exception.rb
+- lib/suggestgrid/exceptions/detailed_error_response.rb
+- lib/suggestgrid/exceptions/error_response.rb
+- lib/suggestgrid/exceptions/limit_exceeded_error_response.rb
 - lib/suggestgrid/http/auth/basic_auth.rb
 - lib/suggestgrid/http/faraday_client.rb
 - lib/suggestgrid/http/http_call_back.rb
@@ -154,12 +154,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: SuggestGrid Ruby SDK