cloudmersive-convert-api-client 1.7.2 → 1.7.7

data/docs/CsvCollection.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::CsvCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**csv_files** | [**Array<CsvFileResult>**](CsvFileResult.md) | Array of CSV File results | [optional] 
+**file_count** | **Integer** | Count of the number of CSV files produced | [optional] 
+
+

data/docs/CsvFileResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::CsvFileResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Title of the CSV file | [optional] 
+**file_contents** | **String** | Contents of the CSV file | [optional] 
+
+

data/docs/DocumentValidationResult.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **document_is_valid** | **BOOLEAN** | True if the document is valid and has no errors, false otherwise | [optional] 
+**password_protected** | **BOOLEAN** | True if the document is password protected, false otherwise | [optional] 
 **error_count** | **Integer** | Number of validation errors found in the document | [optional] 
 **warning_count** | **Integer** | Number of validation warnings found in the document | [optional] 
 **errors_and_warnings** | [**Array<DocumentValidationError>**](DocumentValidationError.md) | Details of errors and warnings found | [optional] 

data/docs/DocxParagraph.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **paragraph_index** | **Integer** | The index of the paragraph; 0-based | [optional] 
-**path** | **String** | The Path of the location of this object; leave blank for new tables | [optional] 
+**path** | **String** | The Path of the location of this Paragraph object; leave blank during creation | [optional] 
 **content_runs** | [**Array<DocxRun>**](DocxRun.md) | The content runs in the paragraph - this is where text is stored; similar to a span in HTML | [optional] 
 **style_id** | **String** | Style ID of the style applied to the paragraph; null if no style is applied | [optional] 
 

data/docs/DocxRun.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **run_index** | **Integer** | Index of the run, 0-based | [optional] 
-**path** | **String** | The Path of the location of this object; leave blank for new tables | [optional] 
+**path** | **String** | The Path of the location of this Run object; leave blank for creation | [optional] 
 **text_items** | [**Array<DocxText>**](DocxText.md) | Text items inside the run; this is where the actual text content is stored | [optional] 
 **bold** | **BOOLEAN** | True to make the text bold, false otherwise | [optional] 
 **italic** | **BOOLEAN** | True to make the text italic, false otherwise | [optional] 

data/docs/DocxText.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **text_index** | **Integer** | Index of the text content in the run; 0-based | [optional] 
-**path** | **String** | The Path of the location of this object; leave blank for new tables | [optional] 
+**path** | **String** | The Path of the location of this Text object; leave blank for creation | [optional] 
 **text_content** | **String** | Text string containing the text content of this text content item | [optional] 
 
 

data/docs/DocxToPngResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::DocxToPngResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**png_result_pages** | [**Array<ConvertedPngPage>**](ConvertedPngPage.md) | Array of converted pages | [optional] 
+
+

data/docs/EditDocumentApi.md

