cloudmersive-validate-api-client 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b718b14d76475a079bd8b6170efa4b446eeb1f72f1dc675e668fc7df317702f7
-  data.tar.gz: 743e6ffadb3143a39d6b1396cbbb49451253474f210997ae1cb96cf8570f9e27
+  metadata.gz: 4a5d849be72f0460fb5087353a35c3c135c399728d5c20ad9eb73a6ad7314f02
+  data.tar.gz: caf6a09893146d0826ccaf1be78b231797e87b2f889060a343f8b78f3ef27cbd
 SHA512:
-  metadata.gz: 5b4cef8c87f1a63adb8f30eaf38b655004ab274da06d27379b3368f5d47742c1853ca6ec945fc27b11b0a5f79790b11d660d56e0cb558769dc94cfed5379474d
-  data.tar.gz: 7f3be0521871024a35d9e8d802727f61475ecfc1761ccb7bcdadaf844708b34fc8ebf2e04e68bfc41b6bac778907dda92c090b7b800b97277407c98e0d657671
+  metadata.gz: 1d1c337167f8e1f54c9b277c1247552517bb87c3b6eab3e49ed695bff3efaaf718b1f569064325f25b4bab59520861d477fcc1720424c187530ea859454bd346
+  data.tar.gz: 3b462325435212058db781798ae6fb84df3ea921cca9c90bdd94305925defd0599cd989ed45fd0ec5419e19cea783f10ca9f694c1052ff8d3b4f27dfe7e359f9

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.2.0
+- Package version: 2.2.2
 - 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.2.0.gem
+gem install ./cloudmersive-validate-api-client-2.2.2.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.2.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.2.0'
+    gem 'cloudmersive-validate-api-client', '~> 2.2.2'
 
 ### Install from Git
 
@@ -103,6 +103,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_parse_standard_date_time**](docs/DateTimeApi.md#date_time_parse_standard_date_time) | **POST** /validate/date-time/parse/date-time/structured | Parses a standardized date and time string into a date and time
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_get_top_level_domain_from_url**](docs/DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
+*CloudmersiveValidateApiClient::DomainApi* | [**domain_is_admin_path**](docs/DomainApi.md#domain_is_admin_path) | **POST** /validate/domain/url/is-admin-path | Check if path is a high-risk server administration path
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_phishing_check**](docs/DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
 *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
@@ -167,6 +168,7 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::IPIntelligenceResponse](docs/IPIntelligenceResponse.md)
  - [CloudmersiveValidateApiClient::IPReverseDNSLookupResponse](docs/IPReverseDNSLookupResponse.md)
  - [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
+ - [CloudmersiveValidateApiClient::IsAdminPathResponse](docs/IsAdminPathResponse.md)
  - [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
  - [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
  - [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.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_get_top_level_domain_from_url**](DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
+[**domain_is_admin_path**](DomainApi.md#domain_is_admin_path) | **POST** /validate/domain/url/is-admin-path | Check if path is a high-risk server administration path
 [**domain_phishing_check**](DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
 [**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
@@ -124,6 +125,60 @@ Name | Type | Description  | Notes
 
 
 
+# **domain_is_admin_path**
+> IsAdminPathResponse domain_is_admin_path(value)
+
+Check if path is a high-risk server administration path
+
+Check if the input URL or relative path is a server Administration Path, and therefore a risk for remote access.
+
+### 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
+
+value = 'value_example' # String | URL or relative path to check, e.g. \"/admin/login\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Check if path is a high-risk server administration path
+  result = api_instance.domain_is_admin_path(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling DomainApi->domain_is_admin_path: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| URL or relative path to check, e.g. \"/admin/login\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**IsAdminPathResponse**](IsAdminPathResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **domain_phishing_check**
 > PhishingCheckResponse domain_phishing_check(request)
 

data/docs/IsAdminPathResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::IsAdminPathResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_admin_path_node** | **BOOLEAN** | True if the input IP address is an Admin Path, and false otherwise | [optional] 
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+
+

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

@@ -43,6 +43,7 @@ require 'cloudmersive-validate-api-client/models/get_timezones_response'
 require 'cloudmersive-validate-api-client/models/ip_intelligence_response'
 require 'cloudmersive-validate-api-client/models/ip_reverse_dns_lookup_response'
 require 'cloudmersive-validate-api-client/models/ip_threat_response'
+require 'cloudmersive-validate-api-client/models/is_admin_path_response'
 require 'cloudmersive-validate-api-client/models/last_name_validation_request'
 require 'cloudmersive-validate-api-client/models/last_name_validation_response'
 require 'cloudmersive-validate-api-client/models/lead_enrichment_request'

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

@@ -127,6 +127,60 @@ module CloudmersiveValidateApiClient
       end
       return data, status_code, headers
     end
+    # Check if path is a high-risk server administration path
+    # Check if the input URL or relative path is a server Administration Path, and therefore a risk for remote access.
+    # @param value URL or relative path to check, e.g. \"/admin/login\".  The input is a string so be sure to enclose it in double-quotes.
+    # @param [Hash] opts the optional parameters
+    # @return [IsAdminPathResponse]
+    def domain_is_admin_path(value, opts = {})
+      data, _status_code, _headers = domain_is_admin_path_with_http_info(value, opts)
+      data
+    end
+
+    # Check if path is a high-risk server administration path
+    # Check if the input URL or relative path is a server Administration Path, and therefore a risk for remote access.
+    # @param value URL or relative path to check, e.g. \"/admin/login\".  The input is a string so be sure to enclose it in double-quotes.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IsAdminPathResponse, Fixnum, Hash)>] IsAdminPathResponse data, response status code and response headers
+    def domain_is_admin_path_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainApi.domain_is_admin_path ...'
+      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 DomainApi.domain_is_admin_path"
+      end
+      # resource path
+      local_var_path = '/validate/domain/url/is-admin-path'
+
+      # 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'])
+
+      # 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 => 'IsAdminPathResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainApi#domain_is_admin_path\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Check a URL for Phishing threats
     # Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.
     # @param request Input URL request

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

@@ -0,0 +1,196 @@
+=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 an Admin Path operation
+  class IsAdminPathResponse
+    # True if the input IP address is an Admin Path, and false otherwise
+    attr_accessor :is_admin_path_node
+
+    # True if the operation was successful, false otherwise
+    attr_accessor :successful
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'is_admin_path_node' => :'IsAdminPathNode',
+        :'successful' => :'Successful'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'is_admin_path_node' => :'BOOLEAN',
+        :'successful' => :'BOOLEAN'
+      }
+    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?(:'IsAdminPathNode')
+        self.is_admin_path_node = attributes[:'IsAdminPathNode']
+      end
+
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      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 &&
+          is_admin_path_node == o.is_admin_path_node &&
+          successful == o.successful
+    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
+      [is_admin_path_node, successful].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.2.0'
+  VERSION = '2.2.2'
 end

data/spec/api/domain_api_spec.rb

@@ -56,6 +56,18 @@ describe 'DomainApi' do
     end
   end
 
+  # unit tests for domain_is_admin_path
+  # Check if path is a high-risk server administration path
+  # Check if the input URL or relative path is a server Administration Path, and therefore a risk for remote access.
+  # @param value URL or relative path to check, e.g. \"/admin/login\".  The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [IsAdminPathResponse]
+  describe 'domain_is_admin_path 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_phishing_check
   # Check a URL for Phishing threats
   # Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.

data/spec/models/is_admin_path_response_spec.rb

@@ -0,0 +1,47 @@
+=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::IsAdminPathResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'IsAdminPathResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::IsAdminPathResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IsAdminPathResponse' do
+    it 'should create an instance of IsAdminPathResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::IsAdminPathResponse)
+    end
+  end
+  describe 'test attribute "is_admin_path_node"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "successful"' 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.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -234,6 +234,7 @@ files:
 - "./docs/IPIntelligenceResponse.md"
 - "./docs/IPReverseDNSLookupResponse.md"
 - "./docs/IPThreatResponse.md"
+- "./docs/IsAdminPathResponse.md"
 - "./docs/LastNameValidationRequest.md"
 - "./docs/LastNameValidationResponse.md"
 - "./docs/LeadEnrichmentApi.md"
@@ -338,6 +339,7 @@ files:
 - "./lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/ip_reverse_dns_lookup_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/ip_threat_response.rb"
+- "./lib/cloudmersive-validate-api-client/models/is_admin_path_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb"
 - "./lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb"
@@ -434,6 +436,7 @@ files:
 - "./spec/models/ip_intelligence_response_spec.rb"
 - "./spec/models/ip_reverse_dns_lookup_response_spec.rb"
 - "./spec/models/ip_threat_response_spec.rb"
+- "./spec/models/is_admin_path_response_spec.rb"
 - "./spec/models/last_name_validation_request_spec.rb"
 - "./spec/models/last_name_validation_response_spec.rb"
 - "./spec/models/lead_enrichment_request_spec.rb"