suggestgrid 0.3.0 → 0.5.0.rc3

data/lib/suggestgrid/controllers/recommendation_controller.rb

@@ -1,87 +1,127 @@
-# 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
+  # RecommendationController
   class RecommendationController < BaseController
-    @@instance = RecommendationController.new
-    # Singleton instance of the controller class
-    def self.instance
-      @@instance
+    @instance = RecommendationController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
     end
 
-    # Gets Recommended Users
-    # @param [GetRecommendedUsersBody] query Required parameter: Query for recommended users.
+    # Returns recommended users for the query.
+    # @param [GetRecommendedUsersBody] query Required parameter: Query for
+    # recommended users.
     # @return UsersResponse response from the API call
     def get_recommended_users(query)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/recommend/users'
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: query.to_json
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 400
-        raise ErrorResponseErrorException.new 'Request body is invalid.', _context
+        raise ErrorResponse.new(
+          'Request body is invalid.',
+          _context
+        )
       elsif _context.response.status_code == 404
-        raise ErrorResponseErrorException.new 'At least one type in the request does not exist.', _context
+        raise ErrorResponse.new(
+          'At least one type in the request does not exist.',
+          _context
+        )
       elsif _context.response.status_code == 422
-        raise ErrorResponseErrorException.new 'Required parameters are missing.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Required parameters are missing.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return UsersResponse.from_hash(decoded)
+      UsersResponse.from_hash(decoded)
     end
 
-    # Gets Recommended Items
-    # @param [GetRecommendedItemsBody] query Required parameter: Query for recommended items.
+    # Returns recommended items for the query.
+    # @param [GetRecommendedItemsBody] query Required parameter: Query for
+    # recommended items.
     # @return ItemsResponse response from the API call
     def get_recommended_items(query)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/recommend/items'
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: query.to_json
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 400
-        raise ErrorResponseErrorException.new 'Request body is invalid.', _context
+        raise ErrorResponse.new(
+          'Request body is invalid.',
+          _context
+        )
       elsif _context.response.status_code == 404
-        raise ErrorResponseErrorException.new 'At least one type in the request does not exist.', _context
+        raise ErrorResponse.new(
+          'At least one type in the request does not exist.',
+          _context
+        )
       elsif _context.response.status_code == 422
-        raise ErrorResponseErrorException.new 'Required parameters are missing.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Required parameters are missing.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return ItemsResponse.from_hash(decoded)
+      ItemsResponse.from_hash(decoded)
     end
   end
 end

data/lib/suggestgrid/controllers/similarity_controller.rb

@@ -1,87 +1,127 @@
-# 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
+  # SimilarityController
   class SimilarityController < BaseController
-    @@instance = SimilarityController.new
-    # Singleton instance of the controller class
-    def self.instance
-      @@instance
+    @instance = SimilarityController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
     end
 
-    # Gets Similar Users
-    # @param [GetSimilarUsersBody] query Required parameter: Query for similar users.
+    # Returns similar users for the query.
+    # @param [GetSimilarUsersBody] query Required parameter: Query for similar
+    # users.
     # @return UsersResponse response from the API call
     def get_similar_users(query)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/similar/users'
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: query.to_json
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 400
-        raise ErrorResponseErrorException.new 'Request body is invalid.', _context
+        raise ErrorResponse.new(
+          'Request body is invalid.',
+          _context
+        )
       elsif _context.response.status_code == 404
-        raise ErrorResponseErrorException.new 'At least one type in the request does not exist.', _context
+        raise ErrorResponse.new(
+          'At least one type in the request does not exist.',
+          _context
+        )
       elsif _context.response.status_code == 422
-        raise ErrorResponseErrorException.new 'Required parameters are missing.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Required parameters are missing.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return UsersResponse.from_hash(decoded)
+      UsersResponse.from_hash(decoded)
     end
 
-    # Gets Similar Items
-    # @param [GetSimilarItemsBody] query Required parameter: Query for similar items.
+    # Returns similar items for the query.
+    # @param [GetSimilarItemsBody] query Required parameter: Query for similar
+    # items.
     # @return ItemsResponse response from the API call
     def get_similar_items(query)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/similar/items'
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: query.to_json
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 400
-        raise ErrorResponseErrorException.new 'Request body is invalid.', _context
+        raise ErrorResponse.new(
+          'Request body is invalid.',
+          _context
+        )
       elsif _context.response.status_code == 404
-        raise ErrorResponseErrorException.new 'At least one type in the request does not exist.', _context
+        raise ErrorResponse.new(
+          'At least one type in the request does not exist.',
+          _context
+        )
       elsif _context.response.status_code == 422
