Skip to content

Commit 3bae30c

Browse files
maranqzmaranqz
committed
Add docs generation
1 parent c22e2df commit 3bae30c

16 files changed

+327
-2
lines changed

‎ev.openapiv3.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,6 @@ components:
226226
$ref: '#/components/schemas/ResultType'
227227
EmailResponse:
228228
type: object
229-
nullable: true
230229
properties:
231230
check_if_email_exist:
232231
$ref: '#/components/schemas/CheckIfEmailExistResult'

‎javascript/.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,5 @@ node_modules
3636
.babelrc
3737
.travis.yml
3838
git_push.sh
39-
mocha.opts
39+
mocha.opts
40+
test

‎php/docs/Api/EmailValidationApi.md‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# OpenAPI\Client\EmailValidationApi
2+
3+
All URIs are relative to http://localhost.
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**emailValidationSingleValidationGet()**](EmailValidationApi.md#emailValidationSingleValidationGet) | **GET** /v1/validation/single/{email} |
8+
[**emailValidationSingleValidationPost()**](EmailValidationApi.md#emailValidationSingleValidationPost) | **POST** /v1/validation/single |
9+
10+
11+
## `emailValidationSingleValidationGet()`
12+
13+
```php
14+
emailValidationSingleValidationGet($email, $result_type): \OpenAPI\Client\Model\EmailResponse
15+
```
16+
17+
18+
19+
POST request contains additional parameters for detailed configuration
20+
21+
### Example
22+
23+
```php
24+
<?php
25+
require_once(__DIR__ . '/vendor/autoload.php');
26+
27+
28+
// Configure API key authorization: AuthKey
29+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
30+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
31+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
32+
33+
// Configure API key authorization: RapidApiKey
34+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-RapidAPI-Key', 'YOUR_API_KEY');
35+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
36+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-RapidAPI-Key', 'Bearer');
37+
38+
// Configure API key authorization: RapidApiSecret
39+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-RapidAPI-Proxy-Secret', 'YOUR_API_KEY');
40+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
41+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-RapidAPI-Proxy-Secret', 'Bearer');
42+
43+
44+
$apiInstance = new OpenAPI\Client\Api\EmailValidationApi(
45+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
46+
// This is optional, `GuzzleHttp\Client` will be used as default.
47+
new GuzzleHttp\Client(),
48+
$config
49+
);
50+
$email = 'email_example'; // string
51+
$result_type = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\ResultType(); // \OpenAPI\Client\Model\ResultType | ResultTypeDescription
52+
53+
try {
54+
$result = $apiInstance->emailValidationSingleValidationGet($email, $result_type);
55+
print_r($result);
56+
} catch (Exception $e) {
57+
echo 'Exception when calling EmailValidationApi->emailValidationSingleValidationGet: ', $e->getMessage(), PHP_EOL;
58+
}
59+
```
60+
61+
### Parameters
62+
63+
Name | Type | Description | Notes
64+
------------- | ------------- | ------------- | -------------
65+
**email** | **string**| |
66+
**result_type** | [**\OpenAPI\Client\Model\ResultType**](../Model/.md)| ResultTypeDescription | [optional]
67+
68+
### Return type
69+
70+
[**\OpenAPI\Client\Model\EmailResponse**](../Model/EmailResponse.md)
71+
72+
### Authorization
73+
74+
[AuthKey](../../README.md#AuthKey), [RapidApiKey](../../README.md#RapidApiKey), [RapidApiSecret](../../README.md#RapidApiSecret)
75+
76+
### HTTP request headers
77+
78+
- **Content-Type**: Not defined
79+
- **Accept**: `application/json`
80+
81+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
82+
[[Back to Model list]](../../README.md#models)
83+
[[Back to README]](../../README.md)
84+
85+
## `emailValidationSingleValidationPost()`
86+
87+
```php
88+
emailValidationSingleValidationPost($body): \OpenAPI\Client\Model\EmailResponse
89+
```
90+
91+
92+
93+
### Example
94+
95+
```php
96+
<?php
97+
require_once(__DIR__ . '/vendor/autoload.php');
98+
99+
100+
// Configure API key authorization: AuthKey
101+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
102+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
103+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
104+
105+
// Configure API key authorization: RapidApiKey
106+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-RapidAPI-Key', 'YOUR_API_KEY');
107+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
108+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-RapidAPI-Key', 'Bearer');
109+
110+
// Configure API key authorization: RapidApiSecret
111+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-RapidAPI-Proxy-Secret', 'YOUR_API_KEY');
112+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
113+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-RapidAPI-Proxy-Secret', 'Bearer');
114+
115+
116+
$apiInstance = new OpenAPI\Client\Api\EmailValidationApi(
117+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
118+
// This is optional, `GuzzleHttp\Client` will be used as default.
119+
new GuzzleHttp\Client(),
120+
$config
121+
);
122+
$body = new \OpenAPI\Client\Model\EmailRequest(); // \OpenAPI\Client\Model\EmailRequest
123+
124+
try {
125+
$result = $apiInstance->emailValidationSingleValidationPost($body);
126+
print_r($result);
127+
} catch (Exception $e) {
128+
echo 'Exception when calling EmailValidationApi->emailValidationSingleValidationPost: ', $e->getMessage(), PHP_EOL;
129+
}
130+
```
131+
132+
### Parameters
133+
134+
Name | Type | Description | Notes
135+
------------- | ------------- | ------------- | -------------
136+
**body** | [**\OpenAPI\Client\Model\EmailRequest**](../Model/EmailRequest.md)| |
137+
138+
### Return type
139+
140+
[**\OpenAPI\Client\Model\EmailResponse**](../Model/EmailResponse.md)
141+
142+
### Authorization
143+
144+
[AuthKey](../../README.md#AuthKey), [RapidApiKey](../../README.md#RapidApiKey), [RapidApiSecret](../../README.md#RapidApiSecret)
145+
146+
### HTTP request headers
147+
148+
- **Content-Type**: `application/json`
149+
- **Accept**: `application/json`
150+
151+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
152+
[[Back to Model list]](../../README.md#models)
153+
[[Back to README]](../../README.md)

‎php/docs/Model/CheckIfEmailExistMX.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # CheckIfEmailExistMX
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**accepts_mail** | **bool** | | [optional]
8+
**records** | **string[]** | | [optional]
9+
10+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎php/docs/Model/CheckIfEmailExistMisc.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # CheckIfEmailExistMisc
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**is_disposable** | **bool** | | [optional]
8+
**is_role_account** | **bool** | | [optional]
9+
10+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎php/docs/Model/CheckIfEmailExistResult.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# # CheckIfEmailExistResult
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**input** | **string** | | [optional]
8+
**is_reachable** | **string** | | [optional]
9+
**misc** | [**\OpenAPI\Client\Model\CheckIfEmailExistMisc**](CheckIfEmailExistMisc.md) | | [optional]
10+
**mx** | [**\OpenAPI\Client\Model\CheckIfEmailExistMX**](CheckIfEmailExistMX.md) | | [optional]
11+
**smtp** | [**\OpenAPI\Client\Model\CheckIfEmailExistSMTP**](CheckIfEmailExistSMTP.md) | | [optional]
12+
**syntax** | [**\OpenAPI\Client\Model\CheckIfEmailExistSyntax**](CheckIfEmailExistSyntax.md) | | [optional]
13+
**error** | **string** | | [optional]
14+
15+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎php/docs/Model/CheckIfEmailExistSMTP.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# # CheckIfEmailExistSMTP
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**can_connect_smtp** | **bool** | | [optional]
8+
**has_full_inbox** | **bool** | | [optional]
9+
**is_catch_all** | **bool** | | [optional]
10+
**is_deliverable** | **bool** | | [optional]
11+
**is_disabled** | **bool** | | [optional]
12+
13+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎php/docs/Model/CheckIfEmailExistSyntax.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# # CheckIfEmailExistSyntax
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**address** | **string** | | [optional]
8+
**domain** | **string** | | [optional]
9+
**is_valid_syntax** | **bool** | | [optional]
10+
**username** | **string** | | [optional]
11+
12+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎php/docs/Model/EmailRequest.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# # EmailRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**email** | **string** | | [optional]
8+
**smtp** | [**\OpenAPI\Client\Model\EmailRequestSmtp**](EmailRequestSmtp.md) | | [optional]
9+
**result_type** | [**\OpenAPI\Client\Model\ResultType**](ResultType.md) | | [optional]
10+
11+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎php/docs/Model/EmailRequestSmtp.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# # EmailRequestSmtp
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**email_from** | **string** | | [optional] [default to 'user@example.org']
8+
**hello_name** | **string** | | [optional] [default to 'localhost']
9+
**proxy** | **string** | Versions - SOCKS4, SOCKS4A and SOCKS5. Format - schema://username:password@host:port. | [optional]
10+
**timeout_connection** | **float** | timeout creating smtp connection | [optional] [default to 5.0]
11+
**timeout_response** | **float** | timeout of communication with smtp server | [optional]
12+
**port** | **int** | smtp port remote server | [optional] [default to 25]
13+
14+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

0 commit comments

Comments
 (0)