cloudmersive-convert-api-client 2.1.5 → 2.2.0

data/docs/EditPdfApi.md

@@ -714,7 +714,7 @@ Name | Type | Description  | Notes
 
 
 # **edit_pdf_reduce_file_size**
-> String edit_pdf_reduce_file_size(input_file)
+> String edit_pdf_reduce_file_size(input_file, opts)
 
 Reduce the file size and optimize a PDF
 
@@ -736,10 +736,13 @@ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
 
 input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
 
+opts = { 
+  quality: 8.14 # Float | Quality level for the images in the PDF, ranging from 0.0 (low quality) to 1.0 (high quality); default is 0.3
+}
 
 begin
   #Reduce the file size and optimize a PDF
-  result = api_instance.edit_pdf_reduce_file_size(input_file)
+  result = api_instance.edit_pdf_reduce_file_size(input_file, opts)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e
   puts "Exception when calling EditPdfApi->edit_pdf_reduce_file_size: #{e}"
@@ -751,6 +754,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **input_file** | **File**| Input file to perform the operation on. | 
+ **quality** | **Float**| Quality level for the images in the PDF, ranging from 0.0 (low quality) to 1.0 (high quality); default is 0.3 | [optional] 
 
 ### Return type
 

data/docs/GetMacrosResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetMacrosResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**contains_vba_macros** | **BOOLEAN** | True if the document contains VBA macros, false otherwise | [optional] 
+
+

data/docs/HtmlGetLanguageResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlGetLanguageResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**language_code** | **String** | HTML language code of the HTML document, e.g. \"en\" or \"de\" | [optional] 
+
+

data/docs/HtmlGetRelCanonicalUrlResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**canonical_url** | **String** | HTML canonical URL if present | [optional] 
+
+

data/docs/HtmlGetSitemapUrlResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::HtmlGetSitemapUrlResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**canonical_url** | **String** | HTML sitemap URL if present | [optional] 
+
+

data/docs/MergeDocumentApi.md

@@ -153,7 +153,7 @@ Name | Type | Description  | Notes
 
 
 # **merge_document_html**
-> Object merge_document_html(input_file1, input_file2)
+> String merge_document_html(input_file1, input_file2)
 
 Merge Two HTML (HTM) Files Together
 
@@ -196,7 +196,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-**Object**
+**String**
 
 ### Authorization
 

data/docs/ValidateDocumentApi.md

