cloudmersive-validate-api-client 2.2.2 → 2.2.5

data/lib/cloudmersive-validate-api-client/models/url_html_ssrf_response_full.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 checking a URL for HTML-embedded SSRF threats
+  class UrlHtmlSsrfResponseFull
+    # True if the URL is clean, false if it is at risk of containing an SSRF threat or attack
+    attr_accessor :clean_url
+
+    # HTTP response code from the URL
+    attr_accessor :http_response_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'clean_url' => :'CleanURL',
+        :'http_response_code' => :'HttpResponseCode'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'clean_url' => :'BOOLEAN',
+        :'http_response_code' => :'Integer'
+      }
+    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?(:'CleanURL')
+        self.clean_url = attributes[:'CleanURL']
+      end
+
+      if attributes.has_key?(:'HttpResponseCode')
+        self.http_response_code = attributes[:'HttpResponseCode']
+      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 &&
+          clean_url == o.clean_url &&
+          http_response_code == o.http_response_code
+    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
+      [clean_url, http_response_code].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.2'
+  VERSION = '2.2.5'
 end

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

@@ -28,6 +28,7 @@ require 'cloudmersive-validate-api-client/models/date_time_now_result'
 require 'cloudmersive-validate-api-client/models/date_time_standardized_parse_request'
 require 'cloudmersive-validate-api-client/models/date_time_standardized_parse_response'
 require 'cloudmersive-validate-api-client/models/domain_quality_response'
+require 'cloudmersive-validate-api-client/models/email_lead'
 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'
@@ -40,6 +41,7 @@ require 'cloudmersive-validate-api-client/models/get_gender_response'
 require 'cloudmersive-validate-api-client/models/get_public_holidays_request'
 require 'cloudmersive-validate-api-client/models/get_timezones_request'
 require 'cloudmersive-validate-api-client/models/get_timezones_response'
+require 'cloudmersive-validate-api-client/models/html_ssrf_detection_result'
 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'
@@ -65,6 +67,8 @@ require 'cloudmersive-validate-api-client/models/sql_injection_check_request_ite
 require 'cloudmersive-validate-api-client/models/sql_injection_detection_result'
 require 'cloudmersive-validate-api-client/models/timezone'
 require 'cloudmersive-validate-api-client/models/tor_node_response'
+require 'cloudmersive-validate-api-client/models/url_html_ssrf_request_full'
+require 'cloudmersive-validate-api-client/models/url_html_ssrf_response_full'
 require 'cloudmersive-validate-api-client/models/url_safety_check_request_full'
 require 'cloudmersive-validate-api-client/models/url_safety_check_response_full'
 require 'cloudmersive-validate-api-client/models/url_ssrf_request_batch'

data/spec/api/domain_api_spec.rb

@@ -57,8 +57,8 @@ describe 'DomainApi' do
   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.
+  # Check if path is a high-risk or vulnerable server administration path
+  # Check if the input URL or relative path is a server Administration Path, and therefore a risk or vulnerability 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]
@@ -152,6 +152,18 @@ describe 'DomainApi' do
     end
   end
 
+  # unit tests for domain_url_html_ssrf_check
+  # Check a URL for HTML embedded SSRF threats
+  # Checks if an input URL HTML is at risk of containing one or more embedded SSRF (Server-side request forgery) threats or attacks.
+  # @param request Input URL request
+  # @param [Hash] opts the optional parameters
+  # @return [UrlHtmlSsrfResponseFull]
+  describe 'domain_url_html_ssrf_check 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_syntax_only
   # Validate a URL syntactically
   # Validate whether a URL is syntactically valid (does not check endpoint for validity).  Accepts various types of input and produces a well-formed URL as output.

data/spec/api/lead_enrichment_api_spec.rb

@@ -43,4 +43,15 @@ describe 'LeadEnrichmentApi' do
     end
   end
 
+  # unit tests for lead_enrichment_get_company_information
+  # Get company information from email address
+  # @param request Input email address lead
+  # @param [Hash] opts the optional parameters
+  # @return [LeadEnrichmentResponse]
+  describe 'lead_enrichment_get_company_information test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api/text_input_api_spec.rb

@@ -32,6 +32,18 @@ describe 'TextInputApi' do
     end
   end
 
+  # unit tests for text_input_check_html_ssrf
+  # Protect html input from Server-side Request Forgery (SSRF) attacks
+  # Detects SSRF (Server-side request forgery) attacks and unsafe URL attacks from HTML text input, where attackers can attempt to access unsafe local or network paths in the server environment by injecting them into HTML.
+  # @param value User-facing HTML input.
+  # @param [Hash] opts the optional parameters
+  # @return [HtmlSsrfDetectionResult]
+  describe 'text_input_check_html_ssrf 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 text_input_check_sql_injection
   # Check text input for SQL Injection (SQLI) attacks
   # Detects SQL Injection (SQLI) attacks from text input.

