cloudmersive-virus-scan-api-client 2.0.9 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 137bd7763b18f850e5041a72ce7d0b47f5aa314a99c78feb1639c21fa54bb782
4
- data.tar.gz: 6380f584c660cf63ddbc8ab1715031b59607446775cb0ed70e1bca82b0d987ff
3
+ metadata.gz: ac4d1c24e76da44416bb101116e3b537209acc4085b8fbed00737ce8d8772776
4
+ data.tar.gz: fbcd272b8bf047e9b3b9f01ab396e9e3c0eaada5652c6fd3726c35b7db581e61
5
5
  SHA512:
6
- metadata.gz: af3451faa07d54652ef015cf871889e8d4ded02e389140f117f1ef4206267bd0309d30005507d1036b6378744c114e52ebe5c99ede84cfc69feaa5945138ec57
7
- data.tar.gz: bf5de355966f1ca791cd085ec6956f8bdd97d675cb5c96cdad416e7f879407646afeed6c5cefbc32b4e896c655adb01bceea90a64c387b43f4798987ada6bf6a
6
+ metadata.gz: 68242336e3958a240593098f4bb995b16ae522c34547121fbe3728a1c77a71f1db9023ea4f67b6846927035d8d4fb755aa893af44e32cabe64c03f35e638f779
7
+ data.tar.gz: 4abc017baed534e706be444923c6adce5fe6206783fd6d2f0169ee0eca54f0d2d395f8f35323c0ec4bd41d611cf95a7724b34ec7662b0ec9abbf707ace70e542
data/README.md CHANGED
@@ -7,7 +7,7 @@ The Cloudmersive Virus Scan API lets you scan files and content for viruses and
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 2.0.9
10
+ - Package version: 2.1.0
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-virus-scan-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-virus-scan-api-client-2.0.9.gem
26
+ gem install ./cloudmersive-virus-scan-api-client-2.1.0.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.9.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.1.0.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-virus-scan-api-client', '~> 2.0.9'
34
+ gem 'cloudmersive-virus-scan-api-client', '~> 2.1.0'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **contains_json** | **BOOLEAN** | True if the input file contains JSON data, false otherwise; this is not a threat signal | [optional]
7
7
  **contains_xml** | **BOOLEAN** | True if the input file contains XML data, false otherwise; this is not a threat signal | [optional]
8
+ **contains_image** | **BOOLEAN** | True if the input file contains an image | [optional]
8
9
 
9
10
 
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
15
15
  **found_viruses** | [**Array<CloudStorageVirusFound>**](CloudStorageVirusFound.md) | Array of viruses found, if any | [optional]
16
16
  **error_detailed_description** | **String** | Detailed error message if the operation was not successful | [optional]
17
17
  **file_size** | **Integer** | Size in bytes of the file that was retrieved and scanned | [optional]
18
+ **content_information** | [**AdditionalAdvancedScanInformation**](AdditionalAdvancedScanInformation.md) | Contains additional non-threat content verification information | [optional]
18
19
 
19
20
 
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
8
8
  **found_viruses** | [**Array<CloudStorageVirusFound>**](CloudStorageVirusFound.md) | Array of viruses found, if any | [optional]
9
9
  **error_detailed_description** | **String** | Detailed error message if the operation was not successful | [optional]
10
10
  **file_size** | **Integer** | Size in bytes of the file that was retrieved and scanned | [optional]
11
+ **contains_content_moderation_rejection** | **BOOLEAN** | Set to true when using NSFW Content Moderation in the Cloudmersive Storage Protect product (disabled by default) | [optional]
11
12
 
12
13
 
data/docs/ScanApi.md CHANGED
@@ -68,7 +68,7 @@ Name | Type | Description | Notes
68
68
 
69
69
  Advanced Scan a file for viruses
70
70
 
71
- Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
71
+ Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash, MSG, and a wide range of image file formats. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
72
72
 
