cloudmersive-virus-scan-api-client 2.0.7 → 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: 3fdcb9abb84157588a2d7ac8fa456d7c5044aefec34b4019313e115714ec0556
4
- data.tar.gz: 341629a0efaf466be326a2e95e39d6117b96a5f92e7524723cc667028f9ab182
3
+ metadata.gz: ac4d1c24e76da44416bb101116e3b537209acc4085b8fbed00737ce8d8772776
4
+ data.tar.gz: fbcd272b8bf047e9b3b9f01ab396e9e3c0eaada5652c6fd3726c35b7db581e61
5
5
  SHA512:
6
- metadata.gz: 9f85f82827d3b6b9114060c760ad402bed18fcee9789906ba7fb6538d6cd532be0a100024c14a0fef03a58c67285642a3d710923d3336744631270985385dd86
7
- data.tar.gz: 559a7cf44416d36b05d563bcd99884ac90656311262c3c9c4c79b7771e74c2d0c9ee5e2a1e50e935a83c5f6edf2cf01b3ea9330270c6bb329588292e2b0d2b56
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.7
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.7.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.7.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.7'
34
+ gem 'cloudmersive-virus-scan-api-client', '~> 2.1.0'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -98,6 +98,7 @@ Class | Method | HTTP request | Description
98
98
 
99
99
  ## Documentation for Models
100
100
 
101
+ - [CloudmersiveVirusScanApiClient::AdditionalAdvancedScanInformation](docs/AdditionalAdvancedScanInformation.md)
101
102
  - [CloudmersiveVirusScanApiClient::CloudStorageAdvancedVirusScanResult](docs/CloudStorageAdvancedVirusScanResult.md)
102
103
  - [CloudmersiveVirusScanApiClient::CloudStorageVirusFound](docs/CloudStorageVirusFound.md)
103
104
  - [CloudmersiveVirusScanApiClient::CloudStorageVirusScanResult](docs/CloudStorageVirusScanResult.md)
@@ -0,0 +1,10 @@
1
+ # CloudmersiveVirusScanApiClient::AdditionalAdvancedScanInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **contains_json** | **BOOLEAN** | True if the input file contains JSON data, false otherwise; this is not a threat signal | [optional]
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]
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
@@ -93,6 +93,8 @@ opts = {
93
93
  allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
94
94
  allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
95
95
  allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
96
+ allow_insecure_deserialization: true, # BOOLEAN | Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
97
+ allow_html: true, # BOOLEAN | Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].
96
98
  restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
97
99
  }
98
100
 
@@ -116,6 +118,8 @@ Name | Type | Description | Notes
116
118
  **allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
117
119
  **allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
118
120
  **allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
121
+ **allow_insecure_deserialization** | **BOOLEAN**| Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
122
+ **allow_html** | **BOOLEAN**| Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability]. | [optional]
119
123
  **restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
120
124
 
121
125
  ### Return type
@@ -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,10 +463,11 @@ 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
- tenant_id: 'tenant_id_example' # String | Optional; Tenant ID of your Azure Active Directory
469
+ tenant_id: 'tenant_id_example', # String | Optional; Tenant ID of your Azure Active Directory
470
+ item_id: 'item_id_example' # String | SharePoint itemID, such as a DriveItem Id
470
471
  }
471
472
 
472
473
  begin
@@ -486,8 +487,9 @@ Name | Type | Description | Notes
486
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 |
487
488
  **sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
488
489
  **site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
489
- **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'. |
490
491
  **tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
492
+ **item_id** | **String**| SharePoint itemID, such as a DriveItem Id | [optional]
491
493
 
492
494
  ### Return type
493
495
 
@@ -505,7 +507,7 @@ Name | Type | Description | Notes
505
507
 
506
508
 
507
509
  # **scan_cloud_storage_scan_share_point_online_file_advanced**
508
- > CloudStorageAdvancedVirusScanResult scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
510
+ > CloudStorageAdvancedVirusScanResult scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, opts)
509
511
 
510
512
  Advanced Virus Scan a file in a SharePoint Online Site Drive
511
513
 
