cloudmersive-convert-api-client 2.0.7 → 2.1.3

data/docs/ViewerToolsApi.md

@@ -8,7 +8,7 @@ Method | HTTP request | Description
 
 
 # **viewer_tools_create_simple**
-> ViewerResponse viewer_tools_create_simple(input_file)
+> ViewerResponse viewer_tools_create_simple(input_file, opts)
 
 Create a web-based viewer
 
@@ -30,10 +30,14 @@ api_instance = CloudmersiveConvertApiClient::ViewerToolsApi.new
 
 input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
 
+opts = { 
+  width: 56, # Integer | Optional; width of the output viewer in pixels
+  height: 56 # Integer | Optional; height of the output viewer in pixels
+}
 
 begin
   #Create a web-based viewer
-  result = api_instance.viewer_tools_create_simple(input_file)
+  result = api_instance.viewer_tools_create_simple(input_file, opts)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e
   puts "Exception when calling ViewerToolsApi->viewer_tools_create_simple: #{e}"
@@ -45,6 +49,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **input_file** | **File**| Input file to perform the operation on. | 
+ **width** | **Integer**| Optional; width of the output viewer in pixels | [optional] 
+ **height** | **Integer**| Optional; height of the output viewer in pixels | [optional] 
 
 ### Return type
 

data/docs/ZipArchiveApi.md

@@ -6,6 +6,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_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
@@ -139,6 +140,85 @@ Name | Type | Description  | Notes
 
 
 
