CloudmersiveconvertClient
Classes
dataclass
CreateBlankDocxResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Create a blank Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.
dataclass
DeleteDocxTableRowResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Deletes a table row in an existing table in a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
DeleteDocxTableRowRangeResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Deletes a range of multiple table rows in an existing table in a Word
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
Response for Get body from a Word DOCX document
Attributes
class-attribute
instance-attribute
Body in the DOCX document
dataclass
GetDocxCommentsHierarchicalResponse(comments: Optional[List[DocxTopLevelComment]] = None, successful: Optional[bool] = None, top_level_comment_count: Optional[int] = None)
Response for Get comments from a Word DOCX document hierarchically
dataclass
dataclass
Response for Get images from a Word DOCX document
Attributes
class-attribute
instance-attribute
Images in the DOCX document
dataclass
GetDocxPagesResponse(page_count: Optional[int] = None, pages: Optional[List[DocxPage]] = None, successful: Optional[bool] = None)
Response for Get pages and content from a Word DOCX document
Attributes
class-attribute
instance-attribute
Count of pages
class-attribute
instance-attribute
Pages in the document
dataclass
GetDocxSectionsResponse(sections: Optional[List[DocxSection]] = None, successful: Optional[bool] = None)
Response for Get sections from a Word DOCX document
Attributes
class-attribute
instance-attribute
Sections in the DOCX document
dataclass
Response for Get styles from a Word DOCX document
Attributes
class-attribute
instance-attribute
Styles in the DOCX document
dataclass
GetDocxTableRowResponse(row_result: Optional[DocxTableRow] = None, successful: Optional[bool] = None)
Response for Gets the contents of an existing table row in an existing table in a W
Attributes
class-attribute
instance-attribute
Contents of the table row that was requested
dataclass
Response for Get a specific table by index in a Word DOCX document
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
Response for Get all tables in Word DOCX document
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
InsertDocxCommentOnParagraphResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Insert a new comment into a Word DOCX document attached to a paragraph
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
DocxInsertImageResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Insert image into a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
InsertDocxInsertParagraphResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Insert a new paragraph into a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
InsertDocxTablesResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Insert a new table into a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
InsertDocxTableRowResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Insert a new row into an existing table in a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
RemoveDocxHeadersAndFootersResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Remove headers and footers from Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
URL of the resulting edited document; this is a secure URL and cannot be downloaded without adding the Apikey header; it is also temporary, stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.
dataclass
DocxRemoveObjectResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Delete any object in a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
DocxSetFooterResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Set the footer in a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
DocxSetHeaderResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Set the header in a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
UpdateDocxTableCellResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Update, set contents of a table cell in an existing table in a Word DO
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
UpdateDocxTableRowResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Update, set contents of a table row in an existing table in a Word DOCX document
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
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.
dataclass
ClearXlsxCellResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.
dataclass
CreateBlankSpreadsheetResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Create a blank Excel XLSX spreadsheet
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.
dataclass
CreateSpreadsheetFromDataResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Create a new Excel XLSX spreadsheet from column and row data
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.
dataclass
dataclass
GetXlsxCellByIdentifierResponse(cell: Optional[XlsxSpreadsheetCell] = None, successful: Optional[bool] = None)
Response for Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
Attributes
class-attribute
instance-attribute
Requested Cell in the Excel XLSX document
dataclass
Response for Get cell from an Excel XLSX spreadsheet, worksheet by index
Attributes
class-attribute
instance-attribute
Requested Cell in the Excel XLSX document
dataclass
GetXlsxColumnsResponse(columns: Optional[List[XlsxSpreadsheetColumn]] = None, successful: Optional[bool] = None)
dataclass
Response for Get images from a Excel XLSX spreadsheet, worksheet
Attributes
class-attribute
instance-attribute
Spreadsheet Images in the XLSX document
dataclass
GetXlsxRowsAndCellsResponse(rows: Optional[List[XlsxSpreadsheetRow]] = None, successful: Optional[bool] = None)
Response for Get rows and cells from a Excel XLSX spreadsheet, worksheet
Attributes
class-attribute
instance-attribute
Spreadsheet Rows in the Excel XLSX document
dataclass
GetXlsxStylesResponse(cell_styles: Optional[List[DocxCellStyle]] = None, successful: Optional[bool] = None)
dataclass
GetXlsxWorksheetsResponse(successful: Optional[bool] = None, worksheets: Optional[List[XlsxWorksheet]] = None)
Response for Get worksheets from a Excel XLSX spreadsheet
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
InsertXlsxWorksheetResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Insert a new worksheet into an Excel XLSX spreadsheet
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.
dataclass
SetXlsxCellByIdentifierResponse(edited_document_u_r_l: Optional[str] = None, successful: Optional[bool] = None)
Response for Set, update cell contents in an Excel XLSX spreadsheet, worksheet by c
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.
dataclass
Response for Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
Attributes
class-attribute
instance-attribute
edited_document_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'EditedDocumentURL'})
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.
dataclass
dataclass
HtmlTemplateApplicationResponse(final_html: Optional[str] = None, successful: Optional[bool] = None)
Response for Apply HTML template
Attributes
class-attribute
instance-attribute
Final HTML result of all operations on input
dataclass
dataclass
Response for Convert HTML string to text (txt)
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
Response for Convert website URL page to text (txt)
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
AddPdfAnnotationRequest(annotations_to_add: Optional[List[PdfAnnotation]] = None, input_file_bytes: Optional[str] = None)
dataclass
AlternateFileFormatCandidate(detected_file_extension: Optional[str] = None, detected_mime_type: Optional[str] = None, probability: Optional[float] = None)
Definition: AlternateFileFormatCandidate
Attributes
class-attribute
instance-attribute
detected_file_extension: Optional[str] = field(default=None, metadata={'wire_name': 'DetectedFileExtension'})
Detected file extension of the file format, with a leading period
class-attribute
instance-attribute
MIME type of this file extension
dataclass
AutodetectDocumentValidationResult(document_is_valid: Optional[bool] = None, error_count: Optional[int] = None, errors_and_warnings: Optional[List[DocumentValidationError]] = None, file_format_extension: Optional[str] = None, warning_count: Optional[int] = None)
Definition: AutodetectDocumentValidationResult
Attributes
class-attribute
instance-attribute
True if the document is valid and has no errors, false otherwise
class-attribute
instance-attribute
Number of validation errors found in the document
dataclass
AutodetectGetInfoResult(alternate_file_type_candidates: Optional[List[AlternateFileFormatCandidate]] = None, author: Optional[str] = None, date_modified: Optional[str] = None, detected_file_extension: Optional[str] = None, detected_mime_type: Optional[str] = None, page_count: Optional[int] = None, successful: Optional[bool] = None)
Definition: AutodetectGetInfoResult
Attributes
class-attribute
instance-attribute
alternate_file_type_candidates: Optional[List[AlternateFileFormatCandidate]] = field(default=None, metadata={'wire_name': 'AlternateFileTypeCandidates'})
Alternate file type options and their probability
class-attribute
instance-attribute
User name of the creator/author of the document, if available, null if not available
class-attribute
instance-attribute
The timestamp that the document was last modified, if available, null if not available
class-attribute
instance-attribute
detected_file_extension: Optional[str] = field(default=None, metadata={'wire_name': 'DetectedFileExtension'})
Detected file extension of the file format, with a leading period
class-attribute
instance-attribute
MIME type of this file extension
class-attribute
instance-attribute
Number of pages in a page-based document; for presentations, this is the number of slides and for a spreadsheet this is the number of worksheets. Contains 0 when the page count cannot be determined, or if the concept of page count does not apply (e.g. for an image)
dataclass
AutodetectToPngResult(png_result_pages: Optional[List[ConvertedPngPage]] = None, successful: Optional[bool] = None)
dataclass
dataclass
Definition: Base64DecodeResponse
Attributes
class-attribute
instance-attribute
Result of performing a base 64 decode operation, binary file content
dataclass
dataclass
Definition: Base64DetectResponse
Attributes
class-attribute
instance-attribute
True if the input string is base 64 encoded, false otherwise
dataclass
dataclass
Base64EncodeResponse(base64_text_content_result: Optional[str] = None, successful: Optional[bool] = None)
Definition: Base64EncodeResponse
dataclass
ChangeLineEndingResponse(successful: Optional[bool] = None, text_content_result: Optional[str] = None)
Definition: ChangeLineEndingResponse
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
ClearXlsxCellRequest(cell_index: Optional[int] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, row_index: Optional[int] = None, worksheet_to_update: Optional[XlsxWorksheet] = None)
Definition: ClearXlsxCellRequest
Attributes
class-attribute
instance-attribute
0-based index of the cell, 0, 1, 2, ... in the row to clear
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
0-based index of the row, 0, 1, 2, ... to clear
dataclass
Definition: ConvertedPngPage
Attributes
class-attribute
instance-attribute
Page number of the converted page, starting with 1
dataclass
dataclass
Definition: CreateBlankSpreadsheetRequest
dataclass
CreateSpreadsheetFromDataRequest(rows: Optional[List[XlsxSpreadsheetRow]] = None, worksheet_name: Optional[str] = None)
Definition: CreateSpreadsheetFromDataRequest
Attributes
class-attribute
instance-attribute
Required; Rows and cells to populate the spreadsheet with
dataclass
CreateZipArchiveRequest(directories_in_zip: Optional[List[ZipDirectory]] = None, files_in_zip: Optional[List[ZipFile]] = None)
Definition: CreateZipArchiveRequest
dataclass
DeleteDocxTableRowRangeRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, table_path: Optional[str] = None, table_row_row_index_end: Optional[int] = None, table_row_row_index_start: Optional[int] = None)
Definition: DeleteDocxTableRowRangeRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
Path to the table to delete the row from
dataclass
DeleteDocxTableRowRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, table_path: Optional[str] = None, table_row_row_index: Optional[int] = None)
Definition: DeleteDocxTableRowRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
Path to the table to delete the row from
dataclass
DetectLineEndingsResponse(input_length: Optional[int] = None, primary_newline_terminator: Optional[str] = None, primary_newline_type: Optional[str] = None, successful: Optional[bool] = None)
Definition: DetectLineEndingsResponse
Attributes
class-attribute
instance-attribute
Length of the input string in characters
class-attribute
instance-attribute
primary_newline_terminator: Optional[str] = field(default=None, metadata={'wire_name': 'PrimaryNewlineTerminator'})
Characters used to terminate a newline; can be carriage return, linefeed, or carriage return + linefeed
class-attribute
instance-attribute
primary_newline_type: Optional[str] = field(default=None, metadata={'wire_name': 'PrimaryNewlineType'})
Type of newline in the file; possible vlaues are "Mac" (legacy Mac OS uses carriage return only); "Unix" (Unix and Linux OSes, and modern Mac OS); "Windows" (Windows operating systems)
dataclass
DocumentValidationError(description: Optional[str] = None, is_error: Optional[bool] = None, path: Optional[str] = None, uri: Optional[str] = None)
Definition: DocumentValidationError
Attributes
class-attribute
instance-attribute
Description of the error
class-attribute
instance-attribute
True if this is an error, false otherwise
class-attribute
instance-attribute
XPath to the error
dataclass
DocumentValidationResult(document_is_valid: Optional[bool] = None, error_count: Optional[int] = None, errors_and_warnings: Optional[List[DocumentValidationError]] = None, warning_count: Optional[int] = None)
Definition: DocumentValidationResult
Attributes
class-attribute
instance-attribute
True if the document is valid and has no errors, false otherwise
class-attribute
instance-attribute
Number of validation errors found in the document
dataclass
DocxBody(all_paragraphs: Optional[List[DocxParagraph]] = None, all_tables: Optional[List[DocxTable]] = None, path: Optional[str] = None)
Definition: DocxBody
Attributes
class-attribute
instance-attribute
all_paragraphs: Optional[List[DocxParagraph]] = field(default=None, metadata={'wire_name': 'AllParagraphs'})
All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document
class-attribute
instance-attribute
All tables anywhere in the document; these objects are not sequentially placed but are scatted across the document
dataclass
DocxCellStyle(built_in_id: Optional[int] = None, format_id: Optional[int] = None, name: Optional[str] = None, path: Optional[str] = None)
Definition: DocxCellStyle
Attributes
class-attribute
instance-attribute
Built=in ID of the cell style
class-attribute
instance-attribute
Format ID of the cell style
class-attribute
instance-attribute
Name of the style
dataclass
DocxComment(author: Optional[str] = None, author_initials: Optional[str] = None, comment_date: Optional[str] = None, comment_text: Optional[str] = None, done: Optional[bool] = None, is_reply: Optional[bool] = None, is_top_level: Optional[bool] = None, parent_comment_path: Optional[str] = None, path: Optional[str] = None)
Definition: DocxComment
Attributes
class-attribute
instance-attribute
Author name of the comment
class-attribute
instance-attribute
Initials of the author of the comment
class-attribute
instance-attribute
Date timestamp of the comment
class-attribute
instance-attribute
Text content of the comment
class-attribute
instance-attribute
True if this comment is marked as Done in Word, otherwise it is false
class-attribute
instance-attribute
True if this comment is a reply to another comment, false otherwise
class-attribute
instance-attribute
True if the comment is at the top level, false if this comment is a child reply of another comment
dataclass
DocxFooter(paragraphs: Optional[List[DocxParagraph]] = None, path: Optional[str] = None, sections_with_footer: Optional[List[DocxSection]] = None)
Definition: DocxFooter
dataclass
DocxHeader(paragraphs: Optional[List[DocxParagraph]] = None, path: Optional[str] = None, sections_with_header: Optional[List[DocxSection]] = None)
Definition: DocxHeader
dataclass
DocxImage(image_contents_u_r_l: Optional[str] = None, image_data_content_type: Optional[str] = None, image_data_embed_id: Optional[str] = None, image_description: Optional[str] = None, image_height: Optional[int] = None, image_id: Optional[int] = None, image_internal_file_name: Optional[str] = None, image_name: Optional[str] = None, image_width: Optional[int] = None, inline_with_text: Optional[bool] = None, path: Optional[str] = None, x_offset: Optional[int] = None, y_offset: Optional[int] = None)
Definition: DocxImage
Attributes
class-attribute
instance-attribute
image_contents_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'ImageContentsURL'})
URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents.
class-attribute
instance-attribute
image_data_content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ImageDataContentType'})
Read-only; image data MIME content-type
class-attribute
instance-attribute
image_data_embed_id: Optional[str] = field(default=None, metadata={'wire_name': 'ImageDataEmbedId'})
Read-only; internal ID for the image contents
class-attribute
instance-attribute
The Description of the image
class-attribute
instance-attribute
Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height
class-attribute
instance-attribute
The Id of the image
class-attribute
instance-attribute
image_internal_file_name: Optional[str] = field(default=None, metadata={'wire_name': 'ImageInternalFileName'})
Read-only; internal file name/path for the image
class-attribute
instance-attribute
The Name of the image
class-attribute
instance-attribute
Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height
class-attribute
instance-attribute
True if the image is inline with the text; false if it is floating
class-attribute
instance-attribute
The Path of the location of this object; leave blank for new tables
class-attribute
instance-attribute
X (horizontal) offset of the image
dataclass
DocxInsertCommentOnParagraphRequest(comment_to_insert: Optional[DocxComment] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, paragraph_path: Optional[str] = None)
Definition: DocxInsertCommentOnParagraphRequest
Attributes
class-attribute
instance-attribute
comment_to_insert: Optional[DocxComment] = field(default=None, metadata={'wire_name': 'CommentToInsert'})
Comment to insert
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
Path to the paragraph to attach the comment to. You can get the Path by retrieving all of the Paragraphs in document by calling Get Body and taking the Path property of the desired paragraph to add the comment to.
dataclass
DocxInsertImageRequest(height_in_e_m_us: Optional[int] = None, image_to_add: Optional[DocxImage] = None, input_document_file_bytes: Optional[str] = None, input_document_file_url: Optional[str] = None, input_image_file_bytes: Optional[str] = None, input_image_file_url: Optional[str] = None, insert_path: Optional[str] = None, insert_placement: Optional[str] = None, width_in_e_m_us: Optional[int] = None)
Definition: DocxInsertImageRequest
Attributes
class-attribute
instance-attribute
Optional: The height of the image in EMUs
class-attribute
instance-attribute
Optional: Image to add; if you supply in this object, do not supply InputImageFileBytes or InputImageFileUrl.
class-attribute
instance-attribute
input_document_file_bytes: Optional[str] = field(default=None, metadata={'wire_name': 'InputDocumentFileBytes'})
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
input_document_file_url: Optional[str] = field(default=None, metadata={'wire_name': 'InputDocumentFileUrl'})
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).
class-attribute
instance-attribute
input_image_file_bytes: Optional[str] = field(default=None, metadata={'wire_name': 'InputImageFileBytes'})
Optional: Bytes of the input image file to operate on; if you supply this value do not supply InputImageFileUrl or ImageToAdd.
class-attribute
instance-attribute
input_image_file_url: Optional[str] = field(default=None, metadata={'wire_name': 'InputImageFileUrl'})
Optional: URL of an image file to operate on as input; if you supply this value do not supply InputImageFileBytes or ImageToAdd. 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).
class-attribute
instance-attribute
Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject
class-attribute
instance-attribute
Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)
dataclass
Definition: DocxPage
Attributes
class-attribute
instance-attribute
Page number of this page, 1-based
dataclass
DocxParagraph(content_runs: Optional[List[DocxRun]] = None, paragraph_index: Optional[int] = None, path: Optional[str] = None, style_id: Optional[str] = None)
Definition: DocxParagraph
Attributes
class-attribute
instance-attribute
The content runs in the paragraph - this is where text is stored; similar to a span in HTML
class-attribute
instance-attribute
The index of the paragraph; 0-based
class-attribute
instance-attribute
The Path of the location of this object; leave blank for new tables
dataclass
DocxRemoveObjectRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, path_to_object_to_remove: Optional[str] = None)
Definition: DocxRemoveObjectRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
path_to_object_to_remove: Optional[str] = field(default=None, metadata={'wire_name': 'PathToObjectToRemove'})
Path within the document of the object to delete; fill in the PathToObjectToRemove field using the Path value from an existing object.
dataclass
DocxRun(bold: Optional[bool] = None, font_family: Optional[str] = None, font_size: Optional[str] = None, italic: Optional[bool] = None, path: Optional[str] = None, run_index: Optional[int] = None, text_items: Optional[List[DocxText]] = None, underline: Optional[str] = None)
Definition: DocxRun
Attributes
class-attribute
instance-attribute
True to make the text bold, false otherwise
class-attribute
instance-attribute
Font Family name for the text, e.g. "Arial" or "Times New Roman"
class-attribute
instance-attribute
Font size in font points (e.g. "24")
class-attribute
instance-attribute
True to make the text italic, false otherwise
class-attribute
instance-attribute
The Path of the location of this object; leave blank for new tables
class-attribute
instance-attribute
Index of the run, 0-based
class-attribute
instance-attribute
Text items inside the run; this is where the actual text content is stored
class-attribute
instance-attribute
Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None
dataclass
Definition: DocxSection
Attributes
class-attribute
instance-attribute
The Path of the location of this object; leave blank for new tables
dataclass
DocxSetFooterAddPageNumberRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, prepend_text: Optional[str] = None)
Definition: DocxSetFooterAddPageNumberRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
DocxSetFooterRequest(footer_to_apply: Optional[DocxFooter] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)
Definition: DocxSetFooterRequest
Attributes
class-attribute
instance-attribute
footer_to_apply: Optional[DocxFooter] = field(default=None, metadata={'wire_name': 'FooterToApply'})
Footer to apply
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
DocxSetHeaderRequest(header_to_apply: Optional[DocxHeader] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)
Definition: DocxSetHeaderRequest
Attributes
class-attribute
instance-attribute
header_to_apply: Optional[DocxHeader] = field(default=None, metadata={'wire_name': 'HeaderToApply'})
Header to apply
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
DocxStyle(bold: Optional[bool] = None, font_family: Optional[str] = None, font_size: Optional[str] = None, italic: Optional[bool] = None, path: Optional[str] = None, style_id: Optional[str] = None, underline: Optional[bool] = None)
Definition: DocxStyle
Attributes
class-attribute
instance-attribute
Style applies bold formatting
class-attribute
instance-attribute
Font family
class-attribute
instance-attribute
Font size
class-attribute
instance-attribute
Style applies italic formatting
class-attribute
instance-attribute
The Path of the location of this object; leave blank for new tables
class-attribute
instance-attribute
ID of the style
dataclass
DocxTable(bottom_border_color: Optional[str] = None, bottom_border_size: Optional[int] = None, bottom_border_space: Optional[int] = None, bottom_border_type: Optional[str] = None, cell_horizontal_border_color: Optional[str] = None, cell_horizontal_border_size: Optional[int] = None, cell_horizontal_border_space: Optional[int] = None, cell_horizontal_border_type: Optional[str] = None, cell_vertical_border_color: Optional[str] = None, cell_vertical_border_size: Optional[int] = None, cell_vertical_border_space: Optional[int] = None, cell_vertical_border_type: Optional[str] = None, end_border_color: Optional[str] = None, end_border_size: Optional[int] = None, end_border_space: Optional[int] = None, end_border_type: Optional[str] = None, left_border_color: Optional[str] = None, left_border_size: Optional[int] = None, left_border_space: Optional[int] = None, left_border_type: Optional[str] = None, path: Optional[str] = None, right_border_color: Optional[str] = None, right_border_size: Optional[int] = None, right_border_space: Optional[int] = None, right_border_type: Optional[str] = None, start_border_color: Optional[str] = None, start_border_size: Optional[int] = None, start_border_space: Optional[int] = None, start_border_type: Optional[str] = None, table_id: Optional[str] = None, table_indentation_mode: Optional[str] = None, table_indentation_width: Optional[int] = None, table_rows: Optional[List[DocxTableRow]] = None, top_border_color: Optional[str] = None, top_border_size: Optional[int] = None, top_border_space: Optional[int] = None, top_border_type: Optional[str] = None, width: Optional[str] = None, width_type: Optional[str] = None)
Definition: DocxTable
Attributes
class-attribute
instance-attribute
bottom_border_color: Optional[str] = field(default=None, metadata={'wire_name': 'BottomBorderColor'})
HTML-style color hex value (do not include a #)
class-attribute
instance-attribute
Width of the border in points (1/72nd of an inch)
class-attribute
instance-attribute
bottom_border_space: Optional[int] = field(default=None, metadata={'wire_name': 'BottomBorderSpace'})
Spacing around the border in points (1/72nd of an inch)
class-attribute
instance-attribute
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
class-attribute
instance-attribute
cell_horizontal_border_color: Optional[str] = field(default=None, metadata={'wire_name': 'CellHorizontalBorderColor'})
HTML-style color hex value (do not include a #)
class-attribute
instance-attribute
cell_horizontal_border_size: Optional[int] = field(default=None, metadata={'wire_name': 'CellHorizontalBorderSize'})
Width of the border in points (1/72nd of an inch)
class-attribute
instance-attribute
cell_horizontal_border_space: Optional[int] = field(default=None, metadata={'wire_name': 'CellHorizontalBorderSpace'})
Spacing around the border in points (1/72nd of an inch)
class-attribute
instance-attribute
cell_horizontal_border_type: Optional[str] = field(default=None, metadata={'wire_name': 'CellHorizontalBorderType'})
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
class-attribute
instance-attribute
cell_vertical_border_color: Optional[str] = field(default=None, metadata={'wire_name': 'CellVerticalBorderColor'})
HTML-style color hex value (do not include a #)
class-attribute
instance-attribute
cell_vertical_border_size: Optional[int] = field(default=None, metadata={'wire_name': 'CellVerticalBorderSize'})
Width of the border in points (1/72nd of an inch)
class-attribute
instance-attribute
cell_vertical_border_space: Optional[int] = field(default=None, metadata={'wire_name': 'CellVerticalBorderSpace'})
Spacing around the border in points (1/72nd of an inch)
class-attribute
instance-attribute
cell_vertical_border_type: Optional[str] = field(default=None, metadata={'wire_name': 'CellVerticalBorderType'})
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
class-attribute
instance-attribute
HTML-style color hex value (do not include a #)
class-attribute
instance-attribute
Width of the border in points (1/72nd of an inch)
class-attribute
instance-attribute
Spacing around the border in points (1/72nd of an inch)
class-attribute
instance-attribute
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
class-attribute
instance-attribute
HTML-style color hex value (do not include a #)
class-attribute
instance-attribute
Width of the border in points (1/72nd of an inch)
class-attribute
instance-attribute
Spacing around the border in points (1/72nd of an inch)
class-attribute
instance-attribute
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
class-attribute
instance-attribute
The Path of the location of this table object; leave blank for new tables
class-attribute
instance-attribute
HTML-style color hex value (do not include a #)
class-attribute
instance-attribute
Width of the border in points (1/72nd of an inch)
class-attribute
instance-attribute
Spacing around the border in points (1/72nd of an inch)
class-attribute
instance-attribute
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
class-attribute
instance-attribute
HTML-style color hex value (do not include a #)
class-attribute
instance-attribute
Width of the border in points (1/72nd of an inch)
class-attribute
instance-attribute
Spacing around the border in points (1/72nd of an inch)
class-attribute
instance-attribute
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
class-attribute
instance-attribute
The ID of the table; leave blank for new tables
class-attribute
instance-attribute
table_indentation_mode: Optional[str] = field(default=None, metadata={'wire_name': 'TableIndentationMode'})
Table indentation type
class-attribute
instance-attribute
table_indentation_width: Optional[int] = field(default=None, metadata={'wire_name': 'TableIndentationWidth'})
Table indentation width
class-attribute
instance-attribute
Rows in the table; this is where the contents is located
class-attribute
instance-attribute
HTML-style color hex value (do not include a #)
class-attribute
instance-attribute
Width of the border in points (1/72nd of an inch)
class-attribute
instance-attribute
Spacing around the border in points (1/72nd of an inch)
class-attribute
instance-attribute
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
class-attribute
instance-attribute
The Width of the table, or 0 if not specified
dataclass
DocxTableCell(cell_index: Optional[int] = None, cell_shading_color: Optional[str] = None, cell_shading_fill: Optional[str] = None, cell_shading_pattern: Optional[str] = None, cell_width: Optional[str] = None, cell_width_mode: Optional[str] = None, paragraphs: Optional[List[DocxParagraph]] = None, path: Optional[str] = None)
Definition: DocxTableCell
Attributes
class-attribute
instance-attribute
The index of the cell, 0-based
class-attribute
instance-attribute
Color of the cell shading
class-attribute
instance-attribute
Fill of the cell shading
class-attribute
instance-attribute
cell_shading_pattern: Optional[str] = field(default=None, metadata={'wire_name': 'CellShadingPattern'})
Pattern of the cell shading
class-attribute
instance-attribute
Width of the cell
class-attribute
instance-attribute
Width mode of the cell; can be auto (for automatic) or manual
dataclass
DocxTableRow(path: Optional[str] = None, row_cells: Optional[List[DocxTableCell]] = None, row_index: Optional[int] = None)
Definition: DocxTableRow
Attributes
class-attribute
instance-attribute
The Path of the location of this table row object; leave blank for new tables
class-attribute
instance-attribute
Cells in the row; this is where the contents of the row is stored
dataclass
dataclass
DocxTemplateOperation(action: Optional[int] = None, match_against: Optional[str] = None, replace_with: Optional[str] = None)
Definition: DocxTemplateOperation
Attributes
class-attribute
instance-attribute
Operation action to take; possible values are "Replace"
class-attribute
instance-attribute
For Replace operations, the string to match against (to be replaced with ReplaceWith string)
dataclass
DocxText(path: Optional[str] = None, text_content: Optional[str] = None, text_index: Optional[int] = None)
Definition: DocxText
Attributes
class-attribute
instance-attribute
The Path of the location of this object; leave blank for new tables
class-attribute
instance-attribute
Text string containing the text content of this text content item
dataclass
DocxTopLevelComment(author: Optional[str] = None, author_initials: Optional[str] = None, comment_date: Optional[str] = None, comment_text: Optional[str] = None, done: Optional[bool] = None, path: Optional[str] = None, reply_child_comments: Optional[List[DocxComment]] = None)
Definition: DocxTopLevelComment
Attributes
class-attribute
instance-attribute
Author name of the comment
class-attribute
instance-attribute
Initials of the author of the comment
class-attribute
instance-attribute
Date timestamp of the comment
class-attribute
instance-attribute
Text content of the comment
class-attribute
instance-attribute
True if this comment is marked as Done in Word, otherwise it is false
class-attribute
instance-attribute
Path to the comment in the document
dataclass
ExifValue(data_type: Optional[str] = None, data_value: Optional[str] = None, tag: Optional[str] = None)
Definition: ExifValue
Attributes
class-attribute
instance-attribute
Date type of the EXIF value
class-attribute
instance-attribute
Value, formatted as a string of the EXIF value
dataclass
FindRegexMatch(character_offset_end: Optional[int] = None, character_offset_start: Optional[int] = None, containing_line: Optional[str] = None, match_groups: Optional[List[str]] = None, match_value: Optional[str] = None)
Definition: FindRegexMatch
Attributes
class-attribute
instance-attribute
character_offset_end: Optional[int] = field(default=None, metadata={'wire_name': 'CharacterOffsetEnd'})
0-based index of the end of the match
class-attribute
instance-attribute
character_offset_start: Optional[int] = field(default=None, metadata={'wire_name': 'CharacterOffsetStart'})
0-based index of the start of the match
class-attribute
instance-attribute
Text content of the line containing the match
class-attribute
instance-attribute
Regular expression regex match groups; these correspond to the match values
dataclass
FindStringMatch(character_offset_end: Optional[int] = None, character_offset_start: Optional[int] = None, containing_line: Optional[str] = None)
Definition: FindStringMatch
Attributes
class-attribute
instance-attribute
character_offset_end: Optional[int] = field(default=None, metadata={'wire_name': 'CharacterOffsetEnd'})
0-based index of the end of the match
dataclass
FindStringRegexRequest(match_case: Optional[bool] = None, target_regex: Optional[str] = None, text_content: Optional[str] = None)
Definition: FindStringRegexRequest
Attributes
class-attribute
instance-attribute
Set to True to match case, False to ignore case
class-attribute
instance-attribute
Target input regular expression (regex) to find
dataclass
FindStringRegexResponse(match_count: Optional[int] = None, matches: Optional[List[FindRegexMatch]] = None, successful: Optional[bool] = None)
Definition: FindStringRegexResponse
Attributes
class-attribute
instance-attribute
The number of matches
class-attribute
instance-attribute
Regular expression matches
dataclass
Definition: FindStringSimpleRequest
Attributes
class-attribute
instance-attribute
Target input string to find
dataclass
FindStringSimpleResponse(match_count: Optional[int] = None, matches: Optional[List[FindStringMatch]] = None, successful: Optional[bool] = None)
Definition: FindStringSimpleResponse
Attributes
class-attribute
instance-attribute
The number of matches
class-attribute
instance-attribute
Found matches
dataclass
dataclass
Definition: GetDocxBodyRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetDocxCommentsResponse(comment_count: Optional[int] = None, comments: Optional[List[DocxComment]] = None, successful: Optional[bool] = None)
Definition: GetDocxCommentsResponse
Attributes
class-attribute
instance-attribute
The number of comments in the document
class-attribute
instance-attribute
Comments in the document
dataclass
GetDocxGetCommentsHierarchicalRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)
Definition: GetDocxGetCommentsHierarchicalRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetDocxGetCommentsRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)
Definition: GetDocxGetCommentsRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetDocxHeadersAndFootersRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)
Definition: GetDocxHeadersAndFootersRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
Definition: GetDocxImagesRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
Definition: GetDocxPagesRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetDocxSectionsRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)
Definition: GetDocxSectionsRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
Definition: GetDocxStylesRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetDocxTableByIndexRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, table_index: Optional[int] = None)
Definition: GetDocxTableByIndexRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetDocxTableRowRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, table_path: Optional[str] = None, table_row_row_index: Optional[int] = None)
Definition: GetDocxTableRowRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
Path to the table to retrievew the row from
dataclass
Definition: GetDocxTablesRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetImageInfoResult(bit_depth: Optional[int] = None, color_count: Optional[int] = None, color_space: Optional[str] = None, color_type: Optional[str] = None, comment: Optional[str] = None, compression_level: Optional[int] = None, d_p_i: Optional[float] = None, d_p_i_unit: Optional[str] = None, exif_profile_name: Optional[str] = None, exif_values: Optional[List[ExifValue]] = None, has_transparency: Optional[bool] = None, height: Optional[int] = None, image_format: Optional[str] = None, image_hash_signature: Optional[str] = None, mime_type: Optional[str] = None, successful: Optional[bool] = None, width: Optional[int] = None)
Definition: GetImageInfoResult
Attributes
class-attribute
instance-attribute
Bit depth of the image
class-attribute
instance-attribute
Unique colors in the image
class-attribute
instance-attribute
Color space of the image
class-attribute
instance-attribute
Color type of the image
class-attribute
instance-attribute
Comment string in the image
class-attribute
instance-attribute
Compression level value from 0 (lowest quality) to 100 (highest quality)
class-attribute
instance-attribute
DPI (pixels per unit, e.g. pixels per inch) of the image
class-attribute
instance-attribute
Units of the DPI measurement; can be either in Inches or Centimeters
class-attribute
instance-attribute
Name of the EXIF profile used
class-attribute
instance-attribute
EXIF tags and values embedded in the image
class-attribute
instance-attribute
True if the image contains transparency, otherwise false
class-attribute
instance-attribute
Height in pixels of the image
class-attribute
instance-attribute
Image format
class-attribute
instance-attribute
image_hash_signature: Optional[str] = field(default=None, metadata={'wire_name': 'ImageHashSignature'})
SHA256 hash signature of the image
class-attribute
instance-attribute
MIME type of the image format
dataclass
GetPdfAnnotationsResult(annotations: Optional[List[PdfAnnotation]] = None, successful: Optional[bool] = None)
dataclass
GetXlsxCellByIdentifierRequest(cell_identifier: Optional[str] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_query: Optional[XlsxWorksheet] = None)
Definition: GetXlsxCellByIdentifierRequest
Attributes
class-attribute
instance-attribute
Required; Excel cell identifier, e.g. A1, B22, C33, etc.
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetXlsxCellRequest(cell_index: Optional[int] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, row_index: Optional[int] = None, worksheet_to_query: Optional[XlsxWorksheet] = None)
Definition: GetXlsxCellRequest
Attributes
class-attribute
instance-attribute
0-based index of the cell, 0, 1, 2, ... in the row to retrieve
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
0-based index of the row, 0, 1, 2, ... to retrieve
dataclass
GetXlsxColumnsRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_query: Optional[XlsxWorksheet] = None)
Definition: GetXlsxColumnsRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetXlsxImagesRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_query: Optional[XlsxWorksheet] = None)
Definition: GetXlsxImagesRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetXlsxRowsAndCellsRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_query: Optional[XlsxWorksheet] = None)
Definition: GetXlsxRowsAndCellsRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
Definition: GetXlsxStylesRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
GetXlsxWorksheetsRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)
Definition: GetXlsxWorksheetsRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
Definition: HtmlMdResult
Attributes
class-attribute
instance-attribute
Resulting HTML from the conversion
dataclass
HtmlTemplateApplicationRequest(html_template: Optional[str] = None, html_template_url: Optional[str] = None, operations: Optional[List[HtmlTemplateOperation]] = None)
Definition: HtmlTemplateApplicationRequest
Attributes
class-attribute
instance-attribute
HTML template input as a string
class-attribute
instance-attribute
URL to HTML template input
dataclass
HtmlTemplateOperation(action: Optional[int] = None, match_agsint: Optional[str] = None, replace_with: Optional[str] = None)
Definition: HtmlTemplateOperation
Attributes
class-attribute
instance-attribute
Operation action to take; possible values are "Replace"
class-attribute
instance-attribute
For Replace operations, the string to match against (to be replaced with ReplaceWith string)
dataclass
dataclass
Definition: HtmlToPdfRequest
Attributes
class-attribute
instance-attribute
Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites.
dataclass
HtmlToPngRequest(extra_loading_wait: Optional[int] = None, html: Optional[str] = None, screenshot_height: Optional[int] = None, screenshot_width: Optional[int] = None)
Definition: HtmlToPngRequest
Attributes
class-attribute
instance-attribute
Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites.
class-attribute
instance-attribute
HTML to render to PNG (screenshot)
class-attribute
instance-attribute
Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
class-attribute
instance-attribute
Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
dataclass
dataclass
InsertDocxInsertParagraphRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, insert_path: Optional[str] = None, insert_placement: Optional[str] = None, paragraph_to_insert: Optional[DocxParagraph] = None)
Definition: InsertDocxInsertParagraphRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject
class-attribute
instance-attribute
Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)
dataclass
InsertDocxTableRowRequest(existing_table_path: Optional[str] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, insert_placement: Optional[str] = None, row_to_insert: Optional[DocxTableRow] = None)
Definition: InsertDocxTableRowRequest
Attributes
class-attribute
instance-attribute
existing_table_path: Optional[str] = field(default=None, metadata={'wire_name': 'ExistingTablePath'})
Required; the path to the existing table to modify
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
Optional; default is TableEnd. Placement Type of the insert; possible values are: TableStart (very beginning of the table), TableEnd (very end of the document), or a 0-based row index number as an integer, 0 being the first row in the table, 1 being the second row in the table, 2 being the third row in the table, etc. to insert this row after
dataclass
InsertDocxTablesRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, insert_path: Optional[str] = None, insert_placement: Optional[str] = None, table_to_insert: Optional[DocxTable] = None)
Definition: InsertDocxTablesRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject
class-attribute
instance-attribute
Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)
dataclass
InsertXlsxWorksheetRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_insert: Optional[XlsxWorksheet] = None)
Definition: InsertXlsxWorksheetRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
MultipageImageFormatConversionResult(page_count: Optional[int] = None, pages: Optional[List[PageConversionResult]] = None, successful: Optional[bool] = None)
Definition: MultipageImageFormatConversionResult
Attributes
class-attribute
instance-attribute
The number of pages in the converted output
class-attribute
instance-attribute
Converted page results
dataclass
Definition: PageConversionResult
Attributes
class-attribute
instance-attribute
File bytes (contents) of the image in converted file format
dataclass
PdfAnnotation(annotation_index: Optional[int] = None, annotation_type: Optional[str] = None, creation_date: Optional[str] = None, height: Optional[float] = None, left_x: Optional[float] = None, modified_date: Optional[str] = None, page_number: Optional[int] = None, subject: Optional[str] = None, text_contents: Optional[str] = None, title: Optional[str] = None, top_y: Optional[float] = None, width: Optional[float] = None)
Definition: PdfAnnotation
Attributes
class-attribute
instance-attribute
The 0-based index of the annotation in the document
class-attribute
instance-attribute
Type of the annotation; possible values are Text
class-attribute
instance-attribute
Date that the annotation was created
class-attribute
instance-attribute
Height of the annotation
class-attribute
instance-attribute
Left X coordinate for the location of the annotation
class-attribute
instance-attribute
Date that the annotation was last modified
class-attribute
instance-attribute
The 1-based index of the page containing the annotation
class-attribute
instance-attribute
Subject of the annotation
class-attribute
instance-attribute
Text contents of the annotation
class-attribute
instance-attribute
Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files
class-attribute
instance-attribute
Top Y coordination of the location of the annotation
dataclass
PdfDocument(document_contents: Optional[str] = None, page_number: Optional[int] = None, u_r_l: Optional[str] = None)
Definition: PdfDocument
Attributes
class-attribute
instance-attribute
If returnDocumentContents is set to true, will contain the contents of the document; otherwise will be set to null and the document contents will be available via the URL parameter
class-attribute
instance-attribute
Page number of the converted page, starting with 1 for the first page
dataclass
PdfFormField(field_combo_box_selected_index: Optional[int] = None, field_name: Optional[str] = None, field_type: Optional[str] = None, field_value: Optional[str] = None)
Definition: PdfFormField
Attributes
class-attribute
instance-attribute
field_combo_box_selected_index: Optional[int] = field(default=None, metadata={'wire_name': 'FieldComboBoxSelectedIndex'})
Applies to ComboBox field types only; specifies the selected index of the combo box selection if available
class-attribute
instance-attribute
Name of the form field
class-attribute
instance-attribute
The data type of the field; possible values are Text (FieldValue will be a string), Checkbox (FieldValue can be "true" or "false"), ComboBox (FieldComboBoxSelectedIndex will also be populated), Other
dataclass
dataclass
PdfMetadata(author: Optional[str] = None, creator: Optional[str] = None, date_created: Optional[str] = None, date_modified: Optional[str] = None, keywords: Optional[str] = None, page_count: Optional[int] = None, subject: Optional[str] = None, successful: Optional[bool] = None, title: Optional[str] = None)
Definition: PdfMetadata
Attributes
class-attribute
instance-attribute
User name of the creator/author of the document, if available, null if not available
class-attribute
instance-attribute
Creator of the document
class-attribute
instance-attribute
The timestamp that the document was created, if available, null if not available
class-attribute
instance-attribute
The timestamp that the document was last modified, if available, null if not available
class-attribute
instance-attribute
Keywords of the document
class-attribute
instance-attribute
The number of pages in the document
class-attribute
instance-attribute
Subject of the document
class-attribute
instance-attribute
True if the operation was successful, false otherwise
dataclass
Definition: PdfPageText
Attributes
class-attribute
instance-attribute
Page number of the page (1-based)
dataclass
Definition: PdfTextByPageResult
Attributes
class-attribute
instance-attribute
Pages in the PDF
dataclass
PdfToPngResult(png_result_pages: Optional[List[ConvertedPngPage]] = None, successful: Optional[bool] = None)
dataclass
PresentationResult(presentation_contents: Optional[str] = None, slide_number: Optional[int] = None, u_r_l: Optional[str] = None)
Definition: PresentationResult
Attributes
class-attribute
instance-attribute
presentation_contents: Optional[str] = field(default=None, metadata={'wire_name': 'PresentationContents'})
Contents of the presentation in bytes
class-attribute
instance-attribute
Worksheet number of the converted page, starting with 1 for the left-most worksheet
dataclass
RemoveDocxHeadersAndFootersRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, remove_footers: Optional[bool] = None, remove_headers: Optional[bool] = None)
Definition: RemoveDocxHeadersAndFootersRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
True if you would like to remove all footers from the input document, false otherwise
dataclass
RemoveDocxPagesRequest(end_delete_page_number: Optional[int] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, start_delete_page_number: Optional[int] = None)
Definition: RemoveDocxPagesRequest
Attributes
class-attribute
instance-attribute
end_delete_page_number: Optional[int] = field(default=None, metadata={'wire_name': 'EndDeletePageNumber'})
Page number (1-based) to stop deleting pages; inclusive
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
dataclass
RemoveHtmlFromTextResponse(successful: Optional[bool] = None, text_content_result: Optional[str] = None)
Definition: RemoveHtmlFromTextResponse
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
RemovePptxSlidesRequest(end_delete_slide_number: Optional[int] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, start_delete_slide_number: Optional[int] = None)
Definition: RemovePptxSlidesRequest
Attributes
class-attribute
instance-attribute
end_delete_slide_number: Optional[int] = field(default=None, metadata={'wire_name': 'EndDeleteSlideNumber'})
Slide number (1-based) to stop deleting slides; inclusive
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
dataclass
RemoveWhitespaceFromTextResponse(successful: Optional[bool] = None, text_content_result: Optional[str] = None)
Definition: RemoveWhitespaceFromTextResponse
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
RemoveXlsxWorksheetRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_remove: Optional[XlsxWorksheet] = None)
Definition: RemoveXlsxWorksheetRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
worksheet_to_remove: Optional[XlsxWorksheet] = field(default=None, metadata={'wire_name': 'WorksheetToRemove'})
Required; Worksheet (tab) within the spreadsheet to delete; leave blank to default to the first worksheet. Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
dataclass
ReplaceStringRegexRequest(regular_expression_string: Optional[str] = None, replace_with_string: Optional[str] = None, text_content: Optional[str] = None)
Definition: ReplaceStringRegexRequest
Attributes
class-attribute
instance-attribute
regular_expression_string: Optional[str] = field(default=None, metadata={'wire_name': 'RegularExpressionString'})
Target input regular expression (regex) string to match and be replaced; supports all regular expression values
dataclass
ReplaceStringRegexResponse(successful: Optional[bool] = None, text_content_result: Optional[str] = None)
Definition: ReplaceStringRegexResponse
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
ReplaceStringRequest(input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, match_case: Optional[bool] = None, match_string: Optional[str] = None, replace_string: Optional[str] = None)
Definition: ReplaceStringRequest
Attributes
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
True if the case should be matched, false for case insensitive match
class-attribute
instance-attribute
String to search for and match against, to be replaced
dataclass
ReplaceStringSimpleRequest(replace_with_string: Optional[str] = None, target_string: Optional[str] = None, text_content: Optional[str] = None)
Definition: ReplaceStringSimpleRequest
dataclass
ReplaceStringSimpleResponse(successful: Optional[bool] = None, text_content_result: Optional[str] = None)
Definition: ReplaceStringSimpleResponse
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
ScreenshotRequest(extra_loading_wait: Optional[int] = None, screenshot_height: Optional[int] = None, screenshot_width: Optional[int] = None, url: Optional[str] = None)
Definition: ScreenshotRequest
Attributes
class-attribute
instance-attribute
Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds)
class-attribute
instance-attribute
Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
class-attribute
instance-attribute
Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024
dataclass
SetFormFieldValue(checkbox_value: Optional[bool] = None, combo_box_selected_index: Optional[int] = None, field_name: Optional[str] = None, text_value: Optional[str] = None)
Definition: SetFormFieldValue
Attributes
class-attribute
instance-attribute
For fields of type Checkbox, the value to put into the field
class-attribute
instance-attribute
combo_box_selected_index: Optional[int] = field(default=None, metadata={'wire_name': 'ComboBoxSelectedIndex'})
For fields of type ComboBox; specifies the selected index of the combo box selection
class-attribute
instance-attribute
Name of the field to set; you can call /convert/edit/pdf/form/get-fields to enumerate field names in a form
dataclass
SetPdfFormFieldsRequest(field_values: Optional[List[SetFormFieldValue]] = None, input_file_bytes: Optional[str] = None)
dataclass
SetPdfMetadataRequest(input_file_bytes: Optional[str] = None, metadata_to_set: Optional[PdfMetadata] = None)
Definition: SetPdfMetadataRequest
Attributes
class-attribute
instance-attribute
Input file contents bytes for the file to modify
dataclass
SetXlsxCellByIdentifierRequest(cell_identifier: Optional[str] = None, cell_value: Optional[XlsxSpreadsheetCell] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_update: Optional[XlsxWorksheet] = None)
Definition: SetXlsxCellByIdentifierRequest
Attributes
class-attribute
instance-attribute
The Excel cell identifier (e.g. A1, B2, C33, etc.) of the cell to update
class-attribute
instance-attribute
cell_value: Optional[XlsxSpreadsheetCell] = field(default=None, metadata={'wire_name': 'CellValue'})
New Cell value to update/overwrite into the Excel XLSX spreadsheet
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
dataclass
SetXlsxCellRequest(cell_index: Optional[int] = None, cell_value: Optional[XlsxSpreadsheetCell] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, row_index: Optional[int] = None, worksheet_to_update: Optional[XlsxWorksheet] = None)
Definition: SetXlsxCellRequest
Attributes
class-attribute
instance-attribute
0-based index of the cell, 0, 1, 2, ... in the row to set
class-attribute
instance-attribute
cell_value: Optional[XlsxSpreadsheetCell] = field(default=None, metadata={'wire_name': 'CellValue'})
New Cell value to update/overwrite into the Excel XLSX spreadsheet
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
0-based index of the row, 0, 1, 2, ... to set
dataclass
SplitDocumentResult(document_contents: Optional[str] = None, page_number: Optional[int] = None, u_r_l: Optional[str] = None)
Definition: SplitDocumentResult
Attributes
class-attribute
instance-attribute
Contents of the document in bytes
class-attribute
instance-attribute
Page number of the converted page, starting with 1 for the first page
dataclass
dataclass
Definition: SplitPdfResult
Attributes
class-attribute
instance-attribute
PDF documents as output
dataclass
dataclass
SplitTextDocumentByLinesResult(line_count: Optional[int] = None, result_lines: Optional[List[TextDocumentLine]] = None, successful: Optional[bool] = None)
Definition: SplitTextDocumentByLinesResult
Attributes
class-attribute
instance-attribute
The count of lines in the text file
dataclass
SplitTextDocumentByStringResult(element_count: Optional[int] = None, result_elements: Optional[List[TextDocumentElement]] = None, successful: Optional[bool] = None)
Definition: SplitTextDocumentByStringResult
Attributes
class-attribute
instance-attribute
The count of elements in the text file
dataclass
dataclass
Definition: TextConversionResult
Attributes
class-attribute
instance-attribute
True if the operation was successful, false otherwise
dataclass
Definition: TextDocumentElement
Attributes
class-attribute
instance-attribute
The text contents of a single element of a text file
dataclass
Definition: TextDocumentLine
Attributes
class-attribute
instance-attribute
The text contents of a single line of a text file
dataclass
Definition: TextEncodingDetectResponse
Attributes
class-attribute
instance-attribute
True if successful, false otherwise
dataclass
UpdateDocxTableCellRequest(cell_to_update: Optional[DocxTableCell] = None, existing_table_path: Optional[str] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, table_cell_index: Optional[int] = None, table_row_index: Optional[int] = None)
Definition: UpdateDocxTableCellRequest
Attributes
class-attribute
instance-attribute
cell_to_update: Optional[DocxTableCell] = field(default=None, metadata={'wire_name': 'CellToUpdate'})
Table cell contents you would like to update the cell with
class-attribute
instance-attribute
existing_table_path: Optional[str] = field(default=None, metadata={'wire_name': 'ExistingTablePath'})
Required; the path to the existing table to modify
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
0-based index of the Table Cell (within the row) to update
dataclass
UpdateDocxTableRowRequest(existing_table_path: Optional[str] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, row_to_update: Optional[DocxTableRow] = None, table_row_index: Optional[int] = None)
Definition: UpdateDocxTableRowRequest
Attributes
class-attribute
instance-attribute
existing_table_path: Optional[str] = field(default=None, metadata={'wire_name': 'ExistingTablePath'})
Required; the path to the existing table to modify
class-attribute
instance-attribute
Optional: Bytes of the input file to operate on
class-attribute
instance-attribute
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).
class-attribute
instance-attribute
Table row contents you would like to update the row with
dataclass
dataclass
Definition: ViewerResponse
dataclass
WorksheetResult(u_r_l: Optional[str] = None, worksheet_contents: Optional[str] = None, worksheet_name: Optional[str] = None, worksheet_number: Optional[int] = None)
Definition: WorksheetResult
Attributes
class-attribute
instance-attribute
URL to the XLSX file of this worksheet; file is stored in an in-memory cache and will be deleted
class-attribute
instance-attribute
worksheet_contents: Optional[str] = field(default=None, metadata={'wire_name': 'WorksheetContents'})
Contents of the worksheet in bytes
class-attribute
instance-attribute
The name of the worksheet
dataclass
XlsxImage(image_contents_u_r_l: Optional[str] = None, image_data_content_type: Optional[str] = None, image_data_embed_id: Optional[str] = None, image_internal_file_name: Optional[str] = None, path: Optional[str] = None)
Definition: XlsxImage
Attributes
class-attribute
instance-attribute
image_contents_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'ImageContentsURL'})
URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents.
class-attribute
instance-attribute
image_data_content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ImageDataContentType'})
Read-only; image data MIME content-type
class-attribute
instance-attribute
image_data_embed_id: Optional[str] = field(default=None, metadata={'wire_name': 'ImageDataEmbedId'})
Read-only; internal ID for the image contents
dataclass
XlsxSpreadsheetCell(cell_identifier: Optional[str] = None, formula: Optional[str] = None, path: Optional[str] = None, style_index: Optional[int] = None, text_value: Optional[str] = None)
Definition: XlsxSpreadsheetCell
Attributes
class-attribute
instance-attribute
Cell reference of the cell, e.g. A1, Z22, etc.
class-attribute
instance-attribute
The Path of the location of this object; leave blank for new rows
class-attribute
instance-attribute
Identifier for the style to apply to this style
dataclass
XlsxSpreadsheetColumn(heading_cell: Optional[XlsxSpreadsheetCell] = None, path: Optional[str] = None)
dataclass
Definition: XlsxSpreadsheetRow
Attributes
class-attribute
instance-attribute
Spreadsheet Cells in the spreadsheet row
dataclass
Definition: XlsxWorksheet
Attributes
class-attribute
instance-attribute
The Path of the location of this object; leave blank for new worksheets
dataclass
XmlAddAttributeWithXPathResult(nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)
Definition: XmlAddAttributeWithXPathResult
dataclass
XmlAddChildWithXPathResult(nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)
Definition: XmlAddChildWithXPathResult
dataclass
XmlFilterWithXPathResult(result_count: Optional[int] = None, successful: Optional[bool] = None, xml_nodes: Optional[List[str]] = None)
Definition: XmlFilterWithXPathResult
Attributes
class-attribute
instance-attribute
Count of the matching results
class-attribute
instance-attribute
True if the operation was successful, false otherwise
dataclass
XmlQueryWithXQueryMultiResult(error_message: Optional[str] = None, resulting_xml: Optional[str] = None, successful: Optional[bool] = None)
Definition: XmlQueryWithXQueryMultiResult
Attributes
class-attribute
instance-attribute
If an error occurs, additional details on the error
class-attribute
instance-attribute
Resulting XML result output
dataclass
XmlQueryWithXQueryResult(error_message: Optional[str] = None, resulting_xml: Optional[str] = None, successful: Optional[bool] = None)
Definition: XmlQueryWithXQueryResult
Attributes
class-attribute
instance-attribute
If an error occurs, additional details on the error
class-attribute
instance-attribute
Resulting XML result output
dataclass
XmlRemoveAllChildrenWithXPathResult(nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)
Definition: XmlRemoveAllChildrenWithXPathResult
dataclass
XmlRemoveWithXPathResult(nodes_removed_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None, xml_nodes_removed: Optional[List[str]] = None)
Definition: XmlRemoveWithXPathResult
Attributes
class-attribute
instance-attribute
nodes_removed_count: Optional[int] = field(default=None, metadata={'wire_name': 'NodesRemovedCount'})
Count of the matching results
class-attribute
instance-attribute
resulting_xml_document: Optional[str] = field(default=None, metadata={'wire_name': 'ResultingXmlDocument'})
Resulting, modified XML document with matching nodes removed as a string
class-attribute
instance-attribute
True if the operation was successful, false otherwise
dataclass
XmlReplaceWithXPathResult(nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)
Definition: XmlReplaceWithXPathResult
dataclass
XmlSetValueWithXPathResult(nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)
Definition: XmlSetValueWithXPathResult
dataclass
ZipDirectory(directories_in_directory: Optional[List[ZipDirectory]] = None, directory_name: Optional[str] = None, files_in_directory: Optional[List[ZipFile]] = None)
Definition: ZipDirectory
Attributes
class-attribute
instance-attribute
directories_in_directory: Optional[List[ZipDirectory]] = field(default=None, metadata={'wire_name': 'DirectoriesInDirectory'})
Child directories contained directly in this directory
class-attribute
instance-attribute
Name of this directory
dataclass
ZipExtractResponse(directories_in_zip: Optional[List[ZipDirectory]] = None, files_in_zip: Optional[List[ZipFile]] = None, successful: Optional[bool] = None)
Definition: ZipExtractResponse
Attributes
class-attribute
instance-attribute
directories_in_zip: Optional[List[ZipDirectory]] = field(default=None, metadata={'wire_name': 'DirectoriesInZip'})
Top-level directories in the root directory of the zip; directories can contain sub-directories and files
class-attribute
instance-attribute
Top-level files in the root directory fo the zip file
dataclass
Definition: ZipFile
Attributes
class-attribute
instance-attribute
Contents of this file
CloudmersiveconvertClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)
Bases: ConnectorClientBase
Typed client for cloudmersiveconvert connector.
Initialize a CloudmersiveconvertClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
token_provider
|
Optional[TokenProvider]
|
Optional token provider. Defaults to ManagedIdentityTokenProvider. |
None
|
options
|
Optional[ConnectorClientOptions]
|
Optional connector client options. |
None
|
Methods:
async
edit_document_docx_create_blank_document_async(input: CreateBlankDocxRequest) -> dict[str, Any] | None
Create a blank Word DOCX document
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.
async
Delete, remove pages from a Word DOCX document
Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed
async
edit_document_docx_delete_table_row_async(input: DeleteDocxTableRowRequest) -> dict[str, Any] | None
Deletes a table row in an existing table in a Word DOCX document
Deletes an existing table row in a Word DOCX Document and returns the result.
async
edit_document_docx_delete_table_row_range_async(input: DeleteDocxTableRowRangeRequest) -> dict[str, Any] | None
Deletes a range of multiple table rows in an existing table in a Word
Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.
async
Get body from a Word DOCX document
Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
async
edit_document_docx_get_comments_hierarchical_async(input: GetDocxGetCommentsHierarchicalRequest) -> dict[str, Any] | None
Get comments from a Word DOCX document hierarchically
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.
async
edit_document_docx_get_headers_and_footers_async(input: GetDocxHeadersAndFootersRequest) -> dict[str, Any] | None
Get content of a footer from a Word DOCX document
Returns the footer content from a Word Document (DOCX) format file
async
Get images from a Word DOCX document
Returns the images defined in the Word Document (DOCX) format file
async
Get pages and content from a Word DOCX document
Returns the pages and contents of each page defined in the Word Document (DOCX) format file
async
Get sections from a Word DOCX document
Returns the sections defined in the Word Document (DOCX) format file
async
Get styles from a Word DOCX document
Returns the styles defined in the Word Document (DOCX) format file
async
Gets the contents of an existing table row in an existing table in a W
Gets the contents of an existing table row in a Word DOCX Document and returns the result.
async
edit_document_docx_get_table_by_index_async(input: GetDocxTableByIndexRequest) -> dict[str, Any] | None
Get a specific table by index in a Word DOCX document
Returns the specific table object by its 0-based index in an Office Word Document (DOCX)
async
Get all tables in Word DOCX document
Returns all the table objects in an Office Word Document (docx)
async
edit_document_docx_insert_comment_on_paragraph_async(input: DocxInsertCommentOnParagraphRequest) -> dict[str, Any] | None
Insert a new comment into a Word DOCX document attached to a paragraph
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.
async
Insert image into a Word DOCX document
Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
async
edit_document_docx_insert_paragraph_async(input: InsertDocxInsertParagraphRequest) -> dict[str, Any] | None
Insert a new paragraph into a Word DOCX document
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.
async
Insert a new table into a Word DOCX document
Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
async
edit_document_docx_insert_table_row_async(input: InsertDocxTableRowRequest) -> dict[str, Any] | None
Insert a new row into an existing table in a Word DOCX document
Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
async
edit_document_docx_remove_headers_and_footers_async(input: RemoveDocxHeadersAndFootersRequest) -> dict[str, Any] | None
Remove headers and footers from Word DOCX document
Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
async
Delete any object in a Word DOCX document
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.
async
Replace string in Word DOCX document
Replace all instances of a string in an Office Word Document (docx)
async
Set the footer in a Word DOCX document
Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
async
edit_document_docx_set_footer_add_page_number_async(input: DocxSetFooterAddPageNumberRequest) -> dict[str, Any] | None
Add page number to footer in a Word DOCX document
Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.
async
Set the header in a Word DOCX document
Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
async
edit_document_docx_update_table_cell_async(input: UpdateDocxTableCellRequest) -> dict[str, Any] | None
Update, set contents of a table cell in an existing table in a Word DO
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.
async
edit_document_docx_update_table_row_async(input: UpdateDocxTableRowRequest) -> dict[str, Any] | None
Update, set contents of a table row in an existing table in a Word DOCX document
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.
async
Finish editing document, and download result from document editing
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.
async
Delete, remove slides from a PowerPoint PPTX presentation document
Edits the input PowerPoint PPTX presentation document to remove the specified slides
async
Replace string in PowerPoint PPTX presentation
Replace all instances of a string in an Office PowerPoint Document (pptx)
async
Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
async
edit_document_xlsx_create_blank_spreadsheet_async(input: CreateBlankSpreadsheetRequest) -> dict[str, Any] | None
Create a blank Excel XLSX spreadsheet
Returns a blank Excel XLSX Spreadsheet (XLSX) format file
async
edit_document_xlsx_create_spreadsheet_from_data_async(input: CreateSpreadsheetFromDataRequest) -> dict[str, Any] | None
Create a new Excel XLSX spreadsheet from column and row data
Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input
async
edit_document_xlsx_delete_worksheet_async(input: RemoveXlsxWorksheetRequest) -> dict[str, Any] | None
Delete, remove worksheet from an Excel XLSX spreadsheet document
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.
async
edit_document_xlsx_get_cell_by_identifier_async(input: GetXlsxCellByIdentifierRequest) -> dict[str, Any] | None
Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet
async
Get cell from an Excel XLSX spreadsheet, worksheet by index
Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet
async
Get rows and cells from a Excel XLSX spreadsheet, worksheet
Returns the rows and cells defined in the Excel Spreadsheet worksheet
async
Get images from a Excel XLSX spreadsheet, worksheet
Returns the images defined in the Excel Spreadsheet worksheet
async
edit_document_xlsx_get_rows_and_cells_async(input: GetXlsxRowsAndCellsRequest) -> dict[str, Any] | None
Get rows and cells from a Excel XLSX spreadsheet, worksheet
Returns the rows and cells defined in the Excel Spreadsheet worksheet
async
Get styles from a Excel XLSX spreadsheet, worksheet
Returns the style defined in the Excel Spreadsheet
async
Get worksheets from a Excel XLSX spreadsheet
Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file
async
edit_document_xlsx_insert_worksheet_async(input: InsertXlsxWorksheetRequest) -> dict[str, Any] | None
Insert a new worksheet into an Excel XLSX spreadsheet
Inserts a new worksheet into an Excel Spreadsheet
async
edit_document_xlsx_set_cell_by_identifier_async(input: SetXlsxCellByIdentifierRequest) -> dict[str, Any] | None
Set, update cell contents in an Excel XLSX spreadsheet, worksheet by c
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
async
Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
async
Convert HTML to Word DOCX Document
Convert HTML to Office Word Document (DOCX) format
async
Convert JSON to XML conversion
Convert a JSON object into XML
async
convert_template_apply_html_template_async(input: HtmlTemplateApplicationRequest) -> dict[str, Any] | None
Apply HTML template
Apply operations to fill in an HTML template, generating a final HTML result
async
Convert HTML string to PDF
Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
async
Convert HTML string to PNG screenshot
Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
async
Convert HTML string to text (txt)
Converts an HTML string input into text (txt); extracts text from HTML
async
Convert a URL to PDF
Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.
async
Take screenshot of URL
Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.