cloudmersive-convert-api-client 1.7.8 → 2.0.5

data/docs/MsgAttachment.md

@@ -1,9 +0,0 @@
-# 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

@@ -1,16 +0,0 @@
-# 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/MultipageImageFormatConversionResult.md

@@ -1,10 +0,0 @@
-# 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/PageConversionResult.md

@@ -1,9 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,16 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

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

@@ -1,9 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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

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

data/docs/RemoveHtmlFromTextResponse.md

@@ -1,9 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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

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

data/docs/RemoveWhitespaceFromTextResponse.md

@@ -1,9 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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/ReplaceDocxParagraphRequest.md

@@ -1,12 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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] 
-
-

data/docs/ReplaceStringRegexResponse.md

@@ -1,9 +0,0 @@
-# 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

@@ -1,12 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

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

@@ -1,11 +0,0 @@
-# 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) | [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

@@ -1,11 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,12 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,13 +0,0 @@
-# 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] 
-
-