+# **zip_archive_zip_create_encrypted**
+> String zip_archive_zip_create_encrypted(password, input_file1, opts)
+
+Compress files to create a new, encrypted and password-protected zip archive
+
+Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.
+
+### 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.
+  input_file2: File.new('/path/to/file.txt'), # File | Second input file to perform the operation on.
+  input_file3: File.new('/path/to/file.txt'), # File | Third input file to perform the operation on.
+  input_file4: File.new('/path/to/file.txt'), # File | Fourth input file to perform the operation on.
+  input_file5: File.new('/path/to/file.txt'), # File | Fifth input file to perform the operation on.
+  input_file6: File.new('/path/to/file.txt'), # File | Sixth input file to perform the operation on.
+  input_file7: File.new('/path/to/file.txt'), # File | Seventh input file to perform the operation on.
+  input_file8: File.new('/path/to/file.txt'), # File | Eighth input file to perform the operation on.
+  input_file9: File.new('/path/to/file.txt'), # File | Ninth input file to perform the operation on.
+  input_file10: File.new('/path/to/file.txt') # File | Tenth input file to perform the operation on.
+}
+
+begin
+  #Compress files to create a new, encrypted and password-protected zip archive
+  result = api_instance.zip_archive_zip_create_encrypted(password, input_file1, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ZipArchiveApi->zip_archive_zip_create_encrypted: #{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] 
+ **input_file2** | **File**| Second input file to perform the operation on. | [optional] 
+ **input_file3** | **File**| Third input file to perform the operation on. | [optional] 
+ **input_file4** | **File**| Fourth input file to perform the operation on. | [optional] 
+ **input_file5** | **File**| Fifth input file to perform the operation on. | [optional] 
+ **input_file6** | **File**| Sixth input file to perform the operation on. | [optional] 
+ **input_file7** | **File**| Seventh input file to perform the operation on. | [optional] 
+ **input_file8** | **File**| Eighth input file to perform the operation on. | [optional] 
+ **input_file9** | **File**| Ninth input file to perform the operation on. | [optional] 
+ **input_file10** | **File**| Tenth input file to perform the operation on. | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/octet-stream
+
+
+
 # **zip_archive_zip_decrypt**
 > Object zip_archive_zip_decrypt(input_file, zip_password)
 

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

@@ -66,12 +66,14 @@ require 'cloudmersive-convert-api-client/models/docx_image'
 require 'cloudmersive-convert-api-client/models/docx_insert_comment_on_paragraph_request'
 require 'cloudmersive-convert-api-client/models/docx_insert_image_request'
 require 'cloudmersive-convert-api-client/models/docx_insert_image_response'
+require 'cloudmersive-convert-api-client/models/docx_metadata_custom_property'
 require 'cloudmersive-convert-api-client/models/docx_page'
 require 'cloudmersive-convert-api-client/models/docx_paragraph'
 require 'cloudmersive-convert-api-client/models/docx_remove_object_request'
 require 'cloudmersive-convert-api-client/models/docx_remove_object_response'
 require 'cloudmersive-convert-api-client/models/docx_run'
 require 'cloudmersive-convert-api-client/models/docx_section'
+require 'cloudmersive-convert-api-client/models/docx_set_custom_metadata_properties_request'
 require 'cloudmersive-convert-api-client/models/docx_set_footer_add_page_number_request'
 require 'cloudmersive-convert-api-client/models/docx_set_footer_request'
 require 'cloudmersive-convert-api-client/models/docx_set_footer_response'
@@ -113,6 +115,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_req
 require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response'
 require 'cloudmersive-convert-api-client/models/get_docx_images_request'
 require 'cloudmersive-convert-api-client/models/get_docx_images_response'
+require 'cloudmersive-convert-api-client/models/get_docx_metadata_properties_response'
 require 'cloudmersive-convert-api-client/models/get_docx_pages_request'
 require 'cloudmersive-convert-api-client/models/get_docx_pages_response'
 require 'cloudmersive-convert-api-client/models/get_docx_sections_request'

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

@@ -77,6 +77,64 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Convert CSV to XML conversion
+    # Convert a CSV file to a XML file
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :column_names_from_first_row Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
+    # @return [String]
+    def convert_data_csv_to_xml(input_file, opts = {})
+      data, _status_code, _headers = convert_data_csv_to_xml_with_http_info(input_file, opts)
+      data
+    end
+
+    # Convert CSV to XML conversion
+    # Convert a CSV file to a XML file
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :column_names_from_first_row Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def convert_data_csv_to_xml_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConvertDataApi.convert_data_csv_to_xml ...'
+      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 ConvertDataApi.convert_data_csv_to_xml"
+      end
+      # resource path
+      local_var_path = '/convert/csv/to/xml'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+      header_params[:'columnNamesFromFirstRow'] = opts[:'column_names_from_first_row'] if !opts[:'column_names_from_first_row'].nil?
+
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConvertDataApi#convert_data_csv_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Convert JSON to XML conversion
     # Convert a JSON object into XML
     # @param json_object Input JSON to convert to XML
@@ -190,7 +248,7 @@ module CloudmersiveConvertApiClient
     # Convert an Excel XLSX file to a JSON object array
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
-    # @return [Object]
+    # @return [String]
     def convert_data_xlsx_to_json(input_file, opts = {})
       data, _status_code, _headers = convert_data_xlsx_to_json_with_http_info(input_file, opts)
       data
@@ -200,7 +258,7 @@ module CloudmersiveConvertApiClient
     # Convert an Excel XLSX file to a JSON object array
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def convert_data_xlsx_to_json_with_http_info(input_file, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConvertDataApi.convert_data_xlsx_to_json ...'
@@ -218,7 +276,7 @@ module CloudmersiveConvertApiClient
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
 
@@ -235,12 +293,67 @@ module CloudmersiveConvertApiClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Object')
+        :return_type => 'String')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ConvertDataApi#convert_data_xlsx_to_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+    # Convert Excel XLSX to XML conversion
+    # Convert an Excel XLSX file to a XML file
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def convert_data_xlsx_to_xml(input_file, opts = {})
+      data, _status_code, _headers = convert_data_xlsx_to_xml_with_http_info(input_file, opts)
+      data
+    end
+
+    # Convert Excel XLSX to XML conversion
+    # Convert an Excel XLSX file to a XML file
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def convert_data_xlsx_to_xml_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConvertDataApi.convert_data_xlsx_to_xml ...'
+      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 ConvertDataApi.convert_data_xlsx_to_xml"
+      end
+      # resource path
+      local_var_path = '/convert/xlsx/to/xml'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConvertDataApi#convert_data_xlsx_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Adds an attribute to all XML nodes matching XPath expression
     # Return the reuslts of editing an XML document by adding an attribute to all of the nodes that match an input XPath expression.
     # @param input_file Input XML file to perform the operation on.

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

@@ -850,6 +850,61 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Convert Word DOCX Document to Legacy Word DOC (97-03)
+    # Convert/downgrade modern Office Word DOCX Documents (DOCX) to the legacy Word DOC (97-2003 Format) format
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def convert_document_docx_to_doc(input_file, opts = {})
+      data, _status_code, _headers = convert_document_docx_to_doc_with_http_info(input_file, opts)
+      data
+    end
+
+    # Convert Word DOCX Document to Legacy Word DOC (97-03)
+    # Convert/downgrade modern Office Word DOCX Documents (DOCX) to the legacy Word DOC (97-2003 Format) format
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def convert_document_docx_to_doc_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConvertDocumentApi.convert_document_docx_to_doc ...'
+      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 ConvertDocumentApi.convert_document_docx_to_doc"
+      end
+      # resource path
+      local_var_path = '/convert/docx/to/doc'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_docx_to_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Convert Word DOCX Document to HTML Document
     # Convert Office Word Document (DOCX) to HTML Document
     # @param input_file Input file to perform the operation on.
@@ -3522,6 +3577,52 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
+    # Convert/downgrade modern Office PowerPoint PPTX Presentation to the legacy PowerPoint PPT (97-2003 Format) format
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def convert_document_pptx_to_ppt(opts = {})
+      data, _status_code, _headers = convert_document_pptx_to_ppt_with_http_info(opts)
+      data
+    end
+
+    # Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
+    # Convert/downgrade modern Office PowerPoint PPTX Presentation to the legacy PowerPoint PPT (97-2003 Format) format
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def convert_document_pptx_to_ppt_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConvertDocumentApi.convert_document_pptx_to_ppt ...'
+      end
+      # resource path
+      local_var_path = '/convert/pptx/to/ppt'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = {}
+
+      # 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 => 'Object')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_pptx_to_ppt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Convert PowerPoint PPTX Presentation to Text (txt)
     # Convert Office PowerPoint Documents (pptx) to standard Text
     # @param input_file Input file to perform the operation on.
@@ -4356,5 +4457,60 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
+    # Convert/downgrade modern Office Excel XLSX Spreadsheet to the legacy Excel XLS (97-2003 Format) format
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def convert_document_xlsx_to_xls(input_file, opts = {})
+      data, _status_code, _headers = convert_document_xlsx_to_xls_with_http_info(input_file, opts)
+      data
+    end
+
+    # Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
+    # Convert/downgrade modern Office Excel XLSX Spreadsheet to the legacy Excel XLS (97-2003 Format) format
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def convert_document_xlsx_to_xls_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConvertDocumentApi.convert_document_xlsx_to_xls ...'
+      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 ConvertDocumentApi.convert_document_xlsx_to_xls"
+      end
+      # resource path
+      local_var_path = '/convert/xlsx/to/xls'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_xlsx_to_xls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end