-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7db390b
commit 9b871be
Showing
51 changed files
with
8,235 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<?php | ||
|
||
return Symfony\CS\Config::create() | ||
->level(Symfony\CS\FixerInterface::PSR2_LEVEL) | ||
->setUsingCache(true) | ||
->fixers( | ||
[ | ||
'ordered_use', | ||
'phpdoc_order', | ||
'short_array_syntax', | ||
'strict', | ||
'strict_param' | ||
] | ||
) | ||
->finder( | ||
Symfony\CS\Finder\DefaultFinder::create() | ||
->in(__DIR__) | ||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Swagger Codegen Ignore | ||
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen | ||
|
||
# Use this file to prevent files from being overwritten by the generator. | ||
# The patterns follow closely to .gitignore or .dockerignore. | ||
|
||
# As an example, the C# client generator defines ApiClient.cs. | ||
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: | ||
#ApiClient.cs | ||
|
||
# You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
#foo/*/qux | ||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
#foo/**/qux | ||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
||
# You can also negate patterns with an exclamation (!). | ||
# For example, you can ignore all files in a docs folder with the file extension .md: | ||
#docs/*.md | ||
# Then explicitly reverse the ignore rule for a single file: | ||
#!docs/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
unset |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
language: php | ||
sudo: false | ||
php: | ||
- 5.4 | ||
- 5.5 | ||
- 5.6 | ||
- 7.0 | ||
- hhvm | ||
before_install: "composer install" | ||
script: "vendor/bin/phpunit" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# cloudmersive_validate_api_client | ||
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. | ||
|
||
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: | ||
|
||
- API version: v1 | ||
- Package version: 1.3.9 | ||
- Build package: io.swagger.codegen.languages.PhpClientCodegen | ||
|
||
## Requirements | ||
|
||
PHP 5.5 and later | ||
|
||
## Installation & Usage | ||
### Composer | ||
|
||
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: | ||
|
||
``` | ||
{ | ||
"repositories": [ | ||
{ | ||
"type": "git", | ||
"url": "https://github.com/cloudmersive/cloudmersive_validate_api_client.git" | ||
} | ||
], | ||
"require": { | ||
"cloudmersive/cloudmersive_validate_api_client": "*@dev" | ||
} | ||
} | ||
``` | ||
|
||
Then run `composer install` | ||
|
||
### Manual Installation | ||
|
||
Download the files and include `autoload.php`: | ||
|
||
```php | ||
require_once('/path/to/cloudmersive_validate_api_client/vendor/autoload.php'); | ||
``` | ||
|
||
## Tests | ||
|
||
To run the unit tests: | ||
|
||
``` | ||
composer install | ||
./vendor/bin/phpunit | ||
``` | ||
|
||
## Getting Started | ||
|
||
Please follow the [installation procedure](#installation--usage) and then run the following: | ||
|
||
```php | ||
<?php | ||
require_once(__DIR__ . '/vendor/autoload.php'); | ||
|
||
// Configure API key authorization: Apikey | ||
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY'); | ||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed | ||
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); | ||
|
||
$apiInstance = new Swagger\Client\Api\DomainApi( | ||
// 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 | ||
); | ||
$domain = "domain_example"; // string | Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes. | ||
|
||
try { | ||
$result = $apiInstance->domainCheck($domain); | ||
print_r($result); | ||
} catch (Exception $e) { | ||
echo 'Exception when calling DomainApi->domainCheck: ', $e->getMessage(), PHP_EOL; | ||
} | ||
|
||
?> | ||
``` | ||
|
||
## Documentation for API Endpoints | ||
|
||
All URIs are relative to *https://api.cloudmersive.com* | ||
|
||
Class | Method | HTTP request | Description | ||
------------ | ------------- | ------------- | ------------- | ||
*DomainApi* | [**domainCheck**](docs/Api/DomainApi.md#domaincheck) | **POST** /validate/domain/check | Validate a domain name | ||
*DomainApi* | [**domainPost**](docs/Api/DomainApi.md#domainpost) | **POST** /validate/domain/whois | Get WHOIS information for a domain | ||
*EmailApi* | [**emailAddressGetServers**](docs/Api/EmailApi.md#emailaddressgetservers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid | ||
*EmailApi* | [**emailFullValidation**](docs/Api/EmailApi.md#emailfullvalidation) | **POST** /validate/email/address/full | Fully validate an email address | ||
*EmailApi* | [**emailPost**](docs/Api/EmailApi.md#emailpost) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only | ||
*IPAddressApi* | [**iPAddressPost**](docs/Api/IPAddressApi.md#ipaddresspost) | **POST** /validate/ip/geolocate | Geolocate an IP address | ||
*VatApi* | [**vatVatLookup**](docs/Api/VatApi.md#vatvatlookup) | **POST** /validate/vat/lookup | Lookup a VAT code | ||
|
||
|
||
## Documentation For Models | ||
|
||
- [AddressGetServersResponse](docs/Model/AddressGetServersResponse.md) | ||
- [AddressVerifySyntaxOnlyResponse](docs/Model/AddressVerifySyntaxOnlyResponse.md) | ||
- [CheckResponse](docs/Model/CheckResponse.md) | ||
- [FullEmailValidationResponse](docs/Model/FullEmailValidationResponse.md) | ||
- [GeolocateResponse](docs/Model/GeolocateResponse.md) | ||
- [VatLookupRequest](docs/Model/VatLookupRequest.md) | ||
- [VatLookupResponse](docs/Model/VatLookupResponse.md) | ||
- [WhoisResponse](docs/Model/WhoisResponse.md) | ||
|
||
|
||
## Documentation For Authorization | ||
|
||
|
||
## Apikey | ||
|
||
- **Type**: API key | ||
- **API key parameter name**: Apikey | ||
- **Location**: HTTP header | ||
|
||
|
||
## Author | ||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{ | ||
"name": "cloudmersive/cloudmersive_validate_api_client", | ||
"version": "1.3.9", | ||
"description": "", | ||
"keywords": [ | ||
"swagger", | ||
"php", | ||
"sdk", | ||
"api" | ||
], | ||
"homepage": "http://swagger.io", | ||
"license": "proprietary", | ||
"authors": [ | ||
{ | ||
"name": "Swagger and contributors", | ||
"homepage": "https://github.com/swagger-api/swagger-codegen" | ||
} | ||
], | ||
"require": { | ||
"php": ">=5.5", | ||
"ext-curl": "*", | ||
"ext-json": "*", | ||
"ext-mbstring": "*", | ||
"guzzlehttp/guzzle": "^6.2" | ||
}, | ||
"require-dev": { | ||
"phpunit/phpunit": "^4.8", | ||
"squizlabs/php_codesniffer": "~2.6", | ||
"friendsofphp/php-cs-fixer": "~1.12" | ||
}, | ||
"autoload": { | ||
"psr-4": { "Swagger\\Client\\" : "lib/" } | ||
}, | ||
"autoload-dev": { | ||
"psr-4": { "Swagger\\Client\\" : "test/" } | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
# Swagger\Client\DomainApi | ||
|
||
All URIs are relative to *https://api.cloudmersive.com* | ||
|
||
Method | HTTP request | Description | ||
------------- | ------------- | ------------- | ||
[**domainCheck**](DomainApi.md#domainCheck) | **POST** /validate/domain/check | Validate a domain name | ||
[**domainPost**](DomainApi.md#domainPost) | **POST** /validate/domain/whois | Get WHOIS information for a domain | ||
|
||
|
||
# **domainCheck** | ||
> \Swagger\Client\Model\CheckResponse domainCheck($domain) | ||
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. | ||
|
||
### Example | ||
```php | ||
<?php | ||
require_once(__DIR__ . '/vendor/autoload.php'); | ||
|
||
// Configure API key authorization: Apikey | ||
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY'); | ||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed | ||
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); | ||
|
||
$apiInstance = new Swagger\Client\Api\DomainApi( | ||
// 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 | ||
); | ||
$domain = "domain_example"; // string | Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes. | ||
|
||
try { | ||
$result = $apiInstance->domainCheck($domain); | ||
print_r($result); | ||
} catch (Exception $e) { | ||
echo 'Exception when calling DomainApi->domainCheck: ', $e->getMessage(), PHP_EOL; | ||
} | ||
?> | ||
``` | ||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**domain** | **string**| Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes. | | ||
|
||
### Return type | ||
|
||
[**\Swagger\Client\Model\CheckResponse**](../Model/CheckResponse.md) | ||
|
||
### Authorization | ||
|
||
[Apikey](../../README.md#Apikey) | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded | ||
- **Accept**: application/json, text/json, application/xml, text/xml | ||
|
||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) | ||
|
||
# **domainPost** | ||
> \Swagger\Client\Model\WhoisResponse domainPost($domain) | ||
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. | ||
|
||
### Example | ||
```php | ||
<?php | ||
require_once(__DIR__ . '/vendor/autoload.php'); | ||
|
||
// Configure API key authorization: Apikey | ||
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY'); | ||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed | ||
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); | ||
|
||
$apiInstance = new Swagger\Client\Api\DomainApi( | ||
// 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 | ||
); | ||
$domain = "domain_example"; // string | Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes. | ||
|
||
try { | ||
$result = $apiInstance->domainPost($domain); | ||
print_r($result); | ||
} catch (Exception $e) { | ||
echo 'Exception when calling DomainApi->domainPost: ', $e->getMessage(), PHP_EOL; | ||
} | ||
?> | ||
``` | ||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**domain** | **string**| Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes. | | ||
|
||
### Return type | ||
|
||
[**\Swagger\Client\Model\WhoisResponse**](../Model/WhoisResponse.md) | ||
|
||
### Authorization | ||
|
||
[Apikey](../../README.md#Apikey) | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded | ||
- **Accept**: application/json, text/json, application/xml, text/xml | ||
|
||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) | ||
|
Oops, something went wrong.