Add docs generation

ev.openapiv3.yaml

@@ -226,7 +226,6 @@ components:
           $ref: '#/components/schemas/ResultType'
     EmailResponse:
       type: object
-      nullable: true
       properties:
         check_if_email_exist:
           $ref: '#/components/schemas/CheckIfEmailExistResult'

javascript/.gitignore

@@ -36,4 +36,5 @@ node_modules
 .babelrc
 .travis.yml
 git_push.sh
-mocha.opts
+mocha.opts
+test

php/docs/Api/EmailValidationApi.md

@@ -0,0 +1,153 @@
+# OpenAPI\Client\EmailValidationApi
+
+All URIs are relative to http://localhost.
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**emailValidationSingleValidationGet()**](EmailValidationApi.md#emailValidationSingleValidationGet) | **GET** /v1/validation/single/{email} | 
+[**emailValidationSingleValidationPost()**](EmailValidationApi.md#emailValidationSingleValidationPost) | **POST** /v1/validation/single | 
+
+
+## `emailValidationSingleValidationGet()`
+
+```php
+emailValidationSingleValidationGet($email, $result_type): \OpenAPI\Client\Model\EmailResponse
+```
+
+
+
+POST request contains additional parameters for detailed configuration
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure API key authorization: AuthKey
+$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
+
+// Configure API key authorization: RapidApiKey
+$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-RapidAPI-Key', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-RapidAPI-Key', 'Bearer');
+
+// Configure API key authorization: RapidApiSecret
+$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-RapidAPI-Proxy-Secret', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-RapidAPI-Proxy-Secret', 'Bearer');
+
+
+$apiInstance = new OpenAPI\Client\Api\EmailValidationApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$email = 'email_example'; // string
+$result_type = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\ResultType(); // \OpenAPI\Client\Model\ResultType | ResultTypeDescription
+
+try {
+    $result = $apiInstance->emailValidationSingleValidationGet($email, $result_type);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling EmailValidationApi->emailValidationSingleValidationGet: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **string**|  |
+ **result_type** | [**\OpenAPI\Client\Model\ResultType**](../Model/.md)| ResultTypeDescription | [optional]
+
+### Return type
+
+[**\OpenAPI\Client\Model\EmailResponse**](../Model/EmailResponse.md)
+
+### Authorization
+
+[AuthKey](../../README.md#AuthKey), [RapidApiKey](../../README.md#RapidApiKey), [RapidApiSecret](../../README.md#RapidApiSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)
+
+## `emailValidationSingleValidationPost()`
+
+```php
+emailValidationSingleValidationPost($body): \OpenAPI\Client\Model\EmailResponse
+```
+
+
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure API key authorization: AuthKey
+$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
+
+// Configure API key authorization: RapidApiKey
+$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-RapidAPI-Key', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-RapidAPI-Key', 'Bearer');
+
+// Configure API key authorization: RapidApiSecret
+$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-RapidAPI-Proxy-Secret', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-RapidAPI-Proxy-Secret', 'Bearer');
+
+
+$apiInstance = new OpenAPI\Client\Api\EmailValidationApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$body = new \OpenAPI\Client\Model\EmailRequest(); // \OpenAPI\Client\Model\EmailRequest
+
+try {
+    $result = $apiInstance->emailValidationSingleValidationPost($body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling EmailValidationApi->emailValidationSingleValidationPost: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**\OpenAPI\Client\Model\EmailRequest**](../Model/EmailRequest.md)|  |
+
+### Return type
+
+[**\OpenAPI\Client\Model\EmailResponse**](../Model/EmailResponse.md)
+
+### Authorization
+
+[AuthKey](../../README.md#AuthKey), [RapidApiKey](../../README.md#RapidApiKey), [RapidApiSecret](../../README.md#RapidApiSecret)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)

php/docs/Model/CheckIfEmailExistMX.md

@@ -0,0 +1,10 @@
+# # CheckIfEmailExistMX
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accepts_mail** | **bool** |  | [optional]
+**records** | **string[]** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/CheckIfEmailExistMisc.md

@@ -0,0 +1,10 @@
+# # CheckIfEmailExistMisc
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_disposable** | **bool** |  | [optional]
+**is_role_account** | **bool** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/CheckIfEmailExistResult.md

@@ -0,0 +1,15 @@
+# # CheckIfEmailExistResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input** | **string** |  | [optional]
+**is_reachable** | **string** |  | [optional]
+**misc** | [**\OpenAPI\Client\Model\CheckIfEmailExistMisc**](CheckIfEmailExistMisc.md) |  | [optional]
+**mx** | [**\OpenAPI\Client\Model\CheckIfEmailExistMX**](CheckIfEmailExistMX.md) |  | [optional]
+**smtp** | [**\OpenAPI\Client\Model\CheckIfEmailExistSMTP**](CheckIfEmailExistSMTP.md) |  | [optional]
+**syntax** | [**\OpenAPI\Client\Model\CheckIfEmailExistSyntax**](CheckIfEmailExistSyntax.md) |  | [optional]
+**error** | **string** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/CheckIfEmailExistSMTP.md

@@ -0,0 +1,13 @@
+# # CheckIfEmailExistSMTP
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**can_connect_smtp** | **bool** |  | [optional]
+**has_full_inbox** | **bool** |  | [optional]
+**is_catch_all** | **bool** |  | [optional]
+**is_deliverable** | **bool** |  | [optional]
+**is_disabled** | **bool** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/CheckIfEmailExistSyntax.md

@@ -0,0 +1,12 @@
+# # CheckIfEmailExistSyntax
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **string** |  | [optional]
+**domain** | **string** |  | [optional]
+**is_valid_syntax** | **bool** |  | [optional]
+**username** | **string** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/EmailRequest.md

@@ -0,0 +1,11 @@
+# # EmailRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional]
+**smtp** | [**\OpenAPI\Client\Model\EmailRequestSmtp**](EmailRequestSmtp.md) |  | [optional]
+**result_type** | [**\OpenAPI\Client\Model\ResultType**](ResultType.md) |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/EmailRequestSmtp.md

@@ -0,0 +1,14 @@
+# # EmailRequestSmtp
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_from** | **string** |  | [optional] [default to 'user@example.org']
+**hello_name** | **string** |  | [optional] [default to 'localhost']
+**proxy** | **string** | Versions - SOCKS4, SOCKS4A and SOCKS5. Format -  schema://username:password@host:port. | [optional]
+**timeout_connection** | **float** | timeout creating smtp connection | [optional] [default to 5.0]
+**timeout_response** | **float** | timeout of communication with smtp server | [optional]
+**port** | **int** | smtp port remote server | [optional] [default to 25]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/EmailResponse.md

@@ -0,0 +1,11 @@
+# # EmailResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**check_if_email_exist** | [**\OpenAPI\Client\Model\CheckIfEmailExistResult**](CheckIfEmailExistResult.md) |  | [optional]
+**mailboxvalidator** | [**\OpenAPI\Client\Model\MailboxvalidatorResult**](MailboxvalidatorResult.md) |  | [optional]
+**prompt_email_verification_api** | [**\OpenAPI\Client\Model\PromptEmailVerificationApiResult**](PromptEmailVerificationApiResult.md) |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/MailboxvalidatorResult.md

@@ -0,0 +1,28 @@
+# # MailboxvalidatorResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **string** |  | [optional]
+**domain** | **string** |  | [optional]
+**is_free** | **string** |  | [optional]
+**is_syntax** | **string** |  | [optional]
+**is_domain** | **string** |  | [optional]
+**is_smtp** | **string** |  | [optional]
+**is_verified** | **string** |  | [optional]
+**is_server_down** | **string** |  | [optional]
+**is_greylisted** | **string** |  | [optional]
+**is_disposable** | **string** |  | [optional]
+**is_suppressed** | **string** |  | [optional]
+**is_role** | **string** |  | [optional]
+**is_high_risk** | **string** |  | [optional]
+**is_catchall** | **string** |  | [optional]
+**mailboxvalidator_score** | **string** |  | [optional]
+**time_taken** | **string** |  | [optional]
+**status** | **string** |  | [optional]
+**credits_available** | **int** |  | [optional]
+**error_code** | **string** |  | [optional]
+**error_message** | **string** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/PromptEmailVerificationApiMX.md

@@ -0,0 +1,10 @@
+# # PromptEmailVerificationApiMX
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accepts_mail** | **bool** |  | [optional]
+**records** | **string[]** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/PromptEmailVerificationApiResult.md

@@ -0,0 +1,19 @@
+# # PromptEmailVerificationApiResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**can_connect_smtp** | **bool** |  | [optional]
+**email** | **string** |  | [optional]
+**is_catch_all** | **bool** |  | [optional]
+**is_deliverable** | **bool** |  | [optional]
+**is_disabled** | **bool** |  | [optional]
+**is_disposable** | **bool** |  | [optional]
+**is_inbox_full** | **bool** |  | [optional]
+**is_role_account** | **bool** |  | [optional]
+**mx_records** | [**\OpenAPI\Client\Model\PromptEmailVerificationApiMX**](PromptEmailVerificationApiMX.md) |  | [optional]
+**syntax_valid** | **bool** |  | [optional]
+**message** | **string** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/ResultType.md

@@ -0,0 +1,8 @@
+# # ResultType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

php/docs/Model/UnexpectedError.md

@@ -0,0 +1,11 @@
+# # UnexpectedError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **int** |  | [optional]
+**message** | **string** |  | [optional]
+**details** | **map[string,object]** |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)