@@ -533,10 +535,10 @@ sharepoint_domain_name = 'sharepoint_domain_name_example' # String | SharePoint
533
535
 
534
536
  site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you wish to retrieve the file from
535
537
 
536
- file_path = 'file_path_example' # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
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'. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
541
+ item_id: 'item_id_example', # String | SharePoint itemID, such as a DriveItem Id
540
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).
541
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).
542
544
  allow_scripts: true, # 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).
@@ -548,7 +550,7 @@ opts = {
548
550
 
549
551
  begin
550
552
  #Advanced Virus Scan a file in a SharePoint Online Site Drive
551
- result = api_instance.scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
553
+ result = api_instance.scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, opts)
552
554
  p result
553
555
  rescue CloudmersiveVirusScanApiClient::ApiError => e
554
556
  puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_share_point_online_file_advanced: #{e}"
@@ -563,8 +565,9 @@ Name | Type | Description | Notes
563
565
  **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 |
564
566
  **sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
565
567
  **site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
566
- **file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
567
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'. 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
+ **item_id** | **String**| SharePoint itemID, such as a DriveItem Id | [optional]
568
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]
569
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]
570
573
  **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]
@@ -11,7 +11,10 @@ Name | Type | Description | Notes
11
11
  **contains_restricted_file_format** | **BOOLEAN** | True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false | [optional]
12
12
  **contains_macros** | **BOOLEAN** | True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor | [optional]
13
13
  **contains_xml_external_entities** | **BOOLEAN** | True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor | [optional]
14
+ **contains_insecure_deserialization** | **BOOLEAN** | True if the uploaded file contains embedded Insecure Deserialization threats of other embedded threats within the document, which can be a significant risk factor | [optional]
15
+ **contains_html** | **BOOLEAN** | True if the uploaded file contains HTML, which can be a significant risk factor | [optional]
14
16
  **verified_file_format** | **String** | For file format verification-supported file formats, the contents-verified file format of the file. Null indicates that the file format is not supported for contents verification. If a Virus or Malware is found, this field will always be set to Null. | [optional]
15
17
  **found_viruses** | [**Array<VirusFound>**](VirusFound.md) | Array of viruses found, if any | [optional]
18
+ **content_information** | [**AdditionalAdvancedScanInformation**](AdditionalAdvancedScanInformation.md) | Contains additional non-threat content verification information | [optional]
16
19
 
17
20
 
@@ -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).
@@ -84,6 +84,8 @@ module CloudmersiveVirusScanApiClient
84
84
  # @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
85
85
  # @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
86
86
  # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
87
+ # @option opts [BOOLEAN] :allow_insecure_deserialization Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
88
+ # @option opts [BOOLEAN] :allow_html Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].
87
89
  # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
88
90
  # @return [VirusScanAdvancedResult]
89
91
  def scan_file_advanced(input_file, opts = {})
@@ -92,7 +94,7 @@ module CloudmersiveVirusScanApiClient
92
94
  end
93
95
 
94
96
  # Advanced Scan a file for viruses
95
- # 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.
96
98
  # @param input_file Input file to perform the operation on.
97
99
  # @param [Hash] opts the optional parameters
98
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).
@@ -101,6 +103,8 @@ module CloudmersiveVirusScanApiClient
101
103
  # @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
102
104
  # @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
103
105
  # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
106
+ # @option opts [BOOLEAN] :allow_insecure_deserialization Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
107
+ # @option opts [BOOLEAN] :allow_html Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].
104
108
  # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
105
109
  # @return [Array<(VirusScanAdvancedResult, Fixnum, Hash)>] VirusScanAdvancedResult data, response status code and response headers
106
110
  def scan_file_advanced_with_http_info(input_file, opts = {})
@@ -129,6 +133,8 @@ module CloudmersiveVirusScanApiClient
129
133
  header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
130
134
  header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
131
135
  header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
136
+ header_params[:'allowInsecureDeserialization'] = opts[:'allow_insecure_deserialization'] if !opts[:'allow_insecure_deserialization'].nil?
137
+ header_params[:'allowHtml'] = opts[:'allow_html'] if !opts[:'allow_html'].nil?
132
138
  header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
133
139
 
