Added 1.5.1

Cloudmersive · Oct 19, 2019 · 717b16c · 717b16c
1 parent c6cf952
commit 717b16c
Show file tree

Hide file tree

Showing 42 changed files with 4,548 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -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.4.9
+- Package version: 1.5.1
 
 
 ## Requirements
@@ -89,16 +89,19 @@ Class | Method | HTTP request | Description
 *AddressApi* | [**addressParseString**](docs/Api/AddressApi.md#addressparsestring) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
 *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
+*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
 *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
 *NameApi* | [**nameGetGender**](docs/Api/NameApi.md#namegetgender) | **POST** /validate/name/get-gender | Get the gender of a first name
+*NameApi* | [**nameIdentifier**](docs/Api/NameApi.md#nameidentifier) | **POST** /validate/name/identifier | Validate a code identifier
 *NameApi* | [**nameValidateFirstName**](docs/Api/NameApi.md#namevalidatefirstname) | **POST** /validate/name/first | Validate a first name
 *NameApi* | [**nameValidateFullName**](docs/Api/NameApi.md#namevalidatefullname) | **POST** /validate/name/full-name | Parse and validate a full name
 *NameApi* | [**nameValidateLastName**](docs/Api/NameApi.md#namevalidatelastname) | **POST** /validate/name/last | Validate a last name
 *PhoneNumberApi* | [**phoneNumberSyntaxOnly**](docs/Api/PhoneNumberApi.md#phonenumbersyntaxonly) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
+*UserAgentApi* | [**userAgentParse**](docs/Api/UserAgentApi.md#useragentparse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
 *VatApi* | [**vatVatLookup**](docs/Api/VatApi.md#vatvatlookup) | **POST** /validate/vat/lookup | Lookup a VAT code
 
 
@@ -121,7 +124,13 @@ Class | Method | HTTP request | Description
  - [ParseAddressResponse](docs/Model/ParseAddressResponse.md)
  - [PhoneNumberValidateRequest](docs/Model/PhoneNumberValidateRequest.md)
  - [PhoneNumberValidationResponse](docs/Model/PhoneNumberValidationResponse.md)
+ - [UserAgentValidateRequest](docs/Model/UserAgentValidateRequest.md)
+ - [UserAgentValidateResponse](docs/Model/UserAgentValidateResponse.md)
+ - [ValidateIdentifierRequest](docs/Model/ValidateIdentifierRequest.md)
+ - [ValidateIdentifierResponse](docs/Model/ValidateIdentifierResponse.md)
+ - [ValidateUrlRequestFull](docs/Model/ValidateUrlRequestFull.md)
  - [ValidateUrlRequestSyntaxOnly](docs/Model/ValidateUrlRequestSyntaxOnly.md)
+ - [ValidateUrlResponseFull](docs/Model/ValidateUrlResponseFull.md)
  - [ValidateUrlResponseSyntaxOnly](docs/Model/ValidateUrlResponseSyntaxOnly.md)
  - [VatLookupRequest](docs/Model/VatLookupRequest.md)
  - [VatLookupResponse](docs/Model/VatLookupResponse.md)

diff --git a/build.ps1 b/build.ps1
@@ -14,4 +14,5 @@ Remove-Item –path ./cloudmersive_validate_api_client –recurse
 (Get-Content ./composer.json).replace('https://github.com/swagger-api/swagger-codegen', 'https://cloudmersive.com') | Set-Content ./composer.json
 (Get-Content ./composer.json).replace('http://swagger.io', 'https://cloudmersive.com') | Set-Content ./composer.json
 
-& php C:\ProgramData\ComposerSetup\bin\composer.phar install
+# & C:\tools\php\php C:\ProgramData\ComposerSetup\bin\composer.phar config -g -- disable-tls true
+& C:\tools\php71\php C:\ProgramData\ComposerSetup\bin\composer.phar install
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "cloudmersive/cloudmersive_validate_api_client",
-    "version": "1.4.9",
+    "version": "1.5.1",
     "description": "",
     "keywords": [
         "swagger",

diff --git a/docs/Api/DomainApi.md b/docs/Api/DomainApi.md
@@ -6,6 +6,7 @@ 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
+[**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
 
 
@@ -119,6 +120,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)
 
+# **domainUrlFull**
+> \Swagger\Client\Model\ValidateUrlResponseFull domainUrlFull($request)
+
+Validate a URL fully
+
+Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.
+
+### 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\ValidateUrlRequestFull(); // \Swagger\Client\Model\ValidateUrlRequestFull | 
+
+try {
+    $result = $apiInstance->domainUrlFull($request);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DomainApi->domainUrlFull: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**\Swagger\Client\Model\ValidateUrlRequestFull**](../Model/ValidateUrlRequestFull.md)|  |
+
+### Return type
+
+[**\Swagger\Client\Model\ValidateUrlResponseFull**](../Model/ValidateUrlResponseFull.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)
+
 # **domainUrlSyntaxOnly**
 > \Swagger\Client\Model\ValidateUrlResponseSyntaxOnly domainUrlSyntaxOnly($request)
 

diff --git a/docs/Api/NameApi.md b/docs/Api/NameApi.md
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**nameGetGender**](NameApi.md#nameGetGender) | **POST** /validate/name/get-gender | Get the gender of a first name
+[**nameIdentifier**](NameApi.md#nameIdentifier) | **POST** /validate/name/identifier | Validate a code identifier
 [**nameValidateFirstName**](NameApi.md#nameValidateFirstName) | **POST** /validate/name/first | Validate a first name
 [**nameValidateFullName**](NameApi.md#nameValidateFullName) | **POST** /validate/name/full-name | Parse and validate a full name
 [**nameValidateLastName**](NameApi.md#nameValidateLastName) | **POST** /validate/name/last | Validate a last name
@@ -65,6 +66,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)
 
+# **nameIdentifier**
+> \Swagger\Client\Model\ValidateIdentifierResponse nameIdentifier($input)
+
+Validate a code identifier
+
+Determines if the input name is a valid technical / code identifier.  Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed.  For example, a valid identifier might be \"helloWorld\" but not \"hello*World\".
+
+### 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\NameApi(
+    // 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
+);
+$input = new \Swagger\Client\Model\ValidateIdentifierRequest(); // \Swagger\Client\Model\ValidateIdentifierRequest | Identifier validation request information
+
+try {
+    $result = $apiInstance->nameIdentifier($input);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling NameApi->nameIdentifier: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**\Swagger\Client\Model\ValidateIdentifierRequest**](../Model/ValidateIdentifierRequest.md)| Identifier validation request information |
+
+### Return type
+
+[**\Swagger\Client\Model\ValidateIdentifierResponse**](../Model/ValidateIdentifierResponse.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)
+
 # **nameValidateFirstName**
 > \Swagger\Client\Model\FirstNameValidationResponse nameValidateFirstName($input)
 

diff --git a/docs/Api/UserAgentApi.md b/docs/Api/UserAgentApi.md
@@ -0,0 +1,64 @@
+# Swagger\Client\UserAgentApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**userAgentParse**](UserAgentApi.md#userAgentParse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
+
+
+# **userAgentParse**
+> \Swagger\Client\Model\UserAgentValidateResponse userAgentParse($request)
+
+Parse an HTTP User-Agent string, identify robots
+
+Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
+
+### 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\UserAgentApi(
+    // 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\UserAgentValidateRequest(); // \Swagger\Client\Model\UserAgentValidateRequest | Input parse request
+
+try {
+    $result = $apiInstance->userAgentParse($request);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling UserAgentApi->userAgentParse: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**\Swagger\Client\Model\UserAgentValidateRequest**](../Model/UserAgentValidateRequest.md)| Input parse request |
+
+### Return type
+
+[**\Swagger\Client\Model\UserAgentValidateResponse**](../Model/UserAgentValidateResponse.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)
+
diff --git a/docs/Model/AddressGetServersResponse.md b/docs/Model/AddressGetServersResponse.md
@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**success** | **bool** |  | [optional] 
-**servers** | **string[]** |  | [optional] 
+**success** | **bool** | True if partial address validation was successufl, false otherwise | [optional] 
+**servers** | **string[]** | Email servers for this email address | [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)
 

diff --git a/docs/Model/UserAgentValidateRequest.md b/docs/Model/UserAgentValidateRequest.md
@@ -0,0 +1,10 @@
+# UserAgentValidateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_agent_string** | **string** | The user agent string you wish to parse and validate | [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)
+
+
diff --git a/docs/Model/UserAgentValidateResponse.md b/docs/Model/UserAgentValidateResponse.md
@@ -0,0 +1,23 @@
+# UserAgentValidateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **bool** | True if the operation was successful, false otherwise | [optional] 
+**is_bot** | **bool** | True if the request is a known robot, false otherwise | [optional] 
+**bot_name** | **string** | Optional; name of the robot if the request was from a known robot, otherwise null | [optional] 
+**bot_url** | **string** | Optional; if available, the URL to the robot | [optional] 
+**operating_system** | **string** | Operating System of the User-Agent (e.g. Windows) | [optional] 
+**operating_system_cpu_platform** | **string** | The CPU platform of the User-Agent (e.g. x64) | [optional] 
+**operating_system_version** | **string** | The version of the operating system of the User-Agent (e.g. \&quot;10\&quot; for Windows 10) | [optional] 
+**device_type** | **string** | Device type of the User-Agent; possible values are \&quot;DESKTOP\&quot;, \&quot;SMARTPHONE\&quot;, \&quot;TABLET\&quot; | [optional] 
+**device_brand_name** | **string** | Brand name of the User-Agent | [optional] 
+**device_model** | **string** | Model name or number of the User-Agent | [optional] 
+**browser_name** | **string** | Name of the Browser | [optional] 
+**browser_version** | **string** | Version of the Browser | [optional] 
+**browser_engine_name** | **string** | Name of the Browser Engine | [optional] 
+**browser_engine_version** | **string** | Version of the Browser Engine | [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)
+
+
diff --git a/docs/Model/ValidateIdentifierRequest.md b/docs/Model/ValidateIdentifierRequest.md
@@ -0,0 +1,17 @@
+# ValidateIdentifierRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input** | **string** | Text string identifier input | [optional] 
+**allow_whitespace** | **bool** | True if whitespace is allowed in the identifier, false otherwise | [optional] 
+**allow_hyphens** | **bool** | True if hyphens are allowd in the identifier, false otherwise | [optional] 
+**allow_underscore** | **bool** | True if underscores are allowed in the identifier, false otherwise | [optional] 
+**allow_numbers** | **bool** | True if numbers are allowed in the identifier, false otherwise | [optional] 
+**allow_periods** | **bool** | True if periods are allowed in the identifier, false otherwise | [optional] 
+**max_length** | **int** | Optional; maximum length, if any, of the identifier | [optional] 
+**min_length** | **int** | Optional; minimum length, if any, of the identifier | [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)
+
+
diff --git a/docs/Model/ValidateIdentifierResponse.md b/docs/Model/ValidateIdentifierResponse.md
@@ -0,0 +1,11 @@
+# ValidateIdentifierResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_identifier** | **bool** | True if the input identifier is valid, false otherwise | [optional] 
+**error** | **string** | Resulting error from the identifier validation; possible errors are: \&quot;InputIsEmpty\&quot;, \&quot;ContainsWhitespace\&quot;, \&quot;ContainsNumbers\&quot;, \&quot;ContainsHyphen\&quot;, \&quot;ContainsUnderscore\&quot;, \&quot;ContainsPeriod\&quot;, \&quot;TooShort\&quot;, \&quot;TooLong\&quot;, \&quot;ContainsSpecialCharacters\&quot; | [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)
+
+
diff --git a/docs/Model/ValidateUrlRequestFull.md b/docs/Model/ValidateUrlRequestFull.md
@@ -0,0 +1,10 @@
+# ValidateUrlRequestFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | URL to validate | [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)
+
+
diff --git a/docs/Model/ValidateUrlRequestSyntaxOnly.md b/docs/Model/ValidateUrlRequestSyntaxOnly.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**url** | **string** |  | [optional] 
+**url** | **string** | URL to validate | [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)
 

diff --git a/docs/Model/ValidateUrlResponseFull.md b/docs/Model/ValidateUrlResponseFull.md
@@ -0,0 +1,14 @@
+# ValidateUrlResponseFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_url** | **bool** | True if the URL has valid syntax, a valid domain, a valid endpoint, and passes virus scan checks; false otherwise | [optional] 
+**valid_syntax** | **bool** | True if the URL has valid syntax, false otherwise | [optional] 
+**valid_domain** | **bool** | True if the domain name is valid and exists, false otherwise | [optional] 
+**valid_endpoint** | **bool** | True if the endpoint is up and responsive and passes a virus scan check, false otherwise | [optional] 
+**well_formed_url** | **string** | Well-formed version of the URL | [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)
+
+