cloudmersive-validate-api-client 2.0.2 → 2.0.7

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

@@ -0,0 +1,15 @@
+=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
+
+module CloudmersiveValidateApiClient
+  VERSION = '2.0.7'
+end

data/spec/api/address_api_spec.rb

@@ -0,0 +1,154 @@
+=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'
+
+# Unit tests for CloudmersiveValidateApiClient::AddressApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AddressApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::AddressApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AddressApi' do
+    it 'should create an instance of AddressApi' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::AddressApi)
+    end
+  end
+
+  # unit tests for address_check_eu_membership
+  # Check if a country is a member of the European Union (EU)
+  # Checks if the input country is a member of the European Union or not.
+  # @param input Input request
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateCountryResponse]
+  describe 'address_check_eu_membership 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 address_country
+  # Validate and normalize country information, return ISO 3166-1 country codes and country name
+  # Validates and normalizes country information, and returns key information about a country, as well as whether it is a member of the European Union.  Also returns distinct time zones in the country.
+  # @param input Input request
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateCountryResponse]
+  describe 'address_country 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 address_country_list
+  # Get a list of ISO 3166-1 countries
+  # Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
+  # @param [Hash] opts the optional parameters
+  # @return [CountryListResult]
+  describe 'address_country_list 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 address_get_country_currency
+  # Get the currency of the input country
+  # Gets the currency information for the input country, including the ISO three-letter country code, currency symbol, and English currency name.
+  # @param input Input request
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateCountryResponse]
+  describe 'address_get_country_currency 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 address_get_timezone
+  # Gets IANA/Olsen time zones for a country
+  # Gets the IANA/Olsen time zones for a country.
+  # @param input Input request
+  # @param [Hash] opts the optional parameters
+  # @return [GetTimezonesResponse]
+  describe 'address_get_timezone 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 address_parse_string
+  # Parse an unstructured input text string into an international, formatted address
+  # Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.
+  # @param input Input parse request
+  # @param [Hash] opts the optional parameters
+  # @return [ParseAddressResponse]
+  describe 'address_parse_string 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 address_validate_address
+  # Validate a street address
+  # Determines if an input structured street address is valid or invalid.  If the address is valid, also returns the latitude and longitude of the address.  Supports all major international addresses.
+  # @param input Input parse request
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateAddressResponse]
+  describe 'address_validate_address 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 address_validate_city
+  # Validate a City and State/Province combination, get location information about it
+  # Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more.  Supports all major international addresses.
+  # @param input Input parse request
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateCityResponse]
+  describe 'address_validate_city 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 address_validate_postal_code
+  # Validate a postal code, get location information about it
+  # Checks if the input postal code is valid, and returns information about it such as City, State and more.  Supports all major countries.
+  # @param input Input parse request
+  # @param [Hash] opts the optional parameters
+  # @return [ValidatePostalCodeResponse]
+  describe 'address_validate_postal_code 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 address_validate_state
+  # Validate a state or province, name or abbreviation, get location information about it
+  # Checks if the input state name or code is valid, and returns information about it such as normalized State name and more.  Supports all major countries.
+  # @param input Input parse request
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateStateResponse]
+  describe 'address_validate_state 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/domain_api_spec.rb

@@ -0,0 +1,83 @@
+=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'
+
+# Unit tests for CloudmersiveValidateApiClient::DomainApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DomainApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::DomainApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DomainApi' do
+    it 'should create an instance of DomainApi' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::DomainApi)
+    end
+  end
+
+  # unit tests for domain_check
+  # Validate a domain name
+  # Check whether a domain name is valid or not.  API performs a live validation by contacting DNS services to validate the existence of the domain name.
+  # @param domain Domain name to check, for example \"cloudmersive.com\".  The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [CheckResponse]
+  describe 'domain_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_post
+  # Get WHOIS information for a domain
+  # Validate whether a domain name exists, and also return the full WHOIS record for that domain name.  WHOIS records include all the registration details of the domain name, such as information about the domain's owners.
+  # @param domain Domain name to check, for example \"cloudmersive.com\".   The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [WhoisResponse]
+  describe 'domain_post 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.
+  # @param request Input URL request
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateUrlResponseFull]
+  describe 'domain_url_full 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.
+  # @param request Input URL information
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateUrlResponseSyntaxOnly]
+  describe 'domain_url_syntax_only 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/email_api_spec.rb

