Skip to content

Commit

Permalink
1.7.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Cloudmersive committed Feb 7, 2021
1 parent 59e31b6 commit 2dc480e
Show file tree
Hide file tree
Showing 22 changed files with 2,711 additions and 10 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
[Cloudmersive Validation API](https://www.cloudmersive.com/validate-api) provides data validation capabilities for validating email addresses, phone numbers, IP addresses, and many other types of business data.

- API version: v1
- Package version: 1.7.0
- Package version: 1.7.1


## Requirements
Expand Down Expand Up @@ -105,8 +105,11 @@ Class | Method | HTTP request | Description
*DateTimeApi* | [**dateTimeParseNaturalLanguageDateTime**](docs/Api/DateTimeApi.md#datetimeparsenaturallanguagedatetime) | **POST** /validate/date-time/parse/date-time/natural-language | Parses a free-form natural language date and time string into a date and time
*DateTimeApi* | [**dateTimeParseStandardDateTime**](docs/Api/DateTimeApi.md#datetimeparsestandarddatetime) | **POST** /validate/date-time/parse/date-time/structured | Parses a standardized date and time string into a date and time
*DomainApi* | [**domainCheck**](docs/Api/DomainApi.md#domaincheck) | **POST** /validate/domain/check | Validate a domain name
*DomainApi* | [**domainGetTopLevelDomainFromUrl**](docs/Api/DomainApi.md#domaingettopleveldomainfromurl) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
*DomainApi* | [**domainPost**](docs/Api/DomainApi.md#domainpost) | **POST** /validate/domain/whois | Get WHOIS information for a domain
*DomainApi* | [**domainQualityScore**](docs/Api/DomainApi.md#domainqualityscore) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
*DomainApi* | [**domainSsrfCheck**](docs/Api/DomainApi.md#domainssrfcheck) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
*DomainApi* | [**domainSsrfCheckBatch**](docs/Api/DomainApi.md#domainssrfcheckbatch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
*DomainApi* | [**domainUrlFull**](docs/Api/DomainApi.md#domainurlfull) | **POST** /validate/domain/url/full | Validate a URL fully
*DomainApi* | [**domainUrlSyntaxOnly**](docs/Api/DomainApi.md#domainurlsyntaxonly) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
*EmailApi* | [**emailAddressGetServers**](docs/Api/EmailApi.md#emailaddressgetservers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
Expand Down Expand Up @@ -176,6 +179,10 @@ Class | Method | HTTP request | Description
- [ReverseGeocodeAddressResponse](docs/Model/ReverseGeocodeAddressResponse.md)
- [Timezone](docs/Model/Timezone.md)
- [TorNodeResponse](docs/Model/TorNodeResponse.md)
- [UrlSsrfRequestBatch](docs/Model/UrlSsrfRequestBatch.md)
- [UrlSsrfRequestFull](docs/Model/UrlSsrfRequestFull.md)
- [UrlSsrfResponseBatch](docs/Model/UrlSsrfResponseBatch.md)
- [UrlSsrfResponseFull](docs/Model/UrlSsrfResponseFull.md)
- [UserAgentValidateRequest](docs/Model/UserAgentValidateRequest.md)
- [UserAgentValidateResponse](docs/Model/UserAgentValidateResponse.md)
- [ValidateAddressRequest](docs/Model/ValidateAddressRequest.md)
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cloudmersive/cloudmersive_validate_api_client",
"version": "1.7.0",
"version": "1.7.1",
"description": "",
"keywords": [
"swagger",
Expand Down
168 changes: 168 additions & 0 deletions docs/Api/DomainApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@ 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
[**domainGetTopLevelDomainFromUrl**](DomainApi.md#domainGetTopLevelDomainFromUrl) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
[**domainPost**](DomainApi.md#domainPost) | **POST** /validate/domain/whois | Get WHOIS information for a domain
[**domainQualityScore**](DomainApi.md#domainQualityScore) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
[**domainSsrfCheck**](DomainApi.md#domainSsrfCheck) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
[**domainSsrfCheckBatch**](DomainApi.md#domainSsrfCheckBatch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
[**domainUrlFull**](DomainApi.md#domainUrlFull) | **POST** /validate/domain/url/full | Validate a URL fully
[**domainUrlSyntaxOnly**](DomainApi.md#domainUrlSyntaxOnly) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically

Expand Down Expand Up @@ -66,6 +69,61 @@ Name | Type | Description | Notes

[[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)

# **domainGetTopLevelDomainFromUrl**
> \Swagger\Client\Model\ValidateUrlResponseSyntaxOnly domainGetTopLevelDomainFromUrl($request)
Get top-level domain name from URL

Gets the top-level domain name from a URL, such as mydomain.com.

### 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
);
$request = new \Swagger\Client\Model\ValidateUrlRequestSyntaxOnly(); // \Swagger\Client\Model\ValidateUrlRequestSyntaxOnly | Input URL information

try {
$result = $apiInstance->domainGetTopLevelDomainFromUrl($request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DomainApi->domainGetTopLevelDomainFromUrl: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**request** | [**\Swagger\Client\Model\ValidateUrlRequestSyntaxOnly**](../Model/ValidateUrlRequestSyntaxOnly.md)| Input URL information |

### Return type

[**\Swagger\Client\Model\ValidateUrlResponseSyntaxOnly**](../Model/ValidateUrlResponseSyntaxOnly.md)

### Authorization

[Apikey](../../README.md#Apikey)

### HTTP request headers

- **Content-Type**: application/json, text/json
- **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)
Expand Down Expand Up @@ -176,6 +234,116 @@ Name | Type | Description | Notes

[[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)

# **domainSsrfCheck**
> \Swagger\Client\Model\UrlSsrfResponseFull domainSsrfCheck($request)
Check a URL for SSRF threats

Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.

### 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
);
$request = new \Swagger\Client\Model\UrlSsrfRequestFull(); // \Swagger\Client\Model\UrlSsrfRequestFull | Input URL request

try {
$result = $apiInstance->domainSsrfCheck($request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DomainApi->domainSsrfCheck: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**request** | [**\Swagger\Client\Model\UrlSsrfRequestFull**](../Model/UrlSsrfRequestFull.md)| Input URL request |

### Return type

[**\Swagger\Client\Model\UrlSsrfResponseFull**](../Model/UrlSsrfResponseFull.md)

### Authorization

[Apikey](../../README.md#Apikey)

### HTTP request headers

- **Content-Type**: application/json, text/json
- **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)

# **domainSsrfCheckBatch**
> \Swagger\Client\Model\UrlSsrfResponseBatch domainSsrfCheckBatch($request)
Check a URL for SSRF threats in batches

Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.

### 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
);
$request = new \Swagger\Client\Model\UrlSsrfRequestBatch(); // \Swagger\Client\Model\UrlSsrfRequestBatch | Input URL request as a batch of multiple URLs

try {
$result = $apiInstance->domainSsrfCheckBatch($request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DomainApi->domainSsrfCheckBatch: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**request** | [**\Swagger\Client\Model\UrlSsrfRequestBatch**](../Model/UrlSsrfRequestBatch.md)| Input URL request as a batch of multiple URLs |

### Return type

[**\Swagger\Client\Model\UrlSsrfResponseBatch**](../Model/UrlSsrfResponseBatch.md)

### Authorization

[Apikey](../../README.md#Apikey)

### HTTP request headers

- **Content-Type**: application/json, text/json
- **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)

# **domainUrlFull**
> \Swagger\Client\Model\ValidateUrlResponseFull domainUrlFull($request)
Expand Down
10 changes: 10 additions & 0 deletions docs/Model/UrlSsrfRequestBatch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# UrlSsrfRequestBatch

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**input_items** | [**\Swagger\Client\Model\UrlSsrfRequestFull[]**](UrlSsrfRequestFull.md) | Input URLs to check for SSRF threats | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/Model/UrlSsrfRequestFull.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UrlSsrfRequestFull

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **string** | URL to validate | [optional]
**blocked_domains** | **string[]** | Top level domains that you do not want to allow access to, e.g. mydomain.com - will block all subdomains as well | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions docs/Model/UrlSsrfResponseBatch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# UrlSsrfResponseBatch

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**output_items** | [**\Swagger\Client\Model\UrlSsrfResponseFull[]**](UrlSsrfResponseFull.md) | Results of the operation, with indexes matched to input values | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/Model/UrlSsrfResponseFull.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UrlSsrfResponseFull

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**clean_url** | **bool** | True if the URL is clean, false if it is at risk of containing an SSRF threat or attack | [optional]
**threat_level** | **string** | Threat level of the URL; possible values are High, Medium, Low and None | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/Model/ValidateUrlResponseSyntaxOnly.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**valid_url** | **bool** | True if the URL is valid, false otherwise | [optional]
**well_formed_url** | **string** | Well-formed version of the URL | [optional]
**top_level_domain_name** | **string** | The top-level domain name of the URL, e.g. mydomain.com | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Loading

0 comments on commit 2dc480e

Please sign in to comment.