cloudmersive-validate-api-client 1.3.2 → 1.3.7

data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/api/user_agent_api.rb

@@ -0,0 +1,78 @@
+=begin
+#validateapi
+
+#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module CloudmersiveValidateApiClient
+  class UserAgentApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Parse an HTTP User-Agent string, identify robots
+    # Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
+    # @param request Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [UserAgentValidateResponse]
+    def user_agent_parse(request, opts = {})
+      data, _status_code, _headers = user_agent_parse_with_http_info(request, opts)
+      return data
+    end
+
+    # Parse an HTTP User-Agent string, identify robots
+    # Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
+    # @param request Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserAgentValidateResponse, Fixnum, Hash)>] UserAgentValidateResponse data, response status code and response headers
+    def user_agent_parse_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UserAgentApi.user_agent_parse ..."
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling UserAgentApi.user_agent_parse"
+      end
+      # resource path
+      local_var_path = "/validate/useragent/parse"
+
+      # 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(request)
+      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 => 'UserAgentValidateResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserAgentApi#user_agent_parse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/cloudmersive-validate-api-client/api/vat_api.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/api_client.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/api_error.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/configuration.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/address_get_servers_response.rb

@@ -6,7 +6,7 @@
 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
 
@@ -15,8 +15,10 @@ require 'date'
 module CloudmersiveValidateApiClient
   # Result of a partial email address validation
   class AddressGetServersResponse
+    # True if partial address validation was successufl, false otherwise
     attr_accessor :success
 
+    # Email servers for this email address
     attr_accessor :servers
 
 

data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/check_response.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/first_name_validation_request.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/first_name_validation_response.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/full_email_validation_response.rb

@@ -6,7 +6,7 @@
 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
 
@@ -36,6 +36,12 @@ module CloudmersiveValidateApiClient
     # Domain name of the email address
     attr_accessor :domain
 
+    # True if the email domain name is a free provider (typically a free to sign up web email provider for consumers / personal use), false otherwise.
+    attr_accessor :is_free_email_provider
+
+    # True if the email address is a disposable email address, false otherwise; these disposable providers are not typically used to receive email and so will have a low likelihood of opening mail sent there.
+    attr_accessor :is_disposable
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -46,7 +52,9 @@ module CloudmersiveValidateApiClient
         :'valid_domain' => :'Valid_Domain',
         :'valid_smtp' => :'Valid_SMTP',
         :'is_catchall_domain' => :'IsCatchallDomain',
-        :'domain' => :'Domain'
+        :'domain' => :'Domain',
+        :'is_free_email_provider' => :'IsFreeEmailProvider',
+        :'is_disposable' => :'IsDisposable'
       }
     end
 
@@ -59,7 +67,9 @@ module CloudmersiveValidateApiClient
         :'valid_domain' => :'BOOLEAN',
         :'valid_smtp' => :'BOOLEAN',
         :'is_catchall_domain' => :'BOOLEAN',
-        :'domain' => :'String'
+        :'domain' => :'String',
+        :'is_free_email_provider' => :'BOOLEAN',
+        :'is_disposable' => :'BOOLEAN'
       }
     end
 
@@ -99,6 +109,14 @@ module CloudmersiveValidateApiClient
         self.domain = attributes[:'Domain']
       end
 
+      if attributes.has_key?(:'IsFreeEmailProvider')
+        self.is_free_email_provider = attributes[:'IsFreeEmailProvider']
+      end
+
+      if attributes.has_key?(:'IsDisposable')
+        self.is_disposable = attributes[:'IsDisposable']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -125,7 +143,9 @@ module CloudmersiveValidateApiClient
           valid_domain == o.valid_domain &&
           valid_smtp == o.valid_smtp &&
           is_catchall_domain == o.is_catchall_domain &&
-          domain == o.domain
+          domain == o.domain &&
+          is_free_email_provider == o.is_free_email_provider &&
+          is_disposable == o.is_disposable
     end
 
     # @see the `==` method
@@ -137,7 +157,7 @@ module CloudmersiveValidateApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [valid_address, mail_server_used_for_validation, valid_syntax, valid_domain, valid_smtp, is_catchall_domain, domain].hash
+      [valid_address, mail_server_used_for_validation, valid_syntax, valid_domain, valid_smtp, is_catchall_domain, domain, is_free_email_provider, is_disposable].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/full_name_validation_response.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/geolocate_response.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/get_gender_request.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/get_gender_response.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/last_name_validation_request.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/last_name_validation_response.rb

@@ -6,7 +6,7 @@
 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-validate-api-client/models/parse_address_request.rb

@@ -0,0 +1,199 @@
+=begin
+#validateapi
+
+#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'date'
+
+module CloudmersiveValidateApiClient
+  # Request to parse an address formatted as a string/free text into a structured address
+  class ParseAddressRequest
+    # A mailing address or street address formatted as a single text string; this will be parsed into its components
+    attr_accessor :address_string
+
+    # Optional; indicates how the parsed output should be capitalized; default is Title Case; possible values are: \"Uppercase\" will set the capitalization to UPPER CASE; \"Lowercase\" will set the capitalization to lower case; \"Titlecase\" will set the capitalization to Title Case; and \"Originalcase\" will preserve the original casing as much as possible
+    attr_accessor :capitalization_mode
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address_string' => :'AddressString',
+        :'capitalization_mode' => :'CapitalizationMode'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'address_string' => :'String',
+        :'capitalization_mode' => :'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?(:'AddressString')
+        self.address_string = attributes[:'AddressString']
+      end
+
+      if attributes.has_key?(:'CapitalizationMode')
+        self.capitalization_mode = attributes[:'CapitalizationMode']
+      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 &&
+          address_string == o.address_string &&
+          capitalization_mode == o.capitalization_mode
+    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
+      [address_string, capitalization_mode].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 = CloudmersiveValidateApiClient.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