cloudmersive-convert-api-client 2.0.6 → 2.1.2

data/docs/ReplaceStringRegexResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::ReplaceStringRegexResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**text_content_result** | **String** | Result of performing a base 64 decode operation, binary file content | [optional] 
+
+

data/docs/ReplaceStringRequest.md

@@ -0,0 +1,12 @@
+# CloudmersiveConvertApiClient::ReplaceStringRequest
+
+## 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] 
+**match_string** | **String** | String to search for and match against, to be replaced | [optional] 
+**replace_string** | **String** | String to replace the matched values with | [optional] 
+**match_case** | **BOOLEAN** | True if the case should be matched, false for case insensitive match | [optional] 
+
+

data/docs/ReplaceStringSimpleRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::ReplaceStringSimpleRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_content** | **String** | Input text content | [optional] 
+**target_string** | **String** | Target input string to match and be replaced | [optional] 
+**replace_with_string** | **String** | Replacement for target string | [optional] 
+
+

data/docs/ReplaceStringSimpleResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::ReplaceStringSimpleResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**text_content_result** | **String** | Result of performing a replace string operation | [optional] 
+
+

data/docs/RtfToJpgResult.md

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

data/docs/RtfToPngResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::RtfToPngResult
+
+## 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/ScreenshotRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::ScreenshotRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports. | [optional] 
+**extra_loading_wait** | **Integer** | Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 20000 milliseconds (20 seconds). | [optional] 
+**screenshot_width** | **Integer** | Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024 | [optional] 
+**screenshot_height** | **Integer** | Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot | [optional] 
+
+

data/docs/SetFormFieldValue.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::SetFormFieldValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_name** | **String** | Name of the field to set; you can call /convert/edit/pdf/form/get-fields to enumerate field names in a form | [optional] 
+**text_value** | **String** | For fields of type Text, the text value to put into the field | [optional] 
+**checkbox_value** | **BOOLEAN** | For fields of type Checkbox, the value to put into the field | [optional] 
+**combo_box_selected_index** | **Integer** | For fields of type ComboBox; specifies the selected index of the combo box selection | [optional] 
+
+

data/docs/SetPdfFormFieldsRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::SetPdfFormFieldsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_values** | [**Array<SetFormFieldValue>**](SetFormFieldValue.md) | Field values to set | [optional] 
+**input_file_bytes** | **String** | Contents of the input file to set the fields on | [optional] 
+
+

data/docs/SetPdfMetadataRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::SetPdfMetadataRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file_bytes** | **String** | Input file contents bytes for the file to modify | [optional] 
+**metadata_to_set** | [**PdfMetadata**](PdfMetadata.md) | PDF metadata to set on the file | [optional] 
+
+

data/docs/SetXlsxCellByIdentifierRequest.md

@@ -0,0 +1,12 @@
+# CloudmersiveConvertApiClient::SetXlsxCellByIdentifierRequest
+
+## 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] 
+**worksheet_to_update** | [**XlsxWorksheet**](XlsxWorksheet.md) | Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet | [optional] 
+**cell_identifier** | **String** | The Excel cell identifier (e.g. A1, B2, C33, etc.) of the cell to update | [optional] 
+**cell_value** | [**XlsxSpreadsheetCell**](XlsxSpreadsheetCell.md) | New Cell value to update/overwrite into the Excel XLSX spreadsheet | [optional] 
+
+

data/docs/SetXlsxCellByIdentifierResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::SetXlsxCellByIdentifierResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**edited_document_url** | **String** | URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents. | [optional] 
+
+

data/docs/SetXlsxCellRequest.md

@@ -0,0 +1,13 @@
+# CloudmersiveConvertApiClient::SetXlsxCellRequest
+
+## 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] 
+**worksheet_to_update** | [**XlsxWorksheet**](XlsxWorksheet.md) | Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet | [optional] 
+**row_index** | **Integer** | 0-based index of the row, 0, 1, 2, ... to set | [optional] 
+**cell_index** | **Integer** | 0-based index of the cell, 0, 1, 2, ... in the row to set | [optional] 
+**cell_value** | [**XlsxSpreadsheetCell**](XlsxSpreadsheetCell.md) | New Cell value to update/overwrite into the Excel XLSX spreadsheet | [optional] 
+
+

data/docs/SetXlsxCellResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::SetXlsxCellResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**edited_document_url** | **String** | URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents. | [optional] 
+
+

data/docs/SingleReplaceString.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::SingleReplaceString
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**match_string** | **String** | String to search for and match against, to be replaced | [optional] 
+**replace_string** | **String** | String to replace the matched values with | [optional] 
+**match_case** | **BOOLEAN** | True if the case should be matched, false for case insensitive match | [optional] 
+
+

data/docs/SplitDocumentApi.md