data/spec/models/email_lead_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::EmailLead
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'EmailLead' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::EmailLead.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EmailLead' do
+    it 'should create an instance of EmailLead' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::EmailLead)
+    end
+  end
+  describe 'test attribute "email_address"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/html_ssrf_detection_result_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::HtmlSsrfDetectionResult
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'HtmlSsrfDetectionResult' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::HtmlSsrfDetectionResult.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of HtmlSsrfDetectionResult' do
+    it 'should create an instance of HtmlSsrfDetectionResult' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::HtmlSsrfDetectionResult)
+    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
+
+  describe 'test attribute "contained_threats"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/url_html_ssrf_request_full_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::UrlHtmlSsrfRequestFull
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UrlHtmlSsrfRequestFull' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::UrlHtmlSsrfRequestFull.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UrlHtmlSsrfRequestFull' do
+    it 'should create an instance of UrlHtmlSsrfRequestFull' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::UrlHtmlSsrfRequestFull)
+    end
+  end
+  describe 'test attribute "url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/url_html_ssrf_response_full_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::UrlHtmlSsrfResponseFull
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UrlHtmlSsrfResponseFull' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::UrlHtmlSsrfResponseFull.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UrlHtmlSsrfResponseFull' do
+    it 'should create an instance of UrlHtmlSsrfResponseFull' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::UrlHtmlSsrfResponseFull)
+    end
+  end
+  describe 'test attribute "clean_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "http_response_code"' 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.2
+  version: 2.2.5
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-17 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -218,6 +218,7 @@ files:
 - "./docs/DomainApi.md"
 - "./docs/DomainQualityResponse.md"
 - "./docs/EmailApi.md"
+- "./docs/EmailLead.md"
 - "./docs/FirstNameValidationRequest.md"
 - "./docs/FirstNameValidationResponse.md"
 - "./docs/FullEmailValidationResponse.md"
@@ -230,6 +231,7 @@ files:
 - "./docs/GetPublicHolidaysRequest.md"
 - "./docs/GetTimezonesRequest.md"
 - "./docs/GetTimezonesResponse.md"
+- "./docs/HtmlSsrfDetectionResult.md"
 - "./docs/IPAddressApi.md"
 - "./docs/IPIntelligenceResponse.md"
 - "./docs/IPReverseDNSLookupResponse.md"
@@ -260,6 +262,8 @@ files:
 - "./docs/TextInputApi.md"
 - "./docs/Timezone.md"
 - "./docs/TorNodeResponse.md"
+- "./docs/UrlHtmlSsrfRequestFull.md"
+- "./docs/UrlHtmlSsrfResponseFull.md"
 - "./docs/UrlSafetyCheckRequestFull.md"
 - "./docs/UrlSafetyCheckResponseFull.md"
 - "./docs/UrlSsrfRequestBatch.md"
@@ -324,6 +328,7 @@ files:
 - "./lib/cloudmersive-validate-api-client/models/date_time_standardized_parse_request.rb"
 - "./lib/cloudmersive-validate-api-client/models/date_time_standardized_parse_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/domain_quality_response.rb"
+- "./lib/cloudmersive-validate-api-client/models/email_lead.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"
@@ -336,6 +341,7 @@ files:
 - "./lib/cloudmersive-validate-api-client/models/get_public_holidays_request.rb"
 - "./lib/cloudmersive-validate-api-client/models/get_timezones_request.rb"
 - "./lib/cloudmersive-validate-api-client/models/get_timezones_response.rb"
+- "./lib/cloudmersive-validate-api-client/models/html_ssrf_detection_result.rb"
 - "./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"
@@ -361,6 +367,8 @@ files:
 - "./lib/cloudmersive-validate-api-client/models/sql_injection_detection_result.rb"
 - "./lib/cloudmersive-validate-api-client/models/timezone.rb"
 - "./lib/cloudmersive-validate-api-client/models/tor_node_response.rb"
+- "./lib/cloudmersive-validate-api-client/models/url_html_ssrf_request_full.rb"
+- "./lib/cloudmersive-validate-api-client/models/url_html_ssrf_response_full.rb"
 - "./lib/cloudmersive-validate-api-client/models/url_safety_check_request_full.rb"
 - "./lib/cloudmersive-validate-api-client/models/url_safety_check_response_full.rb"
 - "./lib/cloudmersive-validate-api-client/models/url_ssrf_request_batch.rb"
@@ -421,6 +429,7 @@ files:
 - "./spec/models/date_time_standardized_parse_request_spec.rb"
 - "./spec/models/date_time_standardized_parse_response_spec.rb"
 - "./spec/models/domain_quality_response_spec.rb"
+- "./spec/models/email_lead_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"
@@ -433,6 +442,7 @@ files:
 - "./spec/models/get_public_holidays_request_spec.rb"
 - "./spec/models/get_timezones_request_spec.rb"
 - "./spec/models/get_timezones_response_spec.rb"
+- "./spec/models/html_ssrf_detection_result_spec.rb"
 - "./spec/models/ip_intelligence_response_spec.rb"
 - "./spec/models/ip_reverse_dns_lookup_response_spec.rb"
 - "./spec/models/ip_threat_response_spec.rb"
@@ -458,6 +468,8 @@ files:
 - "./spec/models/sql_injection_detection_result_spec.rb"
 - "./spec/models/timezone_spec.rb"
 - "./spec/models/tor_node_response_spec.rb"
+- "./spec/models/url_html_ssrf_request_full_spec.rb"
+- "./spec/models/url_html_ssrf_response_full_spec.rb"
 - "./spec/models/url_safety_check_request_full_spec.rb"
 - "./spec/models/url_safety_check_response_full_spec.rb"
 - "./spec/models/url_ssrf_request_batch_spec.rb"