cloudmersive-convert-api-client 2.0.2 → 2.0.7

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] 
+
+

data/docs/MsgToJpgResult.md

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

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

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::MultiReplaceStringRequest
+
+## 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] 
+**replace_strings** | [**Array<SingleReplaceString>**](SingleReplaceString.md) | An array of individual string replacement requests | [optional] 
+
+

data/docs/MultipageImageFormatConversionResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::MultipageImageFormatConversionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**page_count** | **Integer** | The number of pages in the converted output | [optional] 
+**pages** | [**Array<PageConversionResult>**](PageConversionResult.md) | Converted page results | [optional] 
+
+

data/docs/OdpToJpgResult.md

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::PageConversionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **String** | File name of the image in the converted file format | [optional] 
+**file_bytes** | **String** | File bytes (contents) of the image in converted file format | [optional] 
+
+

data/docs/PdfAnnotation.md

@@ -0,0 +1,19 @@
+# CloudmersiveConvertApiClient::PdfAnnotation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files | [optional] 
+**annotation_type** | **String** | Type of the annotation; possible values are Text | [optional] 
+**page_number** | **Integer** | The 1-based index of the page containing the annotation | [optional] 
+**annotation_index** | **Integer** | The 0-based index of the annotation in the document | [optional] 
+**subject** | **String** | Subject of the annotation | [optional] 
+**text_contents** | **String** | Text contents of the annotation | [optional] 
+**creation_date** | **DateTime** | Date that the annotation was created | [optional] 
+**modified_date** | **DateTime** | Date that the annotation was last modified | [optional] 
+**left_x** | **Float** | Left X coordinate for the location of the annotation | [optional] 
+**top_y** | **Float** | Top Y coordination of the location of the annotation | [optional] 
+**width** | **Float** | Width of the annotation | [optional] 
+**height** | **Float** | Height of the annotation | [optional] 
+
+

data/docs/PdfDocument.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::PdfDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_number** | **Integer** | Page number of the converted page, starting with 1 for the first page | [optional] 
+**url** | **String** | URL to the PDF file of this worksheet; file is stored in an in-memory cache and will be deleted | [optional] 
+**document_contents** | **String** | If returnDocumentContents is set to true, will contain the contents of the document; otherwise will be set to null and the document contents will be available via the URL parameter | [optional] 
+
+