@@ -0,0 +1,71 @@
+=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'
+
+# Unit tests for CloudmersiveValidateApiClient::EmailApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'EmailApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::EmailApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EmailApi' do
+    it 'should create an instance of EmailApi' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::EmailApi)
+    end
+  end
+
+  # unit tests for email_address_get_servers
+  # Partially check whether an email address is valid
+  # Validate an email address by identifying whether its parent domain has email servers defined.  This call is less limited than syntaxOnly but not as comprehensive as address/full.
+  # @param email Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [AddressGetServersResponse]
+  describe 'email_address_get_servers 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 email_full_validation
+  # Fully validate an email address
+  # Performs a full validation of the email address.  Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.
+  # @param email Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [FullEmailValidationResponse]
+  describe 'email_full_validation 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 email_post
+  # Validate email adddress for syntactic correctness only
+  # Validate whether a given email address is syntactically correct via a limited local-only check.  Use the address/full API to do a full validation.
+  # @param value Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [AddressVerifySyntaxOnlyResponse]
+  describe 'email_post 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/ip_address_api_spec.rb

@@ -0,0 +1,71 @@
+=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'
+
+# Unit tests for CloudmersiveValidateApiClient::IPAddressApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'IPAddressApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::IPAddressApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IPAddressApi' do
+    it 'should create an instance of IPAddressApi' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::IPAddressApi)
+    end
+  end
+
+  # unit tests for i_p_address_is_threat
+  # Check if IP address is a known threat
+  # Check if the input IP address is a known threat IP address.  Checks against known bad IPs, botnets, compromised servers, and other lists of threats.
+  # @param value IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [IPThreatResponse]
+  describe 'i_p_address_is_threat 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 i_p_address_is_tor_node
+  # Check if IP address is a Tor node server
+  # Check if the input IP address is a Tor exit node server.  Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.
+  # @param value IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [TorNodeResponse]
+  describe 'i_p_address_is_tor_node 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 i_p_address_post
+  # Geolocate an IP address
+  # Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc.  Useful for security and UX applications.
+  # @param value IP address to geolocate, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [GeolocateResponse]
+  describe 'i_p_address_post 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/lead_enrichment_api_spec.rb

@@ -0,0 +1,46 @@
+=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'
+
+# Unit tests for CloudmersiveValidateApiClient::LeadEnrichmentApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'LeadEnrichmentApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::LeadEnrichmentApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of LeadEnrichmentApi' do
+    it 'should create an instance of LeadEnrichmentApi' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::LeadEnrichmentApi)
+    end
+  end
+
+  # unit tests for lead_enrichment_enrich_lead
+  # Enrich an input lead with additional fields of data
+  # @param request Input lead with known fields set, and unknown fields left blank (null)
+  # @param [Hash] opts the optional parameters
+  # @return [LeadEnrichmentResponse]
+  describe 'lead_enrichment_enrich_lead 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/name_api_spec.rb

@@ -0,0 +1,95 @@
+=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'
+
+# Unit tests for CloudmersiveValidateApiClient::NameApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'NameApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::NameApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NameApi' do
+    it 'should create an instance of NameApi' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::NameApi)
+    end
+  end
+
+  # unit tests for name_get_gender
+  # Get the gender of a first name
+  # Determines the gender of a first name (given name)
+  # @param input Gender request information
+  # @param [Hash] opts the optional parameters
+  # @return [GetGenderResponse]
+  describe 'name_get_gender 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 name_identifier
+  # Validate a code identifier
+  # Determines if the input name is a valid technical / code identifier.  Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed.  For example, a valid identifier might be \"helloWorld\" but not \"hello*World\".
+  # @param input Identifier validation request information
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateIdentifierResponse]
+  describe 'name_identifier 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 name_validate_first_name
+  # Validate a first name
+  # Determines if a string is a valid first name (given name)
+  # @param input Validation request information
+  # @param [Hash] opts the optional parameters
+  # @return [FirstNameValidationResponse]
+  describe 'name_validate_first_name 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 name_validate_full_name
+  # Parse and validate a full name
+  # Parses a full name string (e.g. \"Mr. Jon van der Waal Jr.\") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not
+  # @param input Validation request information
+  # @param [Hash] opts the optional parameters
+  # @return [FullNameValidationResponse]
+  describe 'name_validate_full_name 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 name_validate_last_name
+  # Validate a last name
+  # Determines if a string is a valid last name (surname)
+  # @param input Validation request information
+  # @param [Hash] opts the optional parameters
+  # @return [LastNameValidationResponse]
+  describe 'name_validate_last_name test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end