cloudmersive-convert-api-client 2.0.3 → 2.0.8

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,16 @@
+# 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] 
+**date_sent** | **String** | The date and time that the EML file's email was sent | [optional] 
+**subject** | **String** | The subject of the EML file's email | [optional] 
+**attachments** | [**Array<EmlAttachment>**](EmlAttachment.md) | List of all attachments for the EML file | [optional] 
+
+

data/docs/EmlToJpgResult.md

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

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

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::EnableSharedWorkbookRequest
+
+## 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] 
+
+

data/docs/EnableSharedWorkbookResponse.md

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

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::ExifValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag name for the EXIF value | [optional] 
+**data_type** | **String** | Date type of the EXIF value | [optional] 
+**data_value** | **String** | Value, formatted as a string of the EXIF value | [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/FindRegexMatch.md

@@ -0,0 +1,12 @@
+# CloudmersiveConvertApiClient::FindRegexMatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**character_offset_start** | **Integer** | 0-based index of the start of the match | [optional] 
+**character_offset_end** | **Integer** | 0-based index of the end of the match | [optional] 
+**containing_line** | **String** | Text content of the line containing the match | [optional] 
+**match_value** | **String** | The match value | [optional] 
+**match_groups** | **Array<String>** | Regular expression regex match groups; these correspond to the match values | [optional] 
+
+

data/docs/FindStringMatch.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindStringMatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**character_offset_start** | **Integer** | 0-based index of the start of the match | [optional] 
+**character_offset_end** | **Integer** | 0-based index of the end of the match | [optional] 
+**containing_line** | **String** | Text content of the line containing the match | [optional] 
+
+

data/docs/FindStringRegexRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindStringRegexRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_content** | **String** | Input text content | [optional] 
+**target_regex** | **String** | Target input regular expression (regex) to find | [optional] 
+**match_case** | **BOOLEAN** | Set to True to match case, False to ignore case | [optional] 
+
+

data/docs/FindStringRegexResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindStringRegexResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**matches** | [**Array<FindRegexMatch>**](FindRegexMatch.md) | Regular expression matches | [optional] 
+**match_count** | **Integer** | The number of matches | [optional] 
+
+

data/docs/FindStringSimpleRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::FindStringSimpleRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_content** | **String** | Input text content | [optional] 
+**target_string** | **String** | Target input string to find | [optional] 
+
+

data/docs/FindStringSimpleResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindStringSimpleResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**matches** | [**Array<FindStringMatch>**](FindStringMatch.md) | Found matches | [optional] 
+**match_count** | **Integer** | The number of matches | [optional] 
+
+

data/docs/FinishEditingRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveConvertApiClient::FinishEditingRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file_url** | **String** | URL of a document being edited to get the contents of. | [optional] 
+
+

data/docs/GetDocxBodyRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxBodyRequest
+
+## 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] 
+
+

data/docs/GetDocxBodyResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxBodyResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**body** | [**DocxBody**](DocxBody.md) | Body in the DOCX document | [optional] 
+
+

data/docs/GetDocxCommentsHierarchicalResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxCommentsHierarchicalResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**comments** | [**Array<DocxTopLevelComment>**](DocxTopLevelComment.md) | Comments in the document | [optional] 
+**top_level_comment_count** | **Integer** | The number of comments in the document | [optional] 
+
+

data/docs/GetDocxCommentsResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxCommentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**comments** | [**Array<DocxComment>**](DocxComment.md) | Comments in the document | [optional] 
+**comment_count** | **Integer** | The number of comments in the document | [optional] 
+
+

data/docs/GetDocxGetCommentsHierarchicalRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest
+
+## 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] 
+
+

data/docs/GetDocxGetCommentsRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxGetCommentsRequest
+
+## 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] 
+
+

data/docs/GetDocxHeadersAndFootersRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest
+
+## 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] 
+
+

data/docs/GetDocxHeadersAndFootersResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**headers** | [**Array<DocxHeader>**](DocxHeader.md) |  | [optional] 
+**footers** | [**Array<DocxFooter>**](DocxFooter.md) |  | [optional] 
+
+

data/docs/GetDocxImagesRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxImagesRequest
+
+## 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] 
+
+

data/docs/GetDocxImagesResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxImagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**images** | [**Array<DocxImage>**](DocxImage.md) | Images in the DOCX document | [optional] 
+
+

data/docs/GetDocxPagesRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxPagesRequest
+
+## 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] 
+**maximum_pages** | **Integer** | Optional: Maximum number of pages to return; set to 0 or do not supply to return all pages | [optional] 
+
+

data/docs/GetDocxPagesResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxPagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**pages** | [**Array<DocxPage>**](DocxPage.md) | Pages in the document | [optional] 
+**page_count** | **Integer** | Count of pages | [optional] 
+
+

data/docs/GetDocxSectionsRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxSectionsRequest
+
+## 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] 
+
+

data/docs/GetDocxSectionsResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxSectionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**sections** | [**Array<DocxSection>**](DocxSection.md) | Sections in the DOCX document | [optional] 
+
+

data/docs/GetDocxStylesRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxStylesRequest
+
+## 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] 
+
+

data/docs/GetDocxStylesResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxStylesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**styles** | [**Array<DocxStyle>**](DocxStyle.md) | Styles in the DOCX document | [optional] 
+
+

data/docs/GetDocxTableByIndexRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxTableByIndexRequest
+
+## 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] 
+**table_index** | **Integer** | 0-based index of the table to retrieve from the Word Document | [optional] 
+
+

data/docs/GetDocxTableByIndexResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxTableByIndexResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**table** | [**DocxTable**](DocxTable.md) | Requested Table in the DOCX file | [optional] 
+
+

data/docs/GetDocxTableRowRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::GetDocxTableRowRequest
+
+## 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] 
+**table_path** | **String** | Path to the table to retrievew the row from | [optional] 
+**table_row_row_index** | **Integer** | 0-based index of the row to retrieve (e.g. 0, 1, 2, ...) in the table | [optional] 
+
+

data/docs/GetDocxTableRowResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxTableRowResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**row_result** | [**DocxTableRow**](DocxTableRow.md) | Contents of the table row that was requested | [optional] 
+
+

data/docs/GetDocxTablesRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxTablesRequest
+
+## 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] 
+
+

data/docs/GetDocxTablesResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxTablesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**tables** | [**Array<DocxTable>**](DocxTable.md) | Tables in the DOCX file | [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] 
+
+