data/docs/PdfFormField.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::PdfFormField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_name** | **String** | Name of the form field | [optional] 
+**field_type** | **String** | The data type of the field; possible values are Text (FieldValue will be a string), Checkbox (FieldValue can be \"true\" or \"false\"), ComboBox (FieldComboBoxSelectedIndex will also be populated), Other | [optional] 
+**field_value** | **String** | Value of the form field | [optional] 
+**field_combo_box_selected_index** | **Integer** | Applies to ComboBox field types only; specifies the selected index of the combo box selection if available | [optional] 
+
+

data/docs/PdfFormFields.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::PdfFormFields
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**form_fields** | [**Array<PdfFormField>**](PdfFormField.md) | Fields and field values found in the form | [optional] 
+
+

data/docs/PdfMetadata.md

@@ -0,0 +1,16 @@
+# CloudmersiveConvertApiClient::PdfMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**title** | **String** | Title of the document | [optional] 
+**keywords** | **String** | Keywords of the document | [optional] 
+**subject** | **String** | Subject of the document | [optional] 
+**author** | **String** | User name of the creator/author of the document, if available, null if not available | [optional] 
+**creator** | **String** | Creator of the document | [optional] 
+**date_modified** | **DateTime** | The timestamp that the document was last modified, if available, null if not available | [optional] 
+**date_created** | **DateTime** | The timestamp that the document was created, if available, null if not available | [optional] 
+**page_count** | **Integer** | The number of pages in the document | [optional] 
+
+

data/docs/PdfPageText.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::PdfPageText
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_number** | **Integer** | Page number of the page (1-based) | [optional] 
+**page_text** | **String** | Text of the page | [optional] 
+
+

data/docs/PdfTextByPageResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::PdfTextByPageResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**pages** | [**Array<PdfPageText>**](PdfPageText.md) | Pages in the PDF | [optional] 
+
+

data/docs/PdfToJpgResult.md

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

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

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

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::PresentationResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**slide_number** | **Integer** | Worksheet number of the converted page, starting with 1 for the left-most worksheet | [optional] 
+**url** | **String** | URL to the PPTX file of this slide; file is stored in an in-memory cache and will be deleted | [optional] 
+**presentation_contents** | **String** | Contents of the presentation in bytes | [optional] 
+
+

data/docs/RemoveDocxHeadersAndFootersRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest
+
+## 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] 
+**remove_headers** | **BOOLEAN** | True if you would like to remove all headers from the input document, false otherwise | [optional] 
+**remove_footers** | **BOOLEAN** | True if you would like to remove all footers from the input document, false otherwise | [optional] 
+
+

data/docs/RemoveDocxHeadersAndFootersResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**edited_document_url** | **String** | URL of the resulting edited document; this is a secure URL and cannot be downloaded without adding the Apikey header; it is also temporary, stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents. | [optional] 
+
+

data/docs/RemoveDocxPagesRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::RemoveDocxPagesRequest
+
+## 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] 
+**start_delete_page_number** | **Integer** | Page number (1-based) to start deleting pages; inclusive | [optional] 
+**end_delete_page_number** | **Integer** | Page number (1-based) to stop deleting pages; inclusive | [optional] 
+
+

data/docs/RemoveHtmlFromTextRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveConvertApiClient::RemoveHtmlFromTextRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_containing_html** | **String** | Input text string to remove the HTML from | [optional] 
+
+

data/docs/RemoveHtmlFromTextResponse.md

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

data/docs/RemovePptxSlidesRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::RemovePptxSlidesRequest
+
+## 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] 
+**start_delete_slide_number** | **Integer** | Slide number (1-based) to start deleting slides; inclusive | [optional] 
+**end_delete_slide_number** | **Integer** | Slide number (1-based) to stop deleting slides; inclusive | [optional] 
+
+

data/docs/RemoveWhitespaceFromTextRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveConvertApiClient::RemoveWhitespaceFromTextRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_containing_whitespace** | **String** | Input text string to remove the whitespace from | [optional] 
+
+

data/docs/RemoveWhitespaceFromTextResponse.md

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

data/docs/RemoveXlsxWorksheetRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest
+
+## 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_remove** | [**XlsxWorksheet**](XlsxWorksheet.md) | Required; Worksheet (tab) within the spreadsheet to delete; leave blank to default to the first worksheet.  Use the Get Worksheets API to enumerate available worksheets in a spreadsheet. | [optional] 
+
+

data/docs/RenameXlsxWorksheetRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::RenameXlsxWorksheetRequest
+
+## 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_rename** | [**XlsxWorksheet**](XlsxWorksheet.md) | Optional; Worksheet (tab) within the spreadsheet to get the specific row from; leave blank to default to the first worksheet | [optional] 
+**new_worksheet_name** | **String** | Required; The new name to be used for the worksheet | [optional] 
+
+

data/docs/RenameXlsxWorksheetResponse.md

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

@@ -0,0 +1,12 @@
+# CloudmersiveConvertApiClient::ReplaceDocxParagraphRequest
+
+## 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] 
+**replacement_image** | [**DocxImage**](DocxImage.md) | Optional: Image to replace the paragraph with; note that most of the fields in this object are optional and do not need to be supplied | [optional] 
+
+

data/docs/ReplaceDocxParagraphResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::ReplaceDocxParagraphResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful; false otherwise | [optional] 
+**edited_document_url** | **String** | URL of the edited document | [optional] 
+
+

data/docs/ReplaceStringRegexRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::ReplaceStringRegexRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_content** | **String** | Input text content | [optional] 
+**regular_expression_string** | **String** | Target input regular expression (regex) string to match and be replaced; supports all regular expression values | [optional] 
+**replace_with_string** | **String** | Replacement for target string; supports referencing indexed regex matched values from RegularExpressionString, such as $1, $2, and so on | [optional] 
+
+