cloudmersive-convert-api-client 2.0.6 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +7 -0
- data/README.md +597 -0
- data/Rakefile +8 -0
- data/cloudmersive-convert-api-client.gemspec +45 -0
- data/docs/AddPdfAnnotationRequest.md +9 -0
- data/docs/AlternateFileFormatCandidate.md +10 -0
- data/docs/AppendXlsxRowRequest.md +11 -0
- data/docs/AppendXlsxRowResponse.md +9 -0
- data/docs/AutodetectDocumentValidationResult.md +12 -0
- data/docs/AutodetectGetInfoResult.md +14 -0
- data/docs/AutodetectToJpgResult.md +9 -0
- data/docs/AutodetectToPngResult.md +9 -0
- data/docs/AutodetectToThumbnailsResult.md +9 -0
- data/docs/Base64DecodeRequest.md +8 -0
- data/docs/Base64DecodeResponse.md +9 -0
- data/docs/Base64DetectRequest.md +8 -0
- data/docs/Base64DetectResponse.md +9 -0
- data/docs/Base64EncodeRequest.md +8 -0
- data/docs/Base64EncodeResponse.md +9 -0
- data/docs/ChangeLineEndingResponse.md +9 -0
- data/docs/ClearXlsxCellRequest.md +12 -0
- data/docs/ClearXlsxCellResponse.md +9 -0
- data/docs/ClearXlsxRowRequest.md +11 -0
- data/docs/ClearXlsxRowResponse.md +9 -0
- data/docs/CompareDocumentApi.md +66 -0
- data/docs/ConvertDataApi.md +1016 -0
- data/docs/ConvertDocumentApi.md +4503 -0
- data/docs/ConvertImageApi.md +243 -0
- data/docs/ConvertTemplateApi.md +122 -0
- data/docs/ConvertWebApi.md +448 -0
- data/docs/ConvertedJpgPage.md +9 -0
- data/docs/ConvertedPngPage.md +9 -0
- data/docs/CreateBlankDocxRequest.md +8 -0
- data/docs/CreateBlankDocxResponse.md +9 -0
- data/docs/CreateBlankSpreadsheetRequest.md +8 -0
- data/docs/CreateBlankSpreadsheetResponse.md +9 -0
- data/docs/CreateSpreadsheetFromDataRequest.md +9 -0
- data/docs/CreateSpreadsheetFromDataResponse.md +9 -0
- data/docs/CreateZipArchiveRequest.md +9 -0
- data/docs/CsvCollection.md +10 -0
- data/docs/CsvFileResult.md +9 -0
- data/docs/DeleteDocxTableRowRangeRequest.md +12 -0
- data/docs/DeleteDocxTableRowRangeResponse.md +9 -0
- data/docs/DeleteDocxTableRowRequest.md +11 -0
- data/docs/DeleteDocxTableRowResponse.md +9 -0
- data/docs/DetectLineEndingsResponse.md +11 -0
- data/docs/DisableSharedWorkbookRequest.md +9 -0
- data/docs/DisableSharedWorkbookResponse.md +9 -0
- data/docs/DocumentValidationError.md +11 -0
- data/docs/DocumentValidationResult.md +12 -0
- data/docs/DocxBody.md +10 -0
- data/docs/DocxCellStyle.md +11 -0
- data/docs/DocxComment.md +16 -0
- data/docs/DocxFooter.md +10 -0
- data/docs/DocxHeader.md +10 -0
- data/docs/DocxImage.md +20 -0
- data/docs/DocxInsertCommentOnParagraphRequest.md +11 -0
- data/docs/DocxInsertImageRequest.md +16 -0
- data/docs/DocxInsertImageResponse.md +9 -0
- data/docs/DocxPage.md +9 -0
- data/docs/DocxParagraph.md +11 -0
- data/docs/DocxRemoveObjectRequest.md +10 -0
- data/docs/DocxRemoveObjectResponse.md +9 -0
- data/docs/DocxRun.md +15 -0
- data/docs/DocxSection.md +9 -0
- data/docs/DocxSetFooterAddPageNumberRequest.md +10 -0
- data/docs/DocxSetFooterRequest.md +10 -0
- data/docs/DocxSetFooterResponse.md +9 -0
- data/docs/DocxSetHeaderRequest.md +10 -0
- data/docs/DocxSetHeaderResponse.md +9 -0
- data/docs/DocxStyle.md +14 -0
- data/docs/DocxTable.md +46 -0
- data/docs/DocxTableCell.md +15 -0
- data/docs/DocxTableRow.md +10 -0
- data/docs/DocxTemplateApplicationRequest.md +8 -0
- data/docs/DocxTemplateOperation.md +10 -0
- data/docs/DocxText.md +10 -0
- data/docs/DocxToJpgResult.md +9 -0
- data/docs/DocxToPngResult.md +9 -0
- data/docs/DocxTopLevelComment.md +14 -0
- data/docs/EditDocumentApi.md +3253 -0
- data/docs/EditHtmlApi.md +329 -0
- data/docs/EditPdfApi.md +1310 -0
- data/docs/EditTextApi.md +726 -0
- data/docs/EmlAttachment.md +9 -0
- data/docs/EmlToHtmlResult.md +16 -0
- data/docs/EmlToJpgResult.md +9 -0
- data/docs/EmlToPngResult.md +9 -0
- data/docs/EnableSharedWorkbookRequest.md +9 -0
- data/docs/EnableSharedWorkbookResponse.md +9 -0
- data/docs/ExifValue.md +10 -0
- data/docs/FindDocxParagraphRequest.md +11 -0
- data/docs/FindDocxParagraphResponse.md +10 -0
- data/docs/FindRegexMatch.md +12 -0
- data/docs/FindStringMatch.md +10 -0
- data/docs/FindStringRegexRequest.md +10 -0
- data/docs/FindStringRegexResponse.md +10 -0
- data/docs/FindStringSimpleRequest.md +9 -0
- data/docs/FindStringSimpleResponse.md +10 -0
- data/docs/FinishEditingRequest.md +8 -0
- data/docs/GetDocxBodyRequest.md +9 -0
- data/docs/GetDocxBodyResponse.md +9 -0
- data/docs/GetDocxCommentsHierarchicalResponse.md +10 -0
- data/docs/GetDocxCommentsResponse.md +10 -0
- data/docs/GetDocxGetCommentsHierarchicalRequest.md +9 -0
- data/docs/GetDocxGetCommentsRequest.md +9 -0
- data/docs/GetDocxHeadersAndFootersRequest.md +9 -0
- data/docs/GetDocxHeadersAndFootersResponse.md +10 -0
- data/docs/GetDocxImagesRequest.md +9 -0
- data/docs/GetDocxImagesResponse.md +9 -0
- data/docs/GetDocxPagesRequest.md +10 -0
- data/docs/GetDocxPagesResponse.md +10 -0
- data/docs/GetDocxSectionsRequest.md +9 -0
- data/docs/GetDocxSectionsResponse.md +9 -0
- data/docs/GetDocxStylesRequest.md +9 -0
- data/docs/GetDocxStylesResponse.md +9 -0
- data/docs/GetDocxTableByIndexRequest.md +10 -0
- data/docs/GetDocxTableByIndexResponse.md +9 -0
- data/docs/GetDocxTableRowRequest.md +11 -0
- data/docs/GetDocxTableRowResponse.md +9 -0
- data/docs/GetDocxTablesRequest.md +9 -0
- data/docs/GetDocxTablesResponse.md +9 -0
- data/docs/GetFileTypeIconResult.md +10 -0
- data/docs/GetImageInfoResult.md +24 -0
- data/docs/GetPdfAnnotationsResult.md +9 -0
- data/docs/GetXlsxCellByIdentifierRequest.md +11 -0
- data/docs/GetXlsxCellByIdentifierResponse.md +9 -0
- data/docs/GetXlsxCellRequest.md +12 -0
- data/docs/GetXlsxCellResponse.md +9 -0
- data/docs/GetXlsxColumnsRequest.md +10 -0
- data/docs/GetXlsxColumnsResponse.md +9 -0
- data/docs/GetXlsxImagesRequest.md +10 -0
- data/docs/GetXlsxImagesResponse.md +9 -0
- data/docs/GetXlsxRowsAndCellsRequest.md +10 -0
- data/docs/GetXlsxRowsAndCellsResponse.md +9 -0
- data/docs/GetXlsxSpecificRowRequest.md +11 -0
- data/docs/GetXlsxSpecificRowResponse.md +9 -0
- data/docs/GetXlsxStylesRequest.md +9 -0
- data/docs/GetXlsxStylesResponse.md +9 -0
- data/docs/GetXlsxWorksheetsRequest.md +9 -0
- data/docs/GetXlsxWorksheetsResponse.md +9 -0
- data/docs/HtmlMdResult.md +9 -0
- data/docs/HtmlTemplateApplicationRequest.md +10 -0
- data/docs/HtmlTemplateApplicationResponse.md +9 -0
- data/docs/HtmlTemplateOperation.md +10 -0
- data/docs/HtmlToOfficeRequest.md +8 -0
- data/docs/HtmlToPdfRequest.md +11 -0
- data/docs/HtmlToPngRequest.md +11 -0
- data/docs/HtmlToTextRequest.md +8 -0
- data/docs/HtmlToTextResponse.md +9 -0
- data/docs/InsertDocxCommentOnParagraphResponse.md +9 -0
- data/docs/InsertDocxInsertParagraphRequest.md +12 -0
- data/docs/InsertDocxInsertParagraphResponse.md +9 -0
- data/docs/InsertDocxTableRowRequest.md +12 -0
- data/docs/InsertDocxTableRowResponse.md +9 -0
- data/docs/InsertDocxTablesRequest.md +12 -0
- data/docs/InsertDocxTablesResponse.md +9 -0
- data/docs/InsertXlsxWorksheetRequest.md +10 -0
- data/docs/InsertXlsxWorksheetResponse.md +9 -0
- data/docs/KeynoteToJpgResult.md +9 -0
- data/docs/KeynoteToPngResult.md +9 -0
- data/docs/MergeDocumentApi.md +812 -0
- data/docs/MsgAttachment.md +9 -0
- data/docs/MsgToHtmlResult.md +16 -0
- data/docs/MsgToJpgResult.md +9 -0
- data/docs/MsgToPngResult.md +9 -0
- data/docs/MultiReplaceStringRequest.md +10 -0
- data/docs/MultipageImageFormatConversionResult.md +10 -0
- data/docs/OdpToJpgResult.md +9 -0
- data/docs/OdpToPngResult.md +9 -0
- data/docs/OdsToJpgResult.md +9 -0
- data/docs/OdsToPngResult.md +9 -0
- data/docs/OdtToJpgResult.md +9 -0
- data/docs/OdtToPngResult.md +9 -0
- data/docs/PageConversionResult.md +9 -0
- data/docs/PdfAnnotation.md +19 -0
- data/docs/PdfDocument.md +10 -0
- data/docs/PdfFormField.md +11 -0
- data/docs/PdfFormFields.md +9 -0
- data/docs/PdfMetadata.md +16 -0
- data/docs/PdfPageText.md +9 -0
- data/docs/PdfTextByPageResult.md +9 -0
- data/docs/PdfToJpgResult.md +9 -0
- data/docs/PdfToPngResult.md +9 -0
- data/docs/PptxToPngResult.md +9 -0
- data/docs/PresentationResult.md +10 -0
- data/docs/RemoveDocxHeadersAndFootersRequest.md +11 -0
- data/docs/RemoveDocxHeadersAndFootersResponse.md +9 -0
- data/docs/RemoveDocxPagesRequest.md +11 -0
- data/docs/RemoveHtmlFromTextRequest.md +8 -0
- data/docs/RemoveHtmlFromTextResponse.md +9 -0
- data/docs/RemovePptxSlidesRequest.md +11 -0
- data/docs/RemoveWhitespaceFromTextRequest.md +8 -0
- data/docs/RemoveWhitespaceFromTextResponse.md +9 -0
- data/docs/RemoveXlsxWorksheetRequest.md +10 -0
- data/docs/RenameXlsxWorksheetRequest.md +11 -0
- data/docs/RenameXlsxWorksheetResponse.md +9 -0
- data/docs/ReplaceDocxParagraphRequest.md +12 -0
- data/docs/ReplaceDocxParagraphResponse.md +9 -0
- data/docs/ReplaceStringRegexRequest.md +10 -0
- data/docs/ReplaceStringRegexResponse.md +9 -0
- data/docs/ReplaceStringRequest.md +12 -0
- data/docs/ReplaceStringSimpleRequest.md +10 -0
- data/docs/ReplaceStringSimpleResponse.md +9 -0
- data/docs/RtfToJpgResult.md +9 -0
- data/docs/RtfToPngResult.md +9 -0
- data/docs/ScreenshotRequest.md +11 -0
- data/docs/SetFormFieldValue.md +11 -0
- data/docs/SetPdfFormFieldsRequest.md +9 -0
- data/docs/SetPdfMetadataRequest.md +9 -0
- data/docs/SetXlsxCellByIdentifierRequest.md +12 -0
- data/docs/SetXlsxCellByIdentifierResponse.md +9 -0
- data/docs/SetXlsxCellRequest.md +13 -0
- data/docs/SetXlsxCellResponse.md +9 -0
- data/docs/SingleReplaceString.md +10 -0
- data/docs/SplitDocumentApi.md +361 -0
- data/docs/SplitDocumentResult.md +10 -0
- data/docs/SplitDocxDocumentResult.md +9 -0
- data/docs/SplitPdfResult.md +9 -0
- data/docs/SplitPptxPresentationResult.md +9 -0
- data/docs/SplitTextDocumentByLinesResult.md +10 -0
- data/docs/SplitTextDocumentByStringResult.md +10 -0
- data/docs/SplitXlsxWorksheetResult.md +9 -0
- data/docs/TextConversionResult.md +9 -0
- data/docs/TextDocumentElement.md +9 -0
- data/docs/TextDocumentLine.md +9 -0
- data/docs/TextEncodingDetectResponse.md +9 -0
- data/docs/Thumbnail.md +9 -0
- data/docs/TransformDocumentApi.md +140 -0
- data/docs/UpdateDocxTableCellRequest.md +13 -0
- data/docs/UpdateDocxTableCellResponse.md +9 -0
- data/docs/UpdateDocxTableRowRequest.md +12 -0
- data/docs/UpdateDocxTableRowResponse.md +9 -0
- data/docs/UrlToPdfRequest.md +11 -0
- data/docs/UrlToTextRequest.md +8 -0
- data/docs/UrlToTextResponse.md +9 -0
- data/docs/ValidateDocumentApi.md +998 -0
- data/docs/ViewerResponse.md +9 -0
- data/docs/ViewerToolsApi.md +69 -0
- data/docs/WorksheetResult.md +11 -0
- data/docs/XlsxImage.md +12 -0
- data/docs/XlsxSpreadsheetCell.md +12 -0
- data/docs/XlsxSpreadsheetColumn.md +9 -0
- data/docs/XlsxSpreadsheetRow.md +9 -0
- data/docs/XlsxToPngResult.md +9 -0
- data/docs/XlsxWorksheet.md +9 -0
- data/docs/XmlAddAttributeWithXPathResult.md +10 -0
- data/docs/XmlAddChildWithXPathResult.md +10 -0
- data/docs/XmlFilterWithXPathResult.md +10 -0
- data/docs/XmlQueryWithXQueryMultiResult.md +10 -0
- data/docs/XmlQueryWithXQueryResult.md +10 -0
- data/docs/XmlRemoveAllChildrenWithXPathResult.md +10 -0
- data/docs/XmlRemoveWithXPathResult.md +11 -0
- data/docs/XmlReplaceWithXPathResult.md +10 -0
- data/docs/XmlSetValueWithXPathResult.md +10 -0
- data/docs/ZipArchiveApi.md +386 -0
- data/docs/ZipDirectory.md +10 -0
- data/docs/ZipEncryptionAdvancedRequest.md +10 -0
- data/docs/ZipExtractResponse.md +10 -0
- data/docs/ZipFile.md +9 -0
- data/git_push.sh +55 -0
- data/lib/cloudmersive-convert-api-client.rb +295 -0
- data/lib/cloudmersive-convert-api-client/api/compare_document_api.rb +85 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +1079 -0
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +4516 -0
- data/lib/cloudmersive-convert-api-client/api/convert_image_api.rb +273 -0
- data/lib/cloudmersive-convert-api-client/api/convert_template_api.rb +135 -0
- data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +456 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +3214 -0
- data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +339 -0
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +1393 -0
- data/lib/cloudmersive-convert-api-client/api/edit_text_api.rb +735 -0
- data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +911 -0
- data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +375 -0
- data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +161 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +1013 -0
- data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +84 -0
- data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +422 -0
- data/lib/cloudmersive-convert-api-client/api_client.rb +391 -0
- data/lib/cloudmersive-convert-api-client/api_error.rb +38 -0
- data/lib/cloudmersive-convert-api-client/configuration.rb +209 -0
- data/lib/cloudmersive-convert-api-client/models/add_pdf_annotation_request.rb +213 -0
- data/lib/cloudmersive-convert-api-client/models/alternate_file_format_candidate.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/append_xlsx_row_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/append_xlsx_row_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/autodetect_document_validation_result.rb +227 -0
- data/lib/cloudmersive-convert-api-client/models/autodetect_get_info_result.rb +248 -0
- data/lib/cloudmersive-convert-api-client/models/autodetect_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/autodetect_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/base64_decode_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/base64_decode_response.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/base64_detect_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/base64_detect_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/base64_encode_request.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/base64_encode_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/change_line_ending_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/clear_xlsx_cell_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/clear_xlsx_cell_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/clear_xlsx_row_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/clear_xlsx_row_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/converted_jpg_page.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/converted_png_page.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/create_blank_docx_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/create_blank_docx_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/create_blank_spreadsheet_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/create_blank_spreadsheet_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/create_spreadsheet_from_data_request.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/create_spreadsheet_from_data_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/create_zip_archive_request.rb +200 -0
- data/lib/cloudmersive-convert-api-client/models/csv_collection.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/csv_file_result.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_range_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_range_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/detect_line_endings_response.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/disable_shared_workbook_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/disable_shared_workbook_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/document_validation_error.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +228 -0
- data/lib/cloudmersive-convert-api-client/models/docx_body.rb +209 -0
- data/lib/cloudmersive-convert-api-client/models/docx_cell_style.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/docx_comment.rb +266 -0
- data/lib/cloudmersive-convert-api-client/models/docx_footer.rb +210 -0
- data/lib/cloudmersive-convert-api-client/models/docx_header.rb +210 -0
- data/lib/cloudmersive-convert-api-client/models/docx_image.rb +305 -0
- data/lib/cloudmersive-convert-api-client/models/docx_insert_comment_on_paragraph_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb +296 -0
- data/lib/cloudmersive-convert-api-client/models/docx_insert_image_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_page.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +218 -0
- data/lib/cloudmersive-convert-api-client/models/docx_remove_object_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/docx_remove_object_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_run.rb +258 -0
- data/lib/cloudmersive-convert-api-client/models/docx_section.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_footer_add_page_number_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_footer_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_footer_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_header_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_style.rb +246 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table.rb +568 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_cell.rb +258 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_row.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/docx_template_application_request.rb +188 -0
- data/lib/cloudmersive-convert-api-client/models/docx_template_operation.rb +239 -0
- data/lib/cloudmersive-convert-api-client/models/docx_text.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/docx_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/docx_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/docx_top_level_comment.rb +248 -0
- data/lib/cloudmersive-convert-api-client/models/eml_attachment.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/eml_to_html_result.rb +268 -0
- data/lib/cloudmersive-convert-api-client/models/eml_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/eml_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/enable_shared_workbook_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/enable_shared_workbook_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/exif_value.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_response.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/find_regex_match.rb +228 -0
- data/lib/cloudmersive-convert-api-client/models/find_string_match.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/find_string_regex_request.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/find_string_regex_response.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/find_string_simple_request.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/find_string_simple_response.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/finish_editing_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_body_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_body_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_comments_hierarchical_response.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_comments_response.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_get_comments_hierarchical_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_get_comments_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_headers_and_footers_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_images_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_images_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_pages_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_pages_response.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_sections_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_sections_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_styles_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_styles_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_table_by_index_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_table_by_index_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_table_row_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_table_row_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_tables_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_tables_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/get_image_info_result.rb +347 -0
- data/lib/cloudmersive-convert-api-client/models/get_pdf_annotations_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_columns_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_columns_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_images_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_images_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_rows_and_cells_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_rows_and_cells_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_specific_row_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_specific_row_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_styles_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_styles_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_worksheets_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_worksheets_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/html_md_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_template_application_request.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/html_template_application_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_template_operation.rb +239 -0
- data/lib/cloudmersive-convert-api-client/models/html_to_office_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/html_to_pdf_request.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/html_to_png_request.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/html_to_text_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/html_to_text_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_comment_on_paragraph_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_table_row_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_table_row_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_tables_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/insert_xlsx_worksheet_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/insert_xlsx_worksheet_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/keynote_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/keynote_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/msg_attachment.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/msg_to_html_result.rb +268 -0
- data/lib/cloudmersive-convert-api-client/models/msg_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/msg_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/multi_replace_string_request.rb +223 -0
- data/lib/cloudmersive-convert-api-client/models/multipage_image_format_conversion_result.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/odp_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/odp_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/ods_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/ods_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/odt_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/odt_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/page_conversion_result.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_annotation.rb +296 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_document.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_form_field.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_form_fields.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_metadata.rb +266 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_page_text.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_text_by_page_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/pptx_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/presentation_result.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/remove_docx_pages_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/remove_html_from_text_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/remove_html_from_text_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/remove_pptx_slides_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/remove_whitespace_from_text_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/remove_whitespace_from_text_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/remove_xlsx_worksheet_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/rename_xlsx_worksheet_request.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/rename_xlsx_worksheet_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/replace_string_regex_request.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/replace_string_regex_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/replace_string_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/replace_string_simple_request.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/replace_string_simple_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/rtf_to_jpg_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/rtf_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/screenshot_request.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/set_form_field_value.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/set_pdf_form_fields_request.rb +213 -0
- data/lib/cloudmersive-convert-api-client/models/set_pdf_metadata_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_by_identifier_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_by_identifier_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_request.rb +251 -0
- data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/single_replace_string.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/split_document_result.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/split_docx_document_result.rb +197 -0
- data/lib/cloudmersive-convert-api-client/models/split_pdf_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/split_pptx_presentation_result.rb +197 -0
- data/lib/cloudmersive-convert-api-client/models/split_text_document_by_lines_result.rb +207 -0
- data/lib/cloudmersive-convert-api-client/models/split_text_document_by_string_result.rb +207 -0
- data/lib/cloudmersive-convert-api-client/models/split_xlsx_worksheet_result.rb +197 -0
- data/lib/cloudmersive-convert-api-client/models/text_conversion_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/text_document_element.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/text_document_line.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/text_encoding_detect_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/thumbnail.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/update_docx_table_cell_request.rb +251 -0
- data/lib/cloudmersive-convert-api-client/models/update_docx_table_cell_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/update_docx_table_row_request.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/update_docx_table_row_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/url_to_pdf_request.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/url_to_text_request.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/url_to_text_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/viewer_response.rb +194 -0
- data/lib/cloudmersive-convert-api-client/models/worksheet_result.rb +231 -0
- data/lib/cloudmersive-convert-api-client/models/xlsx_image.rb +225 -0
- data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_cell.rb +225 -0
- data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_column.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_row.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/xlsx_to_png_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/xlsx_worksheet.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/xml_add_attribute_with_x_path_result.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/xml_add_child_with_x_path_result.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/xml_filter_with_x_path_result.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/xml_query_with_x_query_multi_result.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/xml_query_with_x_query_result.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/xml_remove_all_children_with_x_path_result.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/xml_remove_with_x_path_result.rb +218 -0
- data/lib/cloudmersive-convert-api-client/models/xml_replace_with_x_path_result.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/xml_set_value_with_x_path_result.rb +206 -0
- data/lib/cloudmersive-convert-api-client/models/zip_directory.rb +210 -0
- data/lib/cloudmersive-convert-api-client/models/zip_encryption_advanced_request.rb +221 -0
- data/lib/cloudmersive-convert-api-client/models/zip_extract_response.rb +210 -0
- data/lib/cloudmersive-convert-api-client/models/zip_file.rb +211 -0
- data/lib/cloudmersive-convert-api-client/version.rb +15 -0
- data/spec/api/compare_document_api_spec.rb +48 -0
- data/spec/api/convert_data_api_spec.rb +265 -0
- data/spec/api/convert_document_api_spec.rb +1033 -0
- data/spec/api/convert_image_api_spec.rb +88 -0
- data/spec/api/convert_template_api_spec.rb +60 -0
- data/spec/api/convert_web_api_spec.rb +131 -0
- data/spec/api/edit_document_api_spec.rb +743 -0
- data/spec/api/edit_html_api_spec.rb +114 -0
- data/spec/api/edit_pdf_api_spec.rb +332 -0
- data/spec/api/edit_text_api_spec.rb +192 -0
- data/spec/api/merge_document_api_spec.rb +239 -0
- data/spec/api/split_document_api_spec.rb +113 -0
- data/spec/api/transform_document_api_spec.rb +67 -0
- data/spec/api/validate_document_api_spec.rb +251 -0
- data/spec/api/viewer_tools_api_spec.rb +49 -0
- data/spec/api/zip_archive_api_spec.rb +128 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/add_pdf_annotation_request_spec.rb +47 -0
- data/spec/models/alternate_file_format_candidate_spec.rb +53 -0
- data/spec/models/append_xlsx_row_request_spec.rb +59 -0
- data/spec/models/append_xlsx_row_response_spec.rb +47 -0
- data/spec/models/autodetect_document_validation_result_spec.rb +65 -0
- data/spec/models/autodetect_get_info_result_spec.rb +77 -0
- data/spec/models/autodetect_to_jpg_result_spec.rb +47 -0
- data/spec/models/autodetect_to_png_result_spec.rb +47 -0
- data/spec/models/autodetect_to_thumbnails_result_spec.rb +47 -0
- data/spec/models/base64_decode_request_spec.rb +41 -0
- data/spec/models/base64_decode_response_spec.rb +47 -0
- data/spec/models/base64_detect_request_spec.rb +41 -0
- data/spec/models/base64_detect_response_spec.rb +47 -0
- data/spec/models/base64_encode_request_spec.rb +41 -0
- data/spec/models/base64_encode_response_spec.rb +47 -0
- data/spec/models/change_line_ending_response_spec.rb +47 -0
- data/spec/models/clear_xlsx_cell_request_spec.rb +65 -0
- data/spec/models/clear_xlsx_cell_response_spec.rb +47 -0
- data/spec/models/clear_xlsx_row_request_spec.rb +59 -0
- data/spec/models/clear_xlsx_row_response_spec.rb +47 -0
- data/spec/models/converted_jpg_page_spec.rb +47 -0
- data/spec/models/converted_png_page_spec.rb +47 -0
- data/spec/models/create_blank_docx_request_spec.rb +41 -0
- data/spec/models/create_blank_docx_response_spec.rb +47 -0
- data/spec/models/create_blank_spreadsheet_request_spec.rb +41 -0
- data/spec/models/create_blank_spreadsheet_response_spec.rb +47 -0
- data/spec/models/create_spreadsheet_from_data_request_spec.rb +47 -0
- data/spec/models/create_spreadsheet_from_data_response_spec.rb +47 -0
- data/spec/models/create_zip_archive_request_spec.rb +47 -0
- data/spec/models/csv_collection_spec.rb +53 -0
- data/spec/models/csv_file_result_spec.rb +47 -0
- data/spec/models/delete_docx_table_row_range_request_spec.rb +65 -0
- data/spec/models/delete_docx_table_row_range_response_spec.rb +47 -0
- data/spec/models/delete_docx_table_row_request_spec.rb +59 -0
- data/spec/models/delete_docx_table_row_response_spec.rb +47 -0
- data/spec/models/detect_line_endings_response_spec.rb +59 -0
- data/spec/models/disable_shared_workbook_request_spec.rb +47 -0
- data/spec/models/disable_shared_workbook_response_spec.rb +47 -0
- data/spec/models/document_validation_error_spec.rb +59 -0
- data/spec/models/document_validation_result_spec.rb +65 -0
- data/spec/models/docx_body_spec.rb +53 -0
- data/spec/models/docx_cell_style_spec.rb +59 -0
- data/spec/models/docx_comment_spec.rb +89 -0
- data/spec/models/docx_footer_spec.rb +53 -0
- data/spec/models/docx_header_spec.rb +53 -0
- data/spec/models/docx_image_spec.rb +113 -0
- data/spec/models/docx_insert_comment_on_paragraph_request_spec.rb +59 -0
- data/spec/models/docx_insert_image_request_spec.rb +89 -0
- data/spec/models/docx_insert_image_response_spec.rb +47 -0
- data/spec/models/docx_page_spec.rb +47 -0
- data/spec/models/docx_paragraph_spec.rb +59 -0
- data/spec/models/docx_remove_object_request_spec.rb +53 -0
- data/spec/models/docx_remove_object_response_spec.rb +47 -0
- data/spec/models/docx_run_spec.rb +83 -0
- data/spec/models/docx_section_spec.rb +47 -0
- data/spec/models/docx_set_footer_add_page_number_request_spec.rb +53 -0
- data/spec/models/docx_set_footer_request_spec.rb +53 -0
- data/spec/models/docx_set_footer_response_spec.rb +47 -0
- data/spec/models/docx_set_header_request_spec.rb +53 -0
- data/spec/models/docx_set_header_response_spec.rb +47 -0
- data/spec/models/docx_style_spec.rb +77 -0
- data/spec/models/docx_table_cell_spec.rb +83 -0
- data/spec/models/docx_table_row_spec.rb +53 -0
- data/spec/models/docx_table_spec.rb +269 -0
- data/spec/models/docx_template_application_request_spec.rb +41 -0
- data/spec/models/docx_template_operation_spec.rb +57 -0
- data/spec/models/docx_text_spec.rb +53 -0
- data/spec/models/docx_to_jpg_result_spec.rb +47 -0
- data/spec/models/docx_to_png_result_spec.rb +47 -0
- data/spec/models/docx_top_level_comment_spec.rb +77 -0
- data/spec/models/eml_attachment_spec.rb +47 -0
- data/spec/models/eml_to_html_result_spec.rb +89 -0
- data/spec/models/eml_to_jpg_result_spec.rb +47 -0
- data/spec/models/eml_to_png_result_spec.rb +47 -0
- data/spec/models/enable_shared_workbook_request_spec.rb +47 -0
- data/spec/models/enable_shared_workbook_response_spec.rb +47 -0
- data/spec/models/exif_value_spec.rb +53 -0
- data/spec/models/find_docx_paragraph_request_spec.rb +59 -0
- data/spec/models/find_docx_paragraph_response_spec.rb +53 -0
- data/spec/models/find_regex_match_spec.rb +65 -0
- data/spec/models/find_string_match_spec.rb +53 -0
- data/spec/models/find_string_regex_request_spec.rb +53 -0
- data/spec/models/find_string_regex_response_spec.rb +53 -0
- data/spec/models/find_string_simple_request_spec.rb +47 -0
- data/spec/models/find_string_simple_response_spec.rb +53 -0
- data/spec/models/finish_editing_request_spec.rb +41 -0
- data/spec/models/get_docx_body_request_spec.rb +47 -0
- data/spec/models/get_docx_body_response_spec.rb +47 -0
- data/spec/models/get_docx_comments_hierarchical_response_spec.rb +53 -0
- data/spec/models/get_docx_comments_response_spec.rb +53 -0
- data/spec/models/get_docx_get_comments_hierarchical_request_spec.rb +47 -0
- data/spec/models/get_docx_get_comments_request_spec.rb +47 -0
- data/spec/models/get_docx_headers_and_footers_request_spec.rb +47 -0
- data/spec/models/get_docx_headers_and_footers_response_spec.rb +53 -0
- data/spec/models/get_docx_images_request_spec.rb +47 -0
- data/spec/models/get_docx_images_response_spec.rb +47 -0
- data/spec/models/get_docx_pages_request_spec.rb +53 -0
- data/spec/models/get_docx_pages_response_spec.rb +53 -0
- data/spec/models/get_docx_sections_request_spec.rb +47 -0
- data/spec/models/get_docx_sections_response_spec.rb +47 -0
- data/spec/models/get_docx_styles_request_spec.rb +47 -0
- data/spec/models/get_docx_styles_response_spec.rb +47 -0
- data/spec/models/get_docx_table_by_index_request_spec.rb +53 -0
- data/spec/models/get_docx_table_by_index_response_spec.rb +47 -0
- data/spec/models/get_docx_table_row_request_spec.rb +59 -0
- data/spec/models/get_docx_table_row_response_spec.rb +47 -0
- data/spec/models/get_docx_tables_request_spec.rb +47 -0
- data/spec/models/get_docx_tables_response_spec.rb +47 -0
- data/spec/models/get_file_type_icon_result_spec.rb +53 -0
- data/spec/models/get_image_info_result_spec.rb +137 -0
- data/spec/models/get_pdf_annotations_result_spec.rb +47 -0
- data/spec/models/get_xlsx_cell_by_identifier_request_spec.rb +59 -0
- data/spec/models/get_xlsx_cell_by_identifier_response_spec.rb +47 -0
- data/spec/models/get_xlsx_cell_request_spec.rb +65 -0
- data/spec/models/get_xlsx_cell_response_spec.rb +47 -0
- data/spec/models/get_xlsx_columns_request_spec.rb +53 -0
- data/spec/models/get_xlsx_columns_response_spec.rb +47 -0
- data/spec/models/get_xlsx_images_request_spec.rb +53 -0
- data/spec/models/get_xlsx_images_response_spec.rb +47 -0
- data/spec/models/get_xlsx_rows_and_cells_request_spec.rb +53 -0
- data/spec/models/get_xlsx_rows_and_cells_response_spec.rb +47 -0
- data/spec/models/get_xlsx_specific_row_request_spec.rb +59 -0
- data/spec/models/get_xlsx_specific_row_response_spec.rb +47 -0
- data/spec/models/get_xlsx_styles_request_spec.rb +47 -0
- data/spec/models/get_xlsx_styles_response_spec.rb +47 -0
- data/spec/models/get_xlsx_worksheets_request_spec.rb +47 -0
- data/spec/models/get_xlsx_worksheets_response_spec.rb +47 -0
- data/spec/models/html_md_result_spec.rb +47 -0
- data/spec/models/html_template_application_request_spec.rb +53 -0
- data/spec/models/html_template_application_response_spec.rb +47 -0
- data/spec/models/html_template_operation_spec.rb +57 -0
- data/spec/models/html_to_office_request_spec.rb +41 -0
- data/spec/models/html_to_pdf_request_spec.rb +59 -0
- data/spec/models/html_to_png_request_spec.rb +59 -0
- data/spec/models/html_to_text_request_spec.rb +41 -0
- data/spec/models/html_to_text_response_spec.rb +47 -0
- data/spec/models/insert_docx_comment_on_paragraph_response_spec.rb +47 -0
- data/spec/models/insert_docx_insert_paragraph_request_spec.rb +65 -0
- data/spec/models/insert_docx_insert_paragraph_response_spec.rb +47 -0
- data/spec/models/insert_docx_table_row_request_spec.rb +65 -0
- data/spec/models/insert_docx_table_row_response_spec.rb +47 -0
- data/spec/models/insert_docx_tables_request_spec.rb +65 -0
- data/spec/models/insert_docx_tables_response_spec.rb +47 -0
- data/spec/models/insert_xlsx_worksheet_request_spec.rb +53 -0
- data/spec/models/insert_xlsx_worksheet_response_spec.rb +47 -0
- data/spec/models/keynote_to_jpg_result_spec.rb +47 -0
- data/spec/models/keynote_to_png_result_spec.rb +47 -0
- data/spec/models/msg_attachment_spec.rb +47 -0
- data/spec/models/msg_to_html_result_spec.rb +89 -0
- data/spec/models/msg_to_jpg_result_spec.rb +47 -0
- data/spec/models/msg_to_png_result_spec.rb +47 -0
- data/spec/models/multi_replace_string_request_spec.rb +53 -0
- data/spec/models/multipage_image_format_conversion_result_spec.rb +53 -0
- data/spec/models/odp_to_jpg_result_spec.rb +47 -0
- data/spec/models/odp_to_png_result_spec.rb +47 -0
- data/spec/models/ods_to_jpg_result_spec.rb +47 -0
- data/spec/models/ods_to_png_result_spec.rb +47 -0
- data/spec/models/odt_to_jpg_result_spec.rb +47 -0
- data/spec/models/odt_to_png_result_spec.rb +47 -0
- data/spec/models/page_conversion_result_spec.rb +47 -0
- data/spec/models/pdf_annotation_spec.rb +107 -0
- data/spec/models/pdf_document_spec.rb +53 -0
- data/spec/models/pdf_form_field_spec.rb +59 -0
- data/spec/models/pdf_form_fields_spec.rb +47 -0
- data/spec/models/pdf_metadata_spec.rb +89 -0
- data/spec/models/pdf_page_text_spec.rb +47 -0
- data/spec/models/pdf_text_by_page_result_spec.rb +47 -0
- data/spec/models/pdf_to_jpg_result_spec.rb +47 -0
- data/spec/models/pdf_to_png_result_spec.rb +47 -0
- data/spec/models/pptx_to_png_result_spec.rb +47 -0
- data/spec/models/presentation_result_spec.rb +53 -0
- data/spec/models/remove_docx_headers_and_footers_request_spec.rb +59 -0
- data/spec/models/remove_docx_headers_and_footers_response_spec.rb +47 -0
- data/spec/models/remove_docx_pages_request_spec.rb +59 -0
- data/spec/models/remove_html_from_text_request_spec.rb +41 -0
- data/spec/models/remove_html_from_text_response_spec.rb +47 -0
- data/spec/models/remove_pptx_slides_request_spec.rb +59 -0
- data/spec/models/remove_whitespace_from_text_request_spec.rb +41 -0
- data/spec/models/remove_whitespace_from_text_response_spec.rb +47 -0
- data/spec/models/remove_xlsx_worksheet_request_spec.rb +53 -0
- data/spec/models/rename_xlsx_worksheet_request_spec.rb +59 -0
- data/spec/models/rename_xlsx_worksheet_response_spec.rb +47 -0
- data/spec/models/replace_docx_paragraph_request_spec.rb +65 -0
- data/spec/models/replace_docx_paragraph_response_spec.rb +47 -0
- data/spec/models/replace_string_regex_request_spec.rb +53 -0
- data/spec/models/replace_string_regex_response_spec.rb +47 -0
- data/spec/models/replace_string_request_spec.rb +65 -0
- data/spec/models/replace_string_simple_request_spec.rb +53 -0
- data/spec/models/replace_string_simple_response_spec.rb +47 -0
- data/spec/models/rtf_to_jpg_result_spec.rb +47 -0
- data/spec/models/rtf_to_png_result_spec.rb +47 -0
- data/spec/models/screenshot_request_spec.rb +59 -0
- data/spec/models/set_form_field_value_spec.rb +59 -0
- data/spec/models/set_pdf_form_fields_request_spec.rb +47 -0
- data/spec/models/set_pdf_metadata_request_spec.rb +47 -0
- data/spec/models/set_xlsx_cell_by_identifier_request_spec.rb +65 -0
- data/spec/models/set_xlsx_cell_by_identifier_response_spec.rb +47 -0
- data/spec/models/set_xlsx_cell_request_spec.rb +71 -0
- data/spec/models/set_xlsx_cell_response_spec.rb +47 -0
- data/spec/models/single_replace_string_spec.rb +53 -0
- data/spec/models/split_document_result_spec.rb +53 -0
- data/spec/models/split_docx_document_result_spec.rb +47 -0
- data/spec/models/split_pdf_result_spec.rb +47 -0
- data/spec/models/split_pptx_presentation_result_spec.rb +47 -0
- data/spec/models/split_text_document_by_lines_result_spec.rb +53 -0
- data/spec/models/split_text_document_by_string_result_spec.rb +53 -0
- data/spec/models/split_xlsx_worksheet_result_spec.rb +47 -0
- data/spec/models/text_conversion_result_spec.rb +47 -0
- data/spec/models/text_document_element_spec.rb +47 -0
- data/spec/models/text_document_line_spec.rb +47 -0
- data/spec/models/text_encoding_detect_response_spec.rb +47 -0
- data/spec/models/thumbnail_spec.rb +47 -0
- data/spec/models/update_docx_table_cell_request_spec.rb +71 -0
- data/spec/models/update_docx_table_cell_response_spec.rb +47 -0
- data/spec/models/update_docx_table_row_request_spec.rb +65 -0
- data/spec/models/update_docx_table_row_response_spec.rb +47 -0
- data/spec/models/url_to_pdf_request_spec.rb +59 -0
- data/spec/models/url_to_text_request_spec.rb +41 -0
- data/spec/models/url_to_text_response_spec.rb +47 -0
- data/spec/models/viewer_response_spec.rb +47 -0
- data/spec/models/worksheet_result_spec.rb +59 -0
- data/spec/models/xlsx_image_spec.rb +65 -0
- data/spec/models/xlsx_spreadsheet_cell_spec.rb +65 -0
- data/spec/models/xlsx_spreadsheet_column_spec.rb +47 -0
- data/spec/models/xlsx_spreadsheet_row_spec.rb +47 -0
- data/spec/models/xlsx_to_png_result_spec.rb +47 -0
- data/spec/models/xlsx_worksheet_spec.rb +47 -0
- data/spec/models/xml_add_attribute_with_x_path_result_spec.rb +53 -0
- data/spec/models/xml_add_child_with_x_path_result_spec.rb +53 -0
- data/spec/models/xml_filter_with_x_path_result_spec.rb +53 -0
- data/spec/models/xml_query_with_x_query_multi_result_spec.rb +53 -0
- data/spec/models/xml_query_with_x_query_result_spec.rb +53 -0
- data/spec/models/xml_remove_all_children_with_x_path_result_spec.rb +53 -0
- data/spec/models/xml_remove_with_x_path_result_spec.rb +59 -0
- data/spec/models/xml_replace_with_x_path_result_spec.rb +53 -0
- data/spec/models/xml_set_value_with_x_path_result_spec.rb +53 -0
- data/spec/models/zip_directory_spec.rb +53 -0
- data/spec/models/zip_encryption_advanced_request_spec.rb +53 -0
- data/spec/models/zip_extract_response_spec.rb +53 -0
- data/spec/models/zip_file_spec.rb +47 -0
- data/spec/spec_helper.rb +111 -0
- metadata +785 -4
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::ViewerToolsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**viewer_tools_create_simple**](ViewerToolsApi.md#viewer_tools_create_simple) | **POST** /convert/viewer/create/web/simple | Create a web-based viewer
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# **viewer_tools_create_simple**
|
|
11
|
+
> ViewerResponse viewer_tools_create_simple(input_file, opts)
|
|
12
|
+
|
|
13
|
+
Create a web-based viewer
|
|
14
|
+
|
|
15
|
+
Creates an HTML embed code for a simple web-based viewer of a document; supports Office document types and PDF.
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```ruby
|
|
19
|
+
# load the gem
|
|
20
|
+
require 'cloudmersive-convert-api-client'
|
|
21
|
+
# setup authorization
|
|
22
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
23
|
+
# Configure API key authorization: Apikey
|
|
24
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
26
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
api_instance = CloudmersiveConvertApiClient::ViewerToolsApi.new
|
|
30
|
+
|
|
31
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
32
|
+
|
|
33
|
+
opts = {
|
|
34
|
+
width: 56, # Integer | Optional; width of the output viewer in pixels
|
|
35
|
+
height: 56 # Integer | Optional; height of the output viewer in pixels
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
begin
|
|
39
|
+
#Create a web-based viewer
|
|
40
|
+
result = api_instance.viewer_tools_create_simple(input_file, opts)
|
|
41
|
+
p result
|
|
42
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
43
|
+
puts "Exception when calling ViewerToolsApi->viewer_tools_create_simple: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
Name | Type | Description | Notes
|
|
50
|
+
------------- | ------------- | ------------- | -------------
|
|
51
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
52
|
+
**width** | **Integer**| Optional; width of the output viewer in pixels | [optional]
|
|
53
|
+
**height** | **Integer**| Optional; height of the output viewer in pixels | [optional]
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
[**ViewerResponse**](ViewerResponse.md)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
[Apikey](../README.md#Apikey)
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: multipart/form-data
|
|
66
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::WorksheetResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**worksheet_number** | **Integer** | Worksheet number of the converted page, starting with 1 for the left-most worksheet | [optional]
|
|
7
|
+
**worksheet_name** | **String** | The name of the worksheet | [optional]
|
|
8
|
+
**url** | **String** | URL to the XLSX file of this worksheet; file is stored in an in-memory cache and will be deleted | [optional]
|
|
9
|
+
**worksheet_contents** | **String** | Contents of the worksheet in bytes | [optional]
|
|
10
|
+
|
|
11
|
+
|
data/docs/XlsxImage.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XlsxImage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**path** | **String** | The Path of the location of this object; leave blank for new rows | [optional]
|
|
7
|
+
**image_data_embed_id** | **String** | Read-only; internal ID for the image contents | [optional]
|
|
8
|
+
**image_data_content_type** | **String** | Read-only; image data MIME content-type | [optional]
|
|
9
|
+
**image_internal_file_name** | **String** | Read-only; internal file name/path for the image | [optional]
|
|
10
|
+
**image_contents_url** | **String** | URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XlsxSpreadsheetCell
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**path** | **String** | The Path of the location of this object; leave blank for new rows | [optional]
|
|
7
|
+
**text_value** | **String** | Text value of the cell | [optional]
|
|
8
|
+
**cell_identifier** | **String** | Cell reference of the cell, e.g. A1, Z22, etc. | [optional]
|
|
9
|
+
**style_index** | **Integer** | Identifier for the style to apply to this style | [optional]
|
|
10
|
+
**formula** | **String** | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XlsxSpreadsheetColumn
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**path** | **String** | The Path of the location of this object; leave blank for new rows | [optional]
|
|
7
|
+
**heading_cell** | [**XlsxSpreadsheetCell**](XlsxSpreadsheetCell.md) | Heading cell for this column | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XlsxSpreadsheetRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**path** | **String** | The Path of the location of this object; leave blank for new rows | [optional]
|
|
7
|
+
**cells** | [**Array<XlsxSpreadsheetCell>**](XlsxSpreadsheetCell.md) | Spreadsheet Cells in the spreadsheet row | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XlsxToPngResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**png_result_pages** | [**Array<ConvertedPngPage>**](ConvertedPngPage.md) | Array of converted pages | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XlsxWorksheet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**path** | **String** | The Path of the location of this object; leave blank for new worksheets | [optional]
|
|
7
|
+
**worksheet_name** | **String** | User-facing name of the worksheet tab | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlAddAttributeWithXPathResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**resulting_xml_document** | **String** | Resulting, modified XML document | [optional]
|
|
8
|
+
**nodes_edited_count** | **Integer** | Count of the matching results | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlAddChildWithXPathResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**resulting_xml_document** | **String** | Resulting, modified XML document | [optional]
|
|
8
|
+
**nodes_edited_count** | **Integer** | Count of the matching results | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlFilterWithXPathResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**xml_nodes** | **Array<String>** | Matching selected XML nodes as strings | [optional]
|
|
8
|
+
**result_count** | **Integer** | Count of the matching results | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlQueryWithXQueryMultiResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**resulting_xml** | **String** | Resulting XML result output | [optional]
|
|
8
|
+
**error_message** | **String** | If an error occurs, additional details on the error | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlQueryWithXQueryResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**resulting_xml** | **String** | Resulting XML result output | [optional]
|
|
8
|
+
**error_message** | **String** | If an error occurs, additional details on the error | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlRemoveAllChildrenWithXPathResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**resulting_xml_document** | **String** | Resulting, modified XML document | [optional]
|
|
8
|
+
**nodes_edited_count** | **Integer** | Count of the matching results | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlRemoveWithXPathResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**resulting_xml_document** | **String** | Resulting, modified XML document with matching nodes removed as a string | [optional]
|
|
8
|
+
**xml_nodes_removed** | **Array<String>** | Matching selected XML nodes as strings | [optional]
|
|
9
|
+
**nodes_removed_count** | **Integer** | Count of the matching results | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlReplaceWithXPathResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**resulting_xml_document** | **String** | Resulting, modified XML document | [optional]
|
|
8
|
+
**nodes_edited_count** | **Integer** | Count of the matching results | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::XmlSetValueWithXPathResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**resulting_xml_document** | **String** | Resulting, modified XML document | [optional]
|
|
8
|
+
**nodes_edited_count** | **Integer** | Count of the matching results | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,386 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::ZipArchiveApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**zip_archive_zip_create**](ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
|
|
8
|
+
[**zip_archive_zip_create_advanced**](ZipArchiveApi.md#zip_archive_zip_create_advanced) | **POST** /convert/archive/zip/create/advanced | Compress files and folders to create a new zip archive with advanced options
|
|
9
|
+
[**zip_archive_zip_create_encrypted**](ZipArchiveApi.md#zip_archive_zip_create_encrypted) | **POST** /convert/archive/zip/create/encrypted | Compress files to create a new, encrypted and password-protected zip archive
|
|
10
|
+
[**zip_archive_zip_decrypt**](ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
|
|
11
|
+
[**zip_archive_zip_encrypt_advanced**](ZipArchiveApi.md#zip_archive_zip_encrypt_advanced) | **POST** /convert/archive/zip/encrypt/advanced | Encrypt and password protect a zip file
|
|
12
|
+
[**zip_archive_zip_extract**](ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
# **zip_archive_zip_create**
|
|
16
|
+
> String zip_archive_zip_create(input_file1, opts)
|
|
17
|
+
|
|
18
|
+
Compress files to create a new zip archive
|
|
19
|
+
|
|
20
|
+
Create a new zip archive by compressing input files.
|
|
21
|
+
|
|
22
|
+
### Example
|
|
23
|
+
```ruby
|
|
24
|
+
# load the gem
|
|
25
|
+
require 'cloudmersive-convert-api-client'
|
|
26
|
+
# setup authorization
|
|
27
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
28
|
+
# Configure API key authorization: Apikey
|
|
29
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
31
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
|
35
|
+
|
|
36
|
+
input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
|
|
37
|
+
|
|
38
|
+
opts = {
|
|
39
|
+
input_file2: File.new('/path/to/file.txt'), # File | Second input file to perform the operation on.
|
|
40
|
+
input_file3: File.new('/path/to/file.txt'), # File | Third input file to perform the operation on.
|
|
41
|
+
input_file4: File.new('/path/to/file.txt'), # File | Fourth input file to perform the operation on.
|
|
42
|
+
input_file5: File.new('/path/to/file.txt'), # File | Fifth input file to perform the operation on.
|
|
43
|
+
input_file6: File.new('/path/to/file.txt'), # File | Sixth input file to perform the operation on.
|
|
44
|
+
input_file7: File.new('/path/to/file.txt'), # File | Seventh input file to perform the operation on.
|
|
45
|
+
input_file8: File.new('/path/to/file.txt'), # File | Eighth input file to perform the operation on.
|
|
46
|
+
input_file9: File.new('/path/to/file.txt'), # File | Ninth input file to perform the operation on.
|
|
47
|
+
input_file10: File.new('/path/to/file.txt') # File | Tenth input file to perform the operation on.
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
begin
|
|
51
|
+
#Compress files to create a new zip archive
|
|
52
|
+
result = api_instance.zip_archive_zip_create(input_file1, opts)
|
|
53
|
+
p result
|
|
54
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
55
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_create: #{e}"
|
|
56
|
+
end
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Parameters
|
|
60
|
+
|
|
61
|
+
Name | Type | Description | Notes
|
|
62
|
+
------------- | ------------- | ------------- | -------------
|
|
63
|
+
**input_file1** | **File**| First input file to perform the operation on. |
|
|
64
|
+
**input_file2** | **File**| Second input file to perform the operation on. | [optional]
|
|
65
|
+
**input_file3** | **File**| Third input file to perform the operation on. | [optional]
|
|
66
|
+
**input_file4** | **File**| Fourth input file to perform the operation on. | [optional]
|
|
67
|
+
**input_file5** | **File**| Fifth input file to perform the operation on. | [optional]
|
|
68
|
+
**input_file6** | **File**| Sixth input file to perform the operation on. | [optional]
|
|
69
|
+
**input_file7** | **File**| Seventh input file to perform the operation on. | [optional]
|
|
70
|
+
**input_file8** | **File**| Eighth input file to perform the operation on. | [optional]
|
|
71
|
+
**input_file9** | **File**| Ninth input file to perform the operation on. | [optional]
|
|
72
|
+
**input_file10** | **File**| Tenth input file to perform the operation on. | [optional]
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
**String**
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[Apikey](../README.md#Apikey)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: multipart/form-data
|
|
85
|
+
- **Accept**: application/octet-stream
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
# **zip_archive_zip_create_advanced**
|
|
90
|
+
> Object zip_archive_zip_create_advanced(request)
|
|
91
|
+
|
|
92
|
+
Compress files and folders to create a new zip archive with advanced options
|
|
93
|
+
|
|
94
|
+
Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.
|
|
95
|
+
|
|
96
|
+
### Example
|
|
97
|
+
```ruby
|
|
98
|
+
# load the gem
|
|
99
|
+
require 'cloudmersive-convert-api-client'
|
|
100
|
+
# setup authorization
|
|
101
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
102
|
+
# Configure API key authorization: Apikey
|
|
103
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
104
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
105
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
|
109
|
+
|
|
110
|
+
request = CloudmersiveConvertApiClient::CreateZipArchiveRequest.new # CreateZipArchiveRequest | Input request
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
begin
|
|
114
|
+
#Compress files and folders to create a new zip archive with advanced options
|
|
115
|
+
result = api_instance.zip_archive_zip_create_advanced(request)
|
|
116
|
+
p result
|
|
117
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
118
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_create_advanced: #{e}"
|
|
119
|
+
end
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
Name | Type | Description | Notes
|
|
125
|
+
------------- | ------------- | ------------- | -------------
|
|
126
|
+
**request** | [**CreateZipArchiveRequest**](CreateZipArchiveRequest.md)| Input request |
|
|
127
|
+
|
|
128
|
+
### Return type
|
|
129
|
+
|
|
130
|
+
**Object**
|
|
131
|
+
|
|
132
|
+
### Authorization
|
|
133
|
+
|
|
134
|
+
[Apikey](../README.md#Apikey)
|
|
135
|
+
|
|
136
|
+
### HTTP request headers
|
|
137
|
+
|
|
138
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
139
|
+
- **Accept**: application/octet-stream
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
# **zip_archive_zip_create_encrypted**
|
|
144
|
+
> String zip_archive_zip_create_encrypted(password, input_file1, opts)
|
|
145
|
+
|
|
146
|
+
Compress files to create a new, encrypted and password-protected zip archive
|
|
147
|
+
|
|
148
|
+
Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.
|
|
149
|
+
|
|
150
|
+
### Example
|
|
151
|
+
```ruby
|
|
152
|
+
# load the gem
|
|
153
|
+
require 'cloudmersive-convert-api-client'
|
|
154
|
+
# setup authorization
|
|
155
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
156
|
+
# Configure API key authorization: Apikey
|
|
157
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
158
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
159
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
|
163
|
+
|
|
164
|
+
password = 'password_example' # String | Password to place on the Zip file; the longer the password, the more secure
|
|
165
|
+
|
|
166
|
+
input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
|
|
167
|
+
|
|
168
|
+
opts = {
|
|
169
|
+
encryption_algorithm: 'encryption_algorithm_example', # String | Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
|
|
170
|
+
input_file2: File.new('/path/to/file.txt'), # File | Second input file to perform the operation on.
|
|
171
|
+
input_file3: File.new('/path/to/file.txt'), # File | Third input file to perform the operation on.
|
|
172
|
+
input_file4: File.new('/path/to/file.txt'), # File | Fourth input file to perform the operation on.
|
|
173
|
+
input_file5: File.new('/path/to/file.txt'), # File | Fifth input file to perform the operation on.
|
|
174
|
+
input_file6: File.new('/path/to/file.txt'), # File | Sixth input file to perform the operation on.
|
|
175
|
+
input_file7: File.new('/path/to/file.txt'), # File | Seventh input file to perform the operation on.
|
|
176
|
+
input_file8: File.new('/path/to/file.txt'), # File | Eighth input file to perform the operation on.
|
|
177
|
+
input_file9: File.new('/path/to/file.txt'), # File | Ninth input file to perform the operation on.
|
|
178
|
+
input_file10: File.new('/path/to/file.txt') # File | Tenth input file to perform the operation on.
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
begin
|
|
182
|
+
#Compress files to create a new, encrypted and password-protected zip archive
|
|
183
|
+
result = api_instance.zip_archive_zip_create_encrypted(password, input_file1, opts)
|
|
184
|
+
p result
|
|
185
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
186
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_create_encrypted: #{e}"
|
|
187
|
+
end
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Parameters
|
|
191
|
+
|
|
192
|
+
Name | Type | Description | Notes
|
|
193
|
+
------------- | ------------- | ------------- | -------------
|
|
194
|
+
**password** | **String**| Password to place on the Zip file; the longer the password, the more secure |
|
|
195
|
+
**input_file1** | **File**| First input file to perform the operation on. |
|
|
196
|
+
**encryption_algorithm** | **String**| Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256. | [optional]
|
|
197
|
+
**input_file2** | **File**| Second input file to perform the operation on. | [optional]
|
|
198
|
+
**input_file3** | **File**| Third input file to perform the operation on. | [optional]
|
|
199
|
+
**input_file4** | **File**| Fourth input file to perform the operation on. | [optional]
|
|
200
|
+
**input_file5** | **File**| Fifth input file to perform the operation on. | [optional]
|
|
201
|
+
**input_file6** | **File**| Sixth input file to perform the operation on. | [optional]
|
|
202
|
+
**input_file7** | **File**| Seventh input file to perform the operation on. | [optional]
|
|
203
|
+
**input_file8** | **File**| Eighth input file to perform the operation on. | [optional]
|
|
204
|
+
**input_file9** | **File**| Ninth input file to perform the operation on. | [optional]
|
|
205
|
+
**input_file10** | **File**| Tenth input file to perform the operation on. | [optional]
|
|
206
|
+
|
|
207
|
+
### Return type
|
|
208
|
+
|
|
209
|
+
**String**
|
|
210
|
+
|
|
211
|
+
### Authorization
|
|
212
|
+
|
|
213
|
+
[Apikey](../README.md#Apikey)
|
|
214
|
+
|
|
215
|
+
### HTTP request headers
|
|
216
|
+
|
|
217
|
+
- **Content-Type**: multipart/form-data
|
|
218
|
+
- **Accept**: application/octet-stream
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
# **zip_archive_zip_decrypt**
|
|
223
|
+
> Object zip_archive_zip_decrypt(input_file, zip_password)
|
|
224
|
+
|
|
225
|
+
Decrypt and remove password protection on a zip file
|
|
226
|
+
|
|
227
|
+
Decrypts and removes password protection from an encrypted zip file with the specified password
|
|
228
|
+
|
|
229
|
+
### Example
|
|
230
|
+
```ruby
|
|
231
|
+
# load the gem
|
|
232
|
+
require 'cloudmersive-convert-api-client'
|
|
233
|
+
# setup authorization
|
|
234
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
235
|
+
# Configure API key authorization: Apikey
|
|
236
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
237
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
238
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
|
242
|
+
|
|
243
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
244
|
+
|
|
245
|
+
zip_password = 'zip_password_example' # String | Required; Password for the input archive
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
begin
|
|
249
|
+
#Decrypt and remove password protection on a zip file
|
|
250
|
+
result = api_instance.zip_archive_zip_decrypt(input_file, zip_password)
|
|
251
|
+
p result
|
|
252
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
253
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_decrypt: #{e}"
|
|
254
|
+
end
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
### Parameters
|
|
258
|
+
|
|
259
|
+
Name | Type | Description | Notes
|
|
260
|
+
------------- | ------------- | ------------- | -------------
|
|
261
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
262
|
+
**zip_password** | **String**| Required; Password for the input archive |
|
|
263
|
+
|
|
264
|
+
### Return type
|
|
265
|
+
|
|
266
|
+
**Object**
|
|
267
|
+
|
|
268
|
+
### Authorization
|
|
269
|
+
|
|
270
|
+
[Apikey](../README.md#Apikey)
|
|
271
|
+
|
|
272
|
+
### HTTP request headers
|
|
273
|
+
|
|
274
|
+
- **Content-Type**: multipart/form-data
|
|
275
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
# **zip_archive_zip_encrypt_advanced**
|
|
280
|
+
> Object zip_archive_zip_encrypt_advanced(encryption_request)
|
|
281
|
+
|
|
282
|
+
Encrypt and password protect a zip file
|
|
283
|
+
|
|
284
|
+
Encrypts and password protects an existing zip file with the specified password and encryption algorithm
|
|
285
|
+
|
|
286
|
+
### Example
|
|
287
|
+
```ruby
|
|
288
|
+
# load the gem
|
|
289
|
+
require 'cloudmersive-convert-api-client'
|
|
290
|
+
# setup authorization
|
|
291
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
292
|
+
# Configure API key authorization: Apikey
|
|
293
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
294
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
295
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
|
299
|
+
|
|
300
|
+
encryption_request = CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest.new # ZipEncryptionAdvancedRequest | Encryption request
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
begin
|
|
304
|
+
#Encrypt and password protect a zip file
|
|
305
|
+
result = api_instance.zip_archive_zip_encrypt_advanced(encryption_request)
|
|
306
|
+
p result
|
|
307
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
308
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_encrypt_advanced: #{e}"
|
|
309
|
+
end
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### Parameters
|
|
313
|
+
|
|
314
|
+
Name | Type | Description | Notes
|
|
315
|
+
------------- | ------------- | ------------- | -------------
|
|
316
|
+
**encryption_request** | [**ZipEncryptionAdvancedRequest**](ZipEncryptionAdvancedRequest.md)| Encryption request |
|
|
317
|
+
|
|
318
|
+
### Return type
|
|
319
|
+
|
|
320
|
+
**Object**
|
|
321
|
+
|
|
322
|
+
### Authorization
|
|
323
|
+
|
|
324
|
+
[Apikey](../README.md#Apikey)
|
|
325
|
+
|
|
326
|
+
### HTTP request headers
|
|
327
|
+
|
|
328
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
329
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
# **zip_archive_zip_extract**
|
|
334
|
+
> ZipExtractResponse zip_archive_zip_extract(input_file)
|
|
335
|
+
|
|
336
|
+
Extract, decompress files and folders from a zip archive
|
|
337
|
+
|
|
338
|
+
Extracts a zip archive by decompressing files, and folders.
|
|
339
|
+
|
|
340
|
+
### Example
|
|
341
|
+
```ruby
|
|
342
|
+
# load the gem
|
|
343
|
+
require 'cloudmersive-convert-api-client'
|
|
344
|
+
# setup authorization
|
|
345
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
346
|
+
# Configure API key authorization: Apikey
|
|
347
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
348
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
349
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
350
|
+
end
|
|
351
|
+
|
|
352
|
+
api_instance = CloudmersiveConvertApiClient::ZipArchiveApi.new
|
|
353
|
+
|
|
354
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
begin
|
|
358
|
+
#Extract, decompress files and folders from a zip archive
|
|
359
|
+
result = api_instance.zip_archive_zip_extract(input_file)
|
|
360
|
+
p result
|
|
361
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
362
|
+
puts "Exception when calling ZipArchiveApi->zip_archive_zip_extract: #{e}"
|
|
363
|
+
end
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### Parameters
|
|
367
|
+
|
|
368
|
+
Name | Type | Description | Notes
|
|
369
|
+
------------- | ------------- | ------------- | -------------
|
|
370
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
371
|
+
|
|
372
|
+
### Return type
|
|
373
|
+
|
|
374
|
+
[**ZipExtractResponse**](ZipExtractResponse.md)
|
|
375
|
+
|
|
376
|
+
### Authorization
|
|
377
|
+
|
|
378
|
+
[Apikey](../README.md#Apikey)
|
|
379
|
+
|
|
380
|
+
### HTTP request headers
|
|
381
|
+
|
|
382
|
+
- **Content-Type**: multipart/form-data
|
|
383
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|