Skip to content

Commit

Permalink
1.7.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Cloudmersive committed Apr 12, 2021
1 parent a587e85 commit 7a707e6
Show file tree
Hide file tree
Showing 19 changed files with 2,448 additions and 5 deletions.
8 changes: 7 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.3
- Package version: 1.7.4


## Requirements
Expand Down Expand Up @@ -135,6 +135,8 @@ Class | Method | HTTP request | Description
*TextInputApi* | [**textInputCheckSqlInjectionBatch**](docs/Api/TextInputApi.md#textinputchecksqlinjectionbatch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
*TextInputApi* | [**textInputCheckXss**](docs/Api/TextInputApi.md#textinputcheckxss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
*TextInputApi* | [**textInputCheckXssBatch**](docs/Api/TextInputApi.md#textinputcheckxssbatch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
*TextInputApi* | [**textInputCheckXxe**](docs/Api/TextInputApi.md#textinputcheckxxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
*TextInputApi* | [**textInputCheckXxeBatch**](docs/Api/TextInputApi.md#textinputcheckxxebatch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
*TextInputApi* | [**textInputProtectXss**](docs/Api/TextInputApi.md#textinputprotectxss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
*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 | Validate a VAT number
Expand Down Expand Up @@ -220,6 +222,10 @@ Class | Method | HTTP request | Description
- [XssProtectionBatchResponse](docs/Model/XssProtectionBatchResponse.md)
- [XssProtectionRequestItem](docs/Model/XssProtectionRequestItem.md)
- [XssProtectionResult](docs/Model/XssProtectionResult.md)
- [XxeDetectionBatchRequest](docs/Model/XxeDetectionBatchRequest.md)
- [XxeDetectionBatchResponse](docs/Model/XxeDetectionBatchResponse.md)
- [XxeDetectionRequestItem](docs/Model/XxeDetectionRequestItem.md)
- [XxeDetectionResult](docs/Model/XxeDetectionResult.md)


## Documentation For Authorization
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.3",
"version": "1.7.4",
"description": "",
"keywords": [
"swagger",
Expand Down
118 changes: 118 additions & 0 deletions docs/Api/TextInputApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Method | HTTP request | Description
[**textInputCheckSqlInjectionBatch**](TextInputApi.md#textInputCheckSqlInjectionBatch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
[**textInputCheckXss**](TextInputApi.md#textInputCheckXss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
[**textInputCheckXssBatch**](TextInputApi.md#textInputCheckXssBatch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
[**textInputCheckXxe**](TextInputApi.md#textInputCheckXxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
[**textInputCheckXxeBatch**](TextInputApi.md#textInputCheckXxeBatch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
[**textInputProtectXss**](TextInputApi.md#textInputProtectXss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization


Expand Down Expand Up @@ -233,6 +235,122 @@ 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)

# **textInputCheckXxe**
> \Swagger\Client\Model\XxeDetectionResult textInputCheckXxe($value, $allow_internet_urls, $known_safe_urls, $known_unsafe_urls)
Protect text input from XML External Entity (XXE) attacks

Detects XXE (XML External Entity) attacks from text input.

### 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\TextInputApi(
// 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
);
$value = "value_example"; // string | User-facing text input.
$allow_internet_urls = true; // bool | Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block. Default is false.
$known_safe_urls = "known_safe_urls_example"; // string | Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe.
$known_unsafe_urls = "known_unsafe_urls_example"; // string | Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe.

try {
$result = $apiInstance->textInputCheckXxe($value, $allow_internet_urls, $known_safe_urls, $known_unsafe_urls);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TextInputApi->textInputCheckXxe: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**value** | **string**| User-facing text input. |
**allow_internet_urls** | **bool**| Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block. Default is false. | [optional]
**known_safe_urls** | **string**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe. | [optional]
**known_unsafe_urls** | **string**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe. | [optional]

### Return type

[**\Swagger\Client\Model\XxeDetectionResult**](../Model/XxeDetectionResult.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)

# **textInputCheckXxeBatch**
> \Swagger\Client\Model\XxeDetectionBatchResponse textInputCheckXxeBatch($request)
Protect text input from XML External Entity (XXE) attacks

Detects XXE (XML External Entity) attacks from text input.

### 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\TextInputApi(
// 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\XxeDetectionBatchRequest(); // \Swagger\Client\Model\XxeDetectionBatchRequest |

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

### Parameters

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

### Return type

[**\Swagger\Client\Model\XxeDetectionBatchResponse**](../Model/XxeDetectionBatchResponse.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)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**request_items** | [**\Swagger\Client\Model\XxeDetectionRequestItem[]**](XxeDetectionRequestItem.md) | Multiple items to protect for XXE | [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/XxeDetectionBatchResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# XxeDetectionBatchResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result_items** | [**\Swagger\Client\Model\XxeDetectionResult[]**](XxeDetectionResult.md) | Results from performing a batch XSS protection operation | [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)


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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**input_text** | **string** | Individual input text item to protect from XXE | [optional]
**allow_internet_urls** | **bool** | Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block. Default is false. | [optional]
**known_safe_urls** | **string[]** | Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe. | [optional]
**known_unsafe_urls** | **string[]** | Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe. | [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/XxeDetectionResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# XxeDetectionResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**successful** | **bool** | True if the operation was successful, false otherwise | [optional]
**contained_xxe** | **bool** | True if the input contained XXE threats, false otherwise | [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)


Loading

0 comments on commit 7a707e6

Please sign in to comment.