cloudmersive-nlp-api-client 1.2.9 → 2.0.1

data/lib/cloudmersive-nlp-api-client/api/spellcheck_api.rb

@@ -0,0 +1,133 @@
+=begin
+#nlpapiv2
+
+#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module CloudmersiveNlpApiClient
+  class SpellcheckApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Check if sentence is spelled correctly
+    # Checks whether the sentence is spelled correctly and returns the result as JSON
+    # @param value Input sentence
+    # @param [Hash] opts the optional parameters
+    # @return [CheckSentenceResponse]
+    def spellcheck_check_sentence(value, opts = {})
+      data, _status_code, _headers = spellcheck_check_sentence_with_http_info(value, opts)
+      return data
+    end
+
+    # Check if sentence is spelled correctly
+    # Checks whether the sentence is spelled correctly and returns the result as JSON
+    # @param value Input sentence
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CheckSentenceResponse, Fixnum, Hash)>] CheckSentenceResponse data, response status code and response headers
+    def spellcheck_check_sentence_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SpellcheckApi.spellcheck_check_sentence ..."
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling SpellcheckApi.spellcheck_check_sentence"
+      end
+      # resource path
+      local_var_path = "/nlp-v2/spellcheck/check/sentence"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CheckSentenceResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpellcheckApi#spellcheck_check_sentence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Find spelling corrections
+    # Find spelling correction suggestions and return result as JSON
+    # @param value Input string
+    # @param [Hash] opts the optional parameters
+    # @return [CheckWordResponse]
+    def spellcheck_correct_json(value, opts = {})
+      data, _status_code, _headers = spellcheck_correct_json_with_http_info(value, opts)
+      return data
+    end
+
+    # Find spelling corrections
+    # Find spelling correction suggestions and return result as JSON
+    # @param value Input string
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CheckWordResponse, Fixnum, Hash)>] CheckWordResponse data, response status code and response headers
+    def spellcheck_correct_json_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SpellcheckApi.spellcheck_correct_json ..."
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling SpellcheckApi.spellcheck_correct_json"
+      end
+      # resource path
+      local_var_path = "/nlp-v2/spellcheck/check/word"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CheckWordResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpellcheckApi#spellcheck_correct_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/cloudmersive-nlp-api-client/api_client.rb

@@ -1,12 +1,12 @@
 =begin
-#nlpapi
+#nlpapiv2
 
-#The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
 
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/cloudmersive-nlp-api-client/api_error.rb

@@ -1,12 +1,12 @@
 =begin
-#nlpapi
+#nlpapiv2
 
-#The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
 
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/cloudmersive-nlp-api-client/configuration.rb

@@ -1,12 +1,12 @@
 =begin
-#nlpapi
+#nlpapiv2
 
-#The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
 
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/cloudmersive-nlp-api-client/models/check_sentence_request.rb

@@ -0,0 +1,189 @@
+=begin
+#nlpapiv2
+
+#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'date'
+
+module CloudmersiveNlpApiClient
+  # Input object for spell checking
+  class CheckSentenceRequest
+    # Input sentence for spell check
+    attr_accessor :sentence
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sentence' => :'Sentence'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'sentence' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'Sentence')
+        self.sentence = attributes[:'Sentence']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          sentence == o.sentence
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [sentence].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveNlpApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/cloudmersive-nlp-api-client/models/{check_sentence_json_response.rb → check_sentence_response.rb}

@@ -1,12 +1,12 @@
 =begin
-#nlpapi
+#nlpapiv2
 
-#The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
 
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 
 module CloudmersiveNlpApiClient
   # Result of spell checking a sentence
-  class CheckSentenceJsonResponse
+  class CheckSentenceResponse
     # Number of incorrect words
     attr_accessor :incorrect_count
 
@@ -34,7 +34,7 @@ module CloudmersiveNlpApiClient
     def self.swagger_types
       {
         :'incorrect_count' => :'Integer',
-        :'words' => :'Array<CorrectWordInSentenceJsonResponse>'
+        :'words' => :'Array<CorrectWordInSentence>'
       }
     end
 

data/lib/cloudmersive-nlp-api-client/models/{check_json_response.rb → check_word_request.rb}

@@ -1,35 +1,34 @@
 =begin
-#nlpapi
+#nlpapiv2
 
-#The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
 
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 
 require 'date'
 
 module CloudmersiveNlpApiClient
-  # Spell check result
-  class CheckJsonResponse
-    # True if spellected correctly, false otherwise
-    attr_accessor :correct
+
+  class CheckWordRequest
+    attr_accessor :word
 
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'correct' => :'Correct'
+        :'word' => :'Word'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'correct' => :'BOOLEAN'
+        :'word' => :'String'
       }
     end
 
@@ -41,8 +40,8 @@ module CloudmersiveNlpApiClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'Correct')
-        self.correct = attributes[:'Correct']
+      if attributes.has_key?(:'Word')
+        self.word = attributes[:'Word']
       end
 
     end
@@ -65,7 +64,7 @@ module CloudmersiveNlpApiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          correct == o.correct
+          word == o.word
     end
 
     # @see the `==` method
@@ -77,7 +76,7 @@ module CloudmersiveNlpApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [correct].hash
+      [word].hash
     end
 
     # Builds the object from hash