@@ -0,0 +1,361 @@
+# CloudmersiveConvertApiClient::SplitDocumentApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**split_document_docx**](SplitDocumentApi.md#split_document_docx) | **POST** /convert/split/docx | Split a single Word Document DOCX into Separate Documents by Page
+[**split_document_pdf_by_page**](SplitDocumentApi.md#split_document_pdf_by_page) | **POST** /convert/split/pdf | Split a PDF file into separate PDF files, one per page
+[**split_document_pptx**](SplitDocumentApi.md#split_document_pptx) | **POST** /convert/split/pptx | Split a single PowerPoint Presentation PPTX into Separate Slides
+[**split_document_txt_by_line**](SplitDocumentApi.md#split_document_txt_by_line) | **POST** /convert/split/txt/by-line | Split a single Text file (txt) into lines
+[**split_document_txt_by_string**](SplitDocumentApi.md#split_document_txt_by_string) | **POST** /convert/split/txt/by-string | Split a single Text file (txt) by a string delimiter
+[**split_document_xlsx**](SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
+
+
+# **split_document_docx**
+> SplitDocxDocumentResult split_document_docx(input_file, opts)
+
+Split a single Word Document DOCX into Separate Documents by Page
+
+Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.
+
+### 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::SplitDocumentApi.new
+
+input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
+
+opts = { 
+  return_document_contents: true # BOOLEAN | Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document.  Default is true.
+}
+
+begin
+  #Split a single Word Document DOCX into Separate Documents by Page
+  result = api_instance.split_document_docx(input_file, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling SplitDocumentApi->split_document_docx: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+ **return_document_contents** | **BOOLEAN**| Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document.  Default is true. | [optional] 
+
+### Return type
+
+[**SplitDocxDocumentResult**](SplitDocxDocumentResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **split_document_pdf_by_page**
+> SplitPdfResult split_document_pdf_by_page(input_file, opts)
+
+Split a PDF file into separate PDF files, one per page
+
+Split an input PDF file into separate pages, comprised of one PDF file per page.
+
+### 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::SplitDocumentApi.new
+
+input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
+
+opts = { 
+  return_document_contents: true # BOOLEAN | Set to true to directly return all of the document contents in the DocumentContents field; set to false to return contents as temporary URLs (more efficient for large operations).  Default is false.
+}
+
+begin
+  #Split a PDF file into separate PDF files, one per page
+  result = api_instance.split_document_pdf_by_page(input_file, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling SplitDocumentApi->split_document_pdf_by_page: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+ **return_document_contents** | **BOOLEAN**| Set to true to directly return all of the document contents in the DocumentContents field; set to false to return contents as temporary URLs (more efficient for large operations).  Default is false. | [optional] 
+
+### Return type
+
+[**SplitPdfResult**](SplitPdfResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **split_document_pptx**
+> SplitPptxPresentationResult split_document_pptx(input_file, opts)
+
+Split a single PowerPoint Presentation PPTX into Separate Slides
+
+Split an PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentation files, with each containing exactly one slide.
+
+### 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::SplitDocumentApi.new
+
+input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
+
+opts = { 
+  return_document_contents: true # BOOLEAN | Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true.
+}
+
+begin
+  #Split a single PowerPoint Presentation PPTX into Separate Slides
+  result = api_instance.split_document_pptx(input_file, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling SplitDocumentApi->split_document_pptx: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+ **return_document_contents** | **BOOLEAN**| Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true. | [optional] 
+
+### Return type
+
+[**SplitPptxPresentationResult**](SplitPptxPresentationResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **split_document_txt_by_line**
+> SplitTextDocumentByLinesResult split_document_txt_by_line(input_file)
+
+Split a single Text file (txt) into lines
+
+Split a Text (txt) Document by line, returning each line separately in order.  Supports multiple types of newlines.
+
+### 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::SplitDocumentApi.new
+
+input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
+
+
+begin
+  #Split a single Text file (txt) into lines
+  result = api_instance.split_document_txt_by_line(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling SplitDocumentApi->split_document_txt_by_line: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+
+### Return type
+
+[**SplitTextDocumentByLinesResult**](SplitTextDocumentByLinesResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **split_document_txt_by_string**
+> SplitTextDocumentByStringResult split_document_txt_by_string(input_file, split_delimiter, opts)
+
+Split a single Text file (txt) by a string delimiter
+
+Split a Text (txt) Document by a string delimiter, returning each component of the string as an array of strings.
+
+### 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::SplitDocumentApi.new
+
+input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
+
+split_delimiter = 'split_delimiter_example' # String | Required; String to split up the input file on
+
+opts = { 
+  skip_empty_elements: true # BOOLEAN | Optional; If true, empty elements will be skipped in the output
+}
+
+begin
+  #Split a single Text file (txt) by a string delimiter
+  result = api_instance.split_document_txt_by_string(input_file, split_delimiter, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling SplitDocumentApi->split_document_txt_by_string: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+ **split_delimiter** | **String**| Required; String to split up the input file on | 
+ **skip_empty_elements** | **BOOLEAN**| Optional; If true, empty elements will be skipped in the output | [optional] 
+
+### Return type
+
+[**SplitTextDocumentByStringResult**](SplitTextDocumentByStringResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **split_document_xlsx**
+> SplitXlsxWorksheetResult split_document_xlsx(input_file, opts)
+
+Split a single Excel XLSX into Separate Worksheets
+
+Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.
+
+### 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::SplitDocumentApi.new
+
+input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
+
+opts = { 
+  return_document_contents: true # BOOLEAN | Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet.  Default is true.
+}
+
+begin
+  #Split a single Excel XLSX into Separate Worksheets
+  result = api_instance.split_document_xlsx(input_file, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling SplitDocumentApi->split_document_xlsx: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+ **return_document_contents** | **BOOLEAN**| Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet.  Default is true. | [optional] 
+
+### Return type
+
+[**SplitXlsxWorksheetResult**](SplitXlsxWorksheetResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+