73
73
  ### Example
74
74
  ```ruby
@@ -43,7 +43,7 @@ bucket_region = 'bucket_region_example' # String | Name of the region of the S3
43
43
 
44
44
  bucket_name = 'bucket_name_example' # String | Name of the S3 bucket
45
45
 
46
- key_name = 'key_name_example' # String | Key name (also called file name) of the file in S3 that you wish to scan for viruses
46
+ key_name = 'key_name_example' # String | Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
47
47
 
48
48
 
49
49
  begin
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
63
63
  **secret_key** | **String**| AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console |
64
64
  **bucket_region** | **String**| Name of the region of the S3 bucket, such as 'US-East-1' |
65
65
  **bucket_name** | **String**| Name of the S3 bucket |
66
- **key_name** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses |
66
+ **key_name** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. |
67
67
 
68
68
  ### Return type
69
69
 
@@ -109,7 +109,7 @@ bucket_region = 'bucket_region_example' # String | Name of the region of the S3
109
109
 
110
110
  bucket_name = 'bucket_name_example' # String | Name of the S3 bucket
111
111
 
112
- key_name = 'key_name_example' # String | Key name (also called file name) of the file in S3 that you wish to scan for viruses
112
+ key_name = 'key_name_example' # String | Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
113
113
 
114
114
  opts = {
115
115
  allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
@@ -138,7 +138,7 @@ Name | Type | Description | Notes
138
138
  **secret_key** | **String**| AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console |
139
139
  **bucket_region** | **String**| Name of the region of the S3 bucket, such as 'US-East-1' |
140
140
  **bucket_name** | **String**| Name of the S3 bucket |
141
- **key_name** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses |
141
+ **key_name** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. |
142
142
  **allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
143
143
  **allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
144
144
  **allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
@@ -187,7 +187,7 @@ connection_string = 'connection_string_example' # String | Connection string for
187
187
 
188
188
  container_name = 'container_name_example' # String | Name of the Blob container within the Azure Blob Storage account
189
189
 
190
- blob_path = 'blob_path_example' # String | Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
190
+ blob_path = 'blob_path_example' # String | Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
191
191
 
192
192
 
193
193
  begin
@@ -205,7 +205,7 @@ Name | Type | Description | Notes
205
205
  ------------- | ------------- | ------------- | -------------
206
206
  **connection_string** | **String**| Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal. |
207
207
  **container_name** | **String**| Name of the Blob container within the Azure Blob Storage account |
208
- **blob_path** | **String**| Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
208
+ **blob_path** | **String**| Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. |
209
209
 
210
210
  ### Return type
211
211
 
@@ -247,7 +247,7 @@ connection_string = 'connection_string_example' # String | Connection string for
247
247
 
248
248
  container_name = 'container_name_example' # String | Name of the Blob container within the Azure Blob Storage account
249
249
 
250
- blob_path = 'blob_path_example' # String | Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
250
+ blob_path = 'blob_path_example' # String | Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
251
251
 
252
252
  opts = {
253
253
  allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
@@ -274,7 +274,7 @@ Name | Type | Description | Notes
274
274
  ------------- | ------------- | ------------- | -------------
275
275
  **connection_string** | **String**| Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal. |
276
276
  **container_name** | **String**| Name of the Blob container within the Azure Blob Storage account |
277
- **blob_path** | **String**| Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
277
+ **blob_path** | **String**| Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. |
278
278
  **allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
279
279
  **allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
280
280
  **allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
@@ -321,7 +321,7 @@ api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
321
321
 
322
322
  bucket_name = 'bucket_name_example' # String | Name of the bucket in Google Cloud Storage
323
323
 
324
- object_name = 'object_name_example' # String | Name of the object or file in Google Cloud Storage
324
+ object_name = 'object_name_example' # String | Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
325
325
 
326
326
  json_credential_file = File.new('/path/to/file.txt') # File | Service Account credential for Google Cloud stored in a JSON file.
327
327
 
@@ -340,7 +340,7 @@ end
340
340
  Name | Type | Description | Notes
341
341
  ------------- | ------------- | ------------- | -------------
342
342
  **bucket_name** | **String**| Name of the bucket in Google Cloud Storage |
343
- **object_name** | **String**| Name of the object or file in Google Cloud Storage |
343
+ **object_name** | **String**| Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. |
344
344
  **json_credential_file** | **File**| Service Account credential for Google Cloud stored in a JSON file. |
345
345
 
346
346
  ### Return type
@@ -381,7 +381,7 @@ api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
381
381
 
382
382
  bucket_name = 'bucket_name_example' # String | Name of the bucket in Google Cloud Storage
383
383
 
384
- object_name = 'object_name_example' # String | Name of the object or file in Google Cloud Storage
384
+ object_name = 'object_name_example' # String | Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
385
385
 
386
386
  json_credential_file = File.new('/path/to/file.txt') # File | Service Account credential for Google Cloud stored in a JSON file.
387
387
 
@@ -409,7 +409,7 @@ end
409
409
  Name | Type | Description | Notes
410
410
  ------------- | ------------- | ------------- | -------------
411
411
  **bucket_name** | **String**| Name of the bucket in Google Cloud Storage |
412
- **object_name** | **String**| Name of the object or file in Google Cloud Storage |
412
+ **object_name** | **String**| Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. |
413
413
  **json_credential_file** | **File**| Service Account credential for Google Cloud stored in a JSON file. |
414
414
  **allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
415
415
  **allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
@@ -463,7 +463,7 @@ sharepoint_domain_name = 'sharepoint_domain_name_example' # String | SharePoint
463
463
 
464
464
  site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you wish to retrieve the file from
465
465
 
466
- file_path = 'file_path_example' # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
466
+ file_path = 'file_path_example' # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
467
467
 
468
468
  opts = {
469
469
  tenant_id: 'tenant_id_example', # String | Optional; Tenant ID of your Azure Active Directory
@@ -487,7 +487,7 @@ Name | Type | Description | Notes
487
487
  **client_secret** | **String**| Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal |
488
488
  **sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
489
489
  **site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
490
- **file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
490
+ **file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. |
491
491
  **tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
492
492
  **item_id** | **String**| SharePoint itemID, such as a DriveItem Id | [optional]
493
493
 
@@ -537,7 +537,7 @@ site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you
537
537
 
538
538
  opts = {
539
539
  tenant_id: 'tenant_id_example', # String | Optional; Tenant ID of your Azure Active Directory
540
- file_path: 'file_path_example', # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
540
+ file_path: 'file_path_example', # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
541
541
  item_id: 'item_id_example', # String | SharePoint itemID, such as a DriveItem Id
542
542
  allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
543
543
  allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -566,7 +566,7 @@ Name | Type | Description | Notes
566
566
  **sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
567
567
  **site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
568
568
  **tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
569
- **file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' | [optional]
569
+ **file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. | [optional]
570
570
  **item_id** | **String**| SharePoint itemID, such as a DriveItem Id | [optional]
571
571
  **allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
572
572
  **allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
@@ -75,7 +75,7 @@ module CloudmersiveVirusScanApiClient
75
75
  return data, status_code, headers
76
76
  end
77
77
  # Advanced Scan a file for viruses
78
- # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
78
+ # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash, MSG, and a wide range of image file formats. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
79
79
  # @param input_file Input file to perform the operation on.
80
80
  # @param [Hash] opts the optional parameters
81
81
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
@@ -94,7 +94,7 @@ module CloudmersiveVirusScanApiClient
94
94
  end
95
95
 
96
96
  # Advanced Scan a file for viruses
97
- # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
97
+ # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash, MSG, and a wide range of image file formats. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
98
98
  # @param input_file Input file to perform the operation on.
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
@@ -25,7 +25,7 @@ module CloudmersiveVirusScanApiClient
25
25
  # @param secret_key AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
26
26
  # @param bucket_region Name of the region of the S3 bucket, such as 'US-East-1'
27
27
  # @param bucket_name Name of the S3 bucket
28
- # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses
28
+ # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
29
29
  # @param [Hash] opts the optional parameters
30
30
  # @return [CloudStorageVirusScanResult]
31
31
  def scan_cloud_storage_scan_aws_s3_file(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
@@ -39,7 +39,7 @@ module CloudmersiveVirusScanApiClient
39
39
  # @param secret_key AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
40
40
  # @param bucket_region Name of the region of the S3 bucket, such as 'US-East-1'
41
41
  # @param bucket_name Name of the S3 bucket
42
- # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses
42
+ # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
43
43
  # @param [Hash] opts the optional parameters
44
44
  # @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
45
45
  def scan_cloud_storage_scan_aws_s3_file_with_http_info(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
@@ -108,7 +108,7 @@ module CloudmersiveVirusScanApiClient
108
108
  # @param secret_key AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
109
109
  # @param bucket_region Name of the region of the S3 bucket, such as &#39;US-East-1&#39;
110
110
  # @param bucket_name Name of the S3 bucket
111
- # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses
111
+ # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
112
112
  # @param [Hash] opts the optional parameters
113
113
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
114
114
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -129,7 +129,7 @@ module CloudmersiveVirusScanApiClient
129
129
  # @param secret_key AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
130
130
  # @param bucket_region Name of the region of the S3 bucket, such as &#39;US-East-1&#39;
131
131
  # @param bucket_name Name of the S3 bucket
132
- # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses
132
+ # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
133
133
  # @param [Hash] opts the optional parameters
134
134
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
135
135
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -210,7 +210,7 @@ module CloudmersiveVirusScanApiClient
210
210
  # Scan the contents of a single Azure Blob and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
211
211
  # @param connection_string Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.
212
212
  # @param container_name Name of the Blob container within the Azure Blob Storage account
213
- # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
213
+ # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
214
214
  # @param [Hash] opts the optional parameters
215
215
  # @return [CloudStorageVirusScanResult]
216
216
  def scan_cloud_storage_scan_azure_blob(connection_string, container_name, blob_path, opts = {})
@@ -222,7 +222,7 @@ module CloudmersiveVirusScanApiClient
222
222
  # Scan the contents of a single Azure Blob and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
223
223
  # @param connection_string Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.
224
224
  # @param container_name Name of the Blob container within the Azure Blob Storage account
225
- # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
225
+ # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
226
226
  # @param [Hash] opts the optional parameters
227
227
  # @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
228
228
  def scan_cloud_storage_scan_azure_blob_with_http_info(connection_string, container_name, blob_path, opts = {})
@@ -279,7 +279,7 @@ module CloudmersiveVirusScanApiClient
279
279
  # Advanced Scan the contents of a single Azure Blob and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
280
280
  # @param connection_string Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.
281
281
  # @param container_name Name of the Blob container within the Azure Blob Storage account
282
- # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
282
+ # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
283
283
  # @param [Hash] opts the optional parameters
284
284
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
285
285
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -298,7 +298,7 @@ module CloudmersiveVirusScanApiClient
298
298
  # Advanced Scan the contents of a single Azure Blob and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
299
299
  # @param connection_string Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.
300
300
  # @param container_name Name of the Blob container within the Azure Blob Storage account
301
- # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
301
+ # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
302
302
  # @param [Hash] opts the optional parameters
303
303
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
304
304
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -368,7 +368,7 @@ module CloudmersiveVirusScanApiClient
368
368
  # Scan an Google Cloud Platform (GCP) Storage file for viruses
369
369
  # Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
370
370
  # @param bucket_name Name of the bucket in Google Cloud Storage
371
- # @param object_name Name of the object or file in Google Cloud Storage
371
+ # @param object_name Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
372
372
  # @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
373
373
  # @param [Hash] opts the optional parameters
374
374
  # @return [CloudStorageVirusScanResult]
@@ -380,7 +380,7 @@ module CloudmersiveVirusScanApiClient
380
380
  # Scan an Google Cloud Platform (GCP) Storage file for viruses
381
381
  # Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
382
382
  # @param bucket_name Name of the bucket in Google Cloud Storage
383
- # @param object_name Name of the object or file in Google Cloud Storage
383
+ # @param object_name Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
384
384
  # @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
385
385
  # @param [Hash] opts the optional parameters
386
386
  # @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
@@ -437,7 +437,7 @@ module CloudmersiveVirusScanApiClient
437
437
  # Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
438
438
  # Advanced Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
439
439
  # @param bucket_name Name of the bucket in Google Cloud Storage
440
- # @param object_name Name of the object or file in Google Cloud Storage
440
+ # @param object_name Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
441
441
  # @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
442
442
  # @param [Hash] opts the optional parameters
443
443
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
@@ -456,7 +456,7 @@ module CloudmersiveVirusScanApiClient
456
456
  # Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
457
457
  # Advanced Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
458
458
  # @param bucket_name Name of the bucket in Google Cloud Storage
459
- # @param object_name Name of the object or file in Google Cloud Storage
459
+ # @param object_name Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
460
460
  # @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
461
461
  # @param [Hash] opts the optional parameters
462
462
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
@@ -530,7 +530,7 @@ module CloudmersiveVirusScanApiClient
530
530
  # @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
531
531
  # @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
532
532
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
533
- # @param file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
533
+ # @param file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
534
534
  # @param [Hash] opts the optional parameters
535
535
  # @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
536
536
  # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
@@ -546,7 +546,7 @@ module CloudmersiveVirusScanApiClient
546
546
  # @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
547
547
  # @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
548
548
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
549
- # @param file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
549
+ # @param file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
550
550
  # @param [Hash] opts the optional parameters
551
551
  # @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
552
552
  # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
@@ -621,7 +621,7 @@ module CloudmersiveVirusScanApiClient
621
621
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
622
622
  # @param [Hash] opts the optional parameters
623
623
  # @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
624
- # @option opts [String] :file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
624
+ # @option opts [String] :file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
625
625
  # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
626
626
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
627
627
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -644,7 +644,7 @@ module CloudmersiveVirusScanApiClient
644
644
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
645
645
  # @param [Hash] opts the optional parameters
646
646
  # @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
647
- # @option opts [String] :file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
647
+ # @option opts [String] :file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
648
648
  # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
649
649
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
650
650
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -21,11 +21,15 @@ module CloudmersiveVirusScanApiClient
21
21
  # True if the input file contains XML data, false otherwise; this is not a threat signal
22
22
  attr_accessor :contains_xml
23
23
 
24
+ # True if the input file contains an image
25
+ attr_accessor :contains_image
26
+
24
27
  # Attribute mapping from ruby-style variable name to JSON key.
25
28
  def self.attribute_map
26
29
  {
27
30
  :'contains_json' => :'ContainsJSON',
28
- :'contains_xml' => :'ContainsXML'
31
+ :'contains_xml' => :'ContainsXML',
32
+ :'contains_image' => :'ContainsImage'
29
33
  }
30
34
  end
31
35
 
@@ -33,7 +37,8 @@ module CloudmersiveVirusScanApiClient
33
37
  def self.swagger_types
34
38
  {
35
39
  :'contains_json' => :'BOOLEAN',
36
- :'contains_xml' => :'BOOLEAN'
40
+ :'contains_xml' => :'BOOLEAN',
41
+ :'contains_image' => :'BOOLEAN'
37
42
  }
38
43
  end
39
44
 
@@ -52,6 +57,10 @@ module CloudmersiveVirusScanApiClient
52
57
  if attributes.has_key?(:'ContainsXML')
53
58
  self.contains_xml = attributes[:'ContainsXML']
54
59
  end
60
+
61
+ if attributes.has_key?(:'ContainsImage')
62
+ self.contains_image = attributes[:'ContainsImage']
63
+ end
55
64
  end
56
65
 
57
66
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -73,7 +82,8 @@ module CloudmersiveVirusScanApiClient
73
82
  return true if self.equal?(o)
74
83
  self.class == o.class &&
75
84
  contains_json == o.contains_json &&
76
- contains_xml == o.contains_xml
85
+ contains_xml == o.contains_xml &&
86
+ contains_image == o.contains_image
77
87
  end
78
88
 
79
89
  # @see the `==` method
@@ -85,7 +95,7 @@ module CloudmersiveVirusScanApiClient
85
95
  # Calculates hash code according to all attributes.
86
96
  # @return [Fixnum] Hash code
87
97
  def hash
88
- [contains_json, contains_xml].hash
98
+ [contains_json, contains_xml, contains_image].hash
89
99
  end
90
100
 
91
101
  # Builds the object from hash
@@ -51,6 +51,9 @@ module CloudmersiveVirusScanApiClient
51
51
  # Size in bytes of the file that was retrieved and scanned
52
52
  attr_accessor :file_size
53
53
 
54
+ # Contains additional non-threat content verification information
55
+ attr_accessor :content_information
56
+
54
57
  # Attribute mapping from ruby-style variable name to JSON key.
55
58
  def self.attribute_map
56
59
  {
@@ -65,7 +68,8 @@ module CloudmersiveVirusScanApiClient
65
68
  :'verified_file_format' => :'VerifiedFileFormat',
66
69
  :'found_viruses' => :'FoundViruses',
67
70
  :'error_detailed_description' => :'ErrorDetailedDescription',
68
- :'file_size' => :'FileSize'
71
+ :'file_size' => :'FileSize',
72
+ :'content_information' => :'ContentInformation'
69
73
  }
70
74
  end
71
75
 
@@ -83,7 +87,8 @@ module CloudmersiveVirusScanApiClient
83
87
  :'verified_file_format' => :'String',
84
88
  :'found_viruses' => :'Array<CloudStorageVirusFound>',
85
89
  :'error_detailed_description' => :'String',
86
- :'file_size' => :'Integer'
90
+ :'file_size' => :'Integer',
91
+ :'content_information' => :'AdditionalAdvancedScanInformation'
87
92
  }
88
93
  end
89
94
 
@@ -144,6 +149,10 @@ module CloudmersiveVirusScanApiClient
144
149
  if attributes.has_key?(:'FileSize')
145
150
  self.file_size = attributes[:'FileSize']
146
151
  end
152
+
153
+ if attributes.has_key?(:'ContentInformation')
154
+ self.content_information = attributes[:'ContentInformation']
155
+ end
147
156
  end
148
157
 
149
158
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -175,7 +184,8 @@ module CloudmersiveVirusScanApiClient
175
184
  verified_file_format == o.verified_file_format &&
176
185
  found_viruses == o.found_viruses &&
177
186
  error_detailed_description == o.error_detailed_description &&
178
- file_size == o.file_size
187
+ file_size == o.file_size &&
188
+ content_information == o.content_information
179
189
  end
180
190
 
181
191
  # @see the `==` method
@@ -187,7 +197,7 @@ module CloudmersiveVirusScanApiClient
187
197
  # Calculates hash code according to all attributes.
188
198
  # @return [Fixnum] Hash code
189
199
  def hash
190
- [successful, clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, verified_file_format, found_viruses, error_detailed_description, file_size].hash
200
+ [successful, clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, verified_file_format, found_viruses, error_detailed_description, file_size, content_information].hash
191
201
  end
192
202
 
193
203
  # Builds the object from hash
@@ -30,6 +30,9 @@ module CloudmersiveVirusScanApiClient
30
30
  # Size in bytes of the file that was retrieved and scanned
31
31
  attr_accessor :file_size
32
32
 
33
+ # Set to true when using NSFW Content Moderation in the Cloudmersive Storage Protect product (disabled by default)
34
+ attr_accessor :contains_content_moderation_rejection
35
+
33
36
  # Attribute mapping from ruby-style variable name to JSON key.
34
37
  def self.attribute_map
35
38
  {
@@ -37,7 +40,8 @@ module CloudmersiveVirusScanApiClient
37
40
  :'clean_result' => :'CleanResult',
38
41
  :'found_viruses' => :'FoundViruses',
39
42
  :'error_detailed_description' => :'ErrorDetailedDescription',
40
- :'file_size' => :'FileSize'
43
+ :'file_size' => :'FileSize',
44
+ :'contains_content_moderation_rejection' => :'ContainsContentModerationRejection'
41
45
  }
42
46
  end
43
47
 
@@ -48,7 +52,8 @@ module CloudmersiveVirusScanApiClient
48
52
  :'clean_result' => :'BOOLEAN',
49
53
  :'found_viruses' => :'Array<CloudStorageVirusFound>',
50
54
  :'error_detailed_description' => :'String',
51
- :'file_size' => :'Integer'
55
+ :'file_size' => :'Integer',
56
+ :'contains_content_moderation_rejection' => :'BOOLEAN'
52
57
  }
53
58
  end
54
59
 
@@ -81,6 +86,10 @@ module CloudmersiveVirusScanApiClient
81
86
  if attributes.has_key?(:'FileSize')
82
87
  self.file_size = attributes[:'FileSize']
83
88
  end
89
+
90
+ if attributes.has_key?(:'ContainsContentModerationRejection')
91
+ self.contains_content_moderation_rejection = attributes[:'ContainsContentModerationRejection']
92
+ end
84
93
  end
85
94
 
86
95
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -105,7 +114,8 @@ module CloudmersiveVirusScanApiClient
105
114
  clean_result == o.clean_result &&
106
115
  found_viruses == o.found_viruses &&
107
116
  error_detailed_description == o.error_detailed_description &&
108
- file_size == o.file_size
117
+ file_size == o.file_size &&
118
+ contains_content_moderation_rejection == o.contains_content_moderation_rejection
109
119
  end
110
120
 
111
121
  # @see the `==` method
@@ -117,7 +127,7 @@ module CloudmersiveVirusScanApiClient
117
127
  # Calculates hash code according to all attributes.
118
128
  # @return [Fixnum] Hash code
119
129
  def hash
120
- [successful, clean_result, found_viruses, error_detailed_description, file_size].hash
130
+ [successful, clean_result, found_viruses, error_detailed_description, file_size, contains_content_moderation_rejection].hash
121
131
  end
122
132
 
123
133
  # Builds the object from hash
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
11
11
  =end
12
12
 
13
13
  module CloudmersiveVirusScanApiClient
14
- VERSION = '2.0.9'
14
+ VERSION = '2.1.0'
15
15
  end
@@ -46,7 +46,7 @@ describe 'ScanApi' do
46
46
 
47
47
  # unit tests for scan_file_advanced
48
48
  # Advanced Scan a file for viruses
49
- # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
49
+ # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash, MSG, and a wide range of image file formats. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
50
50
  # @param input_file Input file to perform the operation on.
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
@@ -39,7 +39,7 @@ describe 'ScanCloudStorageApi' do
39
39
  # @param secret_key AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
40
40
  # @param bucket_region Name of the region of the S3 bucket, such as &#39;US-East-1&#39;
41
41
  # @param bucket_name Name of the S3 bucket
42
- # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses
42
+ # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
43
43
  # @param [Hash] opts the optional parameters
44
44
  # @return [CloudStorageVirusScanResult]
45
45
  describe 'scan_cloud_storage_scan_aws_s3_file test' do
@@ -55,7 +55,7 @@ describe 'ScanCloudStorageApi' do
55
55
  # @param secret_key AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
56
56
  # @param bucket_region Name of the region of the S3 bucket, such as &#39;US-East-1&#39;
57
57
  # @param bucket_name Name of the S3 bucket
58
- # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses
58
+ # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
59
59
  # @param [Hash] opts the optional parameters
60
60
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
61
61
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -76,7 +76,7 @@ describe 'ScanCloudStorageApi' do
76
76
  # Scan the contents of a single Azure Blob and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
77
77
  # @param connection_string Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.
78
78
  # @param container_name Name of the Blob container within the Azure Blob Storage account
79
- # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
79
+ # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
80
80
  # @param [Hash] opts the optional parameters
81
81
  # @return [CloudStorageVirusScanResult]
82
82
  describe 'scan_cloud_storage_scan_azure_blob test' do
@@ -90,7 +90,7 @@ describe 'ScanCloudStorageApi' do
90
90
  # Advanced Scan the contents of a single Azure Blob and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
91
91
  # @param connection_string Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.
92
92
  # @param container_name Name of the Blob container within the Azure Blob Storage account
93
- # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
93
+ # @param blob_path Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
96
96
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -110,7 +110,7 @@ describe 'ScanCloudStorageApi' do
110
110
  # Scan an Google Cloud Platform (GCP) Storage file for viruses
111
111
  # Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
112
112
  # @param bucket_name Name of the bucket in Google Cloud Storage
113
- # @param object_name Name of the object or file in Google Cloud Storage
113
+ # @param object_name Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
114
114
  # @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
115
115
  # @param [Hash] opts the optional parameters
116
116
  # @return [CloudStorageVirusScanResult]
@@ -124,7 +124,7 @@ describe 'ScanCloudStorageApi' do
124
124
  # Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
125
125
  # Advanced Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.
126
126
  # @param bucket_name Name of the bucket in Google Cloud Storage
127
- # @param object_name Name of the object or file in Google Cloud Storage
127
+ # @param object_name Name of the object or file in Google Cloud Storage. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
128
128
  # @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
129
129
  # @param [Hash] opts the optional parameters
130
130
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
@@ -148,7 +148,7 @@ describe 'ScanCloudStorageApi' do
148
148
  # @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
149
149
  # @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
150
150
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
151
- # @param file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
151
+ # @param file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
152
152
  # @param [Hash] opts the optional parameters
153
153
  # @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
154
154
  # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
@@ -168,7 +168,7 @@ describe 'ScanCloudStorageApi' do
168
168
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
169
169
  # @param [Hash] opts the optional parameters
170
170
  # @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
171
- # @option opts [String] :file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
171
+ # @option opts [String] :file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
172
172
  # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
173
173
  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
174
174
  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
@@ -44,4 +44,10 @@ describe 'AdditionalAdvancedScanInformation' do
44
44
  end
45
45
  end
46
46
 
47
+ describe 'test attribute "contains_image"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
47
53
  end
@@ -104,4 +104,10 @@ describe 'CloudStorageAdvancedVirusScanResult' do
104
104
  end
105
105
  end
106
106
 
107
+ describe 'test attribute "content_information"' do
108
+ it 'should work' do
109
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
+ end
111
+ end
112
+
107
113
  end
@@ -62,4 +62,10 @@ describe 'CloudStorageVirusScanResult' do
62
62
  end
63
63
  end
64
64
 
65
+ describe 'test attribute "contains_content_moderation_rejection"' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
65
71
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cloudmersive-virus-scan-api-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.9
4
+ version: 2.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cloudmersive
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-02 00:00:00.000000000 Z
11
+ date: 2022-05-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus