cloudmersive-virus-scan-api-client 2.0.8 → 2.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/docs/AdditionalAdvancedScanInformation.md +10 -0
- data/docs/CloudStorageAdvancedVirusScanResult.md +1 -0
- data/docs/CloudStorageVirusScanResult.md +1 -0
- data/docs/ScanApi.md +7 -3
- data/docs/ScanCloudStorageApi.md +32 -16
- data/docs/VirusScanAdvancedResult.md +3 -0
- data/lib/cloudmersive-virus-scan-api-client/api/scan_api.rb +10 -4
- data/lib/cloudmersive-virus-scan-api-client/api/scan_cloud_storage_api.rb +40 -16
- data/lib/cloudmersive-virus-scan-api-client/models/additional_advanced_scan_information.rb +206 -0
- data/lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb +14 -4
- data/lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb +14 -4
- data/lib/cloudmersive-virus-scan-api-client/models/virus_scan_advanced_result.rb +34 -4
- data/lib/cloudmersive-virus-scan-api-client/version.rb +1 -1
- data/lib/cloudmersive-virus-scan-api-client.rb +1 -0
- data/spec/api/scan_api_spec.rb +4 -2
- data/spec/api/scan_cloud_storage_api_spec.rb +16 -8
- data/spec/models/additional_advanced_scan_information_spec.rb +53 -0
- data/spec/models/cloud_storage_advanced_virus_scan_result_spec.rb +6 -0
- data/spec/models/cloud_storage_virus_scan_result_spec.rb +6 -0
- data/spec/models/virus_scan_advanced_result_spec.rb +18 -0
- metadata +5 -2
@@ -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 'US-East-1'
|
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 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
|
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).
|
@@ -116,6 +116,8 @@ module CloudmersiveVirusScanApiClient
|
|
116
116
|
# @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).
|
117
117
|
# @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).
|
118
118
|
# @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).
|
119
|
+
# @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).
|
120
|
+
# @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].
|
119
121
|
# @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.
|
120
122
|
# @return [CloudStorageAdvancedVirusScanResult]
|
121
123
|
def scan_cloud_storage_scan_aws_s3_file_advanced(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
|
@@ -129,7 +131,7 @@ module CloudmersiveVirusScanApiClient
|
|
129
131
|
# @param secret_key AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
|
130
132
|
# @param bucket_region Name of the region of the S3 bucket, such as 'US-East-1'
|
131
133
|
# @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
|
134
|
+
# @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'.
|
133
135
|
# @param [Hash] opts the optional parameters
|
134
136
|
# @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
137
|
# @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).
|
@@ -137,6 +139,8 @@ module CloudmersiveVirusScanApiClient
|
|
137
139
|
# @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).
|
138
140
|
# @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).
|
139
141
|
# @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).
|
142
|
+
# @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).
|
143
|
+
# @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].
|
140
144
|
# @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.
|
141
145
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
142
146
|
def scan_cloud_storage_scan_aws_s3_file_advanced_with_http_info(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
|
@@ -186,6 +190,8 @@ module CloudmersiveVirusScanApiClient
|
|
186
190
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
187
191
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
188
192
|
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
193
|
+
header_params[:'allowInsecureDeserialization'] = opts[:'allow_insecure_deserialization'] if !opts[:'allow_insecure_deserialization'].nil?
|
194
|
+
header_params[:'allowHtml'] = opts[:'allow_html'] if !opts[:'allow_html'].nil?
|
189
195
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
190
196
|
|
191
197
|
# form parameters
|
@@ -210,7 +216,7 @@ module CloudmersiveVirusScanApiClient
|
|
210
216
|
# 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
217
|
# @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
218
|
# @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 'hello.pdf' or '/folder/subfolder/world.pdf'
|
219
|
+
# @param blob_path 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'.
|
214
220
|
# @param [Hash] opts the optional parameters
|
215
221
|
# @return [CloudStorageVirusScanResult]
|
216
222
|
def scan_cloud_storage_scan_azure_blob(connection_string, container_name, blob_path, opts = {})
|
@@ -222,7 +228,7 @@ module CloudmersiveVirusScanApiClient
|
|
222
228
|
# 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
229
|
# @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
230
|
# @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 'hello.pdf' or '/folder/subfolder/world.pdf'
|
231
|
+
# @param blob_path 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'.
|
226
232
|
# @param [Hash] opts the optional parameters
|
227
233
|
# @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
|
228
234
|
def scan_cloud_storage_scan_azure_blob_with_http_info(connection_string, container_name, blob_path, opts = {})
|
@@ -279,7 +285,7 @@ module CloudmersiveVirusScanApiClient
|
|
279
285
|
# 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
286
|
# @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
287
|
# @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 'hello.pdf' or '/folder/subfolder/world.pdf'
|
288
|
+
# @param blob_path 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'.
|
283
289
|
# @param [Hash] opts the optional parameters
|
284
290
|
# @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
291
|
# @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).
|
@@ -287,6 +293,8 @@ module CloudmersiveVirusScanApiClient
|
|
287
293
|
# @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).
|
288
294
|
# @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).
|
289
295
|
# @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).
|
296
|
+
# @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).
|
297
|
+
# @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].
|
290
298
|
# @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.
|
291
299
|
# @return [CloudStorageAdvancedVirusScanResult]
|
292
300
|
def scan_cloud_storage_scan_azure_blob_advanced(connection_string, container_name, blob_path, opts = {})
|
@@ -298,7 +306,7 @@ module CloudmersiveVirusScanApiClient
|
|
298
306
|
# 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
307
|
# @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
308
|
# @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 'hello.pdf' or '/folder/subfolder/world.pdf'
|
309
|
+
# @param blob_path 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'.
|
302
310
|
# @param [Hash] opts the optional parameters
|
303
311
|
# @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
312
|
# @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).
|
@@ -306,6 +314,8 @@ module CloudmersiveVirusScanApiClient
|
|
306
314
|
# @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).
|
307
315
|
# @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).
|
308
316
|
# @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).
|
317
|
+
# @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).
|
318
|
+
# @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].
|
309
319
|
# @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.
|
310
320
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
311
321
|
def scan_cloud_storage_scan_azure_blob_advanced_with_http_info(connection_string, container_name, blob_path, opts = {})
|
@@ -345,6 +355,8 @@ module CloudmersiveVirusScanApiClient
|
|
345
355
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
346
356
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
347
357
|
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
358
|
+
header_params[:'allowInsecureDeserialization'] = opts[:'allow_insecure_deserialization'] if !opts[:'allow_insecure_deserialization'].nil?
|
359
|
+
header_params[:'allowHtml'] = opts[:'allow_html'] if !opts[:'allow_html'].nil?
|
348
360
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
349
361
|
|
350
362
|
# form parameters
|
@@ -368,7 +380,7 @@ module CloudmersiveVirusScanApiClient
|
|
368
380
|
# Scan an Google Cloud Platform (GCP) Storage file for viruses
|
369
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.
|
370
382
|
# @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
|
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 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
|
372
384
|
# @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
|
373
385
|
# @param [Hash] opts the optional parameters
|
374
386
|
# @return [CloudStorageVirusScanResult]
|
@@ -380,7 +392,7 @@ module CloudmersiveVirusScanApiClient
|
|
380
392
|
# Scan an Google Cloud Platform (GCP) Storage file for viruses
|
381
393
|
# 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
394
|
# @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
|
395
|
+
# @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 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
|
384
396
|
# @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
|
385
397
|
# @param [Hash] opts the optional parameters
|
386
398
|
# @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
|
@@ -437,7 +449,7 @@ module CloudmersiveVirusScanApiClient
|
|
437
449
|
# Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
|
438
450
|
# 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
451
|
# @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
|
452
|
+
# @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 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
|
441
453
|
# @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
|
442
454
|
# @param [Hash] opts the optional parameters
|
443
455
|
# @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).
|
@@ -446,6 +458,8 @@ module CloudmersiveVirusScanApiClient
|
|
446
458
|
# @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).
|
447
459
|
# @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).
|
448
460
|
# @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).
|
461
|
+
# @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).
|
462
|
+
# @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].
|
449
463
|
# @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.
|
450
464
|
# @return [CloudStorageAdvancedVirusScanResult]
|
451
465
|
def scan_cloud_storage_scan_gcp_storage_file_advanced(bucket_name, object_name, json_credential_file, opts = {})
|
@@ -456,7 +470,7 @@ module CloudmersiveVirusScanApiClient
|
|
456
470
|
# Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
|
457
471
|
# 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
472
|
# @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
|
473
|
+
# @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 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
|
460
474
|
# @param json_credential_file Service Account credential for Google Cloud stored in a JSON file.
|
461
475
|
# @param [Hash] opts the optional parameters
|
462
476
|
# @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).
|
@@ -465,6 +479,8 @@ module CloudmersiveVirusScanApiClient
|
|
465
479
|
# @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).
|
466
480
|
# @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).
|
467
481
|
# @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).
|
482
|
+
# @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).
|
483
|
+
# @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].
|
468
484
|
# @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.
|
469
485
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
470
486
|
def scan_cloud_storage_scan_gcp_storage_file_advanced_with_http_info(bucket_name, object_name, json_credential_file, opts = {})
|
@@ -503,6 +519,8 @@ module CloudmersiveVirusScanApiClient
|
|
503
519
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
504
520
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
505
521
|
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
522
|
+
header_params[:'allowInsecureDeserialization'] = opts[:'allow_insecure_deserialization'] if !opts[:'allow_insecure_deserialization'].nil?
|
523
|
+
header_params[:'allowHtml'] = opts[:'allow_html'] if !opts[:'allow_html'].nil?
|
506
524
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
507
525
|
|
508
526
|
# form parameters
|
@@ -530,7 +548,7 @@ module CloudmersiveVirusScanApiClient
|
|
530
548
|
# @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
549
|
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
532
550
|
# @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 'hello.pdf' or '/folder/subfolder/world.pdf'
|
551
|
+
# @param file_path 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'.
|
534
552
|
# @param [Hash] opts the optional parameters
|
535
553
|
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
536
554
|
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
@@ -546,7 +564,7 @@ module CloudmersiveVirusScanApiClient
|
|
546
564
|
# @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
565
|
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
548
566
|
# @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 'hello.pdf' or '/folder/subfolder/world.pdf'
|
567
|
+
# @param file_path 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'.
|
550
568
|
# @param [Hash] opts the optional parameters
|
551
569
|
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
552
570
|
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
@@ -621,7 +639,7 @@ module CloudmersiveVirusScanApiClient
|
|
621
639
|
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
622
640
|
# @param [Hash] opts the optional parameters
|
623
641
|
# @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 'hello.pdf' or '/folder/subfolder/world.pdf'
|
642
|
+
# @option opts [String] :file_path 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'.
|
625
643
|
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
626
644
|
# @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
645
|
# @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).
|
@@ -629,6 +647,8 @@ module CloudmersiveVirusScanApiClient
|
|
629
647
|
# @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).
|
630
648
|
# @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).
|
631
649
|
# @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
|
+
# @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).
|
651
|
+
# @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].
|
632
652
|
# @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.
|
633
653
|
# @return [CloudStorageAdvancedVirusScanResult]
|
634
654
|
def scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, opts = {})
|
@@ -644,7 +664,7 @@ module CloudmersiveVirusScanApiClient
|
|
644
664
|
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
645
665
|
# @param [Hash] opts the optional parameters
|
646
666
|
# @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 'hello.pdf' or '/folder/subfolder/world.pdf'
|
667
|
+
# @option opts [String] :file_path 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'.
|
648
668
|
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
649
669
|
# @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
670
|
# @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).
|
@@ -652,6 +672,8 @@ module CloudmersiveVirusScanApiClient
|
|
652
672
|
# @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).
|
653
673
|
# @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).
|
654
674
|
# @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).
|
675
|
+
# @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).
|
676
|
+
# @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].
|
655
677
|
# @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.
|
656
678
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
657
679
|
def scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, opts = {})
|
@@ -699,6 +721,8 @@ module CloudmersiveVirusScanApiClient
|
|
699
721
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
700
722
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
701
723
|
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
724
|
+
header_params[:'allowInsecureDeserialization'] = opts[:'allow_insecure_deserialization'] if !opts[:'allow_insecure_deserialization'].nil?
|
725
|
+
header_params[:'allowHtml'] = opts[:'allow_html'] if !opts[:'allow_html'].nil?
|
702
726
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
703
727
|
|
704
728
|
# form parameters
|
@@ -0,0 +1,206 @@
|
|
1
|
+
=begin
|
2
|
+
#virusapi
|
3
|
+
|
4
|
+
#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.14
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module CloudmersiveVirusScanApiClient
|
16
|
+
# Additional non-threat content verification information
|
17
|
+
class AdditionalAdvancedScanInformation
|
18
|
+
# True if the input file contains JSON data, false otherwise; this is not a threat signal
|
19
|
+
attr_accessor :contains_json
|
20
|
+
|
21
|
+
# True if the input file contains XML data, false otherwise; this is not a threat signal
|
22
|
+
attr_accessor :contains_xml
|
23
|
+
|
24
|
+
# True if the input file contains an image
|
25
|
+
attr_accessor :contains_image
|
26
|
+
|
27
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
28
|
+
def self.attribute_map
|
29
|
+
{
|
30
|
+
:'contains_json' => :'ContainsJSON',
|
31
|
+
:'contains_xml' => :'ContainsXML',
|
32
|
+
:'contains_image' => :'ContainsImage'
|
33
|
+
}
|
34
|
+
end
|
35
|
+
|
36
|
+
# Attribute type mapping.
|
37
|
+
def self.swagger_types
|
38
|
+
{
|
39
|
+
:'contains_json' => :'BOOLEAN',
|
40
|
+
:'contains_xml' => :'BOOLEAN',
|
41
|
+
:'contains_image' => :'BOOLEAN'
|
42
|
+
}
|
43
|
+
end
|
44
|
+
|
45
|
+
# Initializes the object
|
46
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
47
|
+
def initialize(attributes = {})
|
48
|
+
return unless attributes.is_a?(Hash)
|
49
|
+
|
50
|
+
# convert string to symbol for hash key
|
51
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
52
|
+
|
53
|
+
if attributes.has_key?(:'ContainsJSON')
|
54
|
+
self.contains_json = attributes[:'ContainsJSON']
|
55
|
+
end
|
56
|
+
|
57
|
+
if attributes.has_key?(:'ContainsXML')
|
58
|
+
self.contains_xml = attributes[:'ContainsXML']
|
59
|
+
end
|
60
|
+
|
61
|
+
if attributes.has_key?(:'ContainsImage')
|
62
|
+
self.contains_image = attributes[:'ContainsImage']
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
67
|
+
# @return Array for valid properties with the reasons
|
68
|
+
def list_invalid_properties
|
69
|
+
invalid_properties = Array.new
|
70
|
+
invalid_properties
|
71
|
+
end
|
72
|
+
|
73
|
+
# Check to see if the all the properties in the model are valid
|
74
|
+
# @return true if the model is valid
|
75
|
+
def valid?
|
76
|
+
true
|
77
|
+
end
|
78
|
+
|
79
|
+
# Checks equality by comparing each attribute.
|
80
|
+
# @param [Object] Object to be compared
|
81
|
+
def ==(o)
|
82
|
+
return true if self.equal?(o)
|
83
|
+
self.class == o.class &&
|
84
|
+
contains_json == o.contains_json &&
|
85
|
+
contains_xml == o.contains_xml &&
|
86
|
+
contains_image == o.contains_image
|
87
|
+
end
|
88
|
+
|
89
|
+
# @see the `==` method
|
90
|
+
# @param [Object] Object to be compared
|
91
|
+
def eql?(o)
|
92
|
+
self == o
|
93
|
+
end
|
94
|
+
|
95
|
+
# Calculates hash code according to all attributes.
|
96
|
+
# @return [Fixnum] Hash code
|
97
|
+
def hash
|
98
|
+
[contains_json, contains_xml, contains_image].hash
|
99
|
+
end
|
100
|
+
|
101
|
+
# Builds the object from hash
|
102
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
103
|
+
# @return [Object] Returns the model itself
|
104
|
+
def build_from_hash(attributes)
|
105
|
+
return nil unless attributes.is_a?(Hash)
|
106
|
+
self.class.swagger_types.each_pair do |key, type|
|
107
|
+
if type =~ /\AArray<(.*)>/i
|
108
|
+
# check to ensure the input is an array given that the attribute
|
109
|
+
# is documented as an array but the input is not
|
110
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
111
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
112
|
+
end
|
113
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
114
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
115
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
116
|
+
end
|
117
|
+
|
118
|
+
self
|
119
|
+
end
|
120
|
+
|
121
|
+
# Deserializes the data based on type
|
122
|
+
# @param string type Data type
|
123
|
+
# @param string value Value to be deserialized
|
124
|
+
# @return [Object] Deserialized data
|
125
|
+
def _deserialize(type, value)
|
126
|
+
case type.to_sym
|
127
|
+
when :DateTime
|
128
|
+
DateTime.parse(value)
|
129
|
+
when :Date
|
130
|
+
Date.parse(value)
|
131
|
+
when :String
|
132
|
+
value.to_s
|
133
|
+
when :Integer
|
134
|
+
value.to_i
|
135
|
+
when :Float
|
136
|
+
value.to_f
|
137
|
+
when :BOOLEAN
|
138
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
139
|
+
true
|
140
|
+
else
|
141
|
+
false
|
142
|
+
end
|
143
|
+
when :Object
|
144
|
+
# generic object (usually a Hash), return directly
|
145
|
+
value
|
146
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
147
|
+
inner_type = Regexp.last_match[:inner_type]
|
148
|
+
value.map { |v| _deserialize(inner_type, v) }
|
149
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
150
|
+
k_type = Regexp.last_match[:k_type]
|
151
|
+
v_type = Regexp.last_match[:v_type]
|
152
|
+
{}.tap do |hash|
|
153
|
+
value.each do |k, v|
|
154
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
155
|
+
end
|
156
|
+
end
|
157
|
+
else # model
|
158
|
+
temp_model = CloudmersiveVirusScanApiClient.const_get(type).new
|
159
|
+
temp_model.build_from_hash(value)
|
160
|
+
end
|
161
|
+
end
|
162
|
+
|
163
|
+
# Returns the string representation of the object
|
164
|
+
# @return [String] String presentation of the object
|
165
|
+
def to_s
|
166
|
+
to_hash.to_s
|
167
|
+
end
|
168
|
+
|
169
|
+
# to_body is an alias to to_hash (backward compatibility)
|
170
|
+
# @return [Hash] Returns the object in the form of hash
|
171
|
+
def to_body
|
172
|
+
to_hash
|
173
|
+
end
|
174
|
+
|
175
|
+
# Returns the object in the form of hash
|
176
|
+
# @return [Hash] Returns the object in the form of hash
|
177
|
+
def to_hash
|
178
|
+
hash = {}
|
179
|
+
self.class.attribute_map.each_pair do |attr, param|
|
180
|
+
value = self.send(attr)
|
181
|
+
next if value.nil?
|
182
|
+
hash[param] = _to_hash(value)
|
183
|
+
end
|
184
|
+
hash
|
185
|
+
end
|
186
|
+
|
187
|
+
# Outputs non-array value in the form of hash
|
188
|
+
# For object, use to_hash. Otherwise, just return the value
|
189
|
+
# @param [Object] value Any valid value
|
190
|
+
# @return [Hash] Returns the value in the form of hash
|
191
|
+
def _to_hash(value)
|
192
|
+
if value.is_a?(Array)
|
193
|
+
value.compact.map { |v| _to_hash(v) }
|
194
|
+
elsif value.is_a?(Hash)
|
195
|
+
{}.tap do |hash|
|
196
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
197
|
+
end
|
198
|
+
elsif value.respond_to? :to_hash
|
199
|
+
value.to_hash
|
200
|
+
else
|
201
|
+
value
|
202
|
+
end
|
203
|
+
end
|
204
|
+
|
205
|
+
end
|
206
|
+
end
|
data/lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb
CHANGED
@@ -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
|