@@ -24,6 +24,7 @@ Method | HTTP request | Description
 [**validate_document_txt_validation**](ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
 [**validate_document_xlsx_validation**](ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
 [**validate_document_xml_validation**](ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
+[**validate_document_xml_xxe_threat_validation**](ValidateDocumentApi.md#validate_document_xml_xxe_threat_validation) | **POST** /convert/validate/xml/xxe-threats | Validate an XML file for XML External Entity (XXE) threats
 [**validate_document_zip_validation**](ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
 
 
@@ -1107,6 +1108,60 @@ Name | Type | Description  | Notes
 
 
 
+# **validate_document_xml_xxe_threat_validation**
+> XxeThreatDetectionResult validate_document_xml_xxe_threat_validation(input_file)
+
+Validate an XML file for XML External Entity (XXE) threats
+
+Validate an XML document file for XML External Entity (XXE) threats; if the document is not valid, identifies the errors in the document.  XXE threats are a type of threat that exploits vulnerabilities in the XML standard relating to external or local entity URIs in XML documents.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-convert-api-client'
+# setup authorization
+CloudmersiveConvertApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
+
+input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
+
+
+begin
+  #Validate an XML file for XML External Entity (XXE) threats
+  result = api_instance.validate_document_xml_xxe_threat_validation(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ValidateDocumentApi->validate_document_xml_xxe_threat_validation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+
+### Return type
+
+[**XxeThreatDetectionResult**](XxeThreatDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **validate_document_zip_validation**
 > DocumentValidationResult validate_document_zip_validation(input_file)
 

data/docs/XxeThreatDetectionResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::XxeThreatDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contains_xxe_threat** | **BOOLEAN** | True if the XML input contains XXE threats, false otherwise | [optional] 
+
+

data/docs/ZipArchiveApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**zip_archive_zip_create**](ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
 [**zip_archive_zip_create_advanced**](ZipArchiveApi.md#zip_archive_zip_create_advanced) | **POST** /convert/archive/zip/create/advanced | Compress files and folders to create a new zip archive with advanced options
 [**zip_archive_zip_create_encrypted**](ZipArchiveApi.md#zip_archive_zip_create_encrypted) | **POST** /convert/archive/zip/create/encrypted | Compress files to create a new, encrypted and password-protected zip archive
+[**zip_archive_zip_create_quarantine**](ZipArchiveApi.md#zip_archive_zip_create_quarantine) | **POST** /convert/archive/zip/create/quarantine | Create an encrypted zip file to quarantine a dangerous file
 [**zip_archive_zip_decrypt**](ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
 [**zip_archive_zip_encrypt_advanced**](ZipArchiveApi.md#zip_archive_zip_encrypt_advanced) | **POST** /convert/archive/zip/encrypt/advanced | Encrypt and password protect a zip file
 [**zip_archive_zip_extract**](ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
@@ -219,6 +220,67 @@ Name | Type | Description  | Notes
 
 
 
+# **zip_archive_zip_create_quarantine**
+> Object zip_archive_zip_create_quarantine(password, input_file1, opts)
+
+Create an encrypted zip file to quarantine a dangerous file
+
+Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip, for the purposes of quarantining the underlyikng file.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-convert-api-client'
+# setup authorization
+CloudmersiveConvertApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
+
+password = 'password_example' # String | Password to place on the Zip file; the longer the password, the more secure
+
+input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
+
+opts = { 
+  encryption_algorithm: 'encryption_algorithm_example' # String | Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
+}
+
+begin
+  #Create an encrypted zip file to quarantine a dangerous file
+  result = api_instance.zip_archive_zip_create_quarantine(password, input_file1, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ZipArchiveApi->zip_archive_zip_create_quarantine: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **password** | **String**| Password to place on the Zip file; the longer the password, the more secure | 
+ **input_file1** | **File**| First input file to perform the operation on. | 
+ **encryption_algorithm** | **String**| Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256. | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream
+
+
+
 # **zip_archive_zip_decrypt**
 > Object zip_archive_zip_decrypt(input_file, zip_password)
 

data/lib/cloudmersive-convert-api-client.rb

@@ -130,6 +130,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_tables_request'
 require 'cloudmersive-convert-api-client/models/get_docx_tables_response'
 require 'cloudmersive-convert-api-client/models/get_file_type_icon_result'
 require 'cloudmersive-convert-api-client/models/get_image_info_result'
+require 'cloudmersive-convert-api-client/models/get_macros_response'
 require 'cloudmersive-convert-api-client/models/get_pdf_annotations_result'
 require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request'
 require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_response'
@@ -147,7 +148,10 @@ require 'cloudmersive-convert-api-client/models/get_xlsx_styles_request'
 require 'cloudmersive-convert-api-client/models/get_xlsx_styles_response'
 require 'cloudmersive-convert-api-client/models/get_xlsx_worksheets_request'
 require 'cloudmersive-convert-api-client/models/get_xlsx_worksheets_response'
+require 'cloudmersive-convert-api-client/models/html_get_language_result'
 require 'cloudmersive-convert-api-client/models/html_get_links_response'
+require 'cloudmersive-convert-api-client/models/html_get_rel_canonical_url_result'
+require 'cloudmersive-convert-api-client/models/html_get_sitemap_url_result'
 require 'cloudmersive-convert-api-client/models/html_hyperlink'
 require 'cloudmersive-convert-api-client/models/html_md_result'
 require 'cloudmersive-convert-api-client/models/html_ssrf_threat_check_result'
@@ -260,6 +264,7 @@ require 'cloudmersive-convert-api-client/models/xml_remove_all_children_with_x_p
 require 'cloudmersive-convert-api-client/models/xml_remove_with_x_path_result'
 require 'cloudmersive-convert-api-client/models/xml_replace_with_x_path_result'
 require 'cloudmersive-convert-api-client/models/xml_set_value_with_x_path_result'
+require 'cloudmersive-convert-api-client/models/xxe_threat_detection_result'
 require 'cloudmersive-convert-api-client/models/zip_directory'
 require 'cloudmersive-convert-api-client/models/zip_encryption_advanced_request'
 require 'cloudmersive-convert-api-client/models/zip_extract_response'

data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb

@@ -779,6 +779,61 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Get macro information from a Word DOCX/DOCM document
+    # Returns information about the Macros (e.g. VBA) defined in the Word Document
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [GetMacrosResponse]
+    def edit_document_docx_get_macro_information(input_file, opts = {})
+      data, _status_code, _headers = edit_document_docx_get_macro_information_with_http_info(input_file, opts)
+      data
+    end
+
+    # Get macro information from a Word DOCX/DOCM document
+    # Returns information about the Macros (e.g. VBA) defined in the Word Document
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
+    def edit_document_docx_get_macro_information_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_macro_information ...'
+      end
+      # verify the required parameter 'input_file' is set
+      if @api_client.config.client_side_validation && input_file.nil?
+        fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_macro_information"
+      end
+      # resource path
+      local_var_path = '/convert/edit/docx/get-macros'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['inputFile'] = input_file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetMacrosResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get all metadata properties in Word DOCX document
     # Returns all the metadata properties in an Office Word Document (docx)
     # @param input_file Input file to perform the operation on.
@@ -2185,6 +2240,61 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Get macro information from a PowerPoint PPTX/PPTM presentation document
+    # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [GetMacrosResponse]
+    def edit_document_pptx_get_macro_information(input_file, opts = {})
+      data, _status_code, _headers = edit_document_pptx_get_macro_information_with_http_info(input_file, opts)
+      data
+    end
+
+    # Get macro information from a PowerPoint PPTX/PPTM presentation document
+    # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
+    def edit_document_pptx_get_macro_information_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_get_macro_information ...'
+      end
+      # verify the required parameter 'input_file' is set
+      if @api_client.config.client_side_validation && input_file.nil?
+        fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_pptx_get_macro_information"
+      end
+      # resource path
+      local_var_path = '/convert/edit/pptx/get-macros'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['inputFile'] = input_file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetMacrosResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_pptx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Replace string in PowerPoint PPTX presentation
     # Replace all instances of a string in an Office PowerPoint Document (pptx)
     # @param req_config Replacement document configuration input
@@ -2887,6 +2997,61 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
+    # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [GetMacrosResponse]
+    def edit_document_xlsx_get_macro_information(input_file, opts = {})
+      data, _status_code, _headers = edit_document_xlsx_get_macro_information_with_http_info(input_file, opts)
+      data
+    end
+
+    # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
+    # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
+    def edit_document_xlsx_get_macro_information_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_macro_information ...'
+      end
+      # verify the required parameter 'input_file' is set
+      if @api_client.config.client_side_validation && input_file.nil?
+        fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_xlsx_get_macro_information"
+      end
+      # resource path
+      local_var_path = '/convert/edit/xlsx/get-macros'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['inputFile'] = input_file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetMacrosResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_xlsx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get rows and cells from a Excel XLSX spreadsheet, worksheet
     # Returns the rows and cells defined in the Excel Spreadsheet worksheet
     # @param input Document input request