cloudmersive-convert-api-client 2.0.6 → 2.0.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +7 -0
- data/README.md +579 -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 +902 -0
- data/docs/ConvertDocumentApi.md +4344 -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 +3033 -0
- data/docs/EditHtmlApi.md +261 -0
- data/docs/EditPdfApi.md +1083 -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 +833 -0
- data/docs/ViewerResponse.md +9 -0
- data/docs/ViewerToolsApi.md +63 -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 +306 -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 +966 -0
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +4360 -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 +2994 -0
- data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +270 -0
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +1163 -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 +848 -0
- data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +78 -0
- data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +330 -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 +240 -0
- data/spec/api/convert_document_api_spec.rb +998 -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 +695 -0
- data/spec/api/edit_html_api_spec.rb +96 -0
- data/spec/api/edit_pdf_api_spec.rb +282 -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 +215 -0
- data/spec/api/viewer_tools_api_spec.rb +47 -0
- data/spec/api/zip_archive_api_spec.rb +105 -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,9 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetFooterResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
|
7
|
+
**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetHeaderRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
|
|
7
|
+
**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]
|
|
8
|
+
**header_to_apply** | [**DocxHeader**](DocxHeader.md) | Header to apply | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetHeaderResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
|
7
|
+
**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/DocxStyle.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxStyle
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**style_id** | **String** | ID of the style | [optional]
|
|
7
|
+
**path** | **String** | The Path of the location of this object; leave blank for new tables | [optional]
|
|
8
|
+
**bold** | **BOOLEAN** | Style applies bold formatting | [optional]
|
|
9
|
+
**italic** | **BOOLEAN** | Style applies italic formatting | [optional]
|
|
10
|
+
**underline** | **BOOLEAN** | Style applies underline formatting | [optional]
|
|
11
|
+
**font_size** | **String** | Font size | [optional]
|
|
12
|
+
**font_family** | **String** | Font family | [optional]
|
|
13
|
+
|
|
14
|
+
|
data/docs/DocxTable.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTable
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**table_id** | **String** | The ID of the table; leave blank for new tables | [optional]
|
|
7
|
+
**path** | **String** | The Path of the location of this table object; leave blank for new tables | [optional]
|
|
8
|
+
**width** | **String** | The Width of the table, or 0 if not specified | [optional]
|
|
9
|
+
**width_type** | **String** | The Width configuration type of the table | [optional]
|
|
10
|
+
**table_rows** | [**Array<DocxTableRow>**](DocxTableRow.md) | Rows in the table; this is where the contents is located | [optional]
|
|
11
|
+
**top_border_type** | **String** | Type for the top border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
|
12
|
+
**top_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
|
13
|
+
**top_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
|
14
|
+
**top_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
|
15
|
+
**bottom_border_type** | **String** | Type for the bottom border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
|
16
|
+
**bottom_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
|
17
|
+
**bottom_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
|
18
|
+
**bottom_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
|
19
|
+
**left_border_type** | **String** | Type for the left border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
|
20
|
+
**left_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
|
21
|
+
**left_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
|
22
|
+
**left_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
|
23
|
+
**right_border_type** | **String** | Type for the right border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
|
24
|
+
**right_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
|
25
|
+
**right_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
|
26
|
+
**right_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
|
27
|
+
**cell_horizontal_border_type** | **String** | Type for the cell horizontal border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
|
28
|
+
**cell_horizontal_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
|
29
|
+
**cell_horizontal_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
|
30
|
+
**cell_horizontal_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
|
31
|
+
**cell_vertical_border_type** | **String** | Type for the cell vertical border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
|
32
|
+
**cell_vertical_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
|
33
|
+
**cell_vertical_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
|
34
|
+
**cell_vertical_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
|
35
|
+
**start_border_type** | **String** | Type for the start border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
|
36
|
+
**start_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
|
37
|
+
**start_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
|
38
|
+
**start_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
|
39
|
+
**end_border_type** | **String** | Type for the end border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
|
40
|
+
**end_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
|
41
|
+
**end_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
|
42
|
+
**end_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
|
43
|
+
**table_indentation_mode** | **String** | Table indentation type | [optional]
|
|
44
|
+
**table_indentation_width** | **Integer** | Table indentation width | [optional]
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableCell
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**cell_index** | **Integer** | The index of the cell, 0-based | [optional]
|
|
7
|
+
**path** | **String** | The Path of the location of this object; leave blank for new tables | [optional]
|
|
8
|
+
**paragraphs** | [**Array<DocxParagraph>**](DocxParagraph.md) | Paragraphs inside the cell; this is where the contents of the cell are stored | [optional]
|
|
9
|
+
**cell_shading_color** | **String** | Color of the cell shading | [optional]
|
|
10
|
+
**cell_shading_fill** | **String** | Fill of the cell shading | [optional]
|
|
11
|
+
**cell_shading_pattern** | **String** | Pattern of the cell shading | [optional]
|
|
12
|
+
**cell_width_mode** | **String** | Width mode of the cell; can be auto (for automatic) or manual | [optional]
|
|
13
|
+
**cell_width** | **String** | Width of the cell | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**row_index** | **Integer** | Index of the row, 0-based | [optional]
|
|
7
|
+
**path** | **String** | The Path of the location of this table row object; leave blank for new tables | [optional]
|
|
8
|
+
**row_cells** | [**Array<DocxTableCell>**](DocxTableCell.md) | Cells in the row; this is where the contents of the row is stored | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTemplateApplicationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**operations** | [**Array<DocxTemplateOperation>**](DocxTemplateOperation.md) | Operations to apply to this template | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTemplateOperation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**action** | **Integer** | Operation action to take; possible values are \"Replace\" | [optional]
|
|
7
|
+
**match_against** | **String** | For Replace operations, the string to match against (to be replaced with ReplaceWith string) | [optional]
|
|
8
|
+
**replace_with** | **String** | For Replace operations, the string to Replace the original string with | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/DocxText.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxText
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**text_index** | **Integer** | Index of the text content in the run; 0-based | [optional]
|
|
7
|
+
**path** | **String** | The Path of the location of this Text object; leave blank for creation | [optional]
|
|
8
|
+
**text_content** | **String** | Text string containing the text content of this text content item | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxToJpgResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
+
**jpg_result_pages** | [**Array<ConvertedJpgPage>**](ConvertedJpgPage.md) | Array of converted pages | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxToPngResult
|
|
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,14 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTopLevelComment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**path** | **String** | Path to the comment in the document | [optional]
|
|
7
|
+
**author** | **String** | Author name of the comment | [optional]
|
|
8
|
+
**author_initials** | **String** | Initials of the author of the comment | [optional]
|
|
9
|
+
**comment_text** | **String** | Text content of the comment | [optional]
|
|
10
|
+
**comment_date** | **DateTime** | Date timestamp of the comment | [optional]
|
|
11
|
+
**reply_child_comments** | [**Array<DocxComment>**](DocxComment.md) | Child comments, that are replies to this one | [optional]
|
|
12
|
+
**done** | **BOOLEAN** | True if this comment is marked as Done in Word, otherwise it is false | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,3033 @@
|
|
|
1
|
+
# CloudmersiveConvertApiClient::EditDocumentApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**edit_document_begin_editing**](EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
|
|
8
|
+
[**edit_document_docx_body**](EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a Word DOCX document
|
|
9
|
+
[**edit_document_docx_create_blank_document**](EditDocumentApi.md#edit_document_docx_create_blank_document) | **POST** /convert/edit/docx/create/blank | Create a blank Word DOCX document
|
|
10
|
+
[**edit_document_docx_delete_pages**](EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
|
|
11
|
+
[**edit_document_docx_delete_table_row**](EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
|
|
12
|
+
[**edit_document_docx_delete_table_row_range**](EditDocumentApi.md#edit_document_docx_delete_table_row_range) | **POST** /convert/edit/docx/delete-table-row/range | Deletes a range of multiple table rows in an existing table in a Word DOCX document
|
|
13
|
+
[**edit_document_docx_find_paragraph**](EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
|
|
14
|
+
[**edit_document_docx_get_comments**](EditDocumentApi.md#edit_document_docx_get_comments) | **POST** /convert/edit/docx/get-comments/flat-list | Get comments from a Word DOCX document as a flat list
|
|
15
|
+
[**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
|
|
16
|
+
[**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
|
|
17
|
+
[**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
|
|
18
|
+
[**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
|
|
19
|
+
[**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
|
|
20
|
+
[**edit_document_docx_get_table_by_index**](EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
|
|
21
|
+
[**edit_document_docx_get_table_row**](EditDocumentApi.md#edit_document_docx_get_table_row) | **POST** /convert/edit/docx/get-table-row | Gets the contents of an existing table row in an existing table in a Word DOCX document
|
|
22
|
+
[**edit_document_docx_get_tables**](EditDocumentApi.md#edit_document_docx_get_tables) | **POST** /convert/edit/docx/get-tables | Get all tables in Word DOCX document
|
|
23
|
+
[**edit_document_docx_insert_comment_on_paragraph**](EditDocumentApi.md#edit_document_docx_insert_comment_on_paragraph) | **POST** /convert/edit/docx/insert-comment/on/paragraph | Insert a new comment into a Word DOCX document attached to a paragraph
|
|
24
|
+
[**edit_document_docx_insert_image**](EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a Word DOCX document
|
|
25
|
+
[**edit_document_docx_insert_paragraph**](EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a Word DOCX document
|
|
26
|
+
[**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
|
|
27
|
+
[**edit_document_docx_insert_table_row**](EditDocumentApi.md#edit_document_docx_insert_table_row) | **POST** /convert/edit/docx/insert-table-row | Insert a new row into an existing table in a Word DOCX document
|
|
28
|
+
[**edit_document_docx_pages**](EditDocumentApi.md#edit_document_docx_pages) | **POST** /convert/edit/docx/get-pages | Get pages and content from a Word DOCX document
|
|
29
|
+
[**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
|
|
30
|
+
[**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
|
|
31
|
+
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
|
32
|
+
[**edit_document_docx_replace_multi**](EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
|
|
33
|
+
[**edit_document_docx_replace_paragraph**](EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
|
|
34
|
+
[**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
|
|
35
|
+
[**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
|
|
36
|
+
[**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
|
37
|
+
[**edit_document_docx_update_table_cell**](EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
|
38
|
+
[**edit_document_docx_update_table_row**](EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
|
39
|
+
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
|
|
40
|
+
[**edit_document_pptx_delete_slides**](EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
|
|
41
|
+
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
|
42
|
+
[**edit_document_xlsx_append_row**](EditDocumentApi.md#edit_document_xlsx_append_row) | **POST** /convert/edit/xlsx/append-row | Append row to a Excel XLSX spreadsheet, worksheet
|
|
43
|
+
[**edit_document_xlsx_clear_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
|
|
44
|
+
[**edit_document_xlsx_clear_row**](EditDocumentApi.md#edit_document_xlsx_clear_row) | **POST** /convert/edit/xlsx/clear-row | Clear row from a Excel XLSX spreadsheet, worksheet
|
|
45
|
+
[**edit_document_xlsx_create_blank_spreadsheet**](EditDocumentApi.md#edit_document_xlsx_create_blank_spreadsheet) | **POST** /convert/edit/xlsx/create/blank | Create a blank Excel XLSX spreadsheet
|
|
46
|
+
[**edit_document_xlsx_create_spreadsheet_from_data**](EditDocumentApi.md#edit_document_xlsx_create_spreadsheet_from_data) | **POST** /convert/edit/xlsx/create/from/data | Create a new Excel XLSX spreadsheet from column and row data
|
|
47
|
+
[**edit_document_xlsx_delete_worksheet**](EditDocumentApi.md#edit_document_xlsx_delete_worksheet) | **POST** /convert/edit/xlsx/delete-worksheet | Delete, remove worksheet from an Excel XLSX spreadsheet document
|
|
48
|
+
[**edit_document_xlsx_disable_shared_workbook**](EditDocumentApi.md#edit_document_xlsx_disable_shared_workbook) | **POST** /convert/edit/xlsx/configuration/disable-shared-workbook | Disable Shared Workbook (legacy) in Excel XLSX spreadsheet
|
|
49
|
+
[**edit_document_xlsx_enable_shared_workbook**](EditDocumentApi.md#edit_document_xlsx_enable_shared_workbook) | **POST** /convert/edit/xlsx/configuration/enable-shared-workbook | Enable Shared Workbook (legacy) in Excel XLSX spreadsheet
|
|
50
|
+
[**edit_document_xlsx_get_cell_by_identifier**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_identifier) | **POST** /convert/edit/xlsx/get-cell/by-identifier | Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
|
|
51
|
+
[**edit_document_xlsx_get_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
|
|
52
|
+
[**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get columns from a Excel XLSX spreadsheet, worksheet
|
|
53
|
+
[**edit_document_xlsx_get_images**](EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
|
|
54
|
+
[**edit_document_xlsx_get_rows_and_cells**](EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
|
55
|
+
[**edit_document_xlsx_get_specific_row**](EditDocumentApi.md#edit_document_xlsx_get_specific_row) | **POST** /convert/edit/xlsx/get-specific-row | Get a specific row from a Excel XLSX spreadsheet, worksheet by path
|
|
56
|
+
[**edit_document_xlsx_get_styles**](EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
|
|
57
|
+
[**edit_document_xlsx_get_worksheets**](EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a Excel XLSX spreadsheet
|
|
58
|
+
[**edit_document_xlsx_insert_worksheet**](EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an Excel XLSX spreadsheet
|
|
59
|
+
[**edit_document_xlsx_rename_worksheet**](EditDocumentApi.md#edit_document_xlsx_rename_worksheet) | **POST** /convert/edit/xlsx/rename-worksheet | Rename a specific worksheet in a Excel XLSX spreadsheet
|
|
60
|
+
[**edit_document_xlsx_set_cell_by_identifier**](EditDocumentApi.md#edit_document_xlsx_set_cell_by_identifier) | **POST** /convert/edit/xlsx/set-cell/by-identifier | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
|
|
61
|
+
[**edit_document_xlsx_set_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_set_cell_by_index) | **POST** /convert/edit/xlsx/set-cell/by-index | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
# **edit_document_begin_editing**
|
|
65
|
+
> String edit_document_begin_editing(input_file)
|
|
66
|
+
|
|
67
|
+
Begin editing a document
|
|
68
|
+
|
|
69
|
+
Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
```ruby
|
|
73
|
+
# load the gem
|
|
74
|
+
require 'cloudmersive-convert-api-client'
|
|
75
|
+
# setup authorization
|
|
76
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
77
|
+
# Configure API key authorization: Apikey
|
|
78
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
79
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
80
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
84
|
+
|
|
85
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
begin
|
|
89
|
+
#Begin editing a document
|
|
90
|
+
result = api_instance.edit_document_begin_editing(input_file)
|
|
91
|
+
p result
|
|
92
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
93
|
+
puts "Exception when calling EditDocumentApi->edit_document_begin_editing: #{e}"
|
|
94
|
+
end
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
Name | Type | Description | Notes
|
|
100
|
+
------------- | ------------- | ------------- | -------------
|
|
101
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
**String**
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[Apikey](../README.md#Apikey)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: multipart/form-data
|
|
114
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
# **edit_document_docx_body**
|
|
119
|
+
> GetDocxBodyResponse edit_document_docx_body(req_config)
|
|
120
|
+
|
|
121
|
+
Get body from a Word DOCX document
|
|
122
|
+
|
|
123
|
+
Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
|
|
124
|
+
|
|
125
|
+
### Example
|
|
126
|
+
```ruby
|
|
127
|
+
# load the gem
|
|
128
|
+
require 'cloudmersive-convert-api-client'
|
|
129
|
+
# setup authorization
|
|
130
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
131
|
+
# Configure API key authorization: Apikey
|
|
132
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
133
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
134
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
138
|
+
|
|
139
|
+
req_config = CloudmersiveConvertApiClient::GetDocxBodyRequest.new # GetDocxBodyRequest | Document input request
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
begin
|
|
143
|
+
#Get body from a Word DOCX document
|
|
144
|
+
result = api_instance.edit_document_docx_body(req_config)
|
|
145
|
+
p result
|
|
146
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
147
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_body: #{e}"
|
|
148
|
+
end
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Parameters
|
|
152
|
+
|
|
153
|
+
Name | Type | Description | Notes
|
|
154
|
+
------------- | ------------- | ------------- | -------------
|
|
155
|
+
**req_config** | [**GetDocxBodyRequest**](GetDocxBodyRequest.md)| Document input request |
|
|
156
|
+
|
|
157
|
+
### Return type
|
|
158
|
+
|
|
159
|
+
[**GetDocxBodyResponse**](GetDocxBodyResponse.md)
|
|
160
|
+
|
|
161
|
+
### Authorization
|
|
162
|
+
|
|
163
|
+
[Apikey](../README.md#Apikey)
|
|
164
|
+
|
|
165
|
+
### HTTP request headers
|
|
166
|
+
|
|
167
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
168
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
# **edit_document_docx_create_blank_document**
|
|
173
|
+
> CreateBlankDocxResponse edit_document_docx_create_blank_document(input)
|
|
174
|
+
|
|
175
|
+
Create a blank Word DOCX document
|
|
176
|
+
|
|
177
|
+
Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.
|
|
178
|
+
|
|
179
|
+
### Example
|
|
180
|
+
```ruby
|
|
181
|
+
# load the gem
|
|
182
|
+
require 'cloudmersive-convert-api-client'
|
|
183
|
+
# setup authorization
|
|
184
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
185
|
+
# Configure API key authorization: Apikey
|
|
186
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
187
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
188
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
192
|
+
|
|
193
|
+
input = CloudmersiveConvertApiClient::CreateBlankDocxRequest.new # CreateBlankDocxRequest | Document input request
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
begin
|
|
197
|
+
#Create a blank Word DOCX document
|
|
198
|
+
result = api_instance.edit_document_docx_create_blank_document(input)
|
|
199
|
+
p result
|
|
200
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
201
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_create_blank_document: #{e}"
|
|
202
|
+
end
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### Parameters
|
|
206
|
+
|
|
207
|
+
Name | Type | Description | Notes
|
|
208
|
+
------------- | ------------- | ------------- | -------------
|
|
209
|
+
**input** | [**CreateBlankDocxRequest**](CreateBlankDocxRequest.md)| Document input request |
|
|
210
|
+
|
|
211
|
+
### Return type
|
|
212
|
+
|
|
213
|
+
[**CreateBlankDocxResponse**](CreateBlankDocxResponse.md)
|
|
214
|
+
|
|
215
|
+
### Authorization
|
|
216
|
+
|
|
217
|
+
[Apikey](../README.md#Apikey)
|
|
218
|
+
|
|
219
|
+
### HTTP request headers
|
|
220
|
+
|
|
221
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
222
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
# **edit_document_docx_delete_pages**
|
|
227
|
+
> String edit_document_docx_delete_pages(req_config)
|
|
228
|
+
|
|
229
|
+
Delete, remove pages from a Word DOCX document
|
|
230
|
+
|
|
231
|
+
Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed
|
|
232
|
+
|
|
233
|
+
### Example
|
|
234
|
+
```ruby
|
|
235
|
+
# load the gem
|
|
236
|
+
require 'cloudmersive-convert-api-client'
|
|
237
|
+
# setup authorization
|
|
238
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
239
|
+
# Configure API key authorization: Apikey
|
|
240
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
241
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
242
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
246
|
+
|
|
247
|
+
req_config = CloudmersiveConvertApiClient::RemoveDocxPagesRequest.new # RemoveDocxPagesRequest | Document input request
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
begin
|
|
251
|
+
#Delete, remove pages from a Word DOCX document
|
|
252
|
+
result = api_instance.edit_document_docx_delete_pages(req_config)
|
|
253
|
+
p result
|
|
254
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
255
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_delete_pages: #{e}"
|
|
256
|
+
end
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### Parameters
|
|
260
|
+
|
|
261
|
+
Name | Type | Description | Notes
|
|
262
|
+
------------- | ------------- | ------------- | -------------
|
|
263
|
+
**req_config** | [**RemoveDocxPagesRequest**](RemoveDocxPagesRequest.md)| Document input request |
|
|
264
|
+
|
|
265
|
+
### Return type
|
|
266
|
+
|
|
267
|
+
**String**
|
|
268
|
+
|
|
269
|
+
### Authorization
|
|
270
|
+
|
|
271
|
+
[Apikey](../README.md#Apikey)
|
|
272
|
+
|
|
273
|
+
### HTTP request headers
|
|
274
|
+
|
|
275
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
276
|
+
- **Accept**: application/octet-stream
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
# **edit_document_docx_delete_table_row**
|
|
281
|
+
> DeleteDocxTableRowResponse edit_document_docx_delete_table_row(req_config)
|
|
282
|
+
|
|
283
|
+
Deletes a table row in an existing table in a Word DOCX document
|
|
284
|
+
|
|
285
|
+
Deletes an existing table row in a Word DOCX Document and returns the result.
|
|
286
|
+
|
|
287
|
+
### Example
|
|
288
|
+
```ruby
|
|
289
|
+
# load the gem
|
|
290
|
+
require 'cloudmersive-convert-api-client'
|
|
291
|
+
# setup authorization
|
|
292
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
293
|
+
# Configure API key authorization: Apikey
|
|
294
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
295
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
296
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
297
|
+
end
|
|
298
|
+
|
|
299
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
300
|
+
|
|
301
|
+
req_config = CloudmersiveConvertApiClient::DeleteDocxTableRowRequest.new # DeleteDocxTableRowRequest | Document input request
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
begin
|
|
305
|
+
#Deletes a table row in an existing table in a Word DOCX document
|
|
306
|
+
result = api_instance.edit_document_docx_delete_table_row(req_config)
|
|
307
|
+
p result
|
|
308
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
309
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_delete_table_row: #{e}"
|
|
310
|
+
end
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
### Parameters
|
|
314
|
+
|
|
315
|
+
Name | Type | Description | Notes
|
|
316
|
+
------------- | ------------- | ------------- | -------------
|
|
317
|
+
**req_config** | [**DeleteDocxTableRowRequest**](DeleteDocxTableRowRequest.md)| Document input request |
|
|
318
|
+
|
|
319
|
+
### Return type
|
|
320
|
+
|
|
321
|
+
[**DeleteDocxTableRowResponse**](DeleteDocxTableRowResponse.md)
|
|
322
|
+
|
|
323
|
+
### Authorization
|
|
324
|
+
|
|
325
|
+
[Apikey](../README.md#Apikey)
|
|
326
|
+
|
|
327
|
+
### HTTP request headers
|
|
328
|
+
|
|
329
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
330
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
# **edit_document_docx_delete_table_row_range**
|
|
335
|
+
> DeleteDocxTableRowRangeResponse edit_document_docx_delete_table_row_range(req_config)
|
|
336
|
+
|
|
337
|
+
Deletes a range of multiple table rows in an existing table in a Word DOCX document
|
|
338
|
+
|
|
339
|
+
Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.
|
|
340
|
+
|
|
341
|
+
### Example
|
|
342
|
+
```ruby
|
|
343
|
+
# load the gem
|
|
344
|
+
require 'cloudmersive-convert-api-client'
|
|
345
|
+
# setup authorization
|
|
346
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
347
|
+
# Configure API key authorization: Apikey
|
|
348
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
349
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
350
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
351
|
+
end
|
|
352
|
+
|
|
353
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
354
|
+
|
|
355
|
+
req_config = CloudmersiveConvertApiClient::DeleteDocxTableRowRangeRequest.new # DeleteDocxTableRowRangeRequest | Document input request
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
begin
|
|
359
|
+
#Deletes a range of multiple table rows in an existing table in a Word DOCX document
|
|
360
|
+
result = api_instance.edit_document_docx_delete_table_row_range(req_config)
|
|
361
|
+
p result
|
|
362
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
363
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_delete_table_row_range: #{e}"
|
|
364
|
+
end
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Parameters
|
|
368
|
+
|
|
369
|
+
Name | Type | Description | Notes
|
|
370
|
+
------------- | ------------- | ------------- | -------------
|
|
371
|
+
**req_config** | [**DeleteDocxTableRowRangeRequest**](DeleteDocxTableRowRangeRequest.md)| Document input request |
|
|
372
|
+
|
|
373
|
+
### Return type
|
|
374
|
+
|
|
375
|
+
[**DeleteDocxTableRowRangeResponse**](DeleteDocxTableRowRangeResponse.md)
|
|
376
|
+
|
|
377
|
+
### Authorization
|
|
378
|
+
|
|
379
|
+
[Apikey](../README.md#Apikey)
|
|
380
|
+
|
|
381
|
+
### HTTP request headers
|
|
382
|
+
|
|
383
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
384
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
# **edit_document_docx_find_paragraph**
|
|
389
|
+
> FindDocxParagraphResponse edit_document_docx_find_paragraph(req_config)
|
|
390
|
+
|
|
391
|
+
Find matching paragraphs in a Word DOCX document
|
|
392
|
+
|
|
393
|
+
Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
|
|
394
|
+
|
|
395
|
+
### Example
|
|
396
|
+
```ruby
|
|
397
|
+
# load the gem
|
|
398
|
+
require 'cloudmersive-convert-api-client'
|
|
399
|
+
# setup authorization
|
|
400
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
401
|
+
# Configure API key authorization: Apikey
|
|
402
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
403
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
404
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
405
|
+
end
|
|
406
|
+
|
|
407
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
408
|
+
|
|
409
|
+
req_config = CloudmersiveConvertApiClient::FindDocxParagraphRequest.new # FindDocxParagraphRequest | Document input request
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
begin
|
|
413
|
+
#Find matching paragraphs in a Word DOCX document
|
|
414
|
+
result = api_instance.edit_document_docx_find_paragraph(req_config)
|
|
415
|
+
p result
|
|
416
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
417
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_find_paragraph: #{e}"
|
|
418
|
+
end
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### Parameters
|
|
422
|
+
|
|
423
|
+
Name | Type | Description | Notes
|
|
424
|
+
------------- | ------------- | ------------- | -------------
|
|
425
|
+
**req_config** | [**FindDocxParagraphRequest**](FindDocxParagraphRequest.md)| Document input request |
|
|
426
|
+
|
|
427
|
+
### Return type
|
|
428
|
+
|
|
429
|
+
[**FindDocxParagraphResponse**](FindDocxParagraphResponse.md)
|
|
430
|
+
|
|
431
|
+
### Authorization
|
|
432
|
+
|
|
433
|
+
[Apikey](../README.md#Apikey)
|
|
434
|
+
|
|
435
|
+
### HTTP request headers
|
|
436
|
+
|
|
437
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
438
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
# **edit_document_docx_get_comments**
|
|
443
|
+
> GetDocxCommentsResponse edit_document_docx_get_comments(req_config)
|
|
444
|
+
|
|
445
|
+
Get comments from a Word DOCX document as a flat list
|
|
446
|
+
|
|
447
|
+
Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
|
|
448
|
+
|
|
449
|
+
### Example
|
|
450
|
+
```ruby
|
|
451
|
+
# load the gem
|
|
452
|
+
require 'cloudmersive-convert-api-client'
|
|
453
|
+
# setup authorization
|
|
454
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
455
|
+
# Configure API key authorization: Apikey
|
|
456
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
457
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
458
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
459
|
+
end
|
|
460
|
+
|
|
461
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
462
|
+
|
|
463
|
+
req_config = CloudmersiveConvertApiClient::GetDocxGetCommentsRequest.new # GetDocxGetCommentsRequest | Document input request
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
begin
|
|
467
|
+
#Get comments from a Word DOCX document as a flat list
|
|
468
|
+
result = api_instance.edit_document_docx_get_comments(req_config)
|
|
469
|
+
p result
|
|
470
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
471
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_comments: #{e}"
|
|
472
|
+
end
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
### Parameters
|
|
476
|
+
|
|
477
|
+
Name | Type | Description | Notes
|
|
478
|
+
------------- | ------------- | ------------- | -------------
|
|
479
|
+
**req_config** | [**GetDocxGetCommentsRequest**](GetDocxGetCommentsRequest.md)| Document input request |
|
|
480
|
+
|
|
481
|
+
### Return type
|
|
482
|
+
|
|
483
|
+
[**GetDocxCommentsResponse**](GetDocxCommentsResponse.md)
|
|
484
|
+
|
|
485
|
+
### Authorization
|
|
486
|
+
|
|
487
|
+
[Apikey](../README.md#Apikey)
|
|
488
|
+
|
|
489
|
+
### HTTP request headers
|
|
490
|
+
|
|
491
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
492
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
# **edit_document_docx_get_comments_hierarchical**
|
|
497
|
+
> GetDocxCommentsHierarchicalResponse edit_document_docx_get_comments_hierarchical(req_config)
|
|
498
|
+
|
|
499
|
+
Get comments from a Word DOCX document hierarchically
|
|
500
|
+
|
|
501
|
+
Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.
|
|
502
|
+
|
|
503
|
+
### Example
|
|
504
|
+
```ruby
|
|
505
|
+
# load the gem
|
|
506
|
+
require 'cloudmersive-convert-api-client'
|
|
507
|
+
# setup authorization
|
|
508
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
509
|
+
# Configure API key authorization: Apikey
|
|
510
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
511
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
512
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
513
|
+
end
|
|
514
|
+
|
|
515
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
516
|
+
|
|
517
|
+
req_config = CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest.new # GetDocxGetCommentsHierarchicalRequest | Document input request
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
begin
|
|
521
|
+
#Get comments from a Word DOCX document hierarchically
|
|
522
|
+
result = api_instance.edit_document_docx_get_comments_hierarchical(req_config)
|
|
523
|
+
p result
|
|
524
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
525
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_comments_hierarchical: #{e}"
|
|
526
|
+
end
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
### Parameters
|
|
530
|
+
|
|
531
|
+
Name | Type | Description | Notes
|
|
532
|
+
------------- | ------------- | ------------- | -------------
|
|
533
|
+
**req_config** | [**GetDocxGetCommentsHierarchicalRequest**](GetDocxGetCommentsHierarchicalRequest.md)| Document input request |
|
|
534
|
+
|
|
535
|
+
### Return type
|
|
536
|
+
|
|
537
|
+
[**GetDocxCommentsHierarchicalResponse**](GetDocxCommentsHierarchicalResponse.md)
|
|
538
|
+
|
|
539
|
+
### Authorization
|
|
540
|
+
|
|
541
|
+
[Apikey](../README.md#Apikey)
|
|
542
|
+
|
|
543
|
+
### HTTP request headers
|
|
544
|
+
|
|
545
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
546
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
# **edit_document_docx_get_headers_and_footers**
|
|
551
|
+
> GetDocxHeadersAndFootersResponse edit_document_docx_get_headers_and_footers(req_config)
|
|
552
|
+
|
|
553
|
+
Get content of a footer from a Word DOCX document
|
|
554
|
+
|
|
555
|
+
Returns the footer content from a Word Document (DOCX) format file
|
|
556
|
+
|
|
557
|
+
### Example
|
|
558
|
+
```ruby
|
|
559
|
+
# load the gem
|
|
560
|
+
require 'cloudmersive-convert-api-client'
|
|
561
|
+
# setup authorization
|
|
562
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
563
|
+
# Configure API key authorization: Apikey
|
|
564
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
565
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
566
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
567
|
+
end
|
|
568
|
+
|
|
569
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
570
|
+
|
|
571
|
+
req_config = CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest.new # GetDocxHeadersAndFootersRequest | Document input request
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
begin
|
|
575
|
+
#Get content of a footer from a Word DOCX document
|
|
576
|
+
result = api_instance.edit_document_docx_get_headers_and_footers(req_config)
|
|
577
|
+
p result
|
|
578
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
579
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_headers_and_footers: #{e}"
|
|
580
|
+
end
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
### Parameters
|
|
584
|
+
|
|
585
|
+
Name | Type | Description | Notes
|
|
586
|
+
------------- | ------------- | ------------- | -------------
|
|
587
|
+
**req_config** | [**GetDocxHeadersAndFootersRequest**](GetDocxHeadersAndFootersRequest.md)| Document input request |
|
|
588
|
+
|
|
589
|
+
### Return type
|
|
590
|
+
|
|
591
|
+
[**GetDocxHeadersAndFootersResponse**](GetDocxHeadersAndFootersResponse.md)
|
|
592
|
+
|
|
593
|
+
### Authorization
|
|
594
|
+
|
|
595
|
+
[Apikey](../README.md#Apikey)
|
|
596
|
+
|
|
597
|
+
### HTTP request headers
|
|
598
|
+
|
|
599
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
600
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
# **edit_document_docx_get_images**
|
|
605
|
+
> GetDocxImagesResponse edit_document_docx_get_images(req_config)
|
|
606
|
+
|
|
607
|
+
Get images from a Word DOCX document
|
|
608
|
+
|
|
609
|
+
Returns the images defined in the Word Document (DOCX) format file
|
|
610
|
+
|
|
611
|
+
### Example
|
|
612
|
+
```ruby
|
|
613
|
+
# load the gem
|
|
614
|
+
require 'cloudmersive-convert-api-client'
|
|
615
|
+
# setup authorization
|
|
616
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
617
|
+
# Configure API key authorization: Apikey
|
|
618
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
619
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
620
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
621
|
+
end
|
|
622
|
+
|
|
623
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
624
|
+
|
|
625
|
+
req_config = CloudmersiveConvertApiClient::GetDocxImagesRequest.new # GetDocxImagesRequest | Document input request
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
begin
|
|
629
|
+
#Get images from a Word DOCX document
|
|
630
|
+
result = api_instance.edit_document_docx_get_images(req_config)
|
|
631
|
+
p result
|
|
632
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
633
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_images: #{e}"
|
|
634
|
+
end
|
|
635
|
+
```
|
|
636
|
+
|
|
637
|
+
### Parameters
|
|
638
|
+
|
|
639
|
+
Name | Type | Description | Notes
|
|
640
|
+
------------- | ------------- | ------------- | -------------
|
|
641
|
+
**req_config** | [**GetDocxImagesRequest**](GetDocxImagesRequest.md)| Document input request |
|
|
642
|
+
|
|
643
|
+
### Return type
|
|
644
|
+
|
|
645
|
+
[**GetDocxImagesResponse**](GetDocxImagesResponse.md)
|
|
646
|
+
|
|
647
|
+
### Authorization
|
|
648
|
+
|
|
649
|
+
[Apikey](../README.md#Apikey)
|
|
650
|
+
|
|
651
|
+
### HTTP request headers
|
|
652
|
+
|
|
653
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
654
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
# **edit_document_docx_get_sections**
|
|
659
|
+
> GetDocxSectionsResponse edit_document_docx_get_sections(req_config)
|
|
660
|
+
|
|
661
|
+
Get sections from a Word DOCX document
|
|
662
|
+
|
|
663
|
+
Returns the sections defined in the Word Document (DOCX) format file
|
|
664
|
+
|
|
665
|
+
### Example
|
|
666
|
+
```ruby
|
|
667
|
+
# load the gem
|
|
668
|
+
require 'cloudmersive-convert-api-client'
|
|
669
|
+
# setup authorization
|
|
670
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
671
|
+
# Configure API key authorization: Apikey
|
|
672
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
673
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
674
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
675
|
+
end
|
|
676
|
+
|
|
677
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
678
|
+
|
|
679
|
+
req_config = CloudmersiveConvertApiClient::GetDocxSectionsRequest.new # GetDocxSectionsRequest | Document input request
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
begin
|
|
683
|
+
#Get sections from a Word DOCX document
|
|
684
|
+
result = api_instance.edit_document_docx_get_sections(req_config)
|
|
685
|
+
p result
|
|
686
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
687
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_sections: #{e}"
|
|
688
|
+
end
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
### Parameters
|
|
692
|
+
|
|
693
|
+
Name | Type | Description | Notes
|
|
694
|
+
------------- | ------------- | ------------- | -------------
|
|
695
|
+
**req_config** | [**GetDocxSectionsRequest**](GetDocxSectionsRequest.md)| Document input request |
|
|
696
|
+
|
|
697
|
+
### Return type
|
|
698
|
+
|
|
699
|
+
[**GetDocxSectionsResponse**](GetDocxSectionsResponse.md)
|
|
700
|
+
|
|
701
|
+
### Authorization
|
|
702
|
+
|
|
703
|
+
[Apikey](../README.md#Apikey)
|
|
704
|
+
|
|
705
|
+
### HTTP request headers
|
|
706
|
+
|
|
707
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
708
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
# **edit_document_docx_get_styles**
|
|
713
|
+
> GetDocxStylesResponse edit_document_docx_get_styles(req_config)
|
|
714
|
+
|
|
715
|
+
Get styles from a Word DOCX document
|
|
716
|
+
|
|
717
|
+
Returns the styles defined in the Word Document (DOCX) format file
|
|
718
|
+
|
|
719
|
+
### Example
|
|
720
|
+
```ruby
|
|
721
|
+
# load the gem
|
|
722
|
+
require 'cloudmersive-convert-api-client'
|
|
723
|
+
# setup authorization
|
|
724
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
725
|
+
# Configure API key authorization: Apikey
|
|
726
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
727
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
728
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
729
|
+
end
|
|
730
|
+
|
|
731
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
732
|
+
|
|
733
|
+
req_config = CloudmersiveConvertApiClient::GetDocxStylesRequest.new # GetDocxStylesRequest | Document input request
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
begin
|
|
737
|
+
#Get styles from a Word DOCX document
|
|
738
|
+
result = api_instance.edit_document_docx_get_styles(req_config)
|
|
739
|
+
p result
|
|
740
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
741
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_styles: #{e}"
|
|
742
|
+
end
|
|
743
|
+
```
|
|
744
|
+
|
|
745
|
+
### Parameters
|
|
746
|
+
|
|
747
|
+
Name | Type | Description | Notes
|
|
748
|
+
------------- | ------------- | ------------- | -------------
|
|
749
|
+
**req_config** | [**GetDocxStylesRequest**](GetDocxStylesRequest.md)| Document input request |
|
|
750
|
+
|
|
751
|
+
### Return type
|
|
752
|
+
|
|
753
|
+
[**GetDocxStylesResponse**](GetDocxStylesResponse.md)
|
|
754
|
+
|
|
755
|
+
### Authorization
|
|
756
|
+
|
|
757
|
+
[Apikey](../README.md#Apikey)
|
|
758
|
+
|
|
759
|
+
### HTTP request headers
|
|
760
|
+
|
|
761
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
762
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
# **edit_document_docx_get_table_by_index**
|
|
767
|
+
> GetDocxTableByIndexResponse edit_document_docx_get_table_by_index(req_config)
|
|
768
|
+
|
|
769
|
+
Get a specific table by index in a Word DOCX document
|
|
770
|
+
|
|
771
|
+
Returns the specific table object by its 0-based index in an Office Word Document (DOCX)
|
|
772
|
+
|
|
773
|
+
### Example
|
|
774
|
+
```ruby
|
|
775
|
+
# load the gem
|
|
776
|
+
require 'cloudmersive-convert-api-client'
|
|
777
|
+
# setup authorization
|
|
778
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
779
|
+
# Configure API key authorization: Apikey
|
|
780
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
781
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
782
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
783
|
+
end
|
|
784
|
+
|
|
785
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
786
|
+
|
|
787
|
+
req_config = CloudmersiveConvertApiClient::GetDocxTableByIndexRequest.new # GetDocxTableByIndexRequest | Document input request
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
begin
|
|
791
|
+
#Get a specific table by index in a Word DOCX document
|
|
792
|
+
result = api_instance.edit_document_docx_get_table_by_index(req_config)
|
|
793
|
+
p result
|
|
794
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
795
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_table_by_index: #{e}"
|
|
796
|
+
end
|
|
797
|
+
```
|
|
798
|
+
|
|
799
|
+
### Parameters
|
|
800
|
+
|
|
801
|
+
Name | Type | Description | Notes
|
|
802
|
+
------------- | ------------- | ------------- | -------------
|
|
803
|
+
**req_config** | [**GetDocxTableByIndexRequest**](GetDocxTableByIndexRequest.md)| Document input request |
|
|
804
|
+
|
|
805
|
+
### Return type
|
|
806
|
+
|
|
807
|
+
[**GetDocxTableByIndexResponse**](GetDocxTableByIndexResponse.md)
|
|
808
|
+
|
|
809
|
+
### Authorization
|
|
810
|
+
|
|
811
|
+
[Apikey](../README.md#Apikey)
|
|
812
|
+
|
|
813
|
+
### HTTP request headers
|
|
814
|
+
|
|
815
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
816
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
# **edit_document_docx_get_table_row**
|
|
821
|
+
> GetDocxTableRowResponse edit_document_docx_get_table_row(req_config)
|
|
822
|
+
|
|
823
|
+
Gets the contents of an existing table row in an existing table in a Word DOCX document
|
|
824
|
+
|
|
825
|
+
Gets the contents of an existing table row in a Word DOCX Document and returns the result.
|
|
826
|
+
|
|
827
|
+
### Example
|
|
828
|
+
```ruby
|
|
829
|
+
# load the gem
|
|
830
|
+
require 'cloudmersive-convert-api-client'
|
|
831
|
+
# setup authorization
|
|
832
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
833
|
+
# Configure API key authorization: Apikey
|
|
834
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
835
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
836
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
837
|
+
end
|
|
838
|
+
|
|
839
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
840
|
+
|
|
841
|
+
req_config = CloudmersiveConvertApiClient::GetDocxTableRowRequest.new # GetDocxTableRowRequest | Document input request
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
begin
|
|
845
|
+
#Gets the contents of an existing table row in an existing table in a Word DOCX document
|
|
846
|
+
result = api_instance.edit_document_docx_get_table_row(req_config)
|
|
847
|
+
p result
|
|
848
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
849
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_table_row: #{e}"
|
|
850
|
+
end
|
|
851
|
+
```
|
|
852
|
+
|
|
853
|
+
### Parameters
|
|
854
|
+
|
|
855
|
+
Name | Type | Description | Notes
|
|
856
|
+
------------- | ------------- | ------------- | -------------
|
|
857
|
+
**req_config** | [**GetDocxTableRowRequest**](GetDocxTableRowRequest.md)| Document input request |
|
|
858
|
+
|
|
859
|
+
### Return type
|
|
860
|
+
|
|
861
|
+
[**GetDocxTableRowResponse**](GetDocxTableRowResponse.md)
|
|
862
|
+
|
|
863
|
+
### Authorization
|
|
864
|
+
|
|
865
|
+
[Apikey](../README.md#Apikey)
|
|
866
|
+
|
|
867
|
+
### HTTP request headers
|
|
868
|
+
|
|
869
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
870
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
# **edit_document_docx_get_tables**
|
|
875
|
+
> GetDocxTablesResponse edit_document_docx_get_tables(req_config)
|
|
876
|
+
|
|
877
|
+
Get all tables in Word DOCX document
|
|
878
|
+
|
|
879
|
+
Returns all the table objects in an Office Word Document (docx)
|
|
880
|
+
|
|
881
|
+
### Example
|
|
882
|
+
```ruby
|
|
883
|
+
# load the gem
|
|
884
|
+
require 'cloudmersive-convert-api-client'
|
|
885
|
+
# setup authorization
|
|
886
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
887
|
+
# Configure API key authorization: Apikey
|
|
888
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
889
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
890
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
891
|
+
end
|
|
892
|
+
|
|
893
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
894
|
+
|
|
895
|
+
req_config = CloudmersiveConvertApiClient::GetDocxTablesRequest.new # GetDocxTablesRequest | Document input request
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
begin
|
|
899
|
+
#Get all tables in Word DOCX document
|
|
900
|
+
result = api_instance.edit_document_docx_get_tables(req_config)
|
|
901
|
+
p result
|
|
902
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
903
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_tables: #{e}"
|
|
904
|
+
end
|
|
905
|
+
```
|
|
906
|
+
|
|
907
|
+
### Parameters
|
|
908
|
+
|
|
909
|
+
Name | Type | Description | Notes
|
|
910
|
+
------------- | ------------- | ------------- | -------------
|
|
911
|
+
**req_config** | [**GetDocxTablesRequest**](GetDocxTablesRequest.md)| Document input request |
|
|
912
|
+
|
|
913
|
+
### Return type
|
|
914
|
+
|
|
915
|
+
[**GetDocxTablesResponse**](GetDocxTablesResponse.md)
|
|
916
|
+
|
|
917
|
+
### Authorization
|
|
918
|
+
|
|
919
|
+
[Apikey](../README.md#Apikey)
|
|
920
|
+
|
|
921
|
+
### HTTP request headers
|
|
922
|
+
|
|
923
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
924
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
# **edit_document_docx_insert_comment_on_paragraph**
|
|
929
|
+
> InsertDocxCommentOnParagraphResponse edit_document_docx_insert_comment_on_paragraph(req_config)
|
|
930
|
+
|
|
931
|
+
Insert a new comment into a Word DOCX document attached to a paragraph
|
|
932
|
+
|
|
933
|
+
Adds a new comment into a Word DOCX document attached to a paragraph and returns the result. Call Finish Editing on the output URL to complete the operation.
|
|
934
|
+
|
|
935
|
+
### Example
|
|
936
|
+
```ruby
|
|
937
|
+
# load the gem
|
|
938
|
+
require 'cloudmersive-convert-api-client'
|
|
939
|
+
# setup authorization
|
|
940
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
941
|
+
# Configure API key authorization: Apikey
|
|
942
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
943
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
944
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
945
|
+
end
|
|
946
|
+
|
|
947
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
948
|
+
|
|
949
|
+
req_config = CloudmersiveConvertApiClient::DocxInsertCommentOnParagraphRequest.new # DocxInsertCommentOnParagraphRequest | Document input request
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
begin
|
|
953
|
+
#Insert a new comment into a Word DOCX document attached to a paragraph
|
|
954
|
+
result = api_instance.edit_document_docx_insert_comment_on_paragraph(req_config)
|
|
955
|
+
p result
|
|
956
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
957
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_insert_comment_on_paragraph: #{e}"
|
|
958
|
+
end
|
|
959
|
+
```
|
|
960
|
+
|
|
961
|
+
### Parameters
|
|
962
|
+
|
|
963
|
+
Name | Type | Description | Notes
|
|
964
|
+
------------- | ------------- | ------------- | -------------
|
|
965
|
+
**req_config** | [**DocxInsertCommentOnParagraphRequest**](DocxInsertCommentOnParagraphRequest.md)| Document input request |
|
|
966
|
+
|
|
967
|
+
### Return type
|
|
968
|
+
|
|
969
|
+
[**InsertDocxCommentOnParagraphResponse**](InsertDocxCommentOnParagraphResponse.md)
|
|
970
|
+
|
|
971
|
+
### Authorization
|
|
972
|
+
|
|
973
|
+
[Apikey](../README.md#Apikey)
|
|
974
|
+
|
|
975
|
+
### HTTP request headers
|
|
976
|
+
|
|
977
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
978
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
# **edit_document_docx_insert_image**
|
|
983
|
+
> DocxInsertImageResponse edit_document_docx_insert_image(req_config)
|
|
984
|
+
|
|
985
|
+
Insert image into a Word DOCX document
|
|
986
|
+
|
|
987
|
+
Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
|
988
|
+
|
|
989
|
+
### Example
|
|
990
|
+
```ruby
|
|
991
|
+
# load the gem
|
|
992
|
+
require 'cloudmersive-convert-api-client'
|
|
993
|
+
# setup authorization
|
|
994
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
995
|
+
# Configure API key authorization: Apikey
|
|
996
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
997
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
998
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
999
|
+
end
|
|
1000
|
+
|
|
1001
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1002
|
+
|
|
1003
|
+
req_config = CloudmersiveConvertApiClient::DocxInsertImageRequest.new # DocxInsertImageRequest | Document input request
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
begin
|
|
1007
|
+
#Insert image into a Word DOCX document
|
|
1008
|
+
result = api_instance.edit_document_docx_insert_image(req_config)
|
|
1009
|
+
p result
|
|
1010
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1011
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_insert_image: #{e}"
|
|
1012
|
+
end
|
|
1013
|
+
```
|
|
1014
|
+
|
|
1015
|
+
### Parameters
|
|
1016
|
+
|
|
1017
|
+
Name | Type | Description | Notes
|
|
1018
|
+
------------- | ------------- | ------------- | -------------
|
|
1019
|
+
**req_config** | [**DocxInsertImageRequest**](DocxInsertImageRequest.md)| Document input request |
|
|
1020
|
+
|
|
1021
|
+
### Return type
|
|
1022
|
+
|
|
1023
|
+
[**DocxInsertImageResponse**](DocxInsertImageResponse.md)
|
|
1024
|
+
|
|
1025
|
+
### Authorization
|
|
1026
|
+
|
|
1027
|
+
[Apikey](../README.md#Apikey)
|
|
1028
|
+
|
|
1029
|
+
### HTTP request headers
|
|
1030
|
+
|
|
1031
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1032
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
# **edit_document_docx_insert_paragraph**
|
|
1037
|
+
> InsertDocxInsertParagraphResponse edit_document_docx_insert_paragraph(req_config)
|
|
1038
|
+
|
|
1039
|
+
Insert a new paragraph into a Word DOCX document
|
|
1040
|
+
|
|
1041
|
+
Adds a new paragraph into a DOCX and returns the result. You can insert at the beginning/end of a document, or before/after an existing object using its Path (location within the document). Call Finish Editing on the output URL to complete the operation.
|
|
1042
|
+
|
|
1043
|
+
### Example
|
|
1044
|
+
```ruby
|
|
1045
|
+
# load the gem
|
|
1046
|
+
require 'cloudmersive-convert-api-client'
|
|
1047
|
+
# setup authorization
|
|
1048
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1049
|
+
# Configure API key authorization: Apikey
|
|
1050
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1051
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1052
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1053
|
+
end
|
|
1054
|
+
|
|
1055
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1056
|
+
|
|
1057
|
+
req_config = CloudmersiveConvertApiClient::InsertDocxInsertParagraphRequest.new # InsertDocxInsertParagraphRequest | Document input request
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
begin
|
|
1061
|
+
#Insert a new paragraph into a Word DOCX document
|
|
1062
|
+
result = api_instance.edit_document_docx_insert_paragraph(req_config)
|
|
1063
|
+
p result
|
|
1064
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1065
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_insert_paragraph: #{e}"
|
|
1066
|
+
end
|
|
1067
|
+
```
|
|
1068
|
+
|
|
1069
|
+
### Parameters
|
|
1070
|
+
|
|
1071
|
+
Name | Type | Description | Notes
|
|
1072
|
+
------------- | ------------- | ------------- | -------------
|
|
1073
|
+
**req_config** | [**InsertDocxInsertParagraphRequest**](InsertDocxInsertParagraphRequest.md)| Document input request |
|
|
1074
|
+
|
|
1075
|
+
### Return type
|
|
1076
|
+
|
|
1077
|
+
[**InsertDocxInsertParagraphResponse**](InsertDocxInsertParagraphResponse.md)
|
|
1078
|
+
|
|
1079
|
+
### Authorization
|
|
1080
|
+
|
|
1081
|
+
[Apikey](../README.md#Apikey)
|
|
1082
|
+
|
|
1083
|
+
### HTTP request headers
|
|
1084
|
+
|
|
1085
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1086
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
# **edit_document_docx_insert_table**
|
|
1091
|
+
> InsertDocxTablesResponse edit_document_docx_insert_table(req_config)
|
|
1092
|
+
|
|
1093
|
+
Insert a new table into a Word DOCX document
|
|
1094
|
+
|
|
1095
|
+
Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
|
|
1096
|
+
|
|
1097
|
+
### Example
|
|
1098
|
+
```ruby
|
|
1099
|
+
# load the gem
|
|
1100
|
+
require 'cloudmersive-convert-api-client'
|
|
1101
|
+
# setup authorization
|
|
1102
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1103
|
+
# Configure API key authorization: Apikey
|
|
1104
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1106
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1107
|
+
end
|
|
1108
|
+
|
|
1109
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1110
|
+
|
|
1111
|
+
req_config = CloudmersiveConvertApiClient::InsertDocxTablesRequest.new # InsertDocxTablesRequest | Document input request
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
begin
|
|
1115
|
+
#Insert a new table into a Word DOCX document
|
|
1116
|
+
result = api_instance.edit_document_docx_insert_table(req_config)
|
|
1117
|
+
p result
|
|
1118
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1119
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_insert_table: #{e}"
|
|
1120
|
+
end
|
|
1121
|
+
```
|
|
1122
|
+
|
|
1123
|
+
### Parameters
|
|
1124
|
+
|
|
1125
|
+
Name | Type | Description | Notes
|
|
1126
|
+
------------- | ------------- | ------------- | -------------
|
|
1127
|
+
**req_config** | [**InsertDocxTablesRequest**](InsertDocxTablesRequest.md)| Document input request |
|
|
1128
|
+
|
|
1129
|
+
### Return type
|
|
1130
|
+
|
|
1131
|
+
[**InsertDocxTablesResponse**](InsertDocxTablesResponse.md)
|
|
1132
|
+
|
|
1133
|
+
### Authorization
|
|
1134
|
+
|
|
1135
|
+
[Apikey](../README.md#Apikey)
|
|
1136
|
+
|
|
1137
|
+
### HTTP request headers
|
|
1138
|
+
|
|
1139
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1140
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
# **edit_document_docx_insert_table_row**
|
|
1145
|
+
> InsertDocxTableRowResponse edit_document_docx_insert_table_row(req_config)
|
|
1146
|
+
|
|
1147
|
+
Insert a new row into an existing table in a Word DOCX document
|
|
1148
|
+
|
|
1149
|
+
Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
|
|
1150
|
+
|
|
1151
|
+
### Example
|
|
1152
|
+
```ruby
|
|
1153
|
+
# load the gem
|
|
1154
|
+
require 'cloudmersive-convert-api-client'
|
|
1155
|
+
# setup authorization
|
|
1156
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1157
|
+
# Configure API key authorization: Apikey
|
|
1158
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1159
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1160
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1161
|
+
end
|
|
1162
|
+
|
|
1163
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1164
|
+
|
|
1165
|
+
req_config = CloudmersiveConvertApiClient::InsertDocxTableRowRequest.new # InsertDocxTableRowRequest | Document input request
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
begin
|
|
1169
|
+
#Insert a new row into an existing table in a Word DOCX document
|
|
1170
|
+
result = api_instance.edit_document_docx_insert_table_row(req_config)
|
|
1171
|
+
p result
|
|
1172
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1173
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_insert_table_row: #{e}"
|
|
1174
|
+
end
|
|
1175
|
+
```
|
|
1176
|
+
|
|
1177
|
+
### Parameters
|
|
1178
|
+
|
|
1179
|
+
Name | Type | Description | Notes
|
|
1180
|
+
------------- | ------------- | ------------- | -------------
|
|
1181
|
+
**req_config** | [**InsertDocxTableRowRequest**](InsertDocxTableRowRequest.md)| Document input request |
|
|
1182
|
+
|
|
1183
|
+
### Return type
|
|
1184
|
+
|
|
1185
|
+
[**InsertDocxTableRowResponse**](InsertDocxTableRowResponse.md)
|
|
1186
|
+
|
|
1187
|
+
### Authorization
|
|
1188
|
+
|
|
1189
|
+
[Apikey](../README.md#Apikey)
|
|
1190
|
+
|
|
1191
|
+
### HTTP request headers
|
|
1192
|
+
|
|
1193
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1194
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
# **edit_document_docx_pages**
|
|
1199
|
+
> GetDocxPagesResponse edit_document_docx_pages(req_config)
|
|
1200
|
+
|
|
1201
|
+
Get pages and content from a Word DOCX document
|
|
1202
|
+
|
|
1203
|
+
Returns the pages and contents of each page defined in the Word Document (DOCX) format file
|
|
1204
|
+
|
|
1205
|
+
### Example
|
|
1206
|
+
```ruby
|
|
1207
|
+
# load the gem
|
|
1208
|
+
require 'cloudmersive-convert-api-client'
|
|
1209
|
+
# setup authorization
|
|
1210
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1211
|
+
# Configure API key authorization: Apikey
|
|
1212
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1213
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1214
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1215
|
+
end
|
|
1216
|
+
|
|
1217
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1218
|
+
|
|
1219
|
+
req_config = CloudmersiveConvertApiClient::GetDocxPagesRequest.new # GetDocxPagesRequest | Document input request
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
begin
|
|
1223
|
+
#Get pages and content from a Word DOCX document
|
|
1224
|
+
result = api_instance.edit_document_docx_pages(req_config)
|
|
1225
|
+
p result
|
|
1226
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1227
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_pages: #{e}"
|
|
1228
|
+
end
|
|
1229
|
+
```
|
|
1230
|
+
|
|
1231
|
+
### Parameters
|
|
1232
|
+
|
|
1233
|
+
Name | Type | Description | Notes
|
|
1234
|
+
------------- | ------------- | ------------- | -------------
|
|
1235
|
+
**req_config** | [**GetDocxPagesRequest**](GetDocxPagesRequest.md)| Document input request |
|
|
1236
|
+
|
|
1237
|
+
### Return type
|
|
1238
|
+
|
|
1239
|
+
[**GetDocxPagesResponse**](GetDocxPagesResponse.md)
|
|
1240
|
+
|
|
1241
|
+
### Authorization
|
|
1242
|
+
|
|
1243
|
+
[Apikey](../README.md#Apikey)
|
|
1244
|
+
|
|
1245
|
+
### HTTP request headers
|
|
1246
|
+
|
|
1247
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1248
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
# **edit_document_docx_remove_headers_and_footers**
|
|
1253
|
+
> RemoveDocxHeadersAndFootersResponse edit_document_docx_remove_headers_and_footers(req_config)
|
|
1254
|
+
|
|
1255
|
+
Remove headers and footers from Word DOCX document
|
|
1256
|
+
|
|
1257
|
+
Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
|
1258
|
+
|
|
1259
|
+
### Example
|
|
1260
|
+
```ruby
|
|
1261
|
+
# load the gem
|
|
1262
|
+
require 'cloudmersive-convert-api-client'
|
|
1263
|
+
# setup authorization
|
|
1264
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1265
|
+
# Configure API key authorization: Apikey
|
|
1266
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1267
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1268
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1269
|
+
end
|
|
1270
|
+
|
|
1271
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1272
|
+
|
|
1273
|
+
req_config = CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest.new # RemoveDocxHeadersAndFootersRequest | Document input request
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
begin
|
|
1277
|
+
#Remove headers and footers from Word DOCX document
|
|
1278
|
+
result = api_instance.edit_document_docx_remove_headers_and_footers(req_config)
|
|
1279
|
+
p result
|
|
1280
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1281
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_remove_headers_and_footers: #{e}"
|
|
1282
|
+
end
|
|
1283
|
+
```
|
|
1284
|
+
|
|
1285
|
+
### Parameters
|
|
1286
|
+
|
|
1287
|
+
Name | Type | Description | Notes
|
|
1288
|
+
------------- | ------------- | ------------- | -------------
|
|
1289
|
+
**req_config** | [**RemoveDocxHeadersAndFootersRequest**](RemoveDocxHeadersAndFootersRequest.md)| Document input request |
|
|
1290
|
+
|
|
1291
|
+
### Return type
|
|
1292
|
+
|
|
1293
|
+
[**RemoveDocxHeadersAndFootersResponse**](RemoveDocxHeadersAndFootersResponse.md)
|
|
1294
|
+
|
|
1295
|
+
### Authorization
|
|
1296
|
+
|
|
1297
|
+
[Apikey](../README.md#Apikey)
|
|
1298
|
+
|
|
1299
|
+
### HTTP request headers
|
|
1300
|
+
|
|
1301
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1302
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
# **edit_document_docx_remove_object**
|
|
1307
|
+
> DocxRemoveObjectResponse edit_document_docx_remove_object(req_config)
|
|
1308
|
+
|
|
1309
|
+
Delete any object in a Word DOCX document
|
|
1310
|
+
|
|
1311
|
+
Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX). Pass in the Path of the object you would like to delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation.
|
|
1312
|
+
|
|
1313
|
+
### Example
|
|
1314
|
+
```ruby
|
|
1315
|
+
# load the gem
|
|
1316
|
+
require 'cloudmersive-convert-api-client'
|
|
1317
|
+
# setup authorization
|
|
1318
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1319
|
+
# Configure API key authorization: Apikey
|
|
1320
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1321
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1322
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1323
|
+
end
|
|
1324
|
+
|
|
1325
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1326
|
+
|
|
1327
|
+
req_config = CloudmersiveConvertApiClient::DocxRemoveObjectRequest.new # DocxRemoveObjectRequest | Document input request
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
begin
|
|
1331
|
+
#Delete any object in a Word DOCX document
|
|
1332
|
+
result = api_instance.edit_document_docx_remove_object(req_config)
|
|
1333
|
+
p result
|
|
1334
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1335
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_remove_object: #{e}"
|
|
1336
|
+
end
|
|
1337
|
+
```
|
|
1338
|
+
|
|
1339
|
+
### Parameters
|
|
1340
|
+
|
|
1341
|
+
Name | Type | Description | Notes
|
|
1342
|
+
------------- | ------------- | ------------- | -------------
|
|
1343
|
+
**req_config** | [**DocxRemoveObjectRequest**](DocxRemoveObjectRequest.md)| Document input request |
|
|
1344
|
+
|
|
1345
|
+
### Return type
|
|
1346
|
+
|
|
1347
|
+
[**DocxRemoveObjectResponse**](DocxRemoveObjectResponse.md)
|
|
1348
|
+
|
|
1349
|
+
### Authorization
|
|
1350
|
+
|
|
1351
|
+
[Apikey](../README.md#Apikey)
|
|
1352
|
+
|
|
1353
|
+
### HTTP request headers
|
|
1354
|
+
|
|
1355
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1356
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
# **edit_document_docx_replace**
|
|
1361
|
+
> String edit_document_docx_replace(req_config)
|
|
1362
|
+
|
|
1363
|
+
Replace string in Word DOCX document
|
|
1364
|
+
|
|
1365
|
+
Replace all instances of a string in an Office Word Document (docx)
|
|
1366
|
+
|
|
1367
|
+
### Example
|
|
1368
|
+
```ruby
|
|
1369
|
+
# load the gem
|
|
1370
|
+
require 'cloudmersive-convert-api-client'
|
|
1371
|
+
# setup authorization
|
|
1372
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1373
|
+
# Configure API key authorization: Apikey
|
|
1374
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1375
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1376
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1377
|
+
end
|
|
1378
|
+
|
|
1379
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1380
|
+
|
|
1381
|
+
req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest | Document string replacement configuration input
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
begin
|
|
1385
|
+
#Replace string in Word DOCX document
|
|
1386
|
+
result = api_instance.edit_document_docx_replace(req_config)
|
|
1387
|
+
p result
|
|
1388
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1389
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_replace: #{e}"
|
|
1390
|
+
end
|
|
1391
|
+
```
|
|
1392
|
+
|
|
1393
|
+
### Parameters
|
|
1394
|
+
|
|
1395
|
+
Name | Type | Description | Notes
|
|
1396
|
+
------------- | ------------- | ------------- | -------------
|
|
1397
|
+
**req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)| Document string replacement configuration input |
|
|
1398
|
+
|
|
1399
|
+
### Return type
|
|
1400
|
+
|
|
1401
|
+
**String**
|
|
1402
|
+
|
|
1403
|
+
### Authorization
|
|
1404
|
+
|
|
1405
|
+
[Apikey](../README.md#Apikey)
|
|
1406
|
+
|
|
1407
|
+
### HTTP request headers
|
|
1408
|
+
|
|
1409
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1410
|
+
- **Accept**: application/octet-stream
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
# **edit_document_docx_replace_multi**
|
|
1415
|
+
> String edit_document_docx_replace_multi(req_config)
|
|
1416
|
+
|
|
1417
|
+
Replace multiple strings in Word DOCX document
|
|
1418
|
+
|
|
1419
|
+
Replace all instances of multiple strings in an Office Word Document (docx)
|
|
1420
|
+
|
|
1421
|
+
### Example
|
|
1422
|
+
```ruby
|
|
1423
|
+
# load the gem
|
|
1424
|
+
require 'cloudmersive-convert-api-client'
|
|
1425
|
+
# setup authorization
|
|
1426
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1427
|
+
# Configure API key authorization: Apikey
|
|
1428
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1429
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1430
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1431
|
+
end
|
|
1432
|
+
|
|
1433
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1434
|
+
|
|
1435
|
+
req_config = CloudmersiveConvertApiClient::MultiReplaceStringRequest.new # MultiReplaceStringRequest | Document string replacement configuration input
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
begin
|
|
1439
|
+
#Replace multiple strings in Word DOCX document
|
|
1440
|
+
result = api_instance.edit_document_docx_replace_multi(req_config)
|
|
1441
|
+
p result
|
|
1442
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1443
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_replace_multi: #{e}"
|
|
1444
|
+
end
|
|
1445
|
+
```
|
|
1446
|
+
|
|
1447
|
+
### Parameters
|
|
1448
|
+
|
|
1449
|
+
Name | Type | Description | Notes
|
|
1450
|
+
------------- | ------------- | ------------- | -------------
|
|
1451
|
+
**req_config** | [**MultiReplaceStringRequest**](MultiReplaceStringRequest.md)| Document string replacement configuration input |
|
|
1452
|
+
|
|
1453
|
+
### Return type
|
|
1454
|
+
|
|
1455
|
+
**String**
|
|
1456
|
+
|
|
1457
|
+
### Authorization
|
|
1458
|
+
|
|
1459
|
+
[Apikey](../README.md#Apikey)
|
|
1460
|
+
|
|
1461
|
+
### HTTP request headers
|
|
1462
|
+
|
|
1463
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1464
|
+
- **Accept**: application/octet-stream
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
# **edit_document_docx_replace_paragraph**
|
|
1469
|
+
> ReplaceDocxParagraphResponse edit_document_docx_replace_paragraph(req_config)
|
|
1470
|
+
|
|
1471
|
+
Replace matching paragraphs in a Word DOCX document
|
|
1472
|
+
|
|
1473
|
+
Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.
|
|
1474
|
+
|
|
1475
|
+
### Example
|
|
1476
|
+
```ruby
|
|
1477
|
+
# load the gem
|
|
1478
|
+
require 'cloudmersive-convert-api-client'
|
|
1479
|
+
# setup authorization
|
|
1480
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1481
|
+
# Configure API key authorization: Apikey
|
|
1482
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1483
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1484
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1485
|
+
end
|
|
1486
|
+
|
|
1487
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1488
|
+
|
|
1489
|
+
req_config = CloudmersiveConvertApiClient::ReplaceDocxParagraphRequest.new # ReplaceDocxParagraphRequest | Document input request
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
begin
|
|
1493
|
+
#Replace matching paragraphs in a Word DOCX document
|
|
1494
|
+
result = api_instance.edit_document_docx_replace_paragraph(req_config)
|
|
1495
|
+
p result
|
|
1496
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1497
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_replace_paragraph: #{e}"
|
|
1498
|
+
end
|
|
1499
|
+
```
|
|
1500
|
+
|
|
1501
|
+
### Parameters
|
|
1502
|
+
|
|
1503
|
+
Name | Type | Description | Notes
|
|
1504
|
+
------------- | ------------- | ------------- | -------------
|
|
1505
|
+
**req_config** | [**ReplaceDocxParagraphRequest**](ReplaceDocxParagraphRequest.md)| Document input request |
|
|
1506
|
+
|
|
1507
|
+
### Return type
|
|
1508
|
+
|
|
1509
|
+
[**ReplaceDocxParagraphResponse**](ReplaceDocxParagraphResponse.md)
|
|
1510
|
+
|
|
1511
|
+
### Authorization
|
|
1512
|
+
|
|
1513
|
+
[Apikey](../README.md#Apikey)
|
|
1514
|
+
|
|
1515
|
+
### HTTP request headers
|
|
1516
|
+
|
|
1517
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1518
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
# **edit_document_docx_set_footer**
|
|
1523
|
+
> DocxSetFooterResponse edit_document_docx_set_footer(req_config)
|
|
1524
|
+
|
|
1525
|
+
Set the footer in a Word DOCX document
|
|
1526
|
+
|
|
1527
|
+
Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
|
1528
|
+
|
|
1529
|
+
### Example
|
|
1530
|
+
```ruby
|
|
1531
|
+
# load the gem
|
|
1532
|
+
require 'cloudmersive-convert-api-client'
|
|
1533
|
+
# setup authorization
|
|
1534
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1535
|
+
# Configure API key authorization: Apikey
|
|
1536
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1537
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1538
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1539
|
+
end
|
|
1540
|
+
|
|
1541
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1542
|
+
|
|
1543
|
+
req_config = CloudmersiveConvertApiClient::DocxSetFooterRequest.new # DocxSetFooterRequest | Document input request
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
begin
|
|
1547
|
+
#Set the footer in a Word DOCX document
|
|
1548
|
+
result = api_instance.edit_document_docx_set_footer(req_config)
|
|
1549
|
+
p result
|
|
1550
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1551
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_set_footer: #{e}"
|
|
1552
|
+
end
|
|
1553
|
+
```
|
|
1554
|
+
|
|
1555
|
+
### Parameters
|
|
1556
|
+
|
|
1557
|
+
Name | Type | Description | Notes
|
|
1558
|
+
------------- | ------------- | ------------- | -------------
|
|
1559
|
+
**req_config** | [**DocxSetFooterRequest**](DocxSetFooterRequest.md)| Document input request |
|
|
1560
|
+
|
|
1561
|
+
### Return type
|
|
1562
|
+
|
|
1563
|
+
[**DocxSetFooterResponse**](DocxSetFooterResponse.md)
|
|
1564
|
+
|
|
1565
|
+
### Authorization
|
|
1566
|
+
|
|
1567
|
+
[Apikey](../README.md#Apikey)
|
|
1568
|
+
|
|
1569
|
+
### HTTP request headers
|
|
1570
|
+
|
|
1571
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1572
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
# **edit_document_docx_set_footer_add_page_number**
|
|
1577
|
+
> DocxSetFooterResponse edit_document_docx_set_footer_add_page_number(req_config)
|
|
1578
|
+
|
|
1579
|
+
Add page number to footer in a Word DOCX document
|
|
1580
|
+
|
|
1581
|
+
Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.
|
|
1582
|
+
|
|
1583
|
+
### Example
|
|
1584
|
+
```ruby
|
|
1585
|
+
# load the gem
|
|
1586
|
+
require 'cloudmersive-convert-api-client'
|
|
1587
|
+
# setup authorization
|
|
1588
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1589
|
+
# Configure API key authorization: Apikey
|
|
1590
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1591
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1592
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1593
|
+
end
|
|
1594
|
+
|
|
1595
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1596
|
+
|
|
1597
|
+
req_config = CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest.new # DocxSetFooterAddPageNumberRequest | Document input request
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
begin
|
|
1601
|
+
#Add page number to footer in a Word DOCX document
|
|
1602
|
+
result = api_instance.edit_document_docx_set_footer_add_page_number(req_config)
|
|
1603
|
+
p result
|
|
1604
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1605
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_set_footer_add_page_number: #{e}"
|
|
1606
|
+
end
|
|
1607
|
+
```
|
|
1608
|
+
|
|
1609
|
+
### Parameters
|
|
1610
|
+
|
|
1611
|
+
Name | Type | Description | Notes
|
|
1612
|
+
------------- | ------------- | ------------- | -------------
|
|
1613
|
+
**req_config** | [**DocxSetFooterAddPageNumberRequest**](DocxSetFooterAddPageNumberRequest.md)| Document input request |
|
|
1614
|
+
|
|
1615
|
+
### Return type
|
|
1616
|
+
|
|
1617
|
+
[**DocxSetFooterResponse**](DocxSetFooterResponse.md)
|
|
1618
|
+
|
|
1619
|
+
### Authorization
|
|
1620
|
+
|
|
1621
|
+
[Apikey](../README.md#Apikey)
|
|
1622
|
+
|
|
1623
|
+
### HTTP request headers
|
|
1624
|
+
|
|
1625
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1626
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
# **edit_document_docx_set_header**
|
|
1631
|
+
> DocxSetHeaderResponse edit_document_docx_set_header(req_config)
|
|
1632
|
+
|
|
1633
|
+
Set the header in a Word DOCX document
|
|
1634
|
+
|
|
1635
|
+
Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
|
1636
|
+
|
|
1637
|
+
### Example
|
|
1638
|
+
```ruby
|
|
1639
|
+
# load the gem
|
|
1640
|
+
require 'cloudmersive-convert-api-client'
|
|
1641
|
+
# setup authorization
|
|
1642
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1643
|
+
# Configure API key authorization: Apikey
|
|
1644
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1645
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1646
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1647
|
+
end
|
|
1648
|
+
|
|
1649
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1650
|
+
|
|
1651
|
+
req_config = CloudmersiveConvertApiClient::DocxSetHeaderRequest.new # DocxSetHeaderRequest | Document input request
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
begin
|
|
1655
|
+
#Set the header in a Word DOCX document
|
|
1656
|
+
result = api_instance.edit_document_docx_set_header(req_config)
|
|
1657
|
+
p result
|
|
1658
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1659
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_set_header: #{e}"
|
|
1660
|
+
end
|
|
1661
|
+
```
|
|
1662
|
+
|
|
1663
|
+
### Parameters
|
|
1664
|
+
|
|
1665
|
+
Name | Type | Description | Notes
|
|
1666
|
+
------------- | ------------- | ------------- | -------------
|
|
1667
|
+
**req_config** | [**DocxSetHeaderRequest**](DocxSetHeaderRequest.md)| Document input request |
|
|
1668
|
+
|
|
1669
|
+
### Return type
|
|
1670
|
+
|
|
1671
|
+
[**DocxSetHeaderResponse**](DocxSetHeaderResponse.md)
|
|
1672
|
+
|
|
1673
|
+
### Authorization
|
|
1674
|
+
|
|
1675
|
+
[Apikey](../README.md#Apikey)
|
|
1676
|
+
|
|
1677
|
+
### HTTP request headers
|
|
1678
|
+
|
|
1679
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1680
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
# **edit_document_docx_update_table_cell**
|
|
1685
|
+
> UpdateDocxTableCellResponse edit_document_docx_update_table_cell(req_config)
|
|
1686
|
+
|
|
1687
|
+
Update, set contents of a table cell in an existing table in a Word DOCX document
|
|
1688
|
+
|
|
1689
|
+
Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
|
|
1690
|
+
|
|
1691
|
+
### Example
|
|
1692
|
+
```ruby
|
|
1693
|
+
# load the gem
|
|
1694
|
+
require 'cloudmersive-convert-api-client'
|
|
1695
|
+
# setup authorization
|
|
1696
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1697
|
+
# Configure API key authorization: Apikey
|
|
1698
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1699
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1700
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1701
|
+
end
|
|
1702
|
+
|
|
1703
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1704
|
+
|
|
1705
|
+
req_config = CloudmersiveConvertApiClient::UpdateDocxTableCellRequest.new # UpdateDocxTableCellRequest | Document input request
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
begin
|
|
1709
|
+
#Update, set contents of a table cell in an existing table in a Word DOCX document
|
|
1710
|
+
result = api_instance.edit_document_docx_update_table_cell(req_config)
|
|
1711
|
+
p result
|
|
1712
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1713
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_update_table_cell: #{e}"
|
|
1714
|
+
end
|
|
1715
|
+
```
|
|
1716
|
+
|
|
1717
|
+
### Parameters
|
|
1718
|
+
|
|
1719
|
+
Name | Type | Description | Notes
|
|
1720
|
+
------------- | ------------- | ------------- | -------------
|
|
1721
|
+
**req_config** | [**UpdateDocxTableCellRequest**](UpdateDocxTableCellRequest.md)| Document input request |
|
|
1722
|
+
|
|
1723
|
+
### Return type
|
|
1724
|
+
|
|
1725
|
+
[**UpdateDocxTableCellResponse**](UpdateDocxTableCellResponse.md)
|
|
1726
|
+
|
|
1727
|
+
### Authorization
|
|
1728
|
+
|
|
1729
|
+
[Apikey](../README.md#Apikey)
|
|
1730
|
+
|
|
1731
|
+
### HTTP request headers
|
|
1732
|
+
|
|
1733
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1734
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
# **edit_document_docx_update_table_row**
|
|
1739
|
+
> UpdateDocxTableRowResponse edit_document_docx_update_table_row(req_config)
|
|
1740
|
+
|
|
1741
|
+
Update, set contents of a table row in an existing table in a Word DOCX document
|
|
1742
|
+
|
|
1743
|
+
Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
|
|
1744
|
+
|
|
1745
|
+
### Example
|
|
1746
|
+
```ruby
|
|
1747
|
+
# load the gem
|
|
1748
|
+
require 'cloudmersive-convert-api-client'
|
|
1749
|
+
# setup authorization
|
|
1750
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1751
|
+
# Configure API key authorization: Apikey
|
|
1752
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1753
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1754
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1755
|
+
end
|
|
1756
|
+
|
|
1757
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1758
|
+
|
|
1759
|
+
req_config = CloudmersiveConvertApiClient::UpdateDocxTableRowRequest.new # UpdateDocxTableRowRequest | Document input request
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
begin
|
|
1763
|
+
#Update, set contents of a table row in an existing table in a Word DOCX document
|
|
1764
|
+
result = api_instance.edit_document_docx_update_table_row(req_config)
|
|
1765
|
+
p result
|
|
1766
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1767
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_update_table_row: #{e}"
|
|
1768
|
+
end
|
|
1769
|
+
```
|
|
1770
|
+
|
|
1771
|
+
### Parameters
|
|
1772
|
+
|
|
1773
|
+
Name | Type | Description | Notes
|
|
1774
|
+
------------- | ------------- | ------------- | -------------
|
|
1775
|
+
**req_config** | [**UpdateDocxTableRowRequest**](UpdateDocxTableRowRequest.md)| Document input request |
|
|
1776
|
+
|
|
1777
|
+
### Return type
|
|
1778
|
+
|
|
1779
|
+
[**UpdateDocxTableRowResponse**](UpdateDocxTableRowResponse.md)
|
|
1780
|
+
|
|
1781
|
+
### Authorization
|
|
1782
|
+
|
|
1783
|
+
[Apikey](../README.md#Apikey)
|
|
1784
|
+
|
|
1785
|
+
### HTTP request headers
|
|
1786
|
+
|
|
1787
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1788
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
# **edit_document_finish_editing**
|
|
1793
|
+
> String edit_document_finish_editing(req_config)
|
|
1794
|
+
|
|
1795
|
+
Finish editing document, and download result from document editing
|
|
1796
|
+
|
|
1797
|
+
Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.
|
|
1798
|
+
|
|
1799
|
+
### Example
|
|
1800
|
+
```ruby
|
|
1801
|
+
# load the gem
|
|
1802
|
+
require 'cloudmersive-convert-api-client'
|
|
1803
|
+
# setup authorization
|
|
1804
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1805
|
+
# Configure API key authorization: Apikey
|
|
1806
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1807
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1808
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1809
|
+
end
|
|
1810
|
+
|
|
1811
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1812
|
+
|
|
1813
|
+
req_config = CloudmersiveConvertApiClient::FinishEditingRequest.new # FinishEditingRequest | Cloudmersive Document URL to complete editing on
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
begin
|
|
1817
|
+
#Finish editing document, and download result from document editing
|
|
1818
|
+
result = api_instance.edit_document_finish_editing(req_config)
|
|
1819
|
+
p result
|
|
1820
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1821
|
+
puts "Exception when calling EditDocumentApi->edit_document_finish_editing: #{e}"
|
|
1822
|
+
end
|
|
1823
|
+
```
|
|
1824
|
+
|
|
1825
|
+
### Parameters
|
|
1826
|
+
|
|
1827
|
+
Name | Type | Description | Notes
|
|
1828
|
+
------------- | ------------- | ------------- | -------------
|
|
1829
|
+
**req_config** | [**FinishEditingRequest**](FinishEditingRequest.md)| Cloudmersive Document URL to complete editing on |
|
|
1830
|
+
|
|
1831
|
+
### Return type
|
|
1832
|
+
|
|
1833
|
+
**String**
|
|
1834
|
+
|
|
1835
|
+
### Authorization
|
|
1836
|
+
|
|
1837
|
+
[Apikey](../README.md#Apikey)
|
|
1838
|
+
|
|
1839
|
+
### HTTP request headers
|
|
1840
|
+
|
|
1841
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1842
|
+
- **Accept**: application/octet-stream
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
# **edit_document_pptx_delete_slides**
|
|
1847
|
+
> String edit_document_pptx_delete_slides(req_config)
|
|
1848
|
+
|
|
1849
|
+
Delete, remove slides from a PowerPoint PPTX presentation document
|
|
1850
|
+
|
|
1851
|
+
Edits the input PowerPoint PPTX presentation document to remove the specified slides
|
|
1852
|
+
|
|
1853
|
+
### Example
|
|
1854
|
+
```ruby
|
|
1855
|
+
# load the gem
|
|
1856
|
+
require 'cloudmersive-convert-api-client'
|
|
1857
|
+
# setup authorization
|
|
1858
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1859
|
+
# Configure API key authorization: Apikey
|
|
1860
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1861
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1862
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1863
|
+
end
|
|
1864
|
+
|
|
1865
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1866
|
+
|
|
1867
|
+
req_config = CloudmersiveConvertApiClient::RemovePptxSlidesRequest.new # RemovePptxSlidesRequest | Presentation input request
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
begin
|
|
1871
|
+
#Delete, remove slides from a PowerPoint PPTX presentation document
|
|
1872
|
+
result = api_instance.edit_document_pptx_delete_slides(req_config)
|
|
1873
|
+
p result
|
|
1874
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1875
|
+
puts "Exception when calling EditDocumentApi->edit_document_pptx_delete_slides: #{e}"
|
|
1876
|
+
end
|
|
1877
|
+
```
|
|
1878
|
+
|
|
1879
|
+
### Parameters
|
|
1880
|
+
|
|
1881
|
+
Name | Type | Description | Notes
|
|
1882
|
+
------------- | ------------- | ------------- | -------------
|
|
1883
|
+
**req_config** | [**RemovePptxSlidesRequest**](RemovePptxSlidesRequest.md)| Presentation input request |
|
|
1884
|
+
|
|
1885
|
+
### Return type
|
|
1886
|
+
|
|
1887
|
+
**String**
|
|
1888
|
+
|
|
1889
|
+
### Authorization
|
|
1890
|
+
|
|
1891
|
+
[Apikey](../README.md#Apikey)
|
|
1892
|
+
|
|
1893
|
+
### HTTP request headers
|
|
1894
|
+
|
|
1895
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1896
|
+
- **Accept**: application/octet-stream
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
# **edit_document_pptx_replace**
|
|
1901
|
+
> String edit_document_pptx_replace(req_config)
|
|
1902
|
+
|
|
1903
|
+
Replace string in PowerPoint PPTX presentation
|
|
1904
|
+
|
|
1905
|
+
Replace all instances of a string in an Office PowerPoint Document (pptx)
|
|
1906
|
+
|
|
1907
|
+
### Example
|
|
1908
|
+
```ruby
|
|
1909
|
+
# load the gem
|
|
1910
|
+
require 'cloudmersive-convert-api-client'
|
|
1911
|
+
# setup authorization
|
|
1912
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1913
|
+
# Configure API key authorization: Apikey
|
|
1914
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1915
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1916
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1917
|
+
end
|
|
1918
|
+
|
|
1919
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1920
|
+
|
|
1921
|
+
req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest | Replacement document configuration input
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
begin
|
|
1925
|
+
#Replace string in PowerPoint PPTX presentation
|
|
1926
|
+
result = api_instance.edit_document_pptx_replace(req_config)
|
|
1927
|
+
p result
|
|
1928
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1929
|
+
puts "Exception when calling EditDocumentApi->edit_document_pptx_replace: #{e}"
|
|
1930
|
+
end
|
|
1931
|
+
```
|
|
1932
|
+
|
|
1933
|
+
### Parameters
|
|
1934
|
+
|
|
1935
|
+
Name | Type | Description | Notes
|
|
1936
|
+
------------- | ------------- | ------------- | -------------
|
|
1937
|
+
**req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)| Replacement document configuration input |
|
|
1938
|
+
|
|
1939
|
+
### Return type
|
|
1940
|
+
|
|
1941
|
+
**String**
|
|
1942
|
+
|
|
1943
|
+
### Authorization
|
|
1944
|
+
|
|
1945
|
+
[Apikey](../README.md#Apikey)
|
|
1946
|
+
|
|
1947
|
+
### HTTP request headers
|
|
1948
|
+
|
|
1949
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
1950
|
+
- **Accept**: application/octet-stream
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
# **edit_document_xlsx_append_row**
|
|
1955
|
+
> AppendXlsxRowResponse edit_document_xlsx_append_row(input)
|
|
1956
|
+
|
|
1957
|
+
Append row to a Excel XLSX spreadsheet, worksheet
|
|
1958
|
+
|
|
1959
|
+
Appends a row to the end of an Excel Spreadsheet worksheet.
|
|
1960
|
+
|
|
1961
|
+
### Example
|
|
1962
|
+
```ruby
|
|
1963
|
+
# load the gem
|
|
1964
|
+
require 'cloudmersive-convert-api-client'
|
|
1965
|
+
# setup authorization
|
|
1966
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
1967
|
+
# Configure API key authorization: Apikey
|
|
1968
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
1969
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1970
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
1971
|
+
end
|
|
1972
|
+
|
|
1973
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
1974
|
+
|
|
1975
|
+
input = CloudmersiveConvertApiClient::AppendXlsxRowRequest.new # AppendXlsxRowRequest | Document input request
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
begin
|
|
1979
|
+
#Append row to a Excel XLSX spreadsheet, worksheet
|
|
1980
|
+
result = api_instance.edit_document_xlsx_append_row(input)
|
|
1981
|
+
p result
|
|
1982
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
1983
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_append_row: #{e}"
|
|
1984
|
+
end
|
|
1985
|
+
```
|
|
1986
|
+
|
|
1987
|
+
### Parameters
|
|
1988
|
+
|
|
1989
|
+
Name | Type | Description | Notes
|
|
1990
|
+
------------- | ------------- | ------------- | -------------
|
|
1991
|
+
**input** | [**AppendXlsxRowRequest**](AppendXlsxRowRequest.md)| Document input request |
|
|
1992
|
+
|
|
1993
|
+
### Return type
|
|
1994
|
+
|
|
1995
|
+
[**AppendXlsxRowResponse**](AppendXlsxRowResponse.md)
|
|
1996
|
+
|
|
1997
|
+
### Authorization
|
|
1998
|
+
|
|
1999
|
+
[Apikey](../README.md#Apikey)
|
|
2000
|
+
|
|
2001
|
+
### HTTP request headers
|
|
2002
|
+
|
|
2003
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2004
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
# **edit_document_xlsx_clear_cell_by_index**
|
|
2009
|
+
> ClearXlsxCellResponse edit_document_xlsx_clear_cell_by_index(input)
|
|
2010
|
+
|
|
2011
|
+
Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
|
|
2012
|
+
|
|
2013
|
+
Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
|
|
2014
|
+
|
|
2015
|
+
### Example
|
|
2016
|
+
```ruby
|
|
2017
|
+
# load the gem
|
|
2018
|
+
require 'cloudmersive-convert-api-client'
|
|
2019
|
+
# setup authorization
|
|
2020
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2021
|
+
# Configure API key authorization: Apikey
|
|
2022
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2023
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2024
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2025
|
+
end
|
|
2026
|
+
|
|
2027
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2028
|
+
|
|
2029
|
+
input = CloudmersiveConvertApiClient::ClearXlsxCellRequest.new # ClearXlsxCellRequest | Document input request
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
begin
|
|
2033
|
+
#Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
|
|
2034
|
+
result = api_instance.edit_document_xlsx_clear_cell_by_index(input)
|
|
2035
|
+
p result
|
|
2036
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2037
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_clear_cell_by_index: #{e}"
|
|
2038
|
+
end
|
|
2039
|
+
```
|
|
2040
|
+
|
|
2041
|
+
### Parameters
|
|
2042
|
+
|
|
2043
|
+
Name | Type | Description | Notes
|
|
2044
|
+
------------- | ------------- | ------------- | -------------
|
|
2045
|
+
**input** | [**ClearXlsxCellRequest**](ClearXlsxCellRequest.md)| Document input request |
|
|
2046
|
+
|
|
2047
|
+
### Return type
|
|
2048
|
+
|
|
2049
|
+
[**ClearXlsxCellResponse**](ClearXlsxCellResponse.md)
|
|
2050
|
+
|
|
2051
|
+
### Authorization
|
|
2052
|
+
|
|
2053
|
+
[Apikey](../README.md#Apikey)
|
|
2054
|
+
|
|
2055
|
+
### HTTP request headers
|
|
2056
|
+
|
|
2057
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2058
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
# **edit_document_xlsx_clear_row**
|
|
2063
|
+
> ClearXlsxRowResponse edit_document_xlsx_clear_row(input)
|
|
2064
|
+
|
|
2065
|
+
Clear row from a Excel XLSX spreadsheet, worksheet
|
|
2066
|
+
|
|
2067
|
+
Clears data from a specific row in the Excel Spreadsheet worksheet, leaving a blank row. Use the Get Rows And Cells API to enumerate available rows in a spreadsheet.
|
|
2068
|
+
|
|
2069
|
+
### Example
|
|
2070
|
+
```ruby
|
|
2071
|
+
# load the gem
|
|
2072
|
+
require 'cloudmersive-convert-api-client'
|
|
2073
|
+
# setup authorization
|
|
2074
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2075
|
+
# Configure API key authorization: Apikey
|
|
2076
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2077
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2078
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2079
|
+
end
|
|
2080
|
+
|
|
2081
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2082
|
+
|
|
2083
|
+
input = CloudmersiveConvertApiClient::ClearXlsxRowRequest.new # ClearXlsxRowRequest | Document input request
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
begin
|
|
2087
|
+
#Clear row from a Excel XLSX spreadsheet, worksheet
|
|
2088
|
+
result = api_instance.edit_document_xlsx_clear_row(input)
|
|
2089
|
+
p result
|
|
2090
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2091
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_clear_row: #{e}"
|
|
2092
|
+
end
|
|
2093
|
+
```
|
|
2094
|
+
|
|
2095
|
+
### Parameters
|
|
2096
|
+
|
|
2097
|
+
Name | Type | Description | Notes
|
|
2098
|
+
------------- | ------------- | ------------- | -------------
|
|
2099
|
+
**input** | [**ClearXlsxRowRequest**](ClearXlsxRowRequest.md)| Document input request |
|
|
2100
|
+
|
|
2101
|
+
### Return type
|
|
2102
|
+
|
|
2103
|
+
[**ClearXlsxRowResponse**](ClearXlsxRowResponse.md)
|
|
2104
|
+
|
|
2105
|
+
### Authorization
|
|
2106
|
+
|
|
2107
|
+
[Apikey](../README.md#Apikey)
|
|
2108
|
+
|
|
2109
|
+
### HTTP request headers
|
|
2110
|
+
|
|
2111
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2112
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2113
|
+
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
# **edit_document_xlsx_create_blank_spreadsheet**
|
|
2117
|
+
> CreateBlankSpreadsheetResponse edit_document_xlsx_create_blank_spreadsheet(input)
|
|
2118
|
+
|
|
2119
|
+
Create a blank Excel XLSX spreadsheet
|
|
2120
|
+
|
|
2121
|
+
Returns a blank Excel XLSX Spreadsheet (XLSX) format file
|
|
2122
|
+
|
|
2123
|
+
### Example
|
|
2124
|
+
```ruby
|
|
2125
|
+
# load the gem
|
|
2126
|
+
require 'cloudmersive-convert-api-client'
|
|
2127
|
+
# setup authorization
|
|
2128
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2129
|
+
# Configure API key authorization: Apikey
|
|
2130
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2131
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2132
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2133
|
+
end
|
|
2134
|
+
|
|
2135
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2136
|
+
|
|
2137
|
+
input = CloudmersiveConvertApiClient::CreateBlankSpreadsheetRequest.new # CreateBlankSpreadsheetRequest | Document input request
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
begin
|
|
2141
|
+
#Create a blank Excel XLSX spreadsheet
|
|
2142
|
+
result = api_instance.edit_document_xlsx_create_blank_spreadsheet(input)
|
|
2143
|
+
p result
|
|
2144
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2145
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_create_blank_spreadsheet: #{e}"
|
|
2146
|
+
end
|
|
2147
|
+
```
|
|
2148
|
+
|
|
2149
|
+
### Parameters
|
|
2150
|
+
|
|
2151
|
+
Name | Type | Description | Notes
|
|
2152
|
+
------------- | ------------- | ------------- | -------------
|
|
2153
|
+
**input** | [**CreateBlankSpreadsheetRequest**](CreateBlankSpreadsheetRequest.md)| Document input request |
|
|
2154
|
+
|
|
2155
|
+
### Return type
|
|
2156
|
+
|
|
2157
|
+
[**CreateBlankSpreadsheetResponse**](CreateBlankSpreadsheetResponse.md)
|
|
2158
|
+
|
|
2159
|
+
### Authorization
|
|
2160
|
+
|
|
2161
|
+
[Apikey](../README.md#Apikey)
|
|
2162
|
+
|
|
2163
|
+
### HTTP request headers
|
|
2164
|
+
|
|
2165
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2166
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
# **edit_document_xlsx_create_spreadsheet_from_data**
|
|
2171
|
+
> CreateSpreadsheetFromDataResponse edit_document_xlsx_create_spreadsheet_from_data(input)
|
|
2172
|
+
|
|
2173
|
+
Create a new Excel XLSX spreadsheet from column and row data
|
|
2174
|
+
|
|
2175
|
+
Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input
|
|
2176
|
+
|
|
2177
|
+
### Example
|
|
2178
|
+
```ruby
|
|
2179
|
+
# load the gem
|
|
2180
|
+
require 'cloudmersive-convert-api-client'
|
|
2181
|
+
# setup authorization
|
|
2182
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2183
|
+
# Configure API key authorization: Apikey
|
|
2184
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2185
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2186
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2187
|
+
end
|
|
2188
|
+
|
|
2189
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2190
|
+
|
|
2191
|
+
input = CloudmersiveConvertApiClient::CreateSpreadsheetFromDataRequest.new # CreateSpreadsheetFromDataRequest | Document input request
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
begin
|
|
2195
|
+
#Create a new Excel XLSX spreadsheet from column and row data
|
|
2196
|
+
result = api_instance.edit_document_xlsx_create_spreadsheet_from_data(input)
|
|
2197
|
+
p result
|
|
2198
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2199
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_create_spreadsheet_from_data: #{e}"
|
|
2200
|
+
end
|
|
2201
|
+
```
|
|
2202
|
+
|
|
2203
|
+
### Parameters
|
|
2204
|
+
|
|
2205
|
+
Name | Type | Description | Notes
|
|
2206
|
+
------------- | ------------- | ------------- | -------------
|
|
2207
|
+
**input** | [**CreateSpreadsheetFromDataRequest**](CreateSpreadsheetFromDataRequest.md)| Document input request |
|
|
2208
|
+
|
|
2209
|
+
### Return type
|
|
2210
|
+
|
|
2211
|
+
[**CreateSpreadsheetFromDataResponse**](CreateSpreadsheetFromDataResponse.md)
|
|
2212
|
+
|
|
2213
|
+
### Authorization
|
|
2214
|
+
|
|
2215
|
+
[Apikey](../README.md#Apikey)
|
|
2216
|
+
|
|
2217
|
+
### HTTP request headers
|
|
2218
|
+
|
|
2219
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2220
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2221
|
+
|
|
2222
|
+
|
|
2223
|
+
|
|
2224
|
+
# **edit_document_xlsx_delete_worksheet**
|
|
2225
|
+
> String edit_document_xlsx_delete_worksheet(req_config)
|
|
2226
|
+
|
|
2227
|
+
Delete, remove worksheet from an Excel XLSX spreadsheet document
|
|
2228
|
+
|
|
2229
|
+
Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
|
|
2230
|
+
|
|
2231
|
+
### Example
|
|
2232
|
+
```ruby
|
|
2233
|
+
# load the gem
|
|
2234
|
+
require 'cloudmersive-convert-api-client'
|
|
2235
|
+
# setup authorization
|
|
2236
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2237
|
+
# Configure API key authorization: Apikey
|
|
2238
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2239
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2240
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2241
|
+
end
|
|
2242
|
+
|
|
2243
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2244
|
+
|
|
2245
|
+
req_config = CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest.new # RemoveXlsxWorksheetRequest | Spreadsheet input request
|
|
2246
|
+
|
|
2247
|
+
|
|
2248
|
+
begin
|
|
2249
|
+
#Delete, remove worksheet from an Excel XLSX spreadsheet document
|
|
2250
|
+
result = api_instance.edit_document_xlsx_delete_worksheet(req_config)
|
|
2251
|
+
p result
|
|
2252
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2253
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_delete_worksheet: #{e}"
|
|
2254
|
+
end
|
|
2255
|
+
```
|
|
2256
|
+
|
|
2257
|
+
### Parameters
|
|
2258
|
+
|
|
2259
|
+
Name | Type | Description | Notes
|
|
2260
|
+
------------- | ------------- | ------------- | -------------
|
|
2261
|
+
**req_config** | [**RemoveXlsxWorksheetRequest**](RemoveXlsxWorksheetRequest.md)| Spreadsheet input request |
|
|
2262
|
+
|
|
2263
|
+
### Return type
|
|
2264
|
+
|
|
2265
|
+
**String**
|
|
2266
|
+
|
|
2267
|
+
### Authorization
|
|
2268
|
+
|
|
2269
|
+
[Apikey](../README.md#Apikey)
|
|
2270
|
+
|
|
2271
|
+
### HTTP request headers
|
|
2272
|
+
|
|
2273
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2274
|
+
- **Accept**: application/octet-stream
|
|
2275
|
+
|
|
2276
|
+
|
|
2277
|
+
|
|
2278
|
+
# **edit_document_xlsx_disable_shared_workbook**
|
|
2279
|
+
> DisableSharedWorkbookResponse edit_document_xlsx_disable_shared_workbook(input)
|
|
2280
|
+
|
|
2281
|
+
Disable Shared Workbook (legacy) in Excel XLSX spreadsheet
|
|
2282
|
+
|
|
2283
|
+
Disable the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet
|
|
2284
|
+
|
|
2285
|
+
### Example
|
|
2286
|
+
```ruby
|
|
2287
|
+
# load the gem
|
|
2288
|
+
require 'cloudmersive-convert-api-client'
|
|
2289
|
+
# setup authorization
|
|
2290
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2291
|
+
# Configure API key authorization: Apikey
|
|
2292
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2293
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2294
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2295
|
+
end
|
|
2296
|
+
|
|
2297
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2298
|
+
|
|
2299
|
+
input = CloudmersiveConvertApiClient::DisableSharedWorkbookRequest.new # DisableSharedWorkbookRequest | Document input request
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
begin
|
|
2303
|
+
#Disable Shared Workbook (legacy) in Excel XLSX spreadsheet
|
|
2304
|
+
result = api_instance.edit_document_xlsx_disable_shared_workbook(input)
|
|
2305
|
+
p result
|
|
2306
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2307
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_disable_shared_workbook: #{e}"
|
|
2308
|
+
end
|
|
2309
|
+
```
|
|
2310
|
+
|
|
2311
|
+
### Parameters
|
|
2312
|
+
|
|
2313
|
+
Name | Type | Description | Notes
|
|
2314
|
+
------------- | ------------- | ------------- | -------------
|
|
2315
|
+
**input** | [**DisableSharedWorkbookRequest**](DisableSharedWorkbookRequest.md)| Document input request |
|
|
2316
|
+
|
|
2317
|
+
### Return type
|
|
2318
|
+
|
|
2319
|
+
[**DisableSharedWorkbookResponse**](DisableSharedWorkbookResponse.md)
|
|
2320
|
+
|
|
2321
|
+
### Authorization
|
|
2322
|
+
|
|
2323
|
+
[Apikey](../README.md#Apikey)
|
|
2324
|
+
|
|
2325
|
+
### HTTP request headers
|
|
2326
|
+
|
|
2327
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2328
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
# **edit_document_xlsx_enable_shared_workbook**
|
|
2333
|
+
> EnableSharedWorkbookResponse edit_document_xlsx_enable_shared_workbook(input)
|
|
2334
|
+
|
|
2335
|
+
Enable Shared Workbook (legacy) in Excel XLSX spreadsheet
|
|
2336
|
+
|
|
2337
|
+
Enables the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet
|
|
2338
|
+
|
|
2339
|
+
### Example
|
|
2340
|
+
```ruby
|
|
2341
|
+
# load the gem
|
|
2342
|
+
require 'cloudmersive-convert-api-client'
|
|
2343
|
+
# setup authorization
|
|
2344
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2345
|
+
# Configure API key authorization: Apikey
|
|
2346
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2347
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2348
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2349
|
+
end
|
|
2350
|
+
|
|
2351
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2352
|
+
|
|
2353
|
+
input = CloudmersiveConvertApiClient::EnableSharedWorkbookRequest.new # EnableSharedWorkbookRequest | Document input request
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
begin
|
|
2357
|
+
#Enable Shared Workbook (legacy) in Excel XLSX spreadsheet
|
|
2358
|
+
result = api_instance.edit_document_xlsx_enable_shared_workbook(input)
|
|
2359
|
+
p result
|
|
2360
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2361
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_enable_shared_workbook: #{e}"
|
|
2362
|
+
end
|
|
2363
|
+
```
|
|
2364
|
+
|
|
2365
|
+
### Parameters
|
|
2366
|
+
|
|
2367
|
+
Name | Type | Description | Notes
|
|
2368
|
+
------------- | ------------- | ------------- | -------------
|
|
2369
|
+
**input** | [**EnableSharedWorkbookRequest**](EnableSharedWorkbookRequest.md)| Document input request |
|
|
2370
|
+
|
|
2371
|
+
### Return type
|
|
2372
|
+
|
|
2373
|
+
[**EnableSharedWorkbookResponse**](EnableSharedWorkbookResponse.md)
|
|
2374
|
+
|
|
2375
|
+
### Authorization
|
|
2376
|
+
|
|
2377
|
+
[Apikey](../README.md#Apikey)
|
|
2378
|
+
|
|
2379
|
+
### HTTP request headers
|
|
2380
|
+
|
|
2381
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2382
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
# **edit_document_xlsx_get_cell_by_identifier**
|
|
2387
|
+
> GetXlsxCellByIdentifierResponse edit_document_xlsx_get_cell_by_identifier(input)
|
|
2388
|
+
|
|
2389
|
+
Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
|
|
2390
|
+
|
|
2391
|
+
Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet
|
|
2392
|
+
|
|
2393
|
+
### Example
|
|
2394
|
+
```ruby
|
|
2395
|
+
# load the gem
|
|
2396
|
+
require 'cloudmersive-convert-api-client'
|
|
2397
|
+
# setup authorization
|
|
2398
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2399
|
+
# Configure API key authorization: Apikey
|
|
2400
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2401
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2402
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2403
|
+
end
|
|
2404
|
+
|
|
2405
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2406
|
+
|
|
2407
|
+
input = CloudmersiveConvertApiClient::GetXlsxCellByIdentifierRequest.new # GetXlsxCellByIdentifierRequest | Document input request
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
begin
|
|
2411
|
+
#Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
|
|
2412
|
+
result = api_instance.edit_document_xlsx_get_cell_by_identifier(input)
|
|
2413
|
+
p result
|
|
2414
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2415
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_cell_by_identifier: #{e}"
|
|
2416
|
+
end
|
|
2417
|
+
```
|
|
2418
|
+
|
|
2419
|
+
### Parameters
|
|
2420
|
+
|
|
2421
|
+
Name | Type | Description | Notes
|
|
2422
|
+
------------- | ------------- | ------------- | -------------
|
|
2423
|
+
**input** | [**GetXlsxCellByIdentifierRequest**](GetXlsxCellByIdentifierRequest.md)| Document input request |
|
|
2424
|
+
|
|
2425
|
+
### Return type
|
|
2426
|
+
|
|
2427
|
+
[**GetXlsxCellByIdentifierResponse**](GetXlsxCellByIdentifierResponse.md)
|
|
2428
|
+
|
|
2429
|
+
### Authorization
|
|
2430
|
+
|
|
2431
|
+
[Apikey](../README.md#Apikey)
|
|
2432
|
+
|
|
2433
|
+
### HTTP request headers
|
|
2434
|
+
|
|
2435
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2436
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2437
|
+
|
|
2438
|
+
|
|
2439
|
+
|
|
2440
|
+
# **edit_document_xlsx_get_cell_by_index**
|
|
2441
|
+
> GetXlsxCellResponse edit_document_xlsx_get_cell_by_index(input)
|
|
2442
|
+
|
|
2443
|
+
Get cell from an Excel XLSX spreadsheet, worksheet by index
|
|
2444
|
+
|
|
2445
|
+
Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet
|
|
2446
|
+
|
|
2447
|
+
### Example
|
|
2448
|
+
```ruby
|
|
2449
|
+
# load the gem
|
|
2450
|
+
require 'cloudmersive-convert-api-client'
|
|
2451
|
+
# setup authorization
|
|
2452
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2453
|
+
# Configure API key authorization: Apikey
|
|
2454
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2455
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2456
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2457
|
+
end
|
|
2458
|
+
|
|
2459
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2460
|
+
|
|
2461
|
+
input = CloudmersiveConvertApiClient::GetXlsxCellRequest.new # GetXlsxCellRequest | Document input request
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
begin
|
|
2465
|
+
#Get cell from an Excel XLSX spreadsheet, worksheet by index
|
|
2466
|
+
result = api_instance.edit_document_xlsx_get_cell_by_index(input)
|
|
2467
|
+
p result
|
|
2468
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2469
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_cell_by_index: #{e}"
|
|
2470
|
+
end
|
|
2471
|
+
```
|
|
2472
|
+
|
|
2473
|
+
### Parameters
|
|
2474
|
+
|
|
2475
|
+
Name | Type | Description | Notes
|
|
2476
|
+
------------- | ------------- | ------------- | -------------
|
|
2477
|
+
**input** | [**GetXlsxCellRequest**](GetXlsxCellRequest.md)| Document input request |
|
|
2478
|
+
|
|
2479
|
+
### Return type
|
|
2480
|
+
|
|
2481
|
+
[**GetXlsxCellResponse**](GetXlsxCellResponse.md)
|
|
2482
|
+
|
|
2483
|
+
### Authorization
|
|
2484
|
+
|
|
2485
|
+
[Apikey](../README.md#Apikey)
|
|
2486
|
+
|
|
2487
|
+
### HTTP request headers
|
|
2488
|
+
|
|
2489
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2490
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2491
|
+
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
# **edit_document_xlsx_get_columns**
|
|
2495
|
+
> GetXlsxColumnsResponse edit_document_xlsx_get_columns(input)
|
|
2496
|
+
|
|
2497
|
+
Get columns from a Excel XLSX spreadsheet, worksheet
|
|
2498
|
+
|
|
2499
|
+
Returns the columns defined in the Excel Spreadsheet worksheet
|
|
2500
|
+
|
|
2501
|
+
### Example
|
|
2502
|
+
```ruby
|
|
2503
|
+
# load the gem
|
|
2504
|
+
require 'cloudmersive-convert-api-client'
|
|
2505
|
+
# setup authorization
|
|
2506
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2507
|
+
# Configure API key authorization: Apikey
|
|
2508
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2509
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2510
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2511
|
+
end
|
|
2512
|
+
|
|
2513
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2514
|
+
|
|
2515
|
+
input = CloudmersiveConvertApiClient::GetXlsxColumnsRequest.new # GetXlsxColumnsRequest | Document input request
|
|
2516
|
+
|
|
2517
|
+
|
|
2518
|
+
begin
|
|
2519
|
+
#Get columns from a Excel XLSX spreadsheet, worksheet
|
|
2520
|
+
result = api_instance.edit_document_xlsx_get_columns(input)
|
|
2521
|
+
p result
|
|
2522
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2523
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_columns: #{e}"
|
|
2524
|
+
end
|
|
2525
|
+
```
|
|
2526
|
+
|
|
2527
|
+
### Parameters
|
|
2528
|
+
|
|
2529
|
+
Name | Type | Description | Notes
|
|
2530
|
+
------------- | ------------- | ------------- | -------------
|
|
2531
|
+
**input** | [**GetXlsxColumnsRequest**](GetXlsxColumnsRequest.md)| Document input request |
|
|
2532
|
+
|
|
2533
|
+
### Return type
|
|
2534
|
+
|
|
2535
|
+
[**GetXlsxColumnsResponse**](GetXlsxColumnsResponse.md)
|
|
2536
|
+
|
|
2537
|
+
### Authorization
|
|
2538
|
+
|
|
2539
|
+
[Apikey](../README.md#Apikey)
|
|
2540
|
+
|
|
2541
|
+
### HTTP request headers
|
|
2542
|
+
|
|
2543
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2544
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2545
|
+
|
|
2546
|
+
|
|
2547
|
+
|
|
2548
|
+
# **edit_document_xlsx_get_images**
|
|
2549
|
+
> GetXlsxImagesResponse edit_document_xlsx_get_images(input)
|
|
2550
|
+
|
|
2551
|
+
Get images from a Excel XLSX spreadsheet, worksheet
|
|
2552
|
+
|
|
2553
|
+
Returns the images defined in the Excel Spreadsheet worksheet
|
|
2554
|
+
|
|
2555
|
+
### Example
|
|
2556
|
+
```ruby
|
|
2557
|
+
# load the gem
|
|
2558
|
+
require 'cloudmersive-convert-api-client'
|
|
2559
|
+
# setup authorization
|
|
2560
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2561
|
+
# Configure API key authorization: Apikey
|
|
2562
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2563
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2564
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2565
|
+
end
|
|
2566
|
+
|
|
2567
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2568
|
+
|
|
2569
|
+
input = CloudmersiveConvertApiClient::GetXlsxImagesRequest.new # GetXlsxImagesRequest | Document input request
|
|
2570
|
+
|
|
2571
|
+
|
|
2572
|
+
begin
|
|
2573
|
+
#Get images from a Excel XLSX spreadsheet, worksheet
|
|
2574
|
+
result = api_instance.edit_document_xlsx_get_images(input)
|
|
2575
|
+
p result
|
|
2576
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2577
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_images: #{e}"
|
|
2578
|
+
end
|
|
2579
|
+
```
|
|
2580
|
+
|
|
2581
|
+
### Parameters
|
|
2582
|
+
|
|
2583
|
+
Name | Type | Description | Notes
|
|
2584
|
+
------------- | ------------- | ------------- | -------------
|
|
2585
|
+
**input** | [**GetXlsxImagesRequest**](GetXlsxImagesRequest.md)| Document input request |
|
|
2586
|
+
|
|
2587
|
+
### Return type
|
|
2588
|
+
|
|
2589
|
+
[**GetXlsxImagesResponse**](GetXlsxImagesResponse.md)
|
|
2590
|
+
|
|
2591
|
+
### Authorization
|
|
2592
|
+
|
|
2593
|
+
[Apikey](../README.md#Apikey)
|
|
2594
|
+
|
|
2595
|
+
### HTTP request headers
|
|
2596
|
+
|
|
2597
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2598
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2599
|
+
|
|
2600
|
+
|
|
2601
|
+
|
|
2602
|
+
# **edit_document_xlsx_get_rows_and_cells**
|
|
2603
|
+
> GetXlsxRowsAndCellsResponse edit_document_xlsx_get_rows_and_cells(input)
|
|
2604
|
+
|
|
2605
|
+
Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
|
2606
|
+
|
|
2607
|
+
Returns the rows and cells defined in the Excel Spreadsheet worksheet
|
|
2608
|
+
|
|
2609
|
+
### Example
|
|
2610
|
+
```ruby
|
|
2611
|
+
# load the gem
|
|
2612
|
+
require 'cloudmersive-convert-api-client'
|
|
2613
|
+
# setup authorization
|
|
2614
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2615
|
+
# Configure API key authorization: Apikey
|
|
2616
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2617
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2618
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2619
|
+
end
|
|
2620
|
+
|
|
2621
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2622
|
+
|
|
2623
|
+
input = CloudmersiveConvertApiClient::GetXlsxRowsAndCellsRequest.new # GetXlsxRowsAndCellsRequest | Document input request
|
|
2624
|
+
|
|
2625
|
+
|
|
2626
|
+
begin
|
|
2627
|
+
#Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
|
2628
|
+
result = api_instance.edit_document_xlsx_get_rows_and_cells(input)
|
|
2629
|
+
p result
|
|
2630
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2631
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_rows_and_cells: #{e}"
|
|
2632
|
+
end
|
|
2633
|
+
```
|
|
2634
|
+
|
|
2635
|
+
### Parameters
|
|
2636
|
+
|
|
2637
|
+
Name | Type | Description | Notes
|
|
2638
|
+
------------- | ------------- | ------------- | -------------
|
|
2639
|
+
**input** | [**GetXlsxRowsAndCellsRequest**](GetXlsxRowsAndCellsRequest.md)| Document input request |
|
|
2640
|
+
|
|
2641
|
+
### Return type
|
|
2642
|
+
|
|
2643
|
+
[**GetXlsxRowsAndCellsResponse**](GetXlsxRowsAndCellsResponse.md)
|
|
2644
|
+
|
|
2645
|
+
### Authorization
|
|
2646
|
+
|
|
2647
|
+
[Apikey](../README.md#Apikey)
|
|
2648
|
+
|
|
2649
|
+
### HTTP request headers
|
|
2650
|
+
|
|
2651
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2652
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2653
|
+
|
|
2654
|
+
|
|
2655
|
+
|
|
2656
|
+
# **edit_document_xlsx_get_specific_row**
|
|
2657
|
+
> GetXlsxSpecificRowResponse edit_document_xlsx_get_specific_row(input)
|
|
2658
|
+
|
|
2659
|
+
Get a specific row from a Excel XLSX spreadsheet, worksheet by path
|
|
2660
|
+
|
|
2661
|
+
Returns the specific row and its cells defined in the Excel Spreadsheet worksheet based on the specified path.
|
|
2662
|
+
|
|
2663
|
+
### Example
|
|
2664
|
+
```ruby
|
|
2665
|
+
# load the gem
|
|
2666
|
+
require 'cloudmersive-convert-api-client'
|
|
2667
|
+
# setup authorization
|
|
2668
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2669
|
+
# Configure API key authorization: Apikey
|
|
2670
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2671
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2672
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2673
|
+
end
|
|
2674
|
+
|
|
2675
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2676
|
+
|
|
2677
|
+
input = CloudmersiveConvertApiClient::GetXlsxSpecificRowRequest.new # GetXlsxSpecificRowRequest | Document input request
|
|
2678
|
+
|
|
2679
|
+
|
|
2680
|
+
begin
|
|
2681
|
+
#Get a specific row from a Excel XLSX spreadsheet, worksheet by path
|
|
2682
|
+
result = api_instance.edit_document_xlsx_get_specific_row(input)
|
|
2683
|
+
p result
|
|
2684
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2685
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_specific_row: #{e}"
|
|
2686
|
+
end
|
|
2687
|
+
```
|
|
2688
|
+
|
|
2689
|
+
### Parameters
|
|
2690
|
+
|
|
2691
|
+
Name | Type | Description | Notes
|
|
2692
|
+
------------- | ------------- | ------------- | -------------
|
|
2693
|
+
**input** | [**GetXlsxSpecificRowRequest**](GetXlsxSpecificRowRequest.md)| Document input request |
|
|
2694
|
+
|
|
2695
|
+
### Return type
|
|
2696
|
+
|
|
2697
|
+
[**GetXlsxSpecificRowResponse**](GetXlsxSpecificRowResponse.md)
|
|
2698
|
+
|
|
2699
|
+
### Authorization
|
|
2700
|
+
|
|
2701
|
+
[Apikey](../README.md#Apikey)
|
|
2702
|
+
|
|
2703
|
+
### HTTP request headers
|
|
2704
|
+
|
|
2705
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2706
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2707
|
+
|
|
2708
|
+
|
|
2709
|
+
|
|
2710
|
+
# **edit_document_xlsx_get_styles**
|
|
2711
|
+
> GetXlsxStylesResponse edit_document_xlsx_get_styles(input)
|
|
2712
|
+
|
|
2713
|
+
Get styles from a Excel XLSX spreadsheet, worksheet
|
|
2714
|
+
|
|
2715
|
+
Returns the style defined in the Excel Spreadsheet
|
|
2716
|
+
|
|
2717
|
+
### Example
|
|
2718
|
+
```ruby
|
|
2719
|
+
# load the gem
|
|
2720
|
+
require 'cloudmersive-convert-api-client'
|
|
2721
|
+
# setup authorization
|
|
2722
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2723
|
+
# Configure API key authorization: Apikey
|
|
2724
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2725
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2726
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2727
|
+
end
|
|
2728
|
+
|
|
2729
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2730
|
+
|
|
2731
|
+
input = CloudmersiveConvertApiClient::GetXlsxStylesRequest.new # GetXlsxStylesRequest | Document input request
|
|
2732
|
+
|
|
2733
|
+
|
|
2734
|
+
begin
|
|
2735
|
+
#Get styles from a Excel XLSX spreadsheet, worksheet
|
|
2736
|
+
result = api_instance.edit_document_xlsx_get_styles(input)
|
|
2737
|
+
p result
|
|
2738
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2739
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_styles: #{e}"
|
|
2740
|
+
end
|
|
2741
|
+
```
|
|
2742
|
+
|
|
2743
|
+
### Parameters
|
|
2744
|
+
|
|
2745
|
+
Name | Type | Description | Notes
|
|
2746
|
+
------------- | ------------- | ------------- | -------------
|
|
2747
|
+
**input** | [**GetXlsxStylesRequest**](GetXlsxStylesRequest.md)| Document input request |
|
|
2748
|
+
|
|
2749
|
+
### Return type
|
|
2750
|
+
|
|
2751
|
+
[**GetXlsxStylesResponse**](GetXlsxStylesResponse.md)
|
|
2752
|
+
|
|
2753
|
+
### Authorization
|
|
2754
|
+
|
|
2755
|
+
[Apikey](../README.md#Apikey)
|
|
2756
|
+
|
|
2757
|
+
### HTTP request headers
|
|
2758
|
+
|
|
2759
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2760
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2761
|
+
|
|
2762
|
+
|
|
2763
|
+
|
|
2764
|
+
# **edit_document_xlsx_get_worksheets**
|
|
2765
|
+
> GetXlsxWorksheetsResponse edit_document_xlsx_get_worksheets(input)
|
|
2766
|
+
|
|
2767
|
+
Get worksheets from a Excel XLSX spreadsheet
|
|
2768
|
+
|
|
2769
|
+
Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file
|
|
2770
|
+
|
|
2771
|
+
### Example
|
|
2772
|
+
```ruby
|
|
2773
|
+
# load the gem
|
|
2774
|
+
require 'cloudmersive-convert-api-client'
|
|
2775
|
+
# setup authorization
|
|
2776
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2777
|
+
# Configure API key authorization: Apikey
|
|
2778
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2779
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2780
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2781
|
+
end
|
|
2782
|
+
|
|
2783
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2784
|
+
|
|
2785
|
+
input = CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest.new # GetXlsxWorksheetsRequest | Document input request
|
|
2786
|
+
|
|
2787
|
+
|
|
2788
|
+
begin
|
|
2789
|
+
#Get worksheets from a Excel XLSX spreadsheet
|
|
2790
|
+
result = api_instance.edit_document_xlsx_get_worksheets(input)
|
|
2791
|
+
p result
|
|
2792
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2793
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_worksheets: #{e}"
|
|
2794
|
+
end
|
|
2795
|
+
```
|
|
2796
|
+
|
|
2797
|
+
### Parameters
|
|
2798
|
+
|
|
2799
|
+
Name | Type | Description | Notes
|
|
2800
|
+
------------- | ------------- | ------------- | -------------
|
|
2801
|
+
**input** | [**GetXlsxWorksheetsRequest**](GetXlsxWorksheetsRequest.md)| Document input request |
|
|
2802
|
+
|
|
2803
|
+
### Return type
|
|
2804
|
+
|
|
2805
|
+
[**GetXlsxWorksheetsResponse**](GetXlsxWorksheetsResponse.md)
|
|
2806
|
+
|
|
2807
|
+
### Authorization
|
|
2808
|
+
|
|
2809
|
+
[Apikey](../README.md#Apikey)
|
|
2810
|
+
|
|
2811
|
+
### HTTP request headers
|
|
2812
|
+
|
|
2813
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2814
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2815
|
+
|
|
2816
|
+
|
|
2817
|
+
|
|
2818
|
+
# **edit_document_xlsx_insert_worksheet**
|
|
2819
|
+
> InsertXlsxWorksheetResponse edit_document_xlsx_insert_worksheet(input)
|
|
2820
|
+
|
|
2821
|
+
Insert a new worksheet into an Excel XLSX spreadsheet
|
|
2822
|
+
|
|
2823
|
+
Inserts a new worksheet into an Excel Spreadsheet
|
|
2824
|
+
|
|
2825
|
+
### Example
|
|
2826
|
+
```ruby
|
|
2827
|
+
# load the gem
|
|
2828
|
+
require 'cloudmersive-convert-api-client'
|
|
2829
|
+
# setup authorization
|
|
2830
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2831
|
+
# Configure API key authorization: Apikey
|
|
2832
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2833
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2834
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2835
|
+
end
|
|
2836
|
+
|
|
2837
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2838
|
+
|
|
2839
|
+
input = CloudmersiveConvertApiClient::InsertXlsxWorksheetRequest.new # InsertXlsxWorksheetRequest | Document input request
|
|
2840
|
+
|
|
2841
|
+
|
|
2842
|
+
begin
|
|
2843
|
+
#Insert a new worksheet into an Excel XLSX spreadsheet
|
|
2844
|
+
result = api_instance.edit_document_xlsx_insert_worksheet(input)
|
|
2845
|
+
p result
|
|
2846
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2847
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_insert_worksheet: #{e}"
|
|
2848
|
+
end
|
|
2849
|
+
```
|
|
2850
|
+
|
|
2851
|
+
### Parameters
|
|
2852
|
+
|
|
2853
|
+
Name | Type | Description | Notes
|
|
2854
|
+
------------- | ------------- | ------------- | -------------
|
|
2855
|
+
**input** | [**InsertXlsxWorksheetRequest**](InsertXlsxWorksheetRequest.md)| Document input request |
|
|
2856
|
+
|
|
2857
|
+
### Return type
|
|
2858
|
+
|
|
2859
|
+
[**InsertXlsxWorksheetResponse**](InsertXlsxWorksheetResponse.md)
|
|
2860
|
+
|
|
2861
|
+
### Authorization
|
|
2862
|
+
|
|
2863
|
+
[Apikey](../README.md#Apikey)
|
|
2864
|
+
|
|
2865
|
+
### HTTP request headers
|
|
2866
|
+
|
|
2867
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2868
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2869
|
+
|
|
2870
|
+
|
|
2871
|
+
|
|
2872
|
+
# **edit_document_xlsx_rename_worksheet**
|
|
2873
|
+
> RenameXlsxWorksheetResponse edit_document_xlsx_rename_worksheet(input)
|
|
2874
|
+
|
|
2875
|
+
Rename a specific worksheet in a Excel XLSX spreadsheet
|
|
2876
|
+
|
|
2877
|
+
Edits the input Excel XLSX spreadsheet document to rename a specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
|
|
2878
|
+
|
|
2879
|
+
### Example
|
|
2880
|
+
```ruby
|
|
2881
|
+
# load the gem
|
|
2882
|
+
require 'cloudmersive-convert-api-client'
|
|
2883
|
+
# setup authorization
|
|
2884
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2885
|
+
# Configure API key authorization: Apikey
|
|
2886
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2887
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2888
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2889
|
+
end
|
|
2890
|
+
|
|
2891
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2892
|
+
|
|
2893
|
+
input = CloudmersiveConvertApiClient::RenameXlsxWorksheetRequest.new # RenameXlsxWorksheetRequest | Document input request
|
|
2894
|
+
|
|
2895
|
+
|
|
2896
|
+
begin
|
|
2897
|
+
#Rename a specific worksheet in a Excel XLSX spreadsheet
|
|
2898
|
+
result = api_instance.edit_document_xlsx_rename_worksheet(input)
|
|
2899
|
+
p result
|
|
2900
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2901
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_rename_worksheet: #{e}"
|
|
2902
|
+
end
|
|
2903
|
+
```
|
|
2904
|
+
|
|
2905
|
+
### Parameters
|
|
2906
|
+
|
|
2907
|
+
Name | Type | Description | Notes
|
|
2908
|
+
------------- | ------------- | ------------- | -------------
|
|
2909
|
+
**input** | [**RenameXlsxWorksheetRequest**](RenameXlsxWorksheetRequest.md)| Document input request |
|
|
2910
|
+
|
|
2911
|
+
### Return type
|
|
2912
|
+
|
|
2913
|
+
[**RenameXlsxWorksheetResponse**](RenameXlsxWorksheetResponse.md)
|
|
2914
|
+
|
|
2915
|
+
### Authorization
|
|
2916
|
+
|
|
2917
|
+
[Apikey](../README.md#Apikey)
|
|
2918
|
+
|
|
2919
|
+
### HTTP request headers
|
|
2920
|
+
|
|
2921
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2922
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2923
|
+
|
|
2924
|
+
|
|
2925
|
+
|
|
2926
|
+
# **edit_document_xlsx_set_cell_by_identifier**
|
|
2927
|
+
> SetXlsxCellByIdentifierResponse edit_document_xlsx_set_cell_by_identifier(input)
|
|
2928
|
+
|
|
2929
|
+
Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
|
|
2930
|
+
|
|
2931
|
+
Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet using its cell identifier (e.g. A1, B22, C33) in the worksheet
|
|
2932
|
+
|
|
2933
|
+
### Example
|
|
2934
|
+
```ruby
|
|
2935
|
+
# load the gem
|
|
2936
|
+
require 'cloudmersive-convert-api-client'
|
|
2937
|
+
# setup authorization
|
|
2938
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2939
|
+
# Configure API key authorization: Apikey
|
|
2940
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2941
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2942
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2943
|
+
end
|
|
2944
|
+
|
|
2945
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
2946
|
+
|
|
2947
|
+
input = CloudmersiveConvertApiClient::SetXlsxCellByIdentifierRequest.new # SetXlsxCellByIdentifierRequest | Document input request
|
|
2948
|
+
|
|
2949
|
+
|
|
2950
|
+
begin
|
|
2951
|
+
#Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
|
|
2952
|
+
result = api_instance.edit_document_xlsx_set_cell_by_identifier(input)
|
|
2953
|
+
p result
|
|
2954
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
2955
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_set_cell_by_identifier: #{e}"
|
|
2956
|
+
end
|
|
2957
|
+
```
|
|
2958
|
+
|
|
2959
|
+
### Parameters
|
|
2960
|
+
|
|
2961
|
+
Name | Type | Description | Notes
|
|
2962
|
+
------------- | ------------- | ------------- | -------------
|
|
2963
|
+
**input** | [**SetXlsxCellByIdentifierRequest**](SetXlsxCellByIdentifierRequest.md)| Document input request |
|
|
2964
|
+
|
|
2965
|
+
### Return type
|
|
2966
|
+
|
|
2967
|
+
[**SetXlsxCellByIdentifierResponse**](SetXlsxCellByIdentifierResponse.md)
|
|
2968
|
+
|
|
2969
|
+
### Authorization
|
|
2970
|
+
|
|
2971
|
+
[Apikey](../README.md#Apikey)
|
|
2972
|
+
|
|
2973
|
+
### HTTP request headers
|
|
2974
|
+
|
|
2975
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
2976
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
2977
|
+
|
|
2978
|
+
|
|
2979
|
+
|
|
2980
|
+
# **edit_document_xlsx_set_cell_by_index**
|
|
2981
|
+
> SetXlsxCellResponse edit_document_xlsx_set_cell_by_index(input)
|
|
2982
|
+
|
|
2983
|
+
Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
|
|
2984
|
+
|
|
2985
|
+
Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
|
|
2986
|
+
|
|
2987
|
+
### Example
|
|
2988
|
+
```ruby
|
|
2989
|
+
# load the gem
|
|
2990
|
+
require 'cloudmersive-convert-api-client'
|
|
2991
|
+
# setup authorization
|
|
2992
|
+
CloudmersiveConvertApiClient.configure do |config|
|
|
2993
|
+
# Configure API key authorization: Apikey
|
|
2994
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
2995
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2996
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
2997
|
+
end
|
|
2998
|
+
|
|
2999
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
3000
|
+
|
|
3001
|
+
input = CloudmersiveConvertApiClient::SetXlsxCellRequest.new # SetXlsxCellRequest | Document input request
|
|
3002
|
+
|
|
3003
|
+
|
|
3004
|
+
begin
|
|
3005
|
+
#Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
|
|
3006
|
+
result = api_instance.edit_document_xlsx_set_cell_by_index(input)
|
|
3007
|
+
p result
|
|
3008
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
|
3009
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_set_cell_by_index: #{e}"
|
|
3010
|
+
end
|
|
3011
|
+
```
|
|
3012
|
+
|
|
3013
|
+
### Parameters
|
|
3014
|
+
|
|
3015
|
+
Name | Type | Description | Notes
|
|
3016
|
+
------------- | ------------- | ------------- | -------------
|
|
3017
|
+
**input** | [**SetXlsxCellRequest**](SetXlsxCellRequest.md)| Document input request |
|
|
3018
|
+
|
|
3019
|
+
### Return type
|
|
3020
|
+
|
|
3021
|
+
[**SetXlsxCellResponse**](SetXlsxCellResponse.md)
|
|
3022
|
+
|
|
3023
|
+
### Authorization
|
|
3024
|
+
|
|
3025
|
+
[Apikey](../README.md#Apikey)
|
|
3026
|
+
|
|
3027
|
+
### HTTP request headers
|
|
3028
|
+
|
|
3029
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
|
3030
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
3031
|
+
|
|
3032
|
+
|
|
3033
|
+
|