-        raise ErrorResponseErrorException.new 'Required parameters are missing.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Required parameters are missing.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return ItemsResponse.from_hash(decoded)
+      ItemsResponse.from_hash(decoded)
     end
   end
 end

data/lib/suggestgrid/controllers/type_controller.rb

@@ -1,186 +1,243 @@
-# 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
+  # TypeController
   class TypeController < BaseController
-    @@instance = TypeController.new
-    # Singleton instance of the controller class
-    def self.instance
-      @@instance
+    @instance = TypeController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
     end
 
-    # Creates a Type
+    # Creates a new type.
     # @param [String] type Required parameter: The name of the type.
-    # @param [TypeRequestBody] settings Optional parameter: Optional settings for the rating parameter.
+    # @param [TypeRequestBody] settings Optional parameter: Optional settings
+    # for the rating parameter.
     # @return MessageResponse response from the API call
     def create_type(type,
                     settings = nil)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/types/{type}'
-      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
         'type' => type
-      }
+      )
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.put _query_url, headers: _headers, parameters: settings.to_json
+      # Prepare and execute HttpRequest.
+      _request = @http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: settings.to_json
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 402
-        raise LimitExceededErrorResponseErrorException.new 'Type limit reached.', _context
+        raise LimitExceededErrorResponse.new(
+          'Type limit reached.',
+          _context
+        )
       elsif _context.response.status_code == 409
-        raise ErrorResponseErrorException.new 'Type already exists.', _context
+        raise ErrorResponse.new(
+          'Type already exists.',
+          _context
+        )
       elsif _context.response.status_code == 422
-        raise ErrorResponseErrorException.new 'Rating type is not `implicit` or `explicit`.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Rating type is not `implicit` or `explicit`.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return MessageResponse.from_hash(decoded)
+      MessageResponse.from_hash(decoded)
     end
 
-    # Gets Properties of a Type
-    # @param [String] type Required parameter: The name of the type to get properties.
+    # Returns the options of a type. The response rating parameter.
+    # @param [String] type Required parameter: The name of the type to get
+    # properties.
     # @return GetTypeResponse response from the API call
     def get_type(type)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/types/{type}'
-      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
         'type' => type
-      }
+      )
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.get _query_url, headers: _headers
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 404
-        raise ErrorResponseErrorException.new 'Type does not exists.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Type does not exists.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return GetTypeResponse.from_hash(decoded)
+      GetTypeResponse.from_hash(decoded)
     end
 
-    # Deletes a Type
-    # @param [String] type Required parameter: The name of the type to be deleted.
+    # Warning: Deletes the type with all of its actions and its recommendation
+    # model.
+    # @param [String] type Required parameter: The name of the type to be
+    # deleted.
     # @return MessageResponse response from the API call
     def delete_type(type)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/types/{type}'
-      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
         'type' => type
-      }
+      )
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.delete _query_url, headers: _headers
+      # Prepare and execute HttpRequest.
+      _request = @http_client.delete(
+        _query_url,
+        headers: _headers
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 404
-        raise ErrorResponseErrorException.new 'Action type does not exists.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Action type does not exists.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return MessageResponse.from_hash(decoded)
+      MessageResponse.from_hash(decoded)
     end
 
-    # Gets All Types
+    # Returns all type names in an array named types.
     # @return GetTypesResponse response from the API call
     def get_all_types
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/types'
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.get _query_url, headers: _headers
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
-      if _context.response.status_code == 0
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+      # Validate response against endpoint and global error codes.
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return GetTypesResponse.from_hash(decoded)
+      GetTypesResponse.from_hash(decoded)
     end
 
-    # Deletes All Types
+    # Deletes ALL the types and ALL the actions.
     # @return MessageResponse response from the API call
     def delete_all_types
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/types'
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.delete _query_url, headers: _headers
+      # Prepare and execute HttpRequest.
+      _request = @http_client.delete(
+        _query_url,
+        headers: _headers
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
-      if _context.response.status_code == 0
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+      # Validate response against endpoint and global error codes.
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return MessageResponse.from_hash(decoded)
+      MessageResponse.from_hash(decoded)
     end
   end
 end

data/lib/suggestgrid/exceptions/api_exception.rb

@@ -1,11 +1,13 @@
-# 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
+  # Class for exceptions when there is a network error, status code error, etc.
   class APIException < StandardError
     attr_reader :context, :response_code
 
     # The constructor.
-    # @param [String] The reason for raising an exception
+    # @param [String] The reason for raising an exception.
     # @param [HttpContext] The HttpContext of the API call.
     def initialize(reason, context)
       super(reason)