@@ -10,6 +10,7 @@ Method | HTTP request | Description
 [**edit_document_docx_delete_pages**](EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
 [**edit_document_docx_delete_table_row**](EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
 [**edit_document_docx_delete_table_row_range**](EditDocumentApi.md#edit_document_docx_delete_table_row_range) | **POST** /convert/edit/docx/delete-table-row/range | Deletes a range of multiple table rows in an existing table in a Word DOCX document
+[**edit_document_docx_find_paragraph**](EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
 [**edit_document_docx_get_comments**](EditDocumentApi.md#edit_document_docx_get_comments) | **POST** /convert/edit/docx/get-comments/flat-list | Get comments from a Word DOCX document as a flat list
 [**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
 [**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
@@ -28,6 +29,7 @@ Method | HTTP request | Description
 [**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
 [**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
 [**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
+[**edit_document_docx_replace_paragraph**](EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
 [**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
 [**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
 [**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
@@ -378,6 +380,60 @@ Name | Type | Description  | Notes
 
 
 
+# **edit_document_docx_find_paragraph**
+> FindDocxParagraphResponse edit_document_docx_find_paragraph(req_config)
+
+Find matching paragraphs in a Word DOCX document
+
+Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
+
+### 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::EditDocumentApi.new
+
+req_config = CloudmersiveConvertApiClient::FindDocxParagraphRequest.new # FindDocxParagraphRequest | Document input request
+
+
+begin
+  #Find matching paragraphs in a Word DOCX document
+  result = api_instance.edit_document_docx_find_paragraph(req_config)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling EditDocumentApi->edit_document_docx_find_paragraph: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req_config** | [**FindDocxParagraphRequest**](FindDocxParagraphRequest.md)| Document input request | 
+
+### Return type
+
+[**FindDocxParagraphResponse**](FindDocxParagraphResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **edit_document_docx_get_comments**
 > GetDocxCommentsResponse edit_document_docx_get_comments(req_config)
 
@@ -1350,6 +1406,60 @@ Name | Type | Description  | Notes
 
 
 
+# **edit_document_docx_replace_paragraph**
+> ReplaceDocxParagraphResponse edit_document_docx_replace_paragraph(req_config)
+
+Replace matching paragraphs in a Word DOCX document
+
+Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested.  Replace a paragraph with another object such as an image.  Useful for performing templating operations.
+
+### 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::EditDocumentApi.new
+
+req_config = CloudmersiveConvertApiClient::ReplaceDocxParagraphRequest.new # ReplaceDocxParagraphRequest | Document input request
+
+
+begin
+  #Replace matching paragraphs in a Word DOCX document
+  result = api_instance.edit_document_docx_replace_paragraph(req_config)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling EditDocumentApi->edit_document_docx_replace_paragraph: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req_config** | [**ReplaceDocxParagraphRequest**](ReplaceDocxParagraphRequest.md)| Document input request | 
+
+### Return type
+
+[**ReplaceDocxParagraphResponse**](ReplaceDocxParagraphResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **edit_document_docx_set_footer**
 > DocxSetFooterResponse edit_document_docx_set_footer(req_config)
 

data/docs/EditPdfApi.md

@@ -420,7 +420,7 @@ Name | Type | Description  | Notes
 
 
 # **edit_pdf_get_pdf_text_by_pages**
-> PdfTextByPageResult edit_pdf_get_pdf_text_by_pages(input_file)
+> PdfTextByPageResult edit_pdf_get_pdf_text_by_pages(input_file, opts)
 
 Get text in a PDF document by page
 
@@ -442,10 +442,13 @@ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
 
 input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
 
+opts = { 
+  text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
+}
 
 begin
   #Get text in a PDF document by page
-  result = api_instance.edit_pdf_get_pdf_text_by_pages(input_file)
+  result = api_instance.edit_pdf_get_pdf_text_by_pages(input_file, opts)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e
   puts "Exception when calling EditPdfApi->edit_pdf_get_pdf_text_by_pages: #{e}"
@@ -457,6 +460,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **input_file** | **File**| Input file to perform the operation on. | 
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'. | [optional] 
 
 ### Return type
 

data/docs/EmlAttachment.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::EmlAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the attachment, including file extension | [optional] 
+**content** | **String** | The EML attachment as a byte[] | [optional] 
+
+

data/docs/EmlToHtmlResult.md

@@ -0,0 +1,18 @@
+# CloudmersiveConvertApiClient::EmlToHtmlResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**content** | **String** | An HTML string version of the EML file | [optional] 
+**body** | **String** | The main body of the EML file's email as an HTML string | [optional] 
+**from** | **String** | The From sender of the EML file's email | [optional] 
+**to** | **String** | The To recipients of the EML file's email | [optional] 
+**cc** | **String** | The CC recipients of the EML file's email | [optional] 
+**bcc** | **String** | The BCC recipients of the EML file's email | [optional] 
+**received_time** | **String** | The time that the EML file's email was received | [optional] 
+**subject** | **String** | The subject of the EML file's email | [optional] 
+**organization** | **String** | The Organization of the EML file's email | [optional] 
+**attachments** | [**Array<EmlAttachment>**](EmlAttachment.md) | List of all attachments for the EML file | [optional] 
+
+

data/docs/FindDocxParagraphRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::FindDocxParagraphRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional] 
+**input_file_url** | **String** | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional] 
+**find_string** | **String** | Required: The target string to search for in the paragraphs of the document | [optional] 
+**match_case** | **BOOLEAN** | Optional: True to match case, false to ignore case when matching | [optional] 
+
+

data/docs/FindDocxParagraphResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindDocxParagraphResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful; false otherwise | [optional] 
+**matching_paragraphs** | [**Array<DocxParagraph>**](DocxParagraph.md) | Matching paragraphs | [optional] 
+**count** | **Integer** | Count of matching paragraphs | [optional] 
+
+

data/docs/GetDocxPagesRequest.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional] 
 **input_file_url** | **String** | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional] 
+**maximum_pages** | **Integer** | Optional: Maximum number of pages to return; set to 0 or do not supply to return all pages | [optional] 
 
 

data/docs/GetFileTypeIconResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetFileTypeIconResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**icon** | **String** | PNG icon as a byte array | [optional] 
+**extension** | **String** | Extension used for the icon | [optional] 
+
+

data/docs/MergeDocumentApi.md

@@ -8,7 +8,8 @@ Method | HTTP request | Description
 [**merge_document_docx_multi**](MergeDocumentApi.md#merge_document_docx_multi) | **POST** /convert/merge/docx/multi | Merge Multple Word DOCX Together
 [**merge_document_pdf**](MergeDocumentApi.md#merge_document_pdf) | **POST** /convert/merge/pdf | Merge Two PDF Files Together
 [**merge_document_pdf_multi**](MergeDocumentApi.md#merge_document_pdf_multi) | **POST** /convert/merge/pdf/multi | Merge Multple PDF Files Together
-[**merge_document_png**](MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Multple PNG Files Together
+[**merge_document_png**](MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Two PNG Files Together
+[**merge_document_png_multi**](MergeDocumentApi.md#merge_document_png_multi) | **POST** /convert/merge/png/vertical/multi | Merge Multple PNG Files Together
 [**merge_document_pptx**](MergeDocumentApi.md#merge_document_pptx) | **POST** /convert/merge/pptx | Merge Two PowerPoint PPTX Together
 [**merge_document_pptx_multi**](MergeDocumentApi.md#merge_document_pptx_multi) | **POST** /convert/merge/pptx/multi | Merge Multple PowerPoint PPTX Together
 [**merge_document_txt**](MergeDocumentApi.md#merge_document_txt) | **POST** /convert/merge/txt | Merge Two Text (TXT) Files Together
@@ -284,9 +285,9 @@ Name | Type | Description  | Notes
 # **merge_document_png**
 > String merge_document_png(input_file1, input_file2)
 
-Merge Multple PNG Files Together
+Merge Two PNG Files Together
 
-Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically
+Combine two PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically
 
 ### Example
 ```ruby
@@ -308,7 +309,7 @@ input_file2 = File.new("/path/to/file.txt") # File | Second input file to perfor
 
 
 begin
-  #Merge Multple PNG Files Together
+  #Merge Two PNG Files Together
   result = api_instance.merge_document_png(input_file1, input_file2)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e
@@ -338,6 +339,81 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_document_png_multi**
+> String merge_document_png_multi(input_file1, input_file2, opts)
+
+Merge Multple PNG Files Together
+
+Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically
+
+### 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::MergeDocumentApi.new
+
+input_file1 = File.new("/path/to/file.txt") # File | First input file to perform the operation on.
+
+input_file2 = File.new("/path/to/file.txt") # File | Second input file to perform the operation on.
+
+opts = { 
+  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
+  #Merge Multple PNG Files Together
+  result = api_instance.merge_document_png_multi(input_file1, input_file2, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling MergeDocumentApi->merge_document_png_multi: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file1** | **File**| First input file to perform the operation on. | 
+ **input_file2** | **File**| Second input file to perform the operation on. | 
+ **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
+
+
+
 # **merge_document_pptx**
 > String merge_document_pptx(input_file1, input_file2)
 

data/docs/MsgAttachment.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::MsgAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the attachment, including file extension | [optional] 
+**content** | **String** | The MSG attachment as a byte[] | [optional] 
+
+

data/docs/MsgToHtmlResult.md

@@ -0,0 +1,16 @@
+# CloudmersiveConvertApiClient::MsgToHtmlResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**content** | **String** | An HTML string version of the MSG file | [optional] 
+**body** | **String** | The main body of the MSG file's email as an HTML string | [optional] 
+**from** | **String** | The From sender of the MSG file's email | [optional] 
+**to** | **String** | The To recipients of the MSG file's email | [optional] 
+**cc** | **String** | The CC recipients of the MSG file's email | [optional] 
+**received_time** | **String** | The time that the MSG file's email was received | [optional] 
+**subject** | **String** | The subject of the MSG file's email | [optional] 
+**attachments** | [**Array<MsgAttachment>**](MsgAttachment.md) | List of all attachments for the MSG file | [optional] 
+
+