cloudmersive-validate-api-client 2.0.8 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb382f1dbe5f06ff959501816df879a458d77f7469f9112cfabeb1f9966917c
-  data.tar.gz: f640178248133cd34265425ab9d4fde9ba97f353afed3fc75600f64f23f747a9
+  metadata.gz: 45257c18a8c0587871e54bbcfc01be00f34d09e53c57a13b969ec95f1411c18a
+  data.tar.gz: 39e0dff4b2d59fdb05a05bc7889b8e0517de2a5cc7c15719e4c596a589b3d0a0
 SHA512:
-  metadata.gz: d86f5d1155b8ddeaf82843e39a5bd1155d064d10ec5b73f62a2015bdce567718480a8772188350a0919a6dd572da368a7d7f6cc03255788e2bc213b781369c5f
-  data.tar.gz: 89f94bc4cfffc3faa4b97f451487a2f259e8e0a10c75aaa103b8f1d8377b7cece8541f95321112a39169b1ab41fa5d137a1a9c18a8caa7b3aa92ce7b81f0ed01
+  metadata.gz: 7bb13960378669337a7094c534b0a3beb9516436ebc526b09a885709d236628eee6f5a067aa315a6c4e9a3083b409e32af2b71f95e309d0be1dcdfa188f7b5a5
+  data.tar.gz: 7f30c7be9bb506338153492cfad17d0dea56ac506e8f59d9d993761faf4423e6514bce28331a7f0882115b412be8f4e4f3cadfa93f596446d4e29d51f29b6038

data/README.md

@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 2.0.8
+- Package version: 2.0.9
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-validate-api-client-2.0.8.gem
+gem install ./cloudmersive-validate-api-client-2.0.9.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.0.8.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.0.9.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-validate-api-client', '~> 2.0.8'
+    gem 'cloudmersive-validate-api-client', '~> 2.0.9'
 
 ### Install from Git
 
