cloudmersive-validate-api-client 2.2.4 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bda2d29aed6f694cefad741670033ee4c4413bca97f808db708b6d96e7bfc623
-  data.tar.gz: e98072e83bfa227d8fdc5eda4d050297eaef91fa387b03229051c9b6f66c74bb
+  metadata.gz: 6eced1f0005e1d25a42ac4809b4112292bae4c750b285795d22761339fb79eeb
+  data.tar.gz: 726969fc56bee4cf40921619f06479c8b304e293d23ffeff7c79cb735fba504d
 SHA512:
-  metadata.gz: 6833aa20a67fbeba89dfd15e5b5c6278c79610c830813ced064432c472b0cd1de6a6d4645c9802fdde217a918f96c3fa0c19c894d32f5272fe56860cbf090ab1
-  data.tar.gz: 6b7bb18a5c190a57f15af84fd75bcc019ebde4d27f832493d23430d844a1a2a869eba4b4f285546175a55411f8148815944e866672f4420a123fa672509faca0
+  metadata.gz: fc16b7c25e271cd03544a8acab8e311201361ee55228da1180f7614ec8db0a39b7851c5fcafdbb776eaee13251c192f468e97c05a7b9c863e4b56b229d9ad6b1
+  data.tar.gz: 3dbad4a9baac018d5fce20f23a1a10a764f80ccd60fafc7f201c217253d3ba17d83282007bb9af07bb3d2b8645b3d595f85f46abfd56e08e1a493aa19ed7436b

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.4
+- Package version: 2.2.5
 - 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.4.gem
+gem install ./cloudmersive-validate-api-client-2.2.5.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.4.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.5.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.4'
+    gem 'cloudmersive-validate-api-client', '~> 2.2.5'
 
 ### Install from Git
 
@@ -124,6 +124,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
 *CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_reverse_domain_lookup**](docs/IPAddressApi.md#i_p_address_reverse_domain_lookup) | **POST** /validate/ip/reverse-domain-lookup | Perform a reverse domain name (DNS) lookup on an IP address
 *CloudmersiveValidateApiClient::LeadEnrichmentApi* | [**lead_enrichment_enrich_lead**](docs/LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
+*CloudmersiveValidateApiClient::LeadEnrichmentApi* | [**lead_enrichment_get_company_information**](docs/LeadEnrichmentApi.md#lead_enrichment_get_company_information) | **POST** /validate/lead-enrichment/lead/email/company-information | Get company information from email address
 *CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
 *CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
 *CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
@@ -155,6 +156,7 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest](docs/DateTimeStandardizedParseRequest.md)
  - [CloudmersiveValidateApiClient::DateTimeStandardizedParseResponse](docs/DateTimeStandardizedParseResponse.md)
  - [CloudmersiveValidateApiClient::DomainQualityResponse](docs/DomainQualityResponse.md)
+ - [CloudmersiveValidateApiClient::EmailLead](docs/EmailLead.md)
  - [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
  - [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
  - [CloudmersiveValidateApiClient::FullEmailValidationResponse](docs/FullEmailValidationResponse.md)

data/docs/EmailLead.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::EmailLead
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **String** |  | [optional] 
+
+

data/docs/LeadEnrichmentApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**lead_enrichment_enrich_lead**](LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
+[**lead_enrichment_get_company_information**](LeadEnrichmentApi.md#lead_enrichment_get_company_information) | **POST** /validate/lead-enrichment/lead/email/company-information | Get company information from email address
 
 
 # **lead_enrichment_enrich_lead**
@@ -59,3 +60,55 @@ Name | Type | Description  | Notes
 
 
 
+# **lead_enrichment_get_company_information**
+> LeadEnrichmentResponse lead_enrichment_get_company_information(request)
+
+Get company information from email address
+
+### 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::LeadEnrichmentApi.new
+
+request = CloudmersiveValidateApiClient::EmailLead.new # EmailLead | Input email address lead
+
+
+begin
+  #Get company information from email address
+  result = api_instance.lead_enrichment_get_company_information(request)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling LeadEnrichmentApi->lead_enrichment_get_company_information: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**EmailLead**](EmailLead.md)| Input email address lead | 
+
+### Return type
+
+[**LeadEnrichmentResponse**](LeadEnrichmentResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

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

@@ -71,5 +71,57 @@ module CloudmersiveValidateApiClient
       end
       return data, status_code, headers
     end
+    # Get company information from email address
+    # @param request Input email address lead
+    # @param [Hash] opts the optional parameters
+    # @return [LeadEnrichmentResponse]
+    def lead_enrichment_get_company_information(request, opts = {})
+      data, _status_code, _headers = lead_enrichment_get_company_information_with_http_info(request, opts)
+      data
+    end
+
+    # Get company information from email address
+    # @param request Input email address lead
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LeadEnrichmentResponse, Fixnum, Hash)>] LeadEnrichmentResponse data, response status code and response headers
+    def lead_enrichment_get_company_information_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LeadEnrichmentApi.lead_enrichment_get_company_information ...'
+      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 LeadEnrichmentApi.lead_enrichment_get_company_information"
+      end
+      # resource path
+      local_var_path = '/validate/lead-enrichment/lead/email/company-information'
+
+      # 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(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 => 'LeadEnrichmentResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LeadEnrichmentApi#lead_enrichment_get_company_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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

@@ -0,0 +1,184 @@
+=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
+  class EmailLead
+    attr_accessor :email_address
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email_address' => :'EmailAddress'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email_address' => :'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?(:'EmailAddress')
+        self.email_address = attributes[:'EmailAddress']
+      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 &&
+          email_address == o.email_address
+    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
+      [email_address].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.4'
+  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'

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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-validate-api-client
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.2.5
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-09 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"
@@ -327,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"
@@ -427,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"