134
140
  # form parameters
@@ -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 &#39;US-East-1&#39;
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 &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
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 &#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 [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,9 +530,10 @@ 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
+ # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
536
537
  # @return [CloudStorageVirusScanResult]
537
538
  def scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
538
539
  data, _status_code, _headers = scan_cloud_storage_scan_share_point_online_file_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
@@ -545,9 +546,10 @@ module CloudmersiveVirusScanApiClient
545
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
546
547
  # @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
547
548
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
548
- # @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;.
549
550
  # @param [Hash] opts the optional parameters
550
551
  # @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
552
+ # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
551
553
  # @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
552
554
  def scan_cloud_storage_scan_share_point_online_file_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
553
555
  if @api_client.config.debugging
@@ -591,6 +593,7 @@ module CloudmersiveVirusScanApiClient
591
593
  header_params[:'siteID'] = site_id
592
594
  header_params[:'filePath'] = file_path
593
595
  header_params[:'tenantID'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
596
+ header_params[:'itemID'] = opts[:'item_id'] if !opts[:'item_id'].nil?
594
597
 
595
598
  # form parameters
596
599
  form_params = {}
@@ -616,9 +619,10 @@ module CloudmersiveVirusScanApiClient
616
619
  # @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
617
620
  # @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
618
621
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
619
- # @param file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
620
622
  # @param [Hash] opts the optional parameters
621
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;. 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
+ # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
622
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).
623
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).
624
628
  # @option opts [BOOLEAN] :allow_scripts 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).
@@ -627,8 +631,8 @@ module CloudmersiveVirusScanApiClient
627
631
  # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
628
632
  # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
629
633
  # @return [CloudStorageAdvancedVirusScanResult]
630
- def scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
631
- data, _status_code, _headers = scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
634
+ def scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, opts = {})
635
+ data, _status_code, _headers = scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, opts)
632
636
  data
633
637
  end
634
638
 
@@ -638,9 +642,10 @@ module CloudmersiveVirusScanApiClient
638
642
  # @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
639
643
  # @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
640
644
  # @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
641
- # @param file_path Path to the file within the drive, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
642
645
  # @param [Hash] opts the optional parameters
643
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;. 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
+ # @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
644
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).
645
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).
646
651
  # @option opts [BOOLEAN] :allow_scripts 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).
@@ -649,7 +654,7 @@ module CloudmersiveVirusScanApiClient
649
654
  # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
650
655
  # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
651
656
  # @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
652
- def scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
657
+ def scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, opts = {})
653
658
  if @api_client.config.debugging
654
659
  @api_client.config.logger.debug 'Calling API: ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced ...'
655
660
  end
@@ -669,10 +674,6 @@ module CloudmersiveVirusScanApiClient
669
674
  if @api_client.config.client_side_validation && site_id.nil?
670
675
  fail ArgumentError, "Missing the required parameter 'site_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
671
676
  end
672
- # verify the required parameter 'file_path' is set
673
- if @api_client.config.client_side_validation && file_path.nil?
674
- fail ArgumentError, "Missing the required parameter 'file_path' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
675
- end
676
677
  # resource path
677
678
  local_var_path = '/virus/scan/cloud-storage/sharepoint-online/site/advanced'
678
679
 
@@ -689,8 +690,9 @@ module CloudmersiveVirusScanApiClient
689
690
  header_params[:'clientSecret'] = client_secret
690
691
  header_params[:'sharepointDomainName'] = sharepoint_domain_name
691
692
  header_params[:'siteID'] = site_id
692
- header_params[:'filePath'] = file_path
693
693
  header_params[:'tenantID'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
694
+ header_params[:'filePath'] = opts[:'file_path'] if !opts[:'file_path'].nil?
695
+ header_params[:'itemID'] = opts[:'item_id'] if !opts[:'item_id'].nil?
694
696
  header_params[:'allowExecutables'] = opts[:'allow_executables'] if !opts[:'allow_executables'].nil?
695
697
  header_params[:'allowInvalidFiles'] = opts[:'allow_invalid_files'] if !opts[:'allow_invalid_files'].nil?
696
698
  header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?