@@ -96,6 +96,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveValidateApiClient::AddressApi* | [**address_validate_state**](docs/AddressApi.md#address_validate_state) | **POST** /validate/address/state | Validate a state or province, name or abbreviation, get location information about it
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
+*CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
 *CloudmersiveValidateApiClient::EmailApi* | [**email_address_get_servers**](docs/EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
@@ -122,6 +123,7 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
  - [CloudmersiveValidateApiClient::CountryDetails](docs/CountryDetails.md)
  - [CloudmersiveValidateApiClient::CountryListResult](docs/CountryListResult.md)
+ - [CloudmersiveValidateApiClient::DomainQualityResponse](docs/DomainQualityResponse.md)
  - [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
  - [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
  - [CloudmersiveValidateApiClient::FullEmailValidationResponse](docs/FullEmailValidationResponse.md)

data/docs/DomainApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
 [**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
+[**domain_quality_score**](DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
 [**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
 [**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
 
@@ -118,6 +119,60 @@ Name | Type | Description  | Notes
 
 
 
+# **domain_quality_score**
+> DomainQualityResponse domain_quality_score(domain)
+
+Validate a domain name's quality score
+
+Check the quality of a domain name.  Higher quality scores indicate more trust and authority in the domain name.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::DomainApi.new
+
+domain = 'domain_example' # String | Domain name to check, for example \"cloudmersive.com\".
+
+
+begin
+  #Validate a domain name's quality score
+  result = api_instance.domain_quality_score(domain)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling DomainApi->domain_quality_score: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **domain** | **String**| Domain name to check, for example \"cloudmersive.com\". | 
+
+### Return type
+
+[**DomainQualityResponse**](DomainQualityResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/javascript, application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **domain_url_full**
 > ValidateUrlResponseFull domain_url_full(request)
 

data/docs/DomainQualityResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::DomainQualityResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain_quality_score** | **Float** | The quality score of the domain name; possible values are 0.0 to 10.0 with 10.0 being the highest and 0.0 being the lowest quality. | [optional] 
+
+

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

@@ -22,6 +22,7 @@ require 'cloudmersive-validate-api-client/models/address_verify_syntax_only_resp
 require 'cloudmersive-validate-api-client/models/check_response'
 require 'cloudmersive-validate-api-client/models/country_details'
 require 'cloudmersive-validate-api-client/models/country_list_result'
+require 'cloudmersive-validate-api-client/models/domain_quality_response'
 require 'cloudmersive-validate-api-client/models/first_name_validation_request'
 require 'cloudmersive-validate-api-client/models/first_name_validation_response'
 require 'cloudmersive-validate-api-client/models/full_email_validation_response'

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

@@ -127,6 +127,60 @@ module CloudmersiveValidateApiClient
       end
       return data, status_code, headers
     end
+    # Validate a domain name's quality score
+    # Check the quality of a domain name.  Higher quality scores indicate more trust and authority in the domain name.
+    # @param domain Domain name to check, for example \"cloudmersive.com\".
+    # @param [Hash] opts the optional parameters
+    # @return [DomainQualityResponse]
+    def domain_quality_score(domain, opts = {})
+      data, _status_code, _headers = domain_quality_score_with_http_info(domain, opts)
+      data
+    end
+
+    # Validate a domain name's quality score
+    # Check the quality of a domain name.  Higher quality scores indicate more trust and authority in the domain name.
+    # @param domain Domain name to check, for example \"cloudmersive.com\".
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DomainQualityResponse, Fixnum, Hash)>] DomainQualityResponse data, response status code and response headers
+    def domain_quality_score_with_http_info(domain, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainApi.domain_quality_score ...'
+      end
+      # verify the required parameter 'domain' is set
+      if @api_client.config.client_side_validation && domain.nil?
+        fail ArgumentError, "Missing the required parameter 'domain' when calling DomainApi.domain_quality_score"
+      end
+      # resource path
+      local_var_path = '/validate/domain/quality-score'
+
+      # 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(['text/javascript', 'application/json', 'text/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(domain)
+      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 => 'DomainQualityResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainApi#domain_quality_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Validate a URL fully
     # Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.
     # @param request Input URL request

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

@@ -0,0 +1,186 @@
+=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.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveValidateApiClient
+  # Result of performing a domain quality score operation
+  class DomainQualityResponse
+    # The quality score of the domain name; possible values are 0.0 to 10.0 with 10.0 being the highest and 0.0 being the lowest quality.
+    attr_accessor :domain_quality_score
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'domain_quality_score' => :'DomainQualityScore'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'domain_quality_score' => :'Float'
+      }
+    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?(:'DomainQualityScore')
+        self.domain_quality_score = attributes[:'DomainQualityScore']
+      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
+      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?
+      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 &&
+          domain_quality_score == o.domain_quality_score
+    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
+      [domain_quality_score].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 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

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

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersiveValidateApiClient
-  VERSION = '2.0.8'
+  VERSION = '2.0.9'
 end

data/spec/api/domain_api_spec.rb

@@ -56,6 +56,18 @@ describe 'DomainApi' do
     end
   end
 
+  # unit tests for domain_quality_score
+  # Validate a domain name's quality score
+  # Check the quality of a domain name.  Higher quality scores indicate more trust and authority in the domain name.
+  # @param domain Domain name to check, for example \"cloudmersive.com\".
+  # @param [Hash] opts the optional parameters
+  # @return [DomainQualityResponse]
+  describe 'domain_quality_score test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for domain_url_full
   # Validate a URL fully
   # Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.

data/spec/models/domain_quality_response_spec.rb

@@ -0,0 +1,41 @@
+=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.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveValidateApiClient::DomainQualityResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DomainQualityResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::DomainQualityResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DomainQualityResponse' do
+    it 'should create an instance of DomainQualityResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::DomainQualityResponse)
+    end
+  end
+  describe 'test attribute "domain_quality_score"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-validate-api-client
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.9
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -210,6 +210,7 @@ files:
 - "./docs/CountryDetails.md"
 - "./docs/CountryListResult.md"
 - "./docs/DomainApi.md"
+- "./docs/DomainQualityResponse.md"
 - "./docs/EmailApi.md"
 - "./docs/FirstNameValidationRequest.md"
 - "./docs/FirstNameValidationResponse.md"
@@ -278,6 +279,7 @@ files:
 - "./lib/cloudmersive-validate-api-client/models/check_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/country_details.rb"
 - "./lib/cloudmersive-validate-api-client/models/country_list_result.rb"
+- "./lib/cloudmersive-validate-api-client/models/domain_quality_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb"
 - "./lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb"
@@ -337,6 +339,7 @@ files:
 - "./spec/models/check_response_spec.rb"
 - "./spec/models/country_details_spec.rb"
 - "./spec/models/country_list_result_spec.rb"
+- "./spec/models/domain_quality_response_spec.rb"
 - "./spec/models/first_name_validation_request_spec.rb"
 - "./spec/models/first_name_validation_response_spec.rb"
 - "./spec/models/full_email_validation_response_spec.rb"