verifalia 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14650c8b1a2409f0c037e1e5348c445434fcf22930bb465f78e548c7fb42b4ca
-  data.tar.gz: ceb6552a4935d73b4488558d8e11ae1de15de1b740a92811eb9240984497e446
+  metadata.gz: 44ed994694aed8628bc1b148b0cb244a9c980a62df4ec4cc22146a0b45dd9de8
+  data.tar.gz: 4ad8bf1d5a27d1a9fa5dab24af73e309a31c42562f0bafa47d53ecb1883b945a
 SHA512:
-  metadata.gz: 346075e83859afee3fa6c24b696d889973634eef9bab43febf7c60742b992f08d80035457c6c334f06e8995ac78016ff5b7300cd179a6299804755650fa18691
-  data.tar.gz: 8e5b6be8fe6528bd04b605ff61e39289017a114f31322229595bfd90964f1d6ac596d1aeb0a2eac4317752e367002d68f278a8aae0519e3fc4797beb6a6d8130
+  metadata.gz: bef360e74489bda543cc8120a043ac3d573d2e868da611217e094fe1be9ce23ce9c973017bc2dd0d03f0484ff7999814a8bf6d50d83a9c940412997d4e36ce0a
+  data.tar.gz: efc315ccf5a5c98f4144597c3307f594b79740d7e0aed16f3566d62ba90b46a5161158e43be89742700b5da45042aee17ababfa27433a472cc7b65b417655a76

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2023 Cobisi Research - https://verifalia.com/
+Copyright (c) 2014-2024 Cobisi Research - https://verifalia.com/
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,40 +1,59 @@
-![Verifalia API](https://img.shields.io/badge/Verifalia%20API-v2.4-green)
+![Verifalia API](https://img.shields.io/badge/Verifalia%20API-v2.5-green)
 [![Gem Version](https://badge.fury.io/rb/verifalia.svg)](https://badge.fury.io/rb/verifalia)
 
-# Verifalia - Ruby gem
+# Verifalia API - Ruby gem
 
-[Verifalia](https://verifalia.com/) provides a simple HTTPS-based API for **validating email addresses in
-real-time** and checking whether they are deliverable or not; this SDK library integrates with Verifalia
-and allows to [verify email addresses](https://verifalia.com/) in **Ruby 2.6.0 or higher**.
+This SDK library integrates with Verifalia and allows to [verify email addresses](https://verifalia.com/) in **Ruby 2.6.0 or higher**.
+
+[Verifalia](https://verifalia.com/) is an online service that provides email verification and mailing list cleaning; it helps businesses reduce
+their bounce rate, protect their sender reputation, and ensure their email campaigns reach the intended recipients.
+Verifalia can [verify email addresses](https://verifalia.com/) in real-time or in bulk, using its API or client area; it also
+offers various features and settings to customize the verification process according to the user’s needs.
+
+Verifalia's email verification process consists of several steps, each taking fractions of a second: it checks the **formatting
+and syntax** (RFC 1123, RFC 2821, RFC 2822, RFC 3490, RFC 3696, RFC 4291, RFC 5321, RFC 5322, and RFC 5336) of each email address,
+the **domain and DNS records**, the **mail exchangers**, and the **mailbox existence**, with support for internationalized domains
+and mailboxes. It also detects risky email types, such as **catch-all**, **disposable**, or **spam traps** / **honeypots**.
+
+Verifalia provides detailed and **accurate reports** for each email verification: it categorizes each email address as `Deliverable`,
+`Undeliverable`, `Risky`, or `Unknown`, and assigns one of its exclusive set of over 40 [status codes](https://verifalia.com/developers#email-validations-status-codes).
+It also explains the undeliverability reason and provides **comprehensive verification details**. The service allows the user to choose the desired
+quality level, the waiting timeout, the deduplication preferences, the data retention settings, and the callback preferences
+for each verification.
+
+Of course, Verifalia never sends emails to the contacts or shares the user's data with anyone.
 
 To learn more about Verifalia please see [https://verifalia.com](https://verifalia.com/)
 
 ## Table of contents
 
-- [Adding Verifalia to your Ruby app](#adding-verifalia-to-your-ruby-app)
+* [Adding Verifalia to your Ruby app](#adding-verifalia-to-your-ruby-app)
   * [Authentication](#authentication)
-    + [Authenticating via X.509 client certificate (TLS mutual authentication)](#authenticating-via-x509-client-certificate--tls-mutual-authentication-)
-- [Validating email addresses](#validating-email-addresses)
-  * [How to validate an email address](#how-to-validate-an-email-address)
-  * [How to validate a list of email addresses](#how-to-validate-a-list-of-email-addresses)
+    * [Authenticating via Basic Auth](#authenticating-via-basic-auth)
+    * [Authenticating via X.509 client certificate (TLS mutual authentication)](#authenticating-via-x509-client-certificate-tls-mutual-authentication)
+* [Verifying email addresses](#verifying-email-addresses)
+  * [How to verify an email address](#how-to-verify-an-email-address)
+  * [How to verify a list of email addresses](#how-to-verify-a-list-of-email-addresses)
   * [Processing options](#processing-options)
-    + [Quality level](#quality-level)
-    + [Deduplication mode](#deduplication-mode)
-    + [Data retention](#data-retention)
+    * [Quality level](#quality-level)
+    * [Deduplication mode](#deduplication-mode)
+    * [Data retention](#data-retention)
   * [Wait options](#wait-options)
-    + [Avoid waiting](#avoid-waiting)
-    + [Progress tracking](#progress-tracking)
+    * [Avoid waiting](#avoid-waiting)
+    * [Progress tracking](#progress-tracking)
   * [Completion callbacks](#completion-callbacks)
   * [Retrieving jobs](#retrieving-jobs)
   * [Exporting email verification results in different output formats](#exporting-email-verification-results-in-different-output-formats)
-  * [Don't forget to clean up, when you are done](#don-t-forget-to-clean-up--when-you-are-done)
-- [Managing credits](#managing-credits)
+  * [Don't forget to clean up, when you are done](#dont-forget-to-clean-up-when-you-are-done)
+* [Managing credits](#managing-credits)
   * [Getting the credits balance](#getting-the-credits-balance)
-- [Changelog / What's new](#changelog---what-s-new)
+* [Changelog / What's new](#changelog--whats-new)
+  * [v2.1](#v21)
+  * [v2.0](#v20)
 
 ## Adding Verifalia to your Ruby app
 
-To install using [Bundler](https://bundler.io/) grab the latest version:
+Easily include Verifalia in your Ruby application using [Bundler](https://bundler.io/); just add the following line to your Gemfile to get the latest version:
 
 ```ruby
 gem 'verifalia'
@@ -46,7 +65,7 @@ To manually install `verifalia` via Rubygems simply run `gem install`:
 gem install verifalia
 ```
 
-### Authentication ###
+### Authentication
 
 First things first: authentication to the Verifalia API is performed by way of either the credentials
 of your root Verifalia account or of one of its users (previously known as sub-accounts): if you don't
@@ -56,10 +75,12 @@ for accessing the API, as doing so will allow to assign only the specific needed
 
 Learn more about authenticating to the Verifalia API at [https://verifalia.com/developers#authentication](https://verifalia.com/developers#authentication)
 
-Once you have your Verifalia credentials at hand, use them while creating a new instance of the
-`Verifalia::Client` class, which will be the starting point to every other operation against the
-Verifalia API: the supplied credentials will be automatically provided to the API using the HTTP
-Basic Auth method.
+#### Authenticating via Basic Auth
+
+The most straightforward method for authenticating against the Verifalia API involves using a username and password pair.
+These credentials can be applied during the creation of a new instance of the `Verifalia::Client` class, serving as the
+initial step for all interactions with the Verifalia API: the provided username and password will be automatically
+transmitted to the API using the HTTP Basic Auth method.
 
 ```ruby
 require 'verifalia'
@@ -88,26 +109,27 @@ verifalia = Verifalia::Client.new ssl_client_cert: './my-cert.pem',
 See [how to create a self-signed X.509 client certificate for TLS mutual authentication](https://verifalia.com/help/sub-accounts/how-to-create-self-signed-client-certificate-for-tls-mutual-authentication)
 on the Verifalia website, for more information on creating your own certificates for the Verifalia API.
 
-## Validating email addresses ##
+## Verifying email addresses
 
 Every operation related to verifying / validating email addresses is performed through the
-`email_validations` property exposed by the `Verifalia::Client` instance you created above, which
-exposes some useful functions: in the next few paragraphs we are looking at the most used ones, so
+`email_validations` attribute exposed by the `Verifalia::Client` instance you created above, which
+exposes some useful methods: in the next few paragraphs we are looking at the most used ones, so
 it is strongly advisable to explore the library and look at the embedded help for other opportunities.
 
 **The library automatically waits for the completion of email verification jobs**: if needed, it is possible
 to adjust the wait options and have more control over the entire underlying polling process. Please refer to
 the [Wait options](#wait-options) section below for additional details.
 
-### How to validate an email address ###
+### How to verify an email address
 
 To validate an email address from a Ruby application you can invoke the `submit()` method: it
 accepts one or more email addresses and any eventual verification options you wish to pass to Verifalia,
 including the expected results quality, deduplication preferences, processing priority.
 
-In the following example, we verify an email address with this library, using the default options:
+In the following example, we check an email address with this library, using the default options:
 
 ```ruby
+# verifalia = Verifalia::Client.new ...
 job = verifalia.email_validations.submit 'batman@gmail.com'
 
 # At this point the address has been validated: let's print its validation
@@ -119,13 +141,61 @@ puts "Classification: #{entry.classification} (status: #{entry.status})"
 # Classification: Deliverable (status: Success)
 ```
 
-### How to validate a list of email addresses ###
+As you may expect, each entry may include various additional details about the verified email address:
+
+| Attribute                         | Description                                                                                                                                                                                                                                         |
+|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `ascii_email_address_domain_part` | Gets the domain part of the email address, converted to ASCII if needed and with comments and folding white spaces stripped off.                                                                                                                    |
+| `classification`                  | A string with the classification for this entry; see `Verifalia::EmailValidations::EntryClassification` for a list of the values supported at the time this SDK has been released.                                                                  |
+| `completed_on`                    | The date this entry has been completed, if available.                                                                                                                                                                                               |
+| `custom`                          | A custom, optional string which is passed back upon completing the validation. To pass back and forth a custom value, use the `custom` attribute of `Verifalia::EmailValidations::RequestEntry`.                                                    |
+| `duplicate_of`                    | The zero-based index of the first occurrence of this email address in the parent `Job`, in the event the `status` for this entry is `Duplicate`; duplicated items do not expose any result detail apart from this and the eventual `custom` values. |
+| `index`                           | The index of this entry within its `Job` container; this property is mostly useful in the event the API returns a filtered view of the items.                                                                                                       |
+| `input_data`                      | The input string being validated.                                                                                                                                                                                                                   |
+| `email_address`                   | Gets the email address, without any eventual comment or folding white space. Returns null if the input data is not a syntactically invalid e-mail address.                                                                                          |
+| `email_address_domain_part`       | Gets the domain part of the email address, without comments and folding white spaces.                                                                                                                                                               |
+| `email_address_local_part`        | Gets the local part of the email address, without comments and folding white spaces.                                                                                                                                                                |
+| `has_international_domain_name`   | If true, the email address has an international domain name.                                                                                                                                                                                        |
+| `has_international_mailbox_name`  | If true, the email address has an international mailbox name.                                                                                                                                                                                       |
+| `is_disposable_email_address`     | If true, the email address comes from a disposable email address (DEA) provider. <a href="https://verifalia.com/help/email-validations/what-is-a-disposable-email-address-dea">What is a disposable email address?</a>                              |
+| `is_free_email_address`           | If true, the email address comes from a free email address provider (e.g. gmail, yahoo, outlook / hotmail, ...).                                                                                                                                    |
+| `is_role_account`                 | If true, the local part of the email address is a well-known role account.                                                                                                                                                                          |
+| `status`                          | The status for this entry; see `Verifalia::EmailValidations::EntryStatus` for a list of the values supported at the time this SDK has been released.                                                                                                |
+| `suggestions`                     | The potential corrections for the input data, in the event Verifalia identified potential typos during the verification process.                                                                                                                    |
+| `syntax_failure_index`            | The position of the character in the email address that eventually caused the syntax validation to fail.                                                                                                                                            |
+
+Here is another example, showing some of the additional result details provided by Verifalia:
+
+```ruby
+# verifalia = Verifalia::Client.new ...
+job = verifalia.email_validations.submit 'bat[man@gmal.com'
+
+entry = job.entries[0]
+puts "Classification: #{entry.classification}"
+puts "Status: #{entry.status}"
+puts "Syntax failure index: #{entry.syntax_failure_index}"
+
+puts "Suggestions:"
+
+entry.suggestions.each do |suggestion|
+  puts "- #{suggestion}"
+end
+
+# Classification: Undeliverable
+# Status: InvalidCharacterInSequence
+# Syntax failure index: 3
+# Suggestions:
+# - batman@gmail.com
+```
+
+### How to verify a list of email addresses
 
-To verify a list of email addresses - instead of a single address - it is possible to pass an array of strings with the
-emails to verify to the `submit()` method; here is an example showing how to verify an array with some
+To check a list of email addresses - instead of a single address - it is possible to pass an array of strings with the
+emails to verify to the `submit()` method; here is an example showing how to validate an array with some
 email addresses:
 
 ```ruby
+# verifalia = Verifalia::Client.new ...
 job = verifalia.email_validations.submit ['batman@gmail.com', 'samantha42@yahoo.it']
 
 job.entries.each do |entry|
@@ -152,6 +222,7 @@ to specify the desired quality level; here is an example showing how to verify a
 the _High_ quality level:
 
 ```ruby
+# verifalia = Verifalia::Client.new ...
 job = verifalia.email_validations.submit 'batman@gmail.com', quality: 'High'
 ```
 
@@ -172,6 +243,7 @@ emails = [
   'samantha42@yahoo.it'
 ]
 
+# verifalia = Verifalia::Client.new ...
 job = verifalia.email_validations.submit entries, deduplication: 'Relaxed'
 ```
 
@@ -189,6 +261,7 @@ Here is how, for instance, one can set a data retention policy of 10 minutes whi
 an email address:
 
 ```ruby
+# verifalia = Verifalia::Client.new ...
 job = verifalia.email_validations.submit 'batman@gmail.com', retention: '0:10:0'
 ```
 
@@ -216,6 +289,8 @@ for the `wait_options` keyword argument of the `submit()` method, as shown in th
 
 ```ruby
 wait_options = Verifalia::EmailValidations::WaitOptions.no_wait
+
+# verifalia = Verifalia::Client.new ...
 job = verifalia.email_validations.submit 'elon.musk@tesla.com', wait_options: wait_options
 
 puts "Status: #{job.overview.status}"
@@ -227,19 +302,18 @@ puts "Status: #{job.overview.status}"
 For jobs with a large number of email addresses, it could be useful to track progress as they are processed
 by the Verifalia email verification engine; to do that, it is possible to create an instance of the
 `Verifalia::EmailValidations::WaitOptions` class and provide a lambda which eventually receives progress notifications through the
-`progress` property.
+`progress` attribute.
 
 Here is how to define a progress notification handler which displays the progress percentage of a submitted
 job to the console window:
 
 ```ruby
-WaitOptions = Verifalia::EmailValidations::WaitOptions
-
 progress = ->(overview) do
   puts "Progress: #{(overview.progress&.percentage || 0) * 100}%..."
 end
 
-wait_options = WaitOptions.new 30 * 1000, 30 * 1000, progress: progress
+wait_options = Verifalia::EmailValidations::WaitOptions.new 30 * 1000, 30 * 1000,
+                                                            progress: progress
 
 emails = [
   'alice@example.com',
@@ -247,6 +321,7 @@ emails = [
   'charlie@example.org'
 ]
 
+# verifalia = Verifalia::Client.new ...
 job = verifalia.email_validations.submit emails, wait_options: wait_options
 ```
 
@@ -261,6 +336,7 @@ To specify a completion callback URL, specify the `completion_callback` keyword
 invoking the `submit()` method, as shown in the example below:
 
 ```ruby
+# verifalia = Verifalia::Client.new ...
 verifalia.email_validations.submit 'batman@gmail.com',
                                    completion_callback: {
                                      'url' => 'https://your-website-here/foo/bar'
@@ -282,8 +358,8 @@ please see the [Wait options](#wait-options) section for additional details.
 Here is an example showing how to retrieve a job, given its identifier:
 
 ```ruby
-job_id = 'ec415ecd-0d0b-49c4-a5f0-f35c182e40ea'
-job = verifalia.email_validations.get job_id
+# verifalia = Verifalia::Client.new ...
+job = verifalia.email_validations.get 'ec415ecd-0d0b-49c4-a5f0-f35c182e40ea'
 ```
 
 ### Exporting email verification results in different output formats
@@ -297,13 +373,12 @@ generating a human-readable representation of the verification results.
 > method instead if you need to rely on a stable output schema.
 
 Here is an example showing how to export a given email verification job as an
-Excel (xslx) file:
+Excel (.xslx) file:
 
 ```ruby
-job_id = 'ec415ecd-0d0b-49c4-a5f0-f35c182e40ea'
-format = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
-
-data = verifalia.email_validations.export job_id, format
+# verifalia = Verifalia::Client.new ...
+data = verifalia.email_validations.export 'ec415ecd-0d0b-49c4-a5f0-f35c182e40ea',
+                                          Verifalia::EmailValidations::ExportedEntriesFormat::EXCEL_XLSX
 
 File.open('./export.xlsx', 'wb') do |fp|
   fp.write(data)
@@ -318,25 +393,27 @@ you delete your completed jobs as soon as possible, for privacy and security rea
 To do that, you can invoke the `delete()` method passing the job Id you wish to get rid of:
 
 ```ruby
-verifalia.email_validations.delete job_id
+# verifalia = Verifalia::Client.new ...
+verifalia.email_validations.delete 'ec415ecd-0d0b-49c4-a5f0-f35c182e40ea'
 ```
 
 Once deleted, a job is gone and there is no way to retrieve its email validation results.
 
-## Managing credits ##
+## Managing credits
 
-To manage the Verifalia credits for your account you can use the `credits` property exposed
+To manage the Verifalia credits for your account you can use the `credits` attribute exposed
 by the `Verifalia::Client` instance created above. Like for the previous topic, in the next
 few paragraphs we are looking at the most used operations, so it is strongly advisable to
 explore the library and look at the embedded documentation for other opportunities.
 
-### Getting the credits balance ###
+### Getting the credits balance
 
 One of the most common tasks you may need to perform on your account is retrieving the available
 number of free daily credits and credit packs. To do that, you can use the `get_balance()` method,
 which returns a `Verifalia::Credits::Balance` object, as shown in the next example:
 
 ```ruby
+# verifalia = Verifalia::Client.new ...
 balance = verifalia.credits.get_balance
 
 puts "Credit packs: #{balance.credit_packs}"
@@ -353,6 +430,16 @@ To add credit packs to your Verifalia account visit [https://verifalia.com/clien
 This section lists the changelog for the current major version of the library: for older versions,
 please see the [project releases](https://github.com/verifalia/verifalia-ruby-sdk/releases).
 
+### v2.1
+
+Released on January 18<sup>th</sup>, 2024
+
+- Added support for API v2.5
+- Added support for [classification overrides](https://verifalia.com/help/email-validations/what-are-classification-overrides)
+- Added support for AI-powered suggestions
+- Added `EntryClassification`, `EntryStatus`, `ExportedEntriesFormat` and `JobStatus` module constants
+- Improved documentation
+
 ### v2.0
 
 Released on March 12<sup>th</sup>, 2023

data/lib/verifalia/client.rb

@@ -1,5 +1,34 @@
 # frozen_string_literal: true
 
+# Verifalia - Email list cleaning and real-time email verification service
+# https://verifalia.com/
+# support@verifalia.com
+#
+# Copyright (c) 2005-2024 Cobisi Research
+#
+# Cobisi Research
+# Via Della Costituzione, 31
+# 35010 Vigonza
+# Italy - European Union
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
 require 'openssl/x509'
 require_relative './rest/client'
 
@@ -7,7 +36,7 @@ module Verifalia
   # HTTPS-based REST client for Verifalia.
   class Client
     # The version of the Verifalia SDK for Ruby.
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
 
     # Allows to verify email addresses and manage email verification jobs using the Verifalia service.
     attr_reader :email_validations
@@ -46,7 +75,7 @@ module Verifalia
 
       @base_urls ||= Verifalia::Rest::BASE_URLS
       @rest_client = Verifalia::Rest::Client.new(@authenticator,
-                                                 "verifalia-rest-client/ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
+                                                 "verifalia-rest-client/ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}/#{VERSION}",
                                                  @base_urls)
 
       @rest_client.logger = logger

data/lib/verifalia/credits/balance.rb

@@ -1,5 +1,34 @@
 # frozen_string_literal: true
 
+# Verifalia - Email list cleaning and real-time email verification service
+# https://verifalia.com/
+# support@verifalia.com
+#
+# Copyright (c) 2005-2024 Cobisi Research
+#
+# Cobisi Research
+# Via Della Costituzione, 31
+# 35010 Vigonza
+# Italy - European Union
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
 module Verifalia
   module Credits
     # The credits balance for the Verifalia account.

data/lib/verifalia/credits/client.rb

@@ -1,5 +1,34 @@
 # frozen_string_literal: true
 
+# Verifalia - Email list cleaning and real-time email verification service
+# https://verifalia.com/
+# support@verifalia.com
+#
+# Copyright (c) 2005-2024 Cobisi Research
+#
+# Cobisi Research
+# Via Della Costituzione, 31
+# 35010 Vigonza
+# Italy - European Union
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
 require_relative 'balance'
 
 module Verifalia

data/lib/verifalia/email_validation/client.rb

@@ -1,5 +1,34 @@
 # frozen_string_literal: true
 
+# Verifalia - Email list cleaning and real-time email verification service
+# https://verifalia.com/
+# support@verifalia.com
+#
+# Copyright (c) 2005-2024 Cobisi Research
+#
+# Cobisi Research
+# Via Della Costituzione, 31
+# 35010 Vigonza
+# Italy - European Union
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
 require 'net/http'
 require_relative 'job'
 require_relative 'overview'
@@ -167,11 +196,12 @@ module Verifalia
       end
 
       # Exports the validated entries for a completed email validation job, using the specified output format.
+      # See +ExportedEntriesFormat+ for a list of the values supported at the time this SDK has been released.
       #
       # Supported formats:
-      # - +text/csv+: Comma-Separated Values (CSV)
-      # - +application/vnd.openxmlformats-officedocument.spreadsheetml.sheet+: Microsoft Excel (.xlsx)
-      # - +application/vnd.ms-excel+: Microsoft Excel 97-2003 (.xls)
+      # - Comma-Separated Values (CSV)
+      # - Microsoft Excel (.xlsx)
+      # - Microsoft Excel 97-2003 (.xls)
       #
       # @param [String] id The ID of the email validation job to retrieve.
       # @param [String] format The MIME content type of the desired output file format.

data/lib/verifalia/email_validation/completion_callback.rb

@@ -1,5 +1,34 @@
 # frozen_string_literal: true
 
+# Verifalia - Email list cleaning and real-time email verification service
+# https://verifalia.com/
+# support@verifalia.com
+#
+# Copyright (c) 2005-2024 Cobisi Research
+#
+# Cobisi Research
+# Via Della Costituzione, 31
+# 35010 Vigonza
+# Italy - European Union
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
 module Verifalia
   module EmailValidations
     class CompletionCallback