Skip to content

CloudmersiveConvertClient

Classes

AutodetectGetInfoResult dataclass

AutodetectGetInfoResult(*, alternate_file_type_candidates: Optional[List[AlternateFileFormatCandidate | Mapping[str, Any]]] = 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)

Response for Get document type information

Attributes

alternate_file_type_candidates class-attribute instance-attribute
alternate_file_type_candidates: Optional[List[AlternateFileFormatCandidate | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AlternateFileTypeCandidates'})

Alternate file type options and their probability

author class-attribute instance-attribute
author: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Author'})

User name of the creator/author of the document, if available, null if not available

date_modified class-attribute instance-attribute
date_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateModified'})

The timestamp that the document was last modified, if available, null if not available

detected_file_extension class-attribute instance-attribute
detected_file_extension: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DetectedFileExtension'})

Detected file extension of the file format, with a leading period

detected_mime_type class-attribute instance-attribute
detected_mime_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DetectedMimeType'})

MIME type of this file extension

page_count class-attribute instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageCount'})

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)

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

AutodetectToPngResult dataclass

AutodetectToPngResult(*, png_result_pages: Optional[List[ConvertedPngPage | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Convert Document to PNG array

Attributes

png_result_pages class-attribute instance-attribute
png_result_pages: Optional[List[ConvertedPngPage | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PngResultPages'})

Array of converted pages

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

TextConversionResult dataclass

TextConversionResult(*, successful: Optional[bool] = None, text_result: Optional[str] = None)

Response for Convert Document to Text (txt)

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

text_result class-attribute instance-attribute
text_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextResult'})

Plain Text (TXT) format conversion result of the input document. The text result is returned as a string.

CreateBlankDocxResponse dataclass

CreateBlankDocxResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Create a blank Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

DeleteDocxTableRowResponse dataclass

DeleteDocxTableRowResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Deletes a table row in an existing table in a Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

DeleteDocxTableRowRangeResponse dataclass

DeleteDocxTableRowRangeResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Deletes a range of multiple table rows in an existing table in a Word

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxBodyResponse dataclass

GetDocxBodyResponse(*, body: Optional[DocxBody | Mapping[str, Any]] = None, successful: Optional[bool] = None)

Response for Get body from a Word DOCX document

Attributes

body class-attribute instance-attribute
body: Optional[DocxBody | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Body'})

Body in the DOCX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxCommentsHierarchicalResponse dataclass

GetDocxCommentsHierarchicalResponse(*, comments: Optional[List[DocxTopLevelComment | Mapping[str, Any]]] = None, successful: Optional[bool] = None, top_level_comment_count: Optional[int] = None)

Response for Get comments from a Word DOCX document hierarchically

Attributes

comments class-attribute instance-attribute
comments: Optional[List[DocxTopLevelComment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})

Comments in the document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

top_level_comment_count class-attribute instance-attribute
top_level_comment_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TopLevelCommentCount'})

The number of comments in the document

GetDocxHeadersAndFootersResponse dataclass

GetDocxHeadersAndFootersResponse(*, footers: Optional[List[DocxFooter | Mapping[str, Any]]] = None, headers: Optional[List[DocxHeader | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get content of a footer from a Word DOCX document

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxImagesResponse dataclass

GetDocxImagesResponse(*, images: Optional[List[DocxImage | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get images from a Word DOCX document

Attributes

images class-attribute instance-attribute
images: Optional[List[DocxImage | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Images'})

Images in the DOCX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxPagesResponse dataclass

GetDocxPagesResponse(*, page_count: Optional[int] = None, pages: Optional[List[DocxPage | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get pages and content from a Word DOCX document

Attributes

page_count class-attribute instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageCount'})

Count of pages

pages class-attribute instance-attribute
pages: Optional[List[DocxPage | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Pages'})

Pages in the document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxSectionsResponse dataclass

GetDocxSectionsResponse(*, sections: Optional[List[DocxSection | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get sections from a Word DOCX document

Attributes

sections class-attribute instance-attribute
sections: Optional[List[DocxSection | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sections'})

Sections in the DOCX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxStylesResponse dataclass

GetDocxStylesResponse(*, styles: Optional[List[DocxStyle | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get styles from a Word DOCX document

Attributes

styles class-attribute instance-attribute
styles: Optional[List[DocxStyle | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Styles'})

Styles in the DOCX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxTableRowResponse dataclass

GetDocxTableRowResponse(*, row_result: Optional[DocxTableRow | Mapping[str, Any]] = None, successful: Optional[bool] = None)

Response for Gets the contents of an existing table row in an existing table in a W

Attributes

row_result class-attribute instance-attribute
row_result: Optional[DocxTableRow | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowResult'})

Contents of the table row that was requested

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxTableByIndexResponse dataclass

GetDocxTableByIndexResponse(*, successful: Optional[bool] = None, table: Optional[DocxTable | Mapping[str, Any]] = None)

Response for Get a specific table by index in a Word DOCX document

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

table class-attribute instance-attribute
table: Optional[DocxTable | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Table'})

Requested Table in the DOCX file

GetDocxTablesResponse dataclass

GetDocxTablesResponse(*, successful: Optional[bool] = None, tables: Optional[List[DocxTable | Mapping[str, Any]]] = None)

Response for Get all tables in Word DOCX document

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

tables class-attribute instance-attribute
tables: Optional[List[DocxTable | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Tables'})

Tables in the DOCX file

InsertDocxCommentOnParagraphResponse dataclass

InsertDocxCommentOnParagraphResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Insert a new comment into a Word DOCX document attached to a paragraph

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

DocxInsertImageResponse dataclass

DocxInsertImageResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Insert image into a Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

InsertDocxInsertParagraphResponse dataclass

InsertDocxInsertParagraphResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Insert a new paragraph into a Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

InsertDocxTablesResponse dataclass

InsertDocxTablesResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Insert a new table into a Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

InsertDocxTableRowResponse dataclass

InsertDocxTableRowResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Insert a new row into an existing table in a Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

RemoveDocxHeadersAndFootersResponse dataclass

RemoveDocxHeadersAndFootersResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Remove headers and footers from Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

DocxRemoveObjectResponse dataclass

DocxRemoveObjectResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Delete any object in a Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

DocxSetFooterResponse dataclass

DocxSetFooterResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Set the footer in a Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

DocxSetHeaderResponse dataclass

DocxSetHeaderResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Set the header in a Word DOCX document

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

UpdateDocxTableCellResponse dataclass

UpdateDocxTableCellResponse(*, edited_document_url: 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

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

UpdateDocxTableRowResponse dataclass

UpdateDocxTableRowResponse(*, edited_document_url: 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

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

ClearXlsxCellResponse dataclass

ClearXlsxCellResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Clear cell contents in an Excel XLSX spreadsheet, worksheet by index

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

CreateBlankSpreadsheetResponse dataclass

CreateBlankSpreadsheetResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Create a blank Excel XLSX spreadsheet

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

CreateSpreadsheetFromDataResponse dataclass

CreateSpreadsheetFromDataResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Create a new Excel XLSX spreadsheet from column and row data

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

EditDocumentXlsxDeleteWorksheetResponse dataclass

EditDocumentXlsxDeleteWorksheetResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Delete, remove worksheet from an Excel XLSX spreadsheet document

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetXlsxCellByIdentifierResponse dataclass

GetXlsxCellByIdentifierResponse(*, cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = None, successful: Optional[bool] = None)

Response for Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier

Attributes

cell class-attribute instance-attribute
cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Cell'})

Requested Cell in the Excel XLSX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetXlsxCellResponse dataclass

GetXlsxCellResponse(*, cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = None, successful: Optional[bool] = None)

Response for Get cell from an Excel XLSX spreadsheet, worksheet by index

Attributes

cell class-attribute instance-attribute
cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Cell'})

Requested Cell in the Excel XLSX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetXlsxColumnsResponse dataclass

GetXlsxColumnsResponse(*, columns: Optional[List[XlsxSpreadsheetColumn | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get rows and cells from a Excel XLSX spreadsheet, worksheet

Attributes

columns class-attribute instance-attribute
columns: Optional[List[XlsxSpreadsheetColumn | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Columns'})

Spreadsheet Columns in the XLSX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetXlsxImagesResponse dataclass

GetXlsxImagesResponse(*, images: Optional[List[XlsxImage | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get images from a Excel XLSX spreadsheet, worksheet

Attributes

images class-attribute instance-attribute
images: Optional[List[XlsxImage | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Images'})

Spreadsheet Images in the XLSX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetXlsxRowsAndCellsResponse dataclass

GetXlsxRowsAndCellsResponse(*, rows: Optional[List[XlsxSpreadsheetRow | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get rows and cells from a Excel XLSX spreadsheet, worksheet

Attributes

rows class-attribute instance-attribute
rows: Optional[List[XlsxSpreadsheetRow | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rows'})

Spreadsheet Rows in the Excel XLSX document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetXlsxStylesResponse dataclass

GetXlsxStylesResponse(*, cell_styles: Optional[List[DocxCellStyle | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Get styles from a Excel XLSX spreadsheet, worksheet

Attributes

cell_styles class-attribute instance-attribute
cell_styles: Optional[List[DocxCellStyle | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellStyles'})

Cell styles

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetXlsxWorksheetsResponse dataclass

GetXlsxWorksheetsResponse(*, successful: Optional[bool] = None, worksheets: Optional[List[XlsxWorksheet | Mapping[str, Any]]] = None)

Response for Get worksheets from a Excel XLSX spreadsheet

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

worksheets class-attribute instance-attribute
worksheets: Optional[List[XlsxWorksheet | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Worksheets'})

Worksheets in the Excel XLSX spreadsheet

InsertXlsxWorksheetResponse dataclass

InsertXlsxWorksheetResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Insert a new worksheet into an Excel XLSX spreadsheet

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

SetXlsxCellByIdentifierResponse dataclass

SetXlsxCellByIdentifierResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Set, update cell contents in an Excel XLSX spreadsheet, worksheet by c

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

SetXlsxCellResponse dataclass

SetXlsxCellResponse(*, edited_document_url: Optional[str] = None, successful: Optional[bool] = None)

Response for Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index

Attributes

edited_document_url class-attribute instance-attribute
edited_document_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

PdfToPngResult dataclass

PdfToPngResult(*, png_result_pages: Optional[List[ConvertedPngPage | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Convert HTML document file to PNG image array

Attributes

png_result_pages class-attribute instance-attribute
png_result_pages: Optional[List[ConvertedPngPage | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PngResultPages'})

Array of converted pages

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

MultipageImageFormatConversionResult dataclass

MultipageImageFormatConversionResult(*, page_count: Optional[int] = None, pages: Optional[List[PageConversionResult | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Multi-page image format conversion

Attributes

page_count class-attribute instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageCount'})

The number of pages in the converted output

pages class-attribute instance-attribute
pages: Optional[List[PageConversionResult | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Pages'})

Converted page results

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetImageInfoResult 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, dpi: Optional[float] = None, dpi_unit: Optional[str] = None, exif_profile_name: Optional[str] = None, exif_values: Optional[List[ExifValue | Mapping[str, Any]]] = 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)

Response for Get information about an image

Attributes

bit_depth class-attribute instance-attribute
bit_depth: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BitDepth'})

Bit depth of the image

color_count class-attribute instance-attribute
color_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ColorCount'})

Unique colors in the image

color_space class-attribute instance-attribute
color_space: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ColorSpace'})

Color space of the image

color_type class-attribute instance-attribute
color_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ColorType'})

Color type of the image

comment class-attribute instance-attribute
comment: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comment'})

Comment string in the image

compression_level class-attribute instance-attribute
compression_level: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompressionLevel'})

Compression level value from 0 (lowest quality) to 100 (highest quality)

dpi class-attribute instance-attribute
dpi: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DPI'})

DPI (pixels per unit, e.g. pixels per inch) of the image

dpi_unit class-attribute instance-attribute
dpi_unit: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DPIUnit'})

Units of the DPI measurement; can be either in Inches or Centimeters

exif_profile_name class-attribute instance-attribute
exif_profile_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExifProfileName'})

Name of the EXIF profile used

exif_values class-attribute instance-attribute
exif_values: Optional[List[ExifValue | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExifValues'})

EXIF tags and values embedded in the image

has_transparency class-attribute instance-attribute
has_transparency: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasTransparency'})

True if the image contains transparency, otherwise false

height class-attribute instance-attribute
height: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Height'})

Height in pixels of the image

image_format class-attribute instance-attribute
image_format: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageFormat'})

Image format

image_hash_signature class-attribute instance-attribute
image_hash_signature: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageHashSignature'})

SHA256 hash signature of the image

mime_type class-attribute instance-attribute
mime_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MimeType'})

MIME type of the image format

width class-attribute instance-attribute
width: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Width'})

Width in pixels of the image

ConvertDataJsonToXmlInput dataclass

ConvertDataJsonToXmlInput(*, additional_properties: Dict[str, Any] = dict())

Convert JSON to XML conversion

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

MergeDocumentTxtResponse dataclass

MergeDocumentTxtResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Merge Two Text (TXT) Files Together

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SplitDocxDocumentResult dataclass

SplitDocxDocumentResult(*, result_documents: Optional[List[SplitDocumentResult | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Split a single Word Document DOCX into Separate Documents by Page

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

SplitPdfResult dataclass

SplitPdfResult(*, documents: Optional[List[PdfDocument | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Split a PDF file into separate PDF files, one per page

Attributes

documents class-attribute instance-attribute
documents: Optional[List[PdfDocument | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Documents'})

PDF documents as output

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

SplitPptxPresentationResult dataclass

SplitPptxPresentationResult(*, result_presentations: Optional[List[PresentationResult | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Split a single PowerPoint Presentation PPTX into Separate Slides

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

SplitTextDocumentByLinesResult dataclass

SplitTextDocumentByLinesResult(*, line_count: Optional[int] = None, result_lines: Optional[List[TextDocumentLine | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Split a single Text file (txt) into lines

Attributes

line_count class-attribute instance-attribute
line_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LineCount'})

The count of lines in the text file

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

SplitTextDocumentByStringResult dataclass

SplitTextDocumentByStringResult(*, element_count: Optional[int] = None, result_elements: Optional[List[TextDocumentElement | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Split a single Text file (txt) by a string delimiter

Attributes

element_count class-attribute instance-attribute
element_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ElementCount'})

The count of elements in the text file

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

SplitXlsxWorksheetResult dataclass

SplitXlsxWorksheetResult(*, result_worksheets: Optional[List[WorksheetResult | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Response for Split a single Excel XLSX into Separate Worksheets

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

HtmlTemplateApplicationResponse dataclass

HtmlTemplateApplicationResponse(*, final_html: Optional[str] = None, successful: Optional[bool] = None)

Response for Apply HTML template

Attributes

final_html class-attribute instance-attribute
final_html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinalHtml'})

Final HTML result of all operations on input

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

AutodetectDocumentValidationResult dataclass

AutodetectDocumentValidationResult(*, document_is_valid: Optional[bool] = None, error_count: Optional[int] = None, errors_and_warnings: Optional[List[DocumentValidationError | Mapping[str, Any]]] = None, file_format_extension: Optional[str] = None, warning_count: Optional[int] = None)

Response for Autodetect content type and validate

Attributes

document_is_valid class-attribute instance-attribute
document_is_valid: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DocumentIsValid'})

True if the document is valid and has no errors, false otherwise

error_count class-attribute instance-attribute
error_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ErrorCount'})

Number of validation errors found in the document

errors_and_warnings class-attribute instance-attribute
errors_and_warnings: Optional[List[DocumentValidationError | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ErrorsAndWarnings'})

Details of errors and warnings found

warning_count class-attribute instance-attribute
warning_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WarningCount'})

Number of validation warnings found in the document

DocumentValidationResult dataclass

DocumentValidationResult(*, document_is_valid: Optional[bool] = None, error_count: Optional[int] = None, errors_and_warnings: Optional[List[DocumentValidationError | Mapping[str, Any]]] = None, warning_count: Optional[int] = None)

Response for Validate a Word document (DOCX)

Attributes

document_is_valid class-attribute instance-attribute
document_is_valid: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DocumentIsValid'})

True if the document is valid and has no errors, false otherwise

error_count class-attribute instance-attribute
error_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ErrorCount'})

Number of validation errors found in the document

errors_and_warnings class-attribute instance-attribute
errors_and_warnings: Optional[List[DocumentValidationError | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ErrorsAndWarnings'})

Details of errors and warnings found

warning_count class-attribute instance-attribute
warning_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WarningCount'})

Number of validation warnings found in the document

ConvertWebHtmlToPngResponse dataclass

ConvertWebHtmlToPngResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Convert HTML string to PNG screenshot

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

HtmlToTextResponse dataclass

HtmlToTextResponse(*, successful: Optional[bool] = None, text_content_result: Optional[str] = None)

Response for Convert HTML string to text (txt)

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

text_content_result class-attribute instance-attribute
text_content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContentResult'})

Text content result from the HTML input

HtmlMdResult dataclass

HtmlMdResult(*, html: Optional[str] = None, successful: Optional[bool] = None)

Response for Convert Markdown to HTML

Attributes

html class-attribute instance-attribute
html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Html'})

Resulting HTML from the conversion

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if operation was successful, false otherwise

UrlToTextResponse dataclass

UrlToTextResponse(*, successful: Optional[bool] = None, text_content_result: Optional[str] = None)

Response for Convert website URL page to text (txt)

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

text_content_result class-attribute instance-attribute
text_content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContentResult'})

Text content result from the URL website input

XmlAddAttributeWithXPathResult dataclass

XmlAddAttributeWithXPathResult(*, nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)

Response for Adds an attribute to all XML nodes matching XPath expression

Attributes

nodes_edited_count class-attribute instance-attribute
nodes_edited_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NodesEditedCount'})

Count of the matching results

resulting_xml_document class-attribute instance-attribute
resulting_xml_document: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultingXmlDocument'})

Resulting, modified XML document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

XmlAddChildWithXPathResult dataclass

XmlAddChildWithXPathResult(*, nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)

Response for Adds an XML node as a child to XML nodes matching XPath expression

Attributes

nodes_edited_count class-attribute instance-attribute
nodes_edited_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NodesEditedCount'})

Count of the matching results

resulting_xml_document class-attribute instance-attribute
resulting_xml_document: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultingXmlDocument'})

Resulting, modified XML document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

XmlRemoveWithXPathResult 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)

Response for Remove, delete XML nodes and items matching XPath expression

Attributes

nodes_removed_count class-attribute instance-attribute
nodes_removed_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NodesRemovedCount'})

Count of the matching results

resulting_xml_document class-attribute instance-attribute
resulting_xml_document: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultingXmlDocument'})

Resulting, modified XML document with matching nodes removed as a string

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

xml_nodes_removed class-attribute instance-attribute
xml_nodes_removed: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'XmlNodesRemoved'})

Matching selected XML nodes as strings

XmlRemoveAllChildrenWithXPathResult dataclass

XmlRemoveAllChildrenWithXPathResult(*, nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)

Response for Removes, deletes all children of nodes matching XPath expression, but

Attributes

nodes_edited_count class-attribute instance-attribute
nodes_edited_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NodesEditedCount'})

Count of the matching results

resulting_xml_document class-attribute instance-attribute
resulting_xml_document: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultingXmlDocument'})

Resulting, modified XML document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

XmlReplaceWithXPathResult dataclass

XmlReplaceWithXPathResult(*, nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)

Response for Replaces XML nodes matching XPath expression with new node

Attributes

nodes_edited_count class-attribute instance-attribute
nodes_edited_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NodesEditedCount'})

Count of the matching results

resulting_xml_document class-attribute instance-attribute
resulting_xml_document: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultingXmlDocument'})

Resulting, modified XML document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

XmlSetValueWithXPathResult dataclass

XmlSetValueWithXPathResult(*, nodes_edited_count: Optional[int] = None, resulting_xml_document: Optional[str] = None, successful: Optional[bool] = None)

Response for Sets the value contents of XML nodes matching XPath expression

Attributes

nodes_edited_count class-attribute instance-attribute
nodes_edited_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NodesEditedCount'})

Count of the matching results

resulting_xml_document class-attribute instance-attribute
resulting_xml_document: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultingXmlDocument'})

Resulting, modified XML document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

XmlQueryWithXQueryResult dataclass

XmlQueryWithXQueryResult(*, error_message: Optional[str] = None, resulting_xml: Optional[str] = None, successful: Optional[bool] = None)

Response for Query an XML file using XQuery query, get results

Attributes

error_message class-attribute instance-attribute
error_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ErrorMessage'})

If an error occurs, additional details on the error

resulting_xml class-attribute instance-attribute
resulting_xml: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultingXml'})

Resulting XML result output

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

XmlQueryWithXQueryMultiResult dataclass

XmlQueryWithXQueryMultiResult(*, error_message: Optional[str] = None, resulting_xml: Optional[str] = None, successful: Optional[bool] = None)

Response for Query multiple XML files using XQuery query, get results

Attributes

error_message class-attribute instance-attribute
error_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ErrorMessage'})

If an error occurs, additional details on the error

resulting_xml class-attribute instance-attribute
resulting_xml: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultingXml'})

Resulting XML result output

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

XmlFilterWithXPathResult dataclass

XmlFilterWithXPathResult(*, result_count: Optional[int] = None, successful: Optional[bool] = None, xml_nodes: Optional[List[str]] = None)

Response for Filter, select XML nodes using XPath expression, get results

Attributes

result_count class-attribute instance-attribute
result_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultCount'})

Count of the matching results

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

xml_nodes class-attribute instance-attribute
xml_nodes: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'XmlNodes'})

Matching selected XML nodes as strings

ConvertDataXmlToJsonResponse dataclass

ConvertDataXmlToJsonResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Convert XML to JSON conversion

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

AddPdfAnnotationRequest dataclass

AddPdfAnnotationRequest(*, annotations_to_add: Optional[List[PdfAnnotation | Mapping[str, Any]]] = None, input_file_bytes: Optional[str] = None)

Definition: AddPdfAnnotationRequest

Attributes

annotations_to_add class-attribute instance-attribute
annotations_to_add: Optional[List[PdfAnnotation | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AnnotationsToAdd'})

Annotations to add to the PDF file

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Input file contents bytes for the file to modify

AlternateFileFormatCandidate dataclass

AlternateFileFormatCandidate(*, detected_file_extension: Optional[str] = None, detected_mime_type: Optional[str] = None, probability: Optional[float] = None)

Definition: AlternateFileFormatCandidate

Attributes

detected_file_extension class-attribute instance-attribute
detected_file_extension: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DetectedFileExtension'})

Detected file extension of the file format, with a leading period

detected_mime_type class-attribute instance-attribute
detected_mime_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DetectedMimeType'})

MIME type of this file extension

probability class-attribute instance-attribute
probability: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Probability'})

Probability that this extension is the right one; possible values are between 0.0 (lowest confidence) and 1.0 (highest confidence)

Base64DecodeRequest dataclass

Base64DecodeRequest(*, base64_content_to_decode: Optional[str] = None)

Definition: Base64DecodeRequest

Attributes

base64_content_to_decode class-attribute instance-attribute
base64_content_to_decode: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Base64ContentToDecode'})

Input content to decode from Base 64 into binary

Base64DecodeResponse dataclass

Base64DecodeResponse(*, content_result: Optional[str] = None, successful: Optional[bool] = None)

Definition: Base64DecodeResponse

Attributes

content_result class-attribute instance-attribute
content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentResult'})

Result of performing a base 64 decode operation, binary file content

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

Base64DetectRequest dataclass

Base64DetectRequest(*, base64_content_to_detect: Optional[str] = None)

Definition: Base64DetectRequest

Attributes

base64_content_to_detect class-attribute instance-attribute
base64_content_to_detect: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Base64ContentToDetect'})

Input content text to detect if it is base 64 encoded

Base64DetectResponse dataclass

Base64DetectResponse(*, is_base64_encoded: Optional[bool] = None, successful: Optional[bool] = None)

Definition: Base64DetectResponse

Attributes

is_base64_encoded class-attribute instance-attribute
is_base64_encoded: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsBase64Encoded'})

True if the input string is base 64 encoded, false otherwise

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

Base64EncodeRequest dataclass

Base64EncodeRequest(*, content_to_encode: Optional[str] = None)

Definition: Base64EncodeRequest

Attributes

content_to_encode class-attribute instance-attribute
content_to_encode: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentToEncode'})

Input content to encode into Base 64

Base64EncodeResponse dataclass

Base64EncodeResponse(*, base64_text_content_result: Optional[str] = None, successful: Optional[bool] = None)

Definition: Base64EncodeResponse

Attributes

base64_text_content_result class-attribute instance-attribute
base64_text_content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Base64TextContentResult'})

Result of performing a base 64 encoding operation, a text string representing the encoded original file content

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

ChangeLineEndingResponse dataclass

ChangeLineEndingResponse(*, successful: Optional[bool] = None, text_content_result: Optional[str] = None)

Definition: ChangeLineEndingResponse

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

text_content_result class-attribute instance-attribute
text_content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContentResult'})

Text content result

ClearXlsxCellRequest 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 | Mapping[str, Any]] = None)

Definition: ClearXlsxCellRequest

Attributes

cell_index class-attribute instance-attribute
cell_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellIndex'})

0-based index of the cell, 0, 1, 2, ... in the row to clear

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

row_index class-attribute instance-attribute
row_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowIndex'})

0-based index of the row, 0, 1, 2, ... to clear

worksheet_to_update class-attribute instance-attribute
worksheet_to_update: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToUpdate'})

Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet

ConvertedPngPage dataclass

ConvertedPngPage(*, page_number: Optional[int] = None, url: Optional[str] = None)

Definition: ConvertedPngPage

Attributes

page_number class-attribute instance-attribute
page_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageNumber'})

Page number of the converted page, starting with 1

url class-attribute instance-attribute
url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'URL'})

URL to the PNG file of this page; file is stored in an in-memory cache and will be deleted

CreateBlankDocxRequest dataclass

CreateBlankDocxRequest(*, initial_text: Optional[str] = None)

Definition: CreateBlankDocxRequest

Attributes

initial_text class-attribute instance-attribute
initial_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InitialText'})

Optional; initial text to include in the document

CreateBlankSpreadsheetRequest dataclass

CreateBlankSpreadsheetRequest(*, worksheet_name: Optional[str] = None)

Definition: CreateBlankSpreadsheetRequest

Attributes

worksheet_name class-attribute instance-attribute
worksheet_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetName'})

The blank Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1

CreateSpreadsheetFromDataRequest dataclass

CreateSpreadsheetFromDataRequest(*, rows: Optional[List[XlsxSpreadsheetRow | Mapping[str, Any]]] = None, worksheet_name: Optional[str] = None)

Definition: CreateSpreadsheetFromDataRequest

Attributes

rows class-attribute instance-attribute
rows: Optional[List[XlsxSpreadsheetRow | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rows'})

Required; Rows and cells to populate the spreadsheet with

worksheet_name class-attribute instance-attribute
worksheet_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetName'})

Optional; The new Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1

CreateZipArchiveRequest dataclass

CreateZipArchiveRequest(*, directories_in_zip: Optional[List[ZipDirectory | Mapping[str, Any]]] = None, files_in_zip: Optional[List[ZipFile | Mapping[str, Any]]] = None)

Definition: CreateZipArchiveRequest

Attributes

directories_in_zip class-attribute instance-attribute
directories_in_zip: Optional[List[ZipDirectory | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoriesInZip'})

Top-level directories in the root directory of the zip; directories can contain sub-directories and files

files_in_zip class-attribute instance-attribute
files_in_zip: Optional[List[ZipFile | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FilesInZip'})

Top-level files in the root directory fo the zip file

DeleteDocxTableRowRangeRequest 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

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

table_path class-attribute instance-attribute
table_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TablePath'})

Path to the table to delete the row from

table_row_row_index_end class-attribute instance-attribute
table_row_row_index_end: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableRowRowIndexEnd'})

0-based index of the row to stop deleting rows (e.g. 0, 1, 2, ...) in the table

table_row_row_index_start class-attribute instance-attribute
table_row_row_index_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableRowRowIndexStart'})

0-based index of the row to begin deleting rows (e.g. 0, 1, 2, ...) in the table

DeleteDocxTableRowRequest 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

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

table_path class-attribute instance-attribute
table_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TablePath'})

Path to the table to delete the row from

table_row_row_index class-attribute instance-attribute
table_row_row_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableRowRowIndex'})

0-based index of the row to delete (e.g. 0, 1, 2, ...) in the table

DetectLineEndingsResponse 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

input_length class-attribute instance-attribute
input_length: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputLength'})

Length of the input string in characters

primary_newline_terminator class-attribute instance-attribute
primary_newline_terminator: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PrimaryNewlineTerminator'})

Characters used to terminate a newline; can be carriage return, linefeed, or carriage return + linefeed

primary_newline_type class-attribute instance-attribute
primary_newline_type: Optional[str] = dataclass_field(default=None, kw_only=True, 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)

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

DocumentValidationError dataclass

DocumentValidationError(*, description: Optional[str] = None, is_error: Optional[bool] = None, path: Optional[str] = None, uri: Optional[str] = None)

Definition: DocumentValidationError

Attributes

description class-attribute instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

Description of the error

is_error class-attribute instance-attribute
is_error: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsError'})

True if this is an error, false otherwise

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

XPath to the error

uri class-attribute instance-attribute
uri: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Uri'})

URI of the part in question

DocxBody dataclass

DocxBody(*, all_paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = None, all_tables: Optional[List[DocxTable | Mapping[str, Any]]] = None, path: Optional[str] = None)

Definition: DocxBody

Attributes

all_paragraphs class-attribute instance-attribute
all_paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllParagraphs'})

All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document

all_tables class-attribute instance-attribute
all_tables: Optional[List[DocxTable | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllTables'})

All tables anywhere in the document; these objects are not sequentially placed but are scatted across the document

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

DocxCellStyle dataclass

DocxCellStyle(*, built_in_id: Optional[int] = None, format_id: Optional[int] = None, name: Optional[str] = None, path: Optional[str] = None)

Definition: DocxCellStyle

Attributes

built_in_id class-attribute instance-attribute
built_in_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BuiltInID'})

Built=in ID of the cell style

format_id class-attribute instance-attribute
format_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FormatID'})

Format ID of the cell style

name class-attribute instance-attribute
name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Name of the style

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new rows

DocxComment 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

author class-attribute instance-attribute
author: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Author'})

Author name of the comment

author_initials class-attribute instance-attribute
author_initials: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AuthorInitials'})

Initials of the author of the comment

comment_date class-attribute instance-attribute
comment_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentDate'})

Date timestamp of the comment

comment_text class-attribute instance-attribute
comment_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentText'})

Text content of the comment

done class-attribute instance-attribute
done: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Done'})

True if this comment is marked as Done in Word, otherwise it is false

is_reply class-attribute instance-attribute
is_reply: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsReply'})

True if this comment is a reply to another comment, false otherwise

is_top_level class-attribute instance-attribute
is_top_level: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsTopLevel'})

True if the comment is at the top level, false if this comment is a child reply of another comment

parent_comment_path class-attribute instance-attribute
parent_comment_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ParentCommentPath'})

Path to the parent of this comment, if this comment is a reply, otherwise this value will be null

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

Path to the comment in the document

DocxFooter dataclass

DocxFooter(*, paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = None, path: Optional[str] = None, sections_with_footer: Optional[List[DocxSection | Mapping[str, Any]]] = None)

Definition: DocxFooter

Attributes

paragraphs class-attribute instance-attribute
paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Paragraphs'})

Paragraphs in this footer

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

sections_with_footer: Optional[List[DocxSection | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SectionsWithFooter'})

Sections that the footer is applied to

DocxHeader dataclass

DocxHeader(*, paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = None, path: Optional[str] = None, sections_with_header: Optional[List[DocxSection | Mapping[str, Any]]] = None)

Definition: DocxHeader

Attributes

paragraphs class-attribute instance-attribute
paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Paragraphs'})

Paragraphs in this header

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

sections_with_header class-attribute instance-attribute
sections_with_header: Optional[List[DocxSection | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SectionsWithHeader'})

Sections that the header is applied to

DocxImage dataclass

DocxImage(*, image_contents_url: 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

image_contents_url class-attribute instance-attribute
image_contents_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

image_data_content_type class-attribute instance-attribute
image_data_content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageDataContentType'})

Read-only; image data MIME content-type

image_data_embed_id class-attribute instance-attribute
image_data_embed_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageDataEmbedId'})

Read-only; internal ID for the image contents

image_description class-attribute instance-attribute
image_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageDescription'})

The Description of the image

image_height class-attribute instance-attribute
image_height: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageHeight'})

Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height

image_id class-attribute instance-attribute
image_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageId'})

The Id of the image

image_internal_file_name class-attribute instance-attribute
image_internal_file_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageInternalFileName'})

Read-only; internal file name/path for the image

image_name class-attribute instance-attribute
image_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageName'})

The Name of the image

image_width class-attribute instance-attribute
image_width: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageWidth'})

Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height

inline_with_text class-attribute instance-attribute
inline_with_text: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InlineWithText'})

True if the image is inline with the text; false if it is floating

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

x_offset class-attribute instance-attribute
x_offset: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'XOffset'})

X (horizontal) offset of the image

y_offset class-attribute instance-attribute
y_offset: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'YOffset'})

Y (vertical) offset of the image

DocxInsertCommentOnParagraphRequest dataclass

DocxInsertCommentOnParagraphRequest(*, comment_to_insert: Optional[DocxComment | Mapping[str, Any]] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, paragraph_path: Optional[str] = None)

Definition: DocxInsertCommentOnParagraphRequest

Attributes

comment_to_insert class-attribute instance-attribute
comment_to_insert: Optional[DocxComment | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentToInsert'})

Comment to insert

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

paragraph_path class-attribute instance-attribute
paragraph_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ParagraphPath'})

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.

DocxInsertImageRequest dataclass

DocxInsertImageRequest(*, height_in_emus: Optional[int] = None, image_to_add: Optional[DocxImage | Mapping[str, Any]] = 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_emus: Optional[int] = None)

Definition: DocxInsertImageRequest

Attributes

height_in_emus class-attribute instance-attribute
height_in_emus: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HeightInEMUs'})

Optional: The height of the image in EMUs

image_to_add class-attribute instance-attribute
image_to_add: Optional[DocxImage | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageToAdd'})

Optional: Image to add; if you supply in this object, do not supply InputImageFileBytes or InputImageFileUrl.

input_document_file_bytes class-attribute instance-attribute
input_document_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputDocumentFileBytes'})

Optional: Bytes of the input file to operate on

input_document_file_url class-attribute instance-attribute
input_document_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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).

input_image_file_bytes class-attribute instance-attribute
input_image_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

input_image_file_url class-attribute instance-attribute
input_image_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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).

insert_path class-attribute instance-attribute
insert_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InsertPath'})

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

insert_placement class-attribute instance-attribute
insert_placement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InsertPlacement'})

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)

width_in_emus class-attribute instance-attribute
width_in_emus: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WidthInEMUs'})

Optional: The width of the image in EMUs

DocxPage dataclass

DocxPage(*, page_number: Optional[int] = None, paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = None)

Definition: DocxPage

Attributes

page_number class-attribute instance-attribute
page_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageNumber'})

Page number of this page, 1-based

paragraphs class-attribute instance-attribute
paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Paragraphs'})

All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document

DocxParagraph dataclass

DocxParagraph(*, content_runs: Optional[List[DocxRun | Mapping[str, Any]]] = None, paragraph_index: Optional[int] = None, path: Optional[str] = None, style_id: Optional[str] = None)

Definition: DocxParagraph

Attributes

content_runs class-attribute instance-attribute
content_runs: Optional[List[DocxRun | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentRuns'})

The content runs in the paragraph - this is where text is stored; similar to a span in HTML

paragraph_index class-attribute instance-attribute
paragraph_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ParagraphIndex'})

The index of the paragraph; 0-based

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

style_id class-attribute instance-attribute
style_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StyleID'})

Style ID of the style applied to the paragraph; null if no style is applied

DocxRemoveObjectRequest 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

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

path_to_object_to_remove class-attribute instance-attribute
path_to_object_to_remove: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

DocxRun 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 | Mapping[str, Any]]] = None, underline: Optional[str] = None)

Definition: DocxRun

Attributes

bold class-attribute instance-attribute
bold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Bold'})

True to make the text bold, false otherwise

font_family class-attribute instance-attribute
font_family: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FontFamily'})

Font Family name for the text, e.g. "Arial" or "Times New Roman"

font_size class-attribute instance-attribute
font_size: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FontSize'})

Font size in font points (e.g. "24")

italic class-attribute instance-attribute
italic: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Italic'})

True to make the text italic, false otherwise

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

run_index class-attribute instance-attribute
run_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RunIndex'})

Index of the run, 0-based

text_items class-attribute instance-attribute
text_items: Optional[List[DocxText | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextItems'})

Text items inside the run; this is where the actual text content is stored

underline class-attribute instance-attribute
underline: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Underline'})

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

DocxSection dataclass

DocxSection(*, path: Optional[str] = None, starting_page_numbers: Optional[List[int]] = None)

Definition: DocxSection

Attributes

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

starting_page_numbers class-attribute instance-attribute
starting_page_numbers: Optional[List[int]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartingPageNumbers'})

Page numbers that the section starts at, typically just one

DocxSetFooterAddPageNumberRequest dataclass

DocxSetFooterAddPageNumberRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, prepend_text: Optional[str] = None)

Definition: DocxSetFooterAddPageNumberRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

prepend_text class-attribute instance-attribute
prepend_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PrependText'})

Optional: extra text to add before the page number, for example if you want to show "Page 1" then you can set PrependText to "Page"

DocxSetFooterRequest dataclass

DocxSetFooterRequest(*, footer_to_apply: Optional[DocxFooter | Mapping[str, Any]] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: DocxSetFooterRequest

Attributes

footer_to_apply class-attribute instance-attribute
footer_to_apply: Optional[DocxFooter | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FooterToApply'})

Footer to apply

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

DocxSetHeaderRequest dataclass

DocxSetHeaderRequest(*, header_to_apply: Optional[DocxHeader | Mapping[str, Any]] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: DocxSetHeaderRequest

Attributes

header_to_apply class-attribute instance-attribute
header_to_apply: Optional[DocxHeader | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HeaderToApply'})

Header to apply

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

DocxStyle 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

bold class-attribute instance-attribute
bold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Bold'})

Style applies bold formatting

font_family class-attribute instance-attribute
font_family: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FontFamily'})

Font family

font_size class-attribute instance-attribute
font_size: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FontSize'})

Font size

italic class-attribute instance-attribute
italic: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Italic'})

Style applies italic formatting

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

style_id class-attribute instance-attribute
style_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StyleID'})

ID of the style

underline class-attribute instance-attribute
underline: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Underline'})

Style applies underline formatting

DocxTable 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 | Mapping[str, Any]]] = 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

bottom_border_color class-attribute instance-attribute
bottom_border_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BottomBorderColor'})

HTML-style color hex value (do not include a #)

bottom_border_size class-attribute instance-attribute
bottom_border_size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BottomBorderSize'})

Width of the border in points (1/72nd of an inch)

bottom_border_space class-attribute instance-attribute
bottom_border_space: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BottomBorderSpace'})

Spacing around the border in points (1/72nd of an inch)

bottom_border_type class-attribute instance-attribute
bottom_border_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BottomBorderType'})

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

cell_horizontal_border_color class-attribute instance-attribute
cell_horizontal_border_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellHorizontalBorderColor'})

HTML-style color hex value (do not include a #)

cell_horizontal_border_size class-attribute instance-attribute
cell_horizontal_border_size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellHorizontalBorderSize'})

Width of the border in points (1/72nd of an inch)

cell_horizontal_border_space class-attribute instance-attribute
cell_horizontal_border_space: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellHorizontalBorderSpace'})

Spacing around the border in points (1/72nd of an inch)

cell_horizontal_border_type class-attribute instance-attribute
cell_horizontal_border_type: Optional[str] = dataclass_field(default=None, kw_only=True, 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

cell_vertical_border_color class-attribute instance-attribute
cell_vertical_border_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellVerticalBorderColor'})

HTML-style color hex value (do not include a #)

cell_vertical_border_size class-attribute instance-attribute
cell_vertical_border_size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellVerticalBorderSize'})

Width of the border in points (1/72nd of an inch)

cell_vertical_border_space class-attribute instance-attribute
cell_vertical_border_space: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellVerticalBorderSpace'})

Spacing around the border in points (1/72nd of an inch)

cell_vertical_border_type class-attribute instance-attribute
cell_vertical_border_type: Optional[str] = dataclass_field(default=None, kw_only=True, 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

end_border_color class-attribute instance-attribute
end_border_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndBorderColor'})

HTML-style color hex value (do not include a #)

end_border_size class-attribute instance-attribute
end_border_size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndBorderSize'})

Width of the border in points (1/72nd of an inch)

end_border_space class-attribute instance-attribute
end_border_space: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndBorderSpace'})

Spacing around the border in points (1/72nd of an inch)

end_border_type class-attribute instance-attribute
end_border_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndBorderType'})

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

left_border_color class-attribute instance-attribute
left_border_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LeftBorderColor'})

HTML-style color hex value (do not include a #)

left_border_size class-attribute instance-attribute
left_border_size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LeftBorderSize'})

Width of the border in points (1/72nd of an inch)

left_border_space class-attribute instance-attribute
left_border_space: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LeftBorderSpace'})

Spacing around the border in points (1/72nd of an inch)

left_border_type class-attribute instance-attribute
left_border_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LeftBorderType'})

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

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this table object; leave blank for new tables

right_border_color class-attribute instance-attribute
right_border_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RightBorderColor'})

HTML-style color hex value (do not include a #)

right_border_size class-attribute instance-attribute
right_border_size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RightBorderSize'})

Width of the border in points (1/72nd of an inch)

right_border_space class-attribute instance-attribute
right_border_space: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RightBorderSpace'})

Spacing around the border in points (1/72nd of an inch)

right_border_type class-attribute instance-attribute
right_border_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RightBorderType'})

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

start_border_color class-attribute instance-attribute
start_border_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartBorderColor'})

HTML-style color hex value (do not include a #)

start_border_size class-attribute instance-attribute
start_border_size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartBorderSize'})

Width of the border in points (1/72nd of an inch)

start_border_space class-attribute instance-attribute
start_border_space: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartBorderSpace'})

Spacing around the border in points (1/72nd of an inch)

start_border_type class-attribute instance-attribute
start_border_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartBorderType'})

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

table_id class-attribute instance-attribute
table_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableID'})

The ID of the table; leave blank for new tables

table_indentation_mode class-attribute instance-attribute
table_indentation_mode: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableIndentationMode'})

Table indentation type

table_indentation_width class-attribute instance-attribute
table_indentation_width: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableIndentationWidth'})

Table indentation width

table_rows class-attribute instance-attribute
table_rows: Optional[List[DocxTableRow | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableRows'})

Rows in the table; this is where the contents is located

top_border_color class-attribute instance-attribute
top_border_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TopBorderColor'})

HTML-style color hex value (do not include a #)

top_border_size class-attribute instance-attribute
top_border_size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TopBorderSize'})

Width of the border in points (1/72nd of an inch)

top_border_space class-attribute instance-attribute
top_border_space: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TopBorderSpace'})

Spacing around the border in points (1/72nd of an inch)

top_border_type class-attribute instance-attribute
top_border_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TopBorderType'})

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

width class-attribute instance-attribute
width: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Width'})

The Width of the table, or 0 if not specified

width_type class-attribute instance-attribute
width_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WidthType'})

The Width configuration type of the table

DocxTableCell 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 | Mapping[str, Any]]] = None, path: Optional[str] = None)

Definition: DocxTableCell

Attributes

cell_index class-attribute instance-attribute
cell_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellIndex'})

The index of the cell, 0-based

cell_shading_color class-attribute instance-attribute
cell_shading_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellShadingColor'})

Color of the cell shading

cell_shading_fill class-attribute instance-attribute
cell_shading_fill: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellShadingFill'})

Fill of the cell shading

cell_shading_pattern class-attribute instance-attribute
cell_shading_pattern: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellShadingPattern'})

Pattern of the cell shading

cell_width class-attribute instance-attribute
cell_width: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellWidth'})

Width of the cell

cell_width_mode class-attribute instance-attribute
cell_width_mode: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellWidthMode'})

Width mode of the cell; can be auto (for automatic) or manual

paragraphs class-attribute instance-attribute
paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Paragraphs'})

Paragraphs inside the cell; this is where the contents of the cell are stored

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

DocxTableRow dataclass

DocxTableRow(*, path: Optional[str] = None, row_cells: Optional[List[DocxTableCell | Mapping[str, Any]]] = None, row_index: Optional[int] = None)

Definition: DocxTableRow

Attributes

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this table row object; leave blank for new tables

row_cells class-attribute instance-attribute
row_cells: Optional[List[DocxTableCell | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowCells'})

Cells in the row; this is where the contents of the row is stored

row_index class-attribute instance-attribute
row_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowIndex'})

Index of the row, 0-based

DocxTemplateApplicationRequest dataclass

DocxTemplateApplicationRequest(*, operations: Optional[List[DocxTemplateOperation | Mapping[str, Any]]] = None)

Definition: DocxTemplateApplicationRequest

Attributes

operations class-attribute instance-attribute
operations: Optional[List[DocxTemplateOperation | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Operations'})

Operations to apply to this template

DocxTemplateOperation dataclass

DocxTemplateOperation(*, action: Optional[int] = None, match_against: Optional[str] = None, replace_with: Optional[str] = None)

Definition: DocxTemplateOperation

Attributes

action class-attribute instance-attribute
action: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Action'})

Operation action to take; possible values are "Replace"

match_against class-attribute instance-attribute
match_against: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchAgainst'})

For Replace operations, the string to match against (to be replaced with ReplaceWith string)

replace_with class-attribute instance-attribute
replace_with: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplaceWith'})

For Replace operations, the string to Replace the original string with

DocxText dataclass

DocxText(*, path: Optional[str] = None, text_content: Optional[str] = None, text_index: Optional[int] = None)

Definition: DocxText

Attributes

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new tables

text_content class-attribute instance-attribute
text_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContent'})

Text string containing the text content of this text content item

text_index class-attribute instance-attribute
text_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextIndex'})

Index of the text content in the run; 0-based

DocxTopLevelComment 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 | Mapping[str, Any]]] = None)

Definition: DocxTopLevelComment

Attributes

author class-attribute instance-attribute
author: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Author'})

Author name of the comment

author_initials class-attribute instance-attribute
author_initials: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AuthorInitials'})

Initials of the author of the comment

comment_date class-attribute instance-attribute
comment_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentDate'})

Date timestamp of the comment

comment_text class-attribute instance-attribute
comment_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentText'})

Text content of the comment

done class-attribute instance-attribute
done: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Done'})

True if this comment is marked as Done in Word, otherwise it is false

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

Path to the comment in the document

reply_child_comments class-attribute instance-attribute
reply_child_comments: Optional[List[DocxComment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyChildComments'})

Child comments, that are replies to this one

ExifValue dataclass

ExifValue(*, data_type: Optional[str] = None, data_value: Optional[str] = None, tag: Optional[str] = None)

Definition: ExifValue

Attributes

data_type class-attribute instance-attribute
data_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DataType'})

Date type of the EXIF value

data_value class-attribute instance-attribute
data_value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DataValue'})

Value, formatted as a string of the EXIF value

tag class-attribute instance-attribute
tag: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Tag'})

Tag name for the EXIF value

FindRegexMatch 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

character_offset_end class-attribute instance-attribute
character_offset_end: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CharacterOffsetEnd'})

0-based index of the end of the match

character_offset_start class-attribute instance-attribute
character_offset_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CharacterOffsetStart'})

0-based index of the start of the match

containing_line class-attribute instance-attribute
containing_line: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContainingLine'})

Text content of the line containing the match

match_groups class-attribute instance-attribute
match_groups: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchGroups'})

Regular expression regex match groups; these correspond to the match values

match_value class-attribute instance-attribute
match_value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchValue'})

The match value

FindStringMatch dataclass

FindStringMatch(*, character_offset_end: Optional[int] = None, character_offset_start: Optional[int] = None, containing_line: Optional[str] = None)

Definition: FindStringMatch

Attributes

character_offset_end class-attribute instance-attribute
character_offset_end: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CharacterOffsetEnd'})

0-based index of the end of the match

character_offset_start class-attribute instance-attribute
character_offset_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CharacterOffsetStart'})

0-based index of the start of the match

containing_line class-attribute instance-attribute
containing_line: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContainingLine'})

Text content of the line containing the match

FindStringRegexRequest dataclass

FindStringRegexRequest(*, match_case: Optional[bool] = None, target_regex: Optional[str] = None, text_content: Optional[str] = None)

Definition: FindStringRegexRequest

Attributes

match_case class-attribute instance-attribute
match_case: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchCase'})

Set to True to match case, False to ignore case

target_regex class-attribute instance-attribute
target_regex: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TargetRegex'})

Target input regular expression (regex) to find

text_content class-attribute instance-attribute
text_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContent'})

Input text content

FindStringRegexResponse dataclass

FindStringRegexResponse(*, match_count: Optional[int] = None, matches: Optional[List[FindRegexMatch | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Definition: FindStringRegexResponse

Attributes

match_count class-attribute instance-attribute
match_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchCount'})

The number of matches

matches class-attribute instance-attribute
matches: Optional[List[FindRegexMatch | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Matches'})

Regular expression matches

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

FindStringSimpleRequest dataclass

FindStringSimpleRequest(*, target_string: Optional[str] = None, text_content: Optional[str] = None)

Definition: FindStringSimpleRequest

Attributes

target_string class-attribute instance-attribute
target_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TargetString'})

Target input string to find

text_content class-attribute instance-attribute
text_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContent'})

Input text content

FindStringSimpleResponse dataclass

FindStringSimpleResponse(*, match_count: Optional[int] = None, matches: Optional[List[FindStringMatch | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Definition: FindStringSimpleResponse

Attributes

match_count class-attribute instance-attribute
match_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchCount'})

The number of matches

matches class-attribute instance-attribute
matches: Optional[List[FindStringMatch | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Matches'})

Found matches

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

FinishEditingRequest dataclass

FinishEditingRequest(*, input_file_url: Optional[str] = None)

Definition: FinishEditingRequest

Attributes

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

URL of a document being edited to get the contents of.

GetDocxBodyRequest dataclass

GetDocxBodyRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxBodyRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetDocxCommentsResponse dataclass

GetDocxCommentsResponse(*, comment_count: Optional[int] = None, comments: Optional[List[DocxComment | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Definition: GetDocxCommentsResponse

Attributes

comment_count class-attribute instance-attribute
comment_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentCount'})

The number of comments in the document

comments class-attribute instance-attribute
comments: Optional[List[DocxComment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})

Comments in the document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetDocxGetCommentsHierarchicalRequest dataclass

GetDocxGetCommentsHierarchicalRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxGetCommentsHierarchicalRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetDocxGetCommentsRequest dataclass

GetDocxGetCommentsRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxGetCommentsRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetDocxHeadersAndFootersRequest dataclass

GetDocxHeadersAndFootersRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxHeadersAndFootersRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetDocxImagesRequest dataclass

GetDocxImagesRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxImagesRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetDocxPagesRequest dataclass

GetDocxPagesRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxPagesRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetDocxSectionsRequest dataclass

GetDocxSectionsRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxSectionsRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetDocxStylesRequest dataclass

GetDocxStylesRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxStylesRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetDocxTableByIndexRequest dataclass

GetDocxTableByIndexRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, table_index: Optional[int] = None)

Definition: GetDocxTableByIndexRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

table_index class-attribute instance-attribute
table_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableIndex'})

0-based index of the table to retrieve from the Word Document

GetDocxTableRowRequest 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

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

table_path class-attribute instance-attribute
table_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TablePath'})

Path to the table to retrievew the row from

table_row_row_index class-attribute instance-attribute
table_row_row_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableRowRowIndex'})

0-based index of the row to retrieve (e.g. 0, 1, 2, ...) in the table

GetDocxTablesRequest dataclass

GetDocxTablesRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetDocxTablesRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetPdfAnnotationsResult dataclass

GetPdfAnnotationsResult(*, annotations: Optional[List[PdfAnnotation | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Definition: GetPdfAnnotationsResult

Attributes

annotations class-attribute instance-attribute
annotations: Optional[List[PdfAnnotation | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Annotations'})

Annotations in the PDF file, ordered by placement from start to finish in the document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

GetXlsxCellByIdentifierRequest dataclass

GetXlsxCellByIdentifierRequest(*, cell_identifier: Optional[str] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = None)

Definition: GetXlsxCellByIdentifierRequest

Attributes

cell_identifier class-attribute instance-attribute
cell_identifier: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellIdentifier'})

Required; Excel cell identifier, e.g. A1, B22, C33, etc.

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

worksheet_to_query class-attribute instance-attribute
worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToQuery'})

Optional; Worksheet (tab) within the spreadsheet to get the rows and cells of; leave blank to default to the first worksheet

GetXlsxCellRequest 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 | Mapping[str, Any]] = None)

Definition: GetXlsxCellRequest

Attributes

cell_index class-attribute instance-attribute
cell_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellIndex'})

0-based index of the cell, 0, 1, 2, ... in the row to retrieve

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

row_index class-attribute instance-attribute
row_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowIndex'})

0-based index of the row, 0, 1, 2, ... to retrieve

worksheet_to_query class-attribute instance-attribute
worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToQuery'})

Optional; Worksheet (tab) within the spreadsheet to get the rows and cells of; leave blank to default to the first worksheet

GetXlsxColumnsRequest dataclass

GetXlsxColumnsRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = None)

Definition: GetXlsxColumnsRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

worksheet_to_query class-attribute instance-attribute
worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToQuery'})

Optional; Worksheet (tab) within the spreadsheet to get the columns of; leave blank to default to the first worksheet

GetXlsxImagesRequest dataclass

GetXlsxImagesRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = None)

Definition: GetXlsxImagesRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

worksheet_to_query class-attribute instance-attribute
worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToQuery'})

Optional; Worksheet (tab) within the spreadsheet to get the images of; leave blank to default to the first worksheet

GetXlsxRowsAndCellsRequest dataclass

GetXlsxRowsAndCellsRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = None)

Definition: GetXlsxRowsAndCellsRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

worksheet_to_query class-attribute instance-attribute
worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToQuery'})

Optional; Worksheet (tab) within the spreadsheet to get the rows and cells of; leave blank to default to the first worksheet

GetXlsxStylesRequest dataclass

GetXlsxStylesRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetXlsxStylesRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

GetXlsxWorksheetsRequest dataclass

GetXlsxWorksheetsRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None)

Definition: GetXlsxWorksheetsRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

HtmlTemplateApplicationRequest dataclass

HtmlTemplateApplicationRequest(*, html_template: Optional[str] = None, html_template_url: Optional[str] = None, operations: Optional[List[HtmlTemplateOperation | Mapping[str, Any]]] = None)

Definition: HtmlTemplateApplicationRequest

Attributes

html_template class-attribute instance-attribute
html_template: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HtmlTemplate'})

HTML template input as a string

html_template_url class-attribute instance-attribute
html_template_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HtmlTemplateUrl'})

URL to HTML template input

operations class-attribute instance-attribute
operations: Optional[List[HtmlTemplateOperation | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Operations'})

Operations to apply to this template

HtmlTemplateOperation dataclass

HtmlTemplateOperation(*, action: Optional[int] = None, match_agsint: Optional[str] = None, replace_with: Optional[str] = None)

Definition: HtmlTemplateOperation

Attributes

action class-attribute instance-attribute
action: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Action'})

Operation action to take; possible values are "Replace"

match_agsint class-attribute instance-attribute
match_agsint: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchAgsint'})

For Replace operations, the string to match against (to be replaced with ReplaceWith string)

replace_with class-attribute instance-attribute
replace_with: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplaceWith'})

For Replace operations, the string to Replace the original string with

HtmlToOfficeRequest dataclass

HtmlToOfficeRequest(*, html: Optional[str] = None)

Definition: HtmlToOfficeRequest

Attributes

html class-attribute instance-attribute
html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Html'})

HTML to render to Office format

HtmlToPdfRequest dataclass

HtmlToPdfRequest(*, extra_loading_wait: Optional[int] = None, html: Optional[str] = None)

Definition: HtmlToPdfRequest

Attributes

extra_loading_wait class-attribute instance-attribute
extra_loading_wait: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExtraLoadingWait'})

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.

html class-attribute instance-attribute
html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Html'})

HTML to render to PDF

HtmlToPngRequest 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

extra_loading_wait class-attribute instance-attribute
extra_loading_wait: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExtraLoadingWait'})

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.

html class-attribute instance-attribute
html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Html'})

HTML to render to PNG (screenshot)

screenshot_height class-attribute instance-attribute
screenshot_height: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ScreenshotHeight'})

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

screenshot_width class-attribute instance-attribute
screenshot_width: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ScreenshotWidth'})

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

HtmlToTextRequest dataclass

HtmlToTextRequest(*, html: Optional[str] = None)

Definition: HtmlToTextRequest

Attributes

html class-attribute instance-attribute
html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Html'})

HTML to extract the text from

InsertDocxInsertParagraphRequest 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 | Mapping[str, Any]] = None)

Definition: InsertDocxInsertParagraphRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

insert_path class-attribute instance-attribute
insert_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InsertPath'})

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

insert_placement class-attribute instance-attribute
insert_placement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InsertPlacement'})

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)

paragraph_to_insert class-attribute instance-attribute
paragraph_to_insert: Optional[DocxParagraph | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ParagraphToInsert'})

Table you would like to insert

InsertDocxTableRowRequest 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 | Mapping[str, Any]] = None)

Definition: InsertDocxTableRowRequest

Attributes

existing_table_path class-attribute instance-attribute
existing_table_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExistingTablePath'})

Required; the path to the existing table to modify

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

insert_placement class-attribute instance-attribute
insert_placement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InsertPlacement'})

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

row_to_insert class-attribute instance-attribute
row_to_insert: Optional[DocxTableRow | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowToInsert'})

Table you would like to insert

InsertDocxTablesRequest 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 | Mapping[str, Any]] = None)

Definition: InsertDocxTablesRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

insert_path class-attribute instance-attribute
insert_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InsertPath'})

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

insert_placement class-attribute instance-attribute
insert_placement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InsertPlacement'})

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)

table_to_insert class-attribute instance-attribute
table_to_insert: Optional[DocxTable | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableToInsert'})

Table you would like to insert

InsertXlsxWorksheetRequest dataclass

InsertXlsxWorksheetRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_insert: Optional[XlsxWorksheet | Mapping[str, Any]] = None)

Definition: InsertXlsxWorksheetRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

worksheet_to_insert class-attribute instance-attribute
worksheet_to_insert: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToInsert'})

Workersheet to insert

PageConversionResult dataclass

PageConversionResult(*, file_bytes: Optional[str] = None, file_name: Optional[str] = None)

Definition: PageConversionResult

Attributes

file_bytes class-attribute instance-attribute
file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FileBytes'})

File bytes (contents) of the image in converted file format

file_name class-attribute instance-attribute
file_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Filename'})

File name of the image in the converted file format

PdfAnnotation 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

annotation_index class-attribute instance-attribute
annotation_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AnnotationIndex'})

The 0-based index of the annotation in the document

annotation_type class-attribute instance-attribute
annotation_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AnnotationType'})

Type of the annotation; possible values are Text

creation_date class-attribute instance-attribute
creation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreationDate'})

Date that the annotation was created

height class-attribute instance-attribute
height: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Height'})

Height of the annotation

left_x class-attribute instance-attribute
left_x: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LeftX'})

Left X coordinate for the location of the annotation

modified_date class-attribute instance-attribute
modified_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ModifiedDate'})

Date that the annotation was last modified

page_number class-attribute instance-attribute
page_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageNumber'})

The 1-based index of the page containing the annotation

subject class-attribute instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})

Subject of the annotation

text_contents class-attribute instance-attribute
text_contents: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContents'})

Text contents of the annotation

title class-attribute instance-attribute
title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Title'})

Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files

top_y class-attribute instance-attribute
top_y: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TopY'})

Top Y coordination of the location of the annotation

width class-attribute instance-attribute
width: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Width'})

Width of the annotation

PdfDocument dataclass

PdfDocument(*, document_contents: Optional[str] = None, page_number: Optional[int] = None, url: Optional[str] = None)

Definition: PdfDocument

Attributes

document_contents class-attribute instance-attribute
document_contents: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DocumentContents'})

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

page_number class-attribute instance-attribute
page_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageNumber'})

Page number of the converted page, starting with 1 for the first page

url class-attribute instance-attribute
url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'URL'})

URL to the PDF file of this worksheet; file is stored in an in-memory cache and will be deleted

PdfFormField 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

field_combo_box_selected_index class-attribute instance-attribute
field_combo_box_selected_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldComboBoxSelectedIndex'})

Applies to ComboBox field types only; specifies the selected index of the combo box selection if available

field_name class-attribute instance-attribute
field_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldName'})

Name of the form field

field_type class-attribute instance-attribute
field_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldType'})

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

field_value class-attribute instance-attribute
field_value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldValue'})

Value of the form field

PdfFormFields dataclass

PdfFormFields(*, form_fields: Optional[List[PdfFormField | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Definition: PdfFormFields

Attributes

form_fields class-attribute instance-attribute
form_fields: Optional[List[PdfFormField | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FormFields'})

Fields and field values found in the form

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

PdfMetadata 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

author class-attribute instance-attribute
author: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Author'})

User name of the creator/author of the document, if available, null if not available

creator class-attribute instance-attribute
creator: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Creator'})

Creator of the document

date_created class-attribute instance-attribute
date_created: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateCreated'})

The timestamp that the document was created, if available, null if not available

date_modified class-attribute instance-attribute
date_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateModified'})

The timestamp that the document was last modified, if available, null if not available

keywords class-attribute instance-attribute
keywords: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Keywords'})

Keywords of the document

page_count class-attribute instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageCount'})

The number of pages in the document

subject class-attribute instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})

Subject of the document

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

title class-attribute instance-attribute
title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Title'})

Title of the document

PdfPageText dataclass

PdfPageText(*, page_number: Optional[int] = None, page_text: Optional[str] = None)

Definition: PdfPageText

Attributes

page_number class-attribute instance-attribute
page_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageNumber'})

Page number of the page (1-based)

page_text class-attribute instance-attribute
page_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageText'})

Text of the page

PdfTextByPageResult dataclass

PdfTextByPageResult(*, pages: Optional[List[PdfPageText | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Definition: PdfTextByPageResult

Attributes

pages class-attribute instance-attribute
pages: Optional[List[PdfPageText | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Pages'})

Pages in the PDF

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

PresentationResult dataclass

PresentationResult(*, presentation_contents: Optional[str] = None, slide_number: Optional[int] = None, url: Optional[str] = None)

Definition: PresentationResult

Attributes

presentation_contents class-attribute instance-attribute
presentation_contents: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PresentationContents'})

Contents of the presentation in bytes

slide_number class-attribute instance-attribute
slide_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SlideNumber'})

Worksheet number of the converted page, starting with 1 for the left-most worksheet

url class-attribute instance-attribute
url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'URL'})

URL to the PPTX file of this slide; file is stored in an in-memory cache and will be deleted

RemoveDocxHeadersAndFootersRequest 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

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

remove_footers class-attribute instance-attribute
remove_footers: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RemoveFooters'})

True if you would like to remove all footers from the input document, false otherwise

remove_headers class-attribute instance-attribute
remove_headers: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RemoveHeaders'})

True if you would like to remove all headers from the input document, false otherwise

RemoveDocxPagesRequest 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

end_delete_page_number class-attribute instance-attribute
end_delete_page_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndDeletePageNumber'})

Page number (1-based) to stop deleting pages; inclusive

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

start_delete_page_number class-attribute instance-attribute
start_delete_page_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDeletePageNumber'})

Page number (1-based) to start deleting pages; inclusive

RemoveHtmlFromTextRequest dataclass

RemoveHtmlFromTextRequest(*, text_containing_html: Optional[str] = None)

Definition: RemoveHtmlFromTextRequest

Attributes

text_containing_html class-attribute instance-attribute
text_containing_html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContainingHtml'})

Input text string to remove the HTML from

RemoveHtmlFromTextResponse dataclass

RemoveHtmlFromTextResponse(*, successful: Optional[bool] = None, text_content_result: Optional[str] = None)

Definition: RemoveHtmlFromTextResponse

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

text_content_result class-attribute instance-attribute
text_content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContentResult'})

Result of performing a remove HTML from string operation

RemovePptxSlidesRequest 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

end_delete_slide_number class-attribute instance-attribute
end_delete_slide_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndDeleteSlideNumber'})

Slide number (1-based) to stop deleting slides; inclusive

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

start_delete_slide_number class-attribute instance-attribute
start_delete_slide_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDeleteSlideNumber'})

Slide number (1-based) to start deleting slides; inclusive

RemoveWhiteSpaceFromTextRequest dataclass

RemoveWhiteSpaceFromTextRequest(*, text_containing_whitespace: Optional[str] = None)

Definition: RemoveWhitespaceFromTextRequest

Attributes

text_containing_whitespace class-attribute instance-attribute
text_containing_whitespace: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContainingWhitespace'})

Input text string to remove the whitespace from

RemoveWhiteSpaceFromTextResponse dataclass

RemoveWhiteSpaceFromTextResponse(*, successful: Optional[bool] = None, text_content_result: Optional[str] = None)

Definition: RemoveWhitespaceFromTextResponse

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

text_content_result class-attribute instance-attribute
text_content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContentResult'})

Result of performing a remove whitespace from string operation

RemoveXlsxWorksheetRequest dataclass

RemoveXlsxWorksheetRequest(*, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_remove: Optional[XlsxWorksheet | Mapping[str, Any]] = None)

Definition: RemoveXlsxWorksheetRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

worksheet_to_remove class-attribute instance-attribute
worksheet_to_remove: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, 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.

ReplaceStringRegexRequest dataclass

ReplaceStringRegexRequest(*, regular_expression_string: Optional[str] = None, replace_with_string: Optional[str] = None, text_content: Optional[str] = None)

Definition: ReplaceStringRegexRequest

Attributes

regular_expression_string class-attribute instance-attribute
regular_expression_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RegularExpressionString'})

Target input regular expression (regex) string to match and be replaced; supports all regular expression values

replace_with_string class-attribute instance-attribute
replace_with_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplaceWithString'})

Replacement for target string; supports referencing indexed regex matched values from RegularExpressionString, such as $1, $2, and so on

text_content class-attribute instance-attribute
text_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContent'})

Input text content

ReplaceStringRegexResponse dataclass

ReplaceStringRegexResponse(*, successful: Optional[bool] = None, text_content_result: Optional[str] = None)

Definition: ReplaceStringRegexResponse

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

text_content_result class-attribute instance-attribute
text_content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContentResult'})

Result of performing a base 64 decode operation, binary file content

ReplaceStringRequest 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

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

match_case class-attribute instance-attribute
match_case: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchCase'})

True if the case should be matched, false for case insensitive match

match_string class-attribute instance-attribute
match_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MatchString'})

String to search for and match against, to be replaced

replace_string class-attribute instance-attribute
replace_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplaceString'})

String to replace the matched values with

ReplaceStringSimpleRequest dataclass

ReplaceStringSimpleRequest(*, replace_with_string: Optional[str] = None, target_string: Optional[str] = None, text_content: Optional[str] = None)

Definition: ReplaceStringSimpleRequest

Attributes

replace_with_string class-attribute instance-attribute
replace_with_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplaceWithString'})

Replacement for target string

target_string class-attribute instance-attribute
target_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TargetString'})

Target input string to match and be replaced

text_content class-attribute instance-attribute
text_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContent'})

Input text content

ReplaceStringSimpleResponse dataclass

ReplaceStringSimpleResponse(*, successful: Optional[bool] = None, text_content_result: Optional[str] = None)

Definition: ReplaceStringSimpleResponse

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

text_content_result class-attribute instance-attribute
text_content_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextContentResult'})

Result of performing a replace string operation

ScreenshotRequest 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

extra_loading_wait class-attribute instance-attribute
extra_loading_wait: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExtraLoadingWait'})

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)

screenshot_height class-attribute instance-attribute
screenshot_height: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ScreenshotHeight'})

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

screenshot_width class-attribute instance-attribute
screenshot_width: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ScreenshotWidth'})

Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024

url class-attribute instance-attribute
url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

URL address of the website to screenshot. HTTP and HTTPS are both supported, as are custom ports.

SetFormFieldValue 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

checkbox_value class-attribute instance-attribute
checkbox_value: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckboxValue'})

For fields of type Checkbox, the value to put into the field

combo_box_selected_index class-attribute instance-attribute
combo_box_selected_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ComboBoxSelectedIndex'})

For fields of type ComboBox; specifies the selected index of the combo box selection

field_name class-attribute instance-attribute
field_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldName'})

Name of the field to set; you can call /convert/edit/pdf/form/get-fields to enumerate field names in a form

text_value class-attribute instance-attribute
text_value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextValue'})

For fields of type Text, the text value to put into the field

SetPdfFormFieldsRequest dataclass

SetPdfFormFieldsRequest(*, field_values: Optional[List[SetFormFieldValue | Mapping[str, Any]]] = None, input_file_bytes: Optional[str] = None)

Definition: SetPdfFormFieldsRequest

Attributes

field_values class-attribute instance-attribute
field_values: Optional[List[SetFormFieldValue | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldValues'})

Field values to set

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Contents of the input file to set the fields on

SetPdfMetadataRequest dataclass

SetPdfMetadataRequest(*, input_file_bytes: Optional[str] = None, metadata_to_set: Optional[PdfMetadata | Mapping[str, Any]] = None)

Definition: SetPdfMetadataRequest

Attributes

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Input file contents bytes for the file to modify

metadata_to_set class-attribute instance-attribute
metadata_to_set: Optional[PdfMetadata | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MetadataToSet'})

PDF metadata to set on the file

SetXlsxCellByIdentifierRequest dataclass

SetXlsxCellByIdentifierRequest(*, cell_identifier: Optional[str] = None, cell_value: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, worksheet_to_update: Optional[XlsxWorksheet | Mapping[str, Any]] = None)

Definition: SetXlsxCellByIdentifierRequest

Attributes

cell_identifier class-attribute instance-attribute
cell_identifier: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellIdentifier'})

The Excel cell identifier (e.g. A1, B2, C33, etc.) of the cell to update

cell_value class-attribute instance-attribute
cell_value: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellValue'})

New Cell value to update/overwrite into the Excel XLSX spreadsheet

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

worksheet_to_update class-attribute instance-attribute
worksheet_to_update: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToUpdate'})

Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet

SetXlsxCellRequest dataclass

SetXlsxCellRequest(*, cell_index: Optional[int] = None, cell_value: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = None, input_file_bytes: Optional[str] = None, input_file_url: Optional[str] = None, row_index: Optional[int] = None, worksheet_to_update: Optional[XlsxWorksheet | Mapping[str, Any]] = None)

Definition: SetXlsxCellRequest

Attributes

cell_index class-attribute instance-attribute
cell_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellIndex'})

0-based index of the cell, 0, 1, 2, ... in the row to set

cell_value class-attribute instance-attribute
cell_value: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellValue'})

New Cell value to update/overwrite into the Excel XLSX spreadsheet

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

row_index class-attribute instance-attribute
row_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowIndex'})

0-based index of the row, 0, 1, 2, ... to set

worksheet_to_update class-attribute instance-attribute
worksheet_to_update: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetToUpdate'})

Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet

SplitDocumentResult dataclass

SplitDocumentResult(*, document_contents: Optional[str] = None, page_number: Optional[int] = None, url: Optional[str] = None)

Definition: SplitDocumentResult

Attributes

document_contents class-attribute instance-attribute
document_contents: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DocumentContents'})

Contents of the document in bytes

page_number class-attribute instance-attribute
page_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PageNumber'})

Page number of the converted page, starting with 1 for the first page

url class-attribute instance-attribute
url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'URL'})

URL to the DOCX file of this slide; file is stored in an in-memory cache and will be deleted

TextDocumentElement dataclass

TextDocumentElement(*, element_contents: Optional[str] = None, element_number: Optional[int] = None)

Definition: TextDocumentElement

Attributes

element_contents class-attribute instance-attribute
element_contents: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ElementContents'})

The text contents of a single element of a text file

element_number class-attribute instance-attribute
element_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ElementNumber'})

The 1-based line index of the element

TextDocumentLine dataclass

TextDocumentLine(*, line_contents: Optional[str] = None, line_number: Optional[int] = None)

Definition: TextDocumentLine

Attributes

line_contents class-attribute instance-attribute
line_contents: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LineContents'})

The text contents of a single line of a text file

line_number class-attribute instance-attribute
line_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LineNumber'})

The 1-based line index of the line

TextEncodingDetectResponse dataclass

TextEncodingDetectResponse(*, successful: Optional[bool] = None, text_encoding: Optional[str] = None)

Definition: TextEncodingDetectResponse

Attributes

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if successful, false otherwise

text_encoding class-attribute instance-attribute
text_encoding: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextEncoding'})

Text encoding used in file; possible values are ASCII, UTF7, UTF8, UTF16, BigEndianUnicode and UTF32

UpdateDocxTableCellRequest dataclass

UpdateDocxTableCellRequest(*, cell_to_update: Optional[DocxTableCell | Mapping[str, Any]] = 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

cell_to_update class-attribute instance-attribute
cell_to_update: Optional[DocxTableCell | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellToUpdate'})

Table cell contents you would like to update the cell with

existing_table_path class-attribute instance-attribute
existing_table_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExistingTablePath'})

Required; the path to the existing table to modify

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

table_cell_index class-attribute instance-attribute
table_cell_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableCellIndex'})

0-based index of the Table Cell (within the row) to update

table_row_index class-attribute instance-attribute
table_row_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableRowIndex'})

0-based index of the Table Row to update

UpdateDocxTableRowRequest 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 | Mapping[str, Any]] = None, table_row_index: Optional[int] = None)

Definition: UpdateDocxTableRowRequest

Attributes

existing_table_path class-attribute instance-attribute
existing_table_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExistingTablePath'})

Required; the path to the existing table to modify

input_file_bytes class-attribute instance-attribute
input_file_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileBytes'})

Optional: Bytes of the input file to operate on

input_file_url class-attribute instance-attribute
input_file_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InputFileUrl'})

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).

row_to_update class-attribute instance-attribute
row_to_update: Optional[DocxTableRow | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowToUpdate'})

Table row contents you would like to update the row with

table_row_index class-attribute instance-attribute
table_row_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableRowIndex'})

0-based index of the Table Row to update

UrlToTextRequest dataclass

UrlToTextRequest(*, url: Optional[str] = None)

Definition: UrlToTextRequest

Attributes

url class-attribute instance-attribute
url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

URL of the website to extract the text from

ViewerResponse dataclass

ViewerResponse(*, html_embed: Optional[str] = None, successful: Optional[bool] = None)

Definition: ViewerResponse

WorksheetResult dataclass

WorksheetResult(*, url: Optional[str] = None, worksheet_contents: Optional[str] = None, worksheet_name: Optional[str] = None, worksheet_number: Optional[int] = None)

Definition: WorksheetResult

Attributes

url class-attribute instance-attribute
url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'URL'})

URL to the XLSX file of this worksheet; file is stored in an in-memory cache and will be deleted

worksheet_contents class-attribute instance-attribute
worksheet_contents: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetContents'})

Contents of the worksheet in bytes

worksheet_name class-attribute instance-attribute
worksheet_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetName'})

The name of the worksheet

worksheet_number class-attribute instance-attribute
worksheet_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetNumber'})

Worksheet number of the converted page, starting with 1 for the left-most worksheet

XlsxImage dataclass

XlsxImage(*, image_contents_url: 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

image_contents_url class-attribute instance-attribute
image_contents_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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.

image_data_content_type class-attribute instance-attribute
image_data_content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageDataContentType'})

Read-only; image data MIME content-type

image_data_embed_id class-attribute instance-attribute
image_data_embed_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageDataEmbedId'})

Read-only; internal ID for the image contents

image_internal_file_name class-attribute instance-attribute
image_internal_file_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImageInternalFileName'})

Read-only; internal file name/path for the image

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new rows

XlsxSpreadsheetCell 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

cell_identifier class-attribute instance-attribute
cell_identifier: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CellIdentifier'})

Cell reference of the cell, e.g. A1, Z22, etc.

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new rows

style_index class-attribute instance-attribute
style_index: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StyleIndex'})

Identifier for the style to apply to this style

text_value class-attribute instance-attribute
text_value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TextValue'})

Text value of the cell

XlsxSpreadsheetColumn dataclass

XlsxSpreadsheetColumn(*, heading_cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = None, path: Optional[str] = None)

Definition: XlsxSpreadsheetColumn

Attributes

heading_cell class-attribute instance-attribute
heading_cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HeadingCell'})

Heading cell for this column

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new rows

XlsxSpreadsheetRow dataclass

XlsxSpreadsheetRow(*, cells: Optional[List[XlsxSpreadsheetCell | Mapping[str, Any]]] = None, path: Optional[str] = None)

Definition: XlsxSpreadsheetRow

Attributes

cells class-attribute instance-attribute
cells: Optional[List[XlsxSpreadsheetCell | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Cells'})

Spreadsheet Cells in the spreadsheet row

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new rows

XlsxWorksheet dataclass

XlsxWorksheet(*, path: Optional[str] = None, worksheet_name: Optional[str] = None)

Definition: XlsxWorksheet

Attributes

path class-attribute instance-attribute
path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The Path of the location of this object; leave blank for new worksheets

worksheet_name class-attribute instance-attribute
worksheet_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorksheetName'})

User-facing name of the worksheet tab

ZipDirectory dataclass

ZipDirectory(*, directories_in_directory: Optional[List[ZipDirectory | Mapping[str, Any]]] = None, directory_name: Optional[str] = None, files_in_directory: Optional[List[ZipFile | Mapping[str, Any]]] = None)

Definition: ZipDirectory

Attributes

directories_in_directory class-attribute instance-attribute
directories_in_directory: Optional[List[ZipDirectory | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoriesInDirectory'})

Child directories contained directly in this directory

directory_name class-attribute instance-attribute
directory_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoryName'})

Name of this directory

files_in_directory class-attribute instance-attribute
files_in_directory: Optional[List[ZipFile | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FilesInDirectory'})

Child files contained directly in this directory

ZipExtractResponse dataclass

ZipExtractResponse(*, directories_in_zip: Optional[List[ZipDirectory | Mapping[str, Any]]] = None, files_in_zip: Optional[List[ZipFile | Mapping[str, Any]]] = None, successful: Optional[bool] = None)

Definition: ZipExtractResponse

Attributes

directories_in_zip class-attribute instance-attribute
directories_in_zip: Optional[List[ZipDirectory | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoriesInZip'})

Top-level directories in the root directory of the zip; directories can contain sub-directories and files

files_in_zip class-attribute instance-attribute
files_in_zip: Optional[List[ZipFile | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FilesInZip'})

Top-level files in the root directory fo the zip file

successful class-attribute instance-attribute
successful: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Successful'})

True if the operation was successful, false otherwise

ZipFile dataclass

ZipFile(*, file_contents: Optional[str] = None, file_name: Optional[str] = None)

Definition: ZipFile

Attributes

file_contents class-attribute instance-attribute
file_contents: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FileContents'})

Contents of this file

file_name class-attribute instance-attribute
file_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FileName'})

Name of this file

CloudmersiveConvertClient

CloudmersiveConvertClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential AsyncTokenCredential | AzureKeyCredential

Caller-owned Azure Core credential.

required
max_retry_attempts int

The maximum number of request attempts.

3
timeout float

The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.

30.0
use_exponential_backoff bool

Whether retries use exponential backoff.

True
initial_retry_delay_seconds float

The initial retry delay in seconds.

0.5
maximum_retry_delay_seconds float

The maximum retry delay in seconds.

120.0
retry_jitter_factor float

The jitter fraction applied to retry delays.

0.1
retry_unsafe_http_methods bool

Whether unsafe HTTP methods may be retried.

False
transport Optional[AsyncHttpTransport]

Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.

None
**kwargs Any

Optional Azure Core pipeline policy settings.

{}

Methods:

convert_document_autodetect_get_info async
convert_document_autodetect_get_info(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get document type information

Auto-detects a document's type information; does not require file extension. Analyzes file contents to confirm file type. Even if no file extension is present, the auto-detect system will reliably analyze the contents of the file and identify its file type. Supports over 100 image file formats, Office document file formats, PDF, and more.

Swagger operation ID: ConvertDocument_AutodetectGetInfo.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_autodetect_to_pdf async
convert_document_autodetect_to_pdf(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Document to PDF

Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.

Swagger operation ID: ConvertDocument_AutodetectToPdf.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_autodetect_to_png_array async
convert_document_autodetect_to_png_array(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert Document to PNG array

Automatically detect file type and convert it to an array of PNG images. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.

Swagger operation ID: ConvertDocument_AutodetectToPngArray.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_autodetect_to_txt async
convert_document_autodetect_to_txt(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert Document to Text (txt)

Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files. For spreadsheets, all worksheets will be included. If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.

Swagger operation ID: ConvertDocument_AutodetectToTxt.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

compare_document_docx async
compare_document_docx(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Compare Two Word DOCX

Compare two Office Word Documents (docx) files and highlight the differences

Swagger operation ID: CompareDocument_Docx.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on (more than 2 can be supplied).

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_csv_to_json async
convert_data_csv_to_json(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert CSV to JSON conversion

Convert a CSV file to a JSON object array

Swagger operation ID: ConvertData_CsvToJson.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_csv_to_xlsx async
convert_document_csv_to_xlsx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert CSV to Excel XLSX Spreadsheet

Convert CSV file to Office Excel XLSX Workbooks file format.

Swagger operation ID: ConvertDocument_CsvToXlsx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_doc_to_docx async
convert_document_doc_to_docx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Word DOC (97-03) Document to DOCX

Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format

Swagger operation ID: ConvertDocument_DocToDocx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_doc_to_pdf async
convert_document_doc_to_pdf(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Word DOC (97-03) Document to PDF

Convert Office Word (97-2003 Format) Documents (doc) to standard PDF

Swagger operation ID: ConvertDocument_DocToPdf.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_doc_to_txt async
convert_document_doc_to_txt(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert Word DOC (97-03) Document to Text (txt)

Convert Office Word DOC (97-03) Document (doc) to text

Swagger operation ID: ConvertDocument_DocToTxt.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_docx_to_pdf async
convert_document_docx_to_pdf(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Word DOCX Document to PDF

Convert Office Word Documents (docx) to standard PDF

Swagger operation ID: ConvertDocument_DocxToPdf.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_docx_to_txt async
convert_document_docx_to_txt(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert Word DOCX Document to Text (txt)

Convert Office Word Documents (docx) to text

Swagger operation ID: ConvertDocument_DocxToTxt.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_begin_editing async
edit_document_begin_editing(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Begin editing a document

Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.

Swagger operation ID: EditDocument_BeginEditing.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_create_blank_document async
edit_document_docx_create_blank_document(input: CreateBlankDocxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxCreateBlankDocument.

Parameters:

Name Type Description Default
input CreateBlankDocxRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_delete_pages async
edit_document_docx_delete_pages(input: RemoveDocxPagesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

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

Swagger operation ID: EditDocument_DocxDeletePages.

Parameters:

Name Type Description Default
input RemoveDocxPagesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_delete_table_row async
edit_document_docx_delete_table_row(input: DeleteDocxTableRowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxDeleteTableRow.

Parameters:

Name Type Description Default
input DeleteDocxTableRowRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_delete_table_row_range async
edit_document_docx_delete_table_row_range(input: DeleteDocxTableRowRangeRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxDeleteTableRowRange.

Parameters:

Name Type Description Default
input DeleteDocxTableRowRangeRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_body async
edit_document_docx_body(input: GetDocxBodyRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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

Swagger operation ID: EditDocument_DocxBody.

Parameters:

Name Type Description Default
input GetDocxBodyRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_get_comments_hierarchical async
edit_document_docx_get_comments_hierarchical(input: GetDocxGetCommentsHierarchicalRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxGetCommentsHierarchical.

Parameters:

Name Type Description Default
input GetDocxGetCommentsHierarchicalRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_get_headers_and_footers async
edit_document_docx_get_headers_and_footers(input: GetDocxHeadersAndFootersRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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

Swagger operation ID: EditDocument_DocxGetHeadersAndFooters.

Parameters:

Name Type Description Default
input GetDocxHeadersAndFootersRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_get_images async
edit_document_docx_get_images(input: GetDocxImagesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get images from a Word DOCX document

Returns the images defined in the Word Document (DOCX) format file

Swagger operation ID: EditDocument_DocxGetImages.

Parameters:

Name Type Description Default
input GetDocxImagesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_pages async
edit_document_docx_pages(input: GetDocxPagesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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

Swagger operation ID: EditDocument_DocxPages.

Parameters:

Name Type Description Default
input GetDocxPagesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_get_sections async
edit_document_docx_get_sections(input: GetDocxSectionsRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get sections from a Word DOCX document

Returns the sections defined in the Word Document (DOCX) format file

Swagger operation ID: EditDocument_DocxGetSections.

Parameters:

Name Type Description Default
input GetDocxSectionsRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_get_styles async
edit_document_docx_get_styles(input: GetDocxStylesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get styles from a Word DOCX document

Returns the styles defined in the Word Document (DOCX) format file

Swagger operation ID: EditDocument_DocxGetStyles.

Parameters:

Name Type Description Default
input GetDocxStylesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_get_table_row async
edit_document_docx_get_table_row(input: GetDocxTableRowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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.

Swagger operation ID: EditDocument_DocxGetTableRow.

Parameters:

Name Type Description Default
input GetDocxTableRowRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_get_table_by_index async
edit_document_docx_get_table_by_index(input: GetDocxTableByIndexRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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)

Swagger operation ID: EditDocument_DocxGetTableByIndex.

Parameters:

Name Type Description Default
input GetDocxTableByIndexRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_get_tables async
edit_document_docx_get_tables(input: GetDocxTablesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get all tables in Word DOCX document

Returns all the table objects in an Office Word Document (docx)

Swagger operation ID: EditDocument_DocxGetTables.

Parameters:

Name Type Description Default
input GetDocxTablesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_insert_comment_on_paragraph async
edit_document_docx_insert_comment_on_paragraph(input: DocxInsertCommentOnParagraphRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxInsertCommentOnParagraph.

Parameters:

Name Type Description Default
input DocxInsertCommentOnParagraphRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_insert_image async
edit_document_docx_insert_image(input: DocxInsertImageRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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.

Swagger operation ID: EditDocument_DocxInsertImage.

Parameters:

Name Type Description Default
input DocxInsertImageRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_insert_paragraph async
edit_document_docx_insert_paragraph(input: InsertDocxInsertParagraphRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxInsertParagraph.

Parameters:

Name Type Description Default
input InsertDocxInsertParagraphRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_insert_table async
edit_document_docx_insert_table(input: InsertDocxTablesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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.

Swagger operation ID: EditDocument_DocxInsertTable.

Parameters:

Name Type Description Default
input InsertDocxTablesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_insert_table_row async
edit_document_docx_insert_table_row(input: InsertDocxTableRowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxInsertTableRow.

Parameters:

Name Type Description Default
input InsertDocxTableRowRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_remove_headers_and_footers async
edit_document_docx_remove_headers_and_footers(input: RemoveDocxHeadersAndFootersRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxRemoveHeadersAndFooters.

Parameters:

Name Type Description Default
input RemoveDocxHeadersAndFootersRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_remove_object async
edit_document_docx_remove_object(input: DocxRemoveObjectRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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.

Swagger operation ID: EditDocument_DocxRemoveObject.

Parameters:

Name Type Description Default
input DocxRemoveObjectRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_replace async
edit_document_docx_replace(input: ReplaceStringRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Replace string in Word DOCX document

Replace all instances of a string in an Office Word Document (docx)

Swagger operation ID: EditDocument_DocxReplace.

Parameters:

Name Type Description Default
input ReplaceStringRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_set_footer(input: DocxSetFooterRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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.

Swagger operation ID: EditDocument_DocxSetFooter.

Parameters:

Name Type Description Default
input DocxSetFooterRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_set_footer_add_page_number(input: DocxSetFooterAddPageNumberRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxSetFooterAddPageNumber.

Parameters:

Name Type Description Default
input DocxSetFooterAddPageNumberRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_set_header async
edit_document_docx_set_header(input: DocxSetHeaderRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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.

Swagger operation ID: EditDocument_DocxSetHeader.

Parameters:

Name Type Description Default
input DocxSetHeaderRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_update_table_cell async
edit_document_docx_update_table_cell(input: UpdateDocxTableCellRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxUpdateTableCell.

Parameters:

Name Type Description Default
input UpdateDocxTableCellRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_docx_update_table_row async
edit_document_docx_update_table_row(input: UpdateDocxTableRowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_DocxUpdateTableRow.

Parameters:

Name Type Description Default
input UpdateDocxTableRowRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_finish_editing async
edit_document_finish_editing(input: FinishEditingRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

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.

Swagger operation ID: EditDocument_FinishEditing.

Parameters:

Name Type Description Default
input FinishEditingRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_pptx_delete_slides async
edit_document_pptx_delete_slides(input: RemovePptxSlidesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Delete, remove slides from a PowerPoint PPTX presentation document

Edits the input PowerPoint PPTX presentation document to remove the specified slides

Swagger operation ID: EditDocument_PptxDeleteSlides.

Parameters:

Name Type Description Default
input RemovePptxSlidesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_pptx_replace async
edit_document_pptx_replace(input: ReplaceStringRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Replace string in PowerPoint PPTX presentation

Replace all instances of a string in an Office PowerPoint Document (pptx)

Swagger operation ID: EditDocument_PptxReplace.

Parameters:

Name Type Description Default
input ReplaceStringRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_clear_cell_by_index async
edit_document_xlsx_clear_cell_by_index(input: ClearXlsxCellRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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

Swagger operation ID: EditDocument_XlsxClearCellByIndex.

Parameters:

Name Type Description Default
input ClearXlsxCellRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_create_blank_spreadsheet async
edit_document_xlsx_create_blank_spreadsheet(input: CreateBlankSpreadsheetRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a blank Excel XLSX spreadsheet

Returns a blank Excel XLSX Spreadsheet (XLSX) format file

Swagger operation ID: EditDocument_XlsxCreateBlankSpreadsheet.

Parameters:

Name Type Description Default
input CreateBlankSpreadsheetRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_create_spreadsheet_from_data async
edit_document_xlsx_create_spreadsheet_from_data(input: CreateSpreadsheetFromDataRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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

Swagger operation ID: EditDocument_XlsxCreateSpreadsheetFromData.

Parameters:

Name Type Description Default
input CreateSpreadsheetFromDataRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_delete_worksheet async
edit_document_xlsx_delete_worksheet(input: RemoveXlsxWorksheetRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: EditDocument_XlsxDeleteWorksheet.

Parameters:

Name Type Description Default
input RemoveXlsxWorksheetRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_get_cell_by_identifier async
edit_document_xlsx_get_cell_by_identifier(input: GetXlsxCellByIdentifierRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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

Swagger operation ID: EditDocument_XlsxGetCellByIdentifier.

Parameters:

Name Type Description Default
input GetXlsxCellByIdentifierRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_get_cell_by_index async
edit_document_xlsx_get_cell_by_index(input: GetXlsxCellRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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

Swagger operation ID: EditDocument_XlsxGetCellByIndex.

Parameters:

Name Type Description Default
input GetXlsxCellRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_get_columns async
edit_document_xlsx_get_columns(input: GetXlsxColumnsRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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

Swagger operation ID: EditDocument_XlsxGetColumns.

Parameters:

Name Type Description Default
input GetXlsxColumnsRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_get_images async
edit_document_xlsx_get_images(input: GetXlsxImagesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get images from a Excel XLSX spreadsheet, worksheet

Returns the images defined in the Excel Spreadsheet worksheet

Swagger operation ID: EditDocument_XlsxGetImages.

Parameters:

Name Type Description Default
input GetXlsxImagesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_get_rows_and_cells async
edit_document_xlsx_get_rows_and_cells(input: GetXlsxRowsAndCellsRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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

Swagger operation ID: EditDocument_XlsxGetRowsAndCells.

Parameters:

Name Type Description Default
input GetXlsxRowsAndCellsRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_get_styles async
edit_document_xlsx_get_styles(input: GetXlsxStylesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get styles from a Excel XLSX spreadsheet, worksheet

Returns the style defined in the Excel Spreadsheet

Swagger operation ID: EditDocument_XlsxGetStyles.

Parameters:

Name Type Description Default
input GetXlsxStylesRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_get_worksheets async
edit_document_xlsx_get_worksheets(input: GetXlsxWorksheetsRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get worksheets from a Excel XLSX spreadsheet

Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file

Swagger operation ID: EditDocument_XlsxGetWorksheets.

Parameters:

Name Type Description Default
input GetXlsxWorksheetsRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_insert_worksheet async
edit_document_xlsx_insert_worksheet(input: InsertXlsxWorksheetRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Insert a new worksheet into an Excel XLSX spreadsheet

Inserts a new worksheet into an Excel Spreadsheet

Swagger operation ID: EditDocument_XlsxInsertWorksheet.

Parameters:

Name Type Description Default
input InsertXlsxWorksheetRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_set_cell_by_identifier async
edit_document_xlsx_set_cell_by_identifier(input: SetXlsxCellByIdentifierRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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

Swagger operation ID: EditDocument_XlsxSetCellByIdentifier.

Parameters:

Name Type Description Default
input SetXlsxCellByIdentifierRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

edit_document_xlsx_set_cell_by_index async
edit_document_xlsx_set_cell_by_index(input: SetXlsxCellRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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

Swagger operation ID: EditDocument_XlsxSetCellByIndex.

Parameters:

Name Type Description Default
input SetXlsxCellRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_web_html_to_docx async
convert_web_html_to_docx(input: HtmlToOfficeRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert HTML to Word DOCX Document

Convert HTML to Office Word Document (DOCX) format

Swagger operation ID: ConvertWeb_HtmlToDocx.

Parameters:

Name Type Description Default
input HtmlToOfficeRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_html_to_pdf async
convert_document_html_to_pdf(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert HTML document file to PDF Document

Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.

Swagger operation ID: ConvertDocument_HtmlToPdf.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_html_to_png async
convert_document_html_to_png(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert HTML document file to PNG image array

Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.

Swagger operation ID: ConvertDocument_HtmlToPng.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_html_to_txt async
convert_document_html_to_txt(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

HTML Document file to Text (txt)

HTML document to text

Swagger operation ID: ConvertDocument_HtmlToTxt.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_image_multipage_image_format_convert async
convert_image_multipage_image_format_convert(format1: str, format2: str, input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Multi-page image format conversion

Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).

Swagger operation ID: ConvertImage_MultipageImageFormatConvert.

Parameters:

Name Type Description Default
format1 str

Input file format as a 3+ letter file extension. You can also provide.

required
format2 str

Output (convert to this format) file format as a 3+ letter file extens.

required
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_image_get_image_info async
convert_image_get_image_info(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get information about an image

Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more

Swagger operation ID: ConvertImage_GetImageInfo.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_image_image_set_dpi async
convert_image_image_set_dpi(dpi: int, input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Change image DPI

Resize an image to have a different DPI

Swagger operation ID: ConvertImage_ImageSetDPI.

Parameters:

Name Type Description Default
dpi int

New DPI in pixels-per-inch, for example 300 DPI or 600 DPI.

required
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_image_image_format_convert async
convert_image_image_format_convert(format1: str, format2: str, input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Image format conversion

Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.

Swagger operation ID: ConvertImage_ImageFormatConvert.

Parameters:

Name Type Description Default
format1 str

Input file format as a 3+ letter file extension. You can also provide.

required
format2 str

Output (convert to this format) file format as a 3+ letter file extens.

required
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_json_to_xml async
convert_data_json_to_xml(input: ConvertDataJsonToXmlInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert JSON to XML conversion

Convert a JSON object into XML

Swagger operation ID: ConvertData_JsonToXml.

Parameters:

Name Type Description Default
input ConvertDataJsonToXmlInput | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_docx async
merge_document_docx(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Two Word DOCX Together

Combine two Office Word Documents (docx) into one single Office Word document

Swagger operation ID: MergeDocument_Docx.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on (more than 2 can be supplied).

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_docx_multi async
merge_document_docx_multi(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, input_file3: Optional[MultipartFile | bytes] = None, input_file4: Optional[MultipartFile | bytes] = None, input_file5: Optional[MultipartFile | bytes] = None, input_file6: Optional[MultipartFile | bytes] = None, input_file7: Optional[MultipartFile | bytes] = None, input_file8: Optional[MultipartFile | bytes] = None, input_file9: Optional[MultipartFile | bytes] = None, input_file10: Optional[MultipartFile | bytes] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Multple Word DOCX Together

Combine multiple Office Word Documents (docx) into one single Office Word document

Swagger operation ID: MergeDocument_DocxMulti.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on.

required
input_file3 Optional[MultipartFile | bytes]

Third input file to perform the operation on.

None
input_file4 Optional[MultipartFile | bytes]

Fourth input file to perform the operation on.

None
input_file5 Optional[MultipartFile | bytes]

Fifth input file to perform the operation on.

None
input_file6 Optional[MultipartFile | bytes]

Sixth input file to perform the operation on.

None
input_file7 Optional[MultipartFile | bytes]

Seventh input file to perform the operation on.

None
input_file8 Optional[MultipartFile | bytes]

Eighth input file to perform the operation on.

None
input_file9 Optional[MultipartFile | bytes]

Ninth input file to perform the operation on.

None
input_file10 Optional[MultipartFile | bytes]

Tenth input file to perform the operation on.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_pdf async
merge_document_pdf(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Two PDF Files Together

Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Swagger operation ID: MergeDocument_Pdf.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on (more than 2 can be supplied).

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_pdf_multi async
merge_document_pdf_multi(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, input_file3: Optional[MultipartFile | bytes] = None, input_file4: Optional[MultipartFile | bytes] = None, input_file5: Optional[MultipartFile | bytes] = None, input_file6: Optional[MultipartFile | bytes] = None, input_file7: Optional[MultipartFile | bytes] = None, input_file8: Optional[MultipartFile | bytes] = None, input_file9: Optional[MultipartFile | bytes] = None, input_file10: Optional[MultipartFile | bytes] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Multple PDF Files Together

Combine multiple PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Swagger operation ID: MergeDocument_PdfMulti.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on.

required
input_file3 Optional[MultipartFile | bytes]

Third input file to perform the operation on.

None
input_file4 Optional[MultipartFile | bytes]

Fourth input file to perform the operation on.

None
input_file5 Optional[MultipartFile | bytes]

Fifth input file to perform the operation on.

None
input_file6 Optional[MultipartFile | bytes]

Sixth input file to perform the operation on.

None
input_file7 Optional[MultipartFile | bytes]

Seventh input file to perform the operation on.

None
input_file8 Optional[MultipartFile | bytes]

Eighth input file to perform the operation on.

None
input_file9 Optional[MultipartFile | bytes]

Ninth input file to perform the operation on.

None
input_file10 Optional[MultipartFile | bytes]

Tenth input file to perform the operation on.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_png async
merge_document_png(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Multple PNG Files Together

Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Swagger operation ID: MergeDocument_Png.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on (more than 2 can be supplied).

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_pptx async
merge_document_pptx(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Two PowerPoint PPTX Together

Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Swagger operation ID: MergeDocument_Pptx.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on (more than 2 can be supplied).

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_pptx_multi async
merge_document_pptx_multi(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, input_file3: Optional[MultipartFile | bytes] = None, input_file4: Optional[MultipartFile | bytes] = None, input_file5: Optional[MultipartFile | bytes] = None, input_file6: Optional[MultipartFile | bytes] = None, input_file7: Optional[MultipartFile | bytes] = None, input_file8: Optional[MultipartFile | bytes] = None, input_file9: Optional[MultipartFile | bytes] = None, input_file10: Optional[MultipartFile | bytes] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Multple PowerPoint PPTX Together

Combine multiple Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Swagger operation ID: MergeDocument_PptxMulti.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on.

required
input_file3 Optional[MultipartFile | bytes]

Third input file to perform the operation on.

None
input_file4 Optional[MultipartFile | bytes]

Fourth input file to perform the operation on.

None
input_file5 Optional[MultipartFile | bytes]

Fifth input file to perform the operation on.

None
input_file6 Optional[MultipartFile | bytes]

Sixth input file to perform the operation on.

None
input_file7 Optional[MultipartFile | bytes]

Seventh input file to perform the operation on.

None
input_file8 Optional[MultipartFile | bytes]

Eighth input file to perform the operation on.

None
input_file9 Optional[MultipartFile | bytes]

Ninth input file to perform the operation on.

None
input_file10 Optional[MultipartFile | bytes]

Tenth input file to perform the operation on.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_txt async
merge_document_txt(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Merge Two Text (TXT) Files Together

Combine two Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

Swagger operation ID: MergeDocument_Txt.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on (more than 2 can be supplied).

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_txt_multi async
merge_document_txt_multi(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, input_file3: Optional[MultipartFile | bytes] = None, input_file4: Optional[MultipartFile | bytes] = None, input_file5: Optional[MultipartFile | bytes] = None, input_file6: Optional[MultipartFile | bytes] = None, input_file7: Optional[MultipartFile | bytes] = None, input_file8: Optional[MultipartFile | bytes] = None, input_file9: Optional[MultipartFile | bytes] = None, input_file10: Optional[MultipartFile | bytes] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Multple Text (TXT) Files Together

Combine multiple Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

Swagger operation ID: MergeDocument_TxtMulti.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on.

required
input_file3 Optional[MultipartFile | bytes]

Third input file to perform the operation on.

None
input_file4 Optional[MultipartFile | bytes]

Fourth input file to perform the operation on.

None
input_file5 Optional[MultipartFile | bytes]

Fifth input file to perform the operation on.

None
input_file6 Optional[MultipartFile | bytes]

Sixth input file to perform the operation on.

None
input_file7 Optional[MultipartFile | bytes]

Seventh input file to perform the operation on.

None
input_file8 Optional[MultipartFile | bytes]

Eighth input file to perform the operation on.

None
input_file9 Optional[MultipartFile | bytes]

Ninth input file to perform the operation on.

None
input_file10 Optional[MultipartFile | bytes]

Tenth input file to perform the operation on.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_xlsx async
merge_document_xlsx(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Two Excel XLSX Together

Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Swagger operation ID: MergeDocument_Xlsx.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on (more than 2 can be supplied).

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

merge_document_xlsx_multi async
merge_document_xlsx_multi(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, input_file3: Optional[MultipartFile | bytes] = None, input_file4: Optional[MultipartFile | bytes] = None, input_file5: Optional[MultipartFile | bytes] = None, input_file6: Optional[MultipartFile | bytes] = None, input_file7: Optional[MultipartFile | bytes] = None, input_file8: Optional[MultipartFile | bytes] = None, input_file9: Optional[MultipartFile | bytes] = None, input_file10: Optional[MultipartFile | bytes] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Multple Excel XLSX Together

Combine multiple Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Swagger operation ID: MergeDocument_XlsxMulti.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on.

required
input_file3 Optional[MultipartFile | bytes]

Third input file to perform the operation on.

None
input_file4 Optional[MultipartFile | bytes]

Fourth input file to perform the operation on.

None
input_file5 Optional[MultipartFile | bytes]

Fifth input file to perform the operation on.

None
input_file6 Optional[MultipartFile | bytes]

Sixth input file to perform the operation on.

None
input_file7 Optional[MultipartFile | bytes]

Seventh input file to perform the operation on.

None
input_file8 Optional[MultipartFile | bytes]

Eighth input file to perform the operation on.

None
input_file9 Optional[MultipartFile | bytes]

Ninth input file to perform the operation on.

None
input_file10 Optional[MultipartFile | bytes]

Tenth input file to perform the operation on.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_pdf_to_docx async
convert_document_pdf_to_docx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert PDF to Word DOCX Document

Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.

Swagger operation ID: ConvertDocument_PdfToDocx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_pdf_to_docx_rasterize async
convert_document_pdf_to_docx_rasterize(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert PDF to Word DOCX Document based on rasterized version of the PDF

Convert standard PDF to Office Word Documents (docx), but first rasterize the PDF. Converts a PDF at high fidelity into Word format.

Swagger operation ID: ConvertDocument_PdfToDocxRasterize.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_pdf_to_png_array async
convert_document_pdf_to_png_array(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert PDF to PNG Image Array

Convert PDF document to PNG array, one image per page.

Swagger operation ID: ConvertDocument_PdfToPngArray.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_pdf_to_png_single async
convert_document_pdf_to_png_single(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert PDF to Single PNG image

Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single "tall" image

Swagger operation ID: ConvertDocument_PdfToPngSingle.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_pdf_to_pptx async
convert_document_pdf_to_pptx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert PDF to PowerPoint PPTX Presentation

Convert standard PDF to Office PowerPoint Presentation (pptx). Converts a PDF file at high fidelity into PowerPoint format, where it can be easily edited and processed.

Swagger operation ID: ConvertDocument_PdfToPptx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_pdf_to_txt async
convert_document_pdf_to_txt(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert PDF Document to Text (txt)

PDF document to text

Swagger operation ID: ConvertDocument_PdfToTxt.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_png_array_to_pdf async
convert_document_png_array_to_pdf(input_file1: MultipartFile | bytes, input_file2: MultipartFile | bytes, *, input_file3: Optional[MultipartFile | bytes] = None, input_file4: Optional[MultipartFile | bytes] = None, input_file5: Optional[MultipartFile | bytes] = None, input_file6: Optional[MultipartFile | bytes] = None, input_file7: Optional[MultipartFile | bytes] = None, input_file8: Optional[MultipartFile | bytes] = None, input_file9: Optional[MultipartFile | bytes] = None, input_file10: Optional[MultipartFile | bytes] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert PNG Array to PDF

Convert an array of PNG images, one image per page, into a newly-created PDF. Supports images of different sizes as input.

Swagger operation ID: ConvertDocument_PngArrayToPdf.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input file to perform the operation on.

required
input_file2 MultipartFile | bytes

Second input file to perform the operation on.

required
input_file3 Optional[MultipartFile | bytes]

Third input file to perform the operation on.

None
input_file4 Optional[MultipartFile | bytes]

Fourth input file to perform the operation on.

None
input_file5 Optional[MultipartFile | bytes]

Fifth input file to perform the operation on.

None
input_file6 Optional[MultipartFile | bytes]

Sixth input file to perform the operation on.

None
input_file7 Optional[MultipartFile | bytes]

Seventh input file to perform the operation on.

None
input_file8 Optional[MultipartFile | bytes]

Eighth input file to perform the operation on.

None
input_file9 Optional[MultipartFile | bytes]

Ninth input file to perform the operation on.

None
input_file10 Optional[MultipartFile | bytes]

Tenth input file to perform the operation on.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_ppt_to_pdf async
convert_document_ppt_to_pdf(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert PowerPoint PPT (97-03) Presentation to PDF

Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF

Swagger operation ID: ConvertDocument_PptToPdf.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_ppt_to_pptx async
convert_document_ppt_to_pptx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert PowerPoint PPT (97-03) Presentation to PPTX

Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX

Swagger operation ID: ConvertDocument_PptToPptx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_pptx_to_pdf async
convert_document_pptx_to_pdf(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert PowerPoint PPTX Presentation to PDF

Convert Office PowerPoint Documents (pptx) to standard PDF

Swagger operation ID: ConvertDocument_PptxToPdf.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_pptx_to_txt async
convert_document_pptx_to_txt(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert PowerPoint PPTX Presentation to Text (txt)

Convert Office PowerPoint Documents (pptx) to standard Text

Swagger operation ID: ConvertDocument_PptxToTxt.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

split_document_docx async
split_document_docx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Split a single Word Document DOCX into Separate Documents by Page

Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.

Swagger operation ID: SplitDocument_Docx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

split_document_pdf_by_page async
split_document_pdf_by_page(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Split a PDF file into separate PDF files, one per page

Split an input PDF file into separate pages, comprised of one PDF file per page.

Swagger operation ID: SplitDocument_PdfByPage.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

split_document_pptx async
split_document_pptx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Split a single PowerPoint Presentation PPTX into Separate Slides

Split an PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentation files, with each containing exactly one slide.

Swagger operation ID: SplitDocument_Pptx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

split_document_txt_by_line async
split_document_txt_by_line(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Split a single Text file (txt) into lines

Split a Text (txt) Document by line, returning each line separately in order. Supports multiple types of newlines.

Swagger operation ID: SplitDocument_TxtByLine.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

split_document_txt_by_string async
split_document_txt_by_string(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Split a single Text file (txt) by a string delimiter

Split a Text (txt) Document by a string delimiter, returning each component of the string as an array of strings.

Swagger operation ID: SplitDocument_TxtByString.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

split_document_xlsx async
split_document_xlsx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Split a single Excel XLSX into Separate Worksheets

Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.

Swagger operation ID: SplitDocument_Xlsx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_template_apply_html_template async
convert_template_apply_html_template(input: HtmlTemplateApplicationRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Apply HTML template

Apply operations to fill in an HTML template, generating a final HTML result

Swagger operation ID: ConvertTemplate_ApplyHtmlTemplate.

Parameters:

Name Type Description Default
input HtmlTemplateApplicationRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

validate_document_autodetect_validation async
validate_document_autodetect_validation(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Autodetect content type and validate

Automatically detect the type of content, verify and validate that the content is indeed fully valid at depth, and then report the validation result.

Swagger operation ID: ValidateDocument_AutodetectValidation.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

validate_document_docx_validation async
validate_document_docx_validation(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Validate a Word document (DOCX)

Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document

Swagger operation ID: ValidateDocument_DocxValidation.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

validate_document_json_validation async
validate_document_json_validation(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Validate a JSON file

Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document

Swagger operation ID: ValidateDocument_JsonValidation.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

validate_document_pdf_validation async
validate_document_pdf_validation(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Validate a PDF document file

Validate a PDF document; if the document is not valid, identifies the errors in the document

Swagger operation ID: ValidateDocument_PdfValidation.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

validate_document_pptx_validation async
validate_document_pptx_validation(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Validate a PowerPoint presentation (PPTX)

Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document

Swagger operation ID: ValidateDocument_PptxValidation.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

validate_document_xlsx_validation async
validate_document_xlsx_validation(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Validate a Excel document (XLSX)

Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document

Swagger operation ID: ValidateDocument_XlsxValidation.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

validate_document_xml_validation async
validate_document_xml_validation(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Validate an XML file

Validate an XML document file; if the document is not valid, identifies the errors in the document

Swagger operation ID: ValidateDocument_XmlValidation.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_web_html_to_pdf async
convert_web_html_to_pdf(input: HtmlToPdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

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.

Swagger operation ID: ConvertWeb_HtmlToPdf.

Parameters:

Name Type Description Default
input HtmlToPdfRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_web_html_to_png async
convert_web_html_to_png(input: HtmlToPngRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

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.

Swagger operation ID: ConvertWeb_HtmlToPng.

Parameters:

Name Type Description Default
input HtmlToPngRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_web_html_to_txt async
convert_web_html_to_txt(input: HtmlToTextRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert HTML string to text (txt)

Converts an HTML string input into text (txt); extracts text from HTML

Swagger operation ID: ConvertWeb_HtmlToTxt.

Parameters:

Name Type Description Default
input HtmlToTextRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_web_md_to_html async
convert_web_md_to_html(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert Markdown to HTML

Convert a markdown file (.md) to HTML

Swagger operation ID: ConvertWeb_MdToHtml.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_web_url_to_pdf async
convert_web_url_to_pdf(input: ScreenshotRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

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.

Swagger operation ID: ConvertWeb_UrlToPdf.

Parameters:

Name Type Description Default
input ScreenshotRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_web_url_to_screenshot async
convert_web_url_to_screenshot(input: ScreenshotRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

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.

Swagger operation ID: ConvertWeb_UrlToScreenshot.

Parameters:

Name Type Description Default
input ScreenshotRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_web_url_to_txt async
convert_web_url_to_txt(input: UrlToTextRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert website URL page to text (txt)

Converts a website URL page into text (txt); extracts text from HTML

Swagger operation ID: ConvertWeb_UrlToTxt.

Parameters:

Name Type Description Default
input UrlToTextRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_xls_to_csv async
convert_document_xls_to_csv(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Excel XLS (97-03) Spreadsheet to CSV

Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.

Swagger operation ID: ConvertDocument_XlsToCsv.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xls_to_json async
convert_data_xls_to_json(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert Excel (97-2003) XLS to JSON conversion

Convert an Excel (97-2003) XLS file to a JSON object array

Swagger operation ID: ConvertData_XlsToJson.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_xls_to_pdf async
convert_document_xls_to_pdf(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Excel XLS (97-03) Spreadsheet to PDF

Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.

Swagger operation ID: ConvertDocument_XlsToPdf.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_xls_to_xlsx async
convert_document_xls_to_xlsx(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Excel XLS (97-03) Spreadsheet to XLSX

Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.

Swagger operation ID: ConvertDocument_XlsToXlsx.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_xlsx_to_csv async
convert_document_xlsx_to_csv(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Excel XLSX Spreadsheet to CSV

Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.

Swagger operation ID: ConvertDocument_XlsxToCsv.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xlsx_to_json async
convert_data_xlsx_to_json(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert Excel XLSX to JSON conversion

Convert an Excel XLSX file to a JSON object array

Swagger operation ID: ConvertData_XlsxToJson.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_xlsx_to_pdf async
convert_document_xlsx_to_pdf(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert Excel XLSX Spreadsheet to PDF

Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.

Swagger operation ID: ConvertDocument_XlsxToPdf.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Name Type Description
bytes bytes

The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_document_xlsx_to_txt async
convert_document_xlsx_to_txt(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert Excel XLSX Spreadsheet to Text (txt)

Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.

Swagger operation ID: ConvertDocument_XlsxToTxt.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_edit_add_attribute_with_x_path async
convert_data_xml_edit_add_attribute_with_x_path(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Adds an attribute to all XML nodes matching XPath expression

Return the reuslts of editing an XML document by adding an attribute to all of the nodes that match an input XPath expression.

Swagger operation ID: ConvertData_XmlEditAddAttributeWithXPath.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input XML file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_edit_add_child_with_x_path async
convert_data_xml_edit_add_child_with_x_path(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Adds an XML node as a child to XML nodes matching XPath expression

Return the reuslts of editing an XML document by adding an XML node as a child to all of the nodes that match an input XPath expression.

Swagger operation ID: ConvertData_XmlEditAddChildWithXPath.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input XML file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_remove_with_x_path async
convert_data_xml_remove_with_x_path(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Remove, delete XML nodes and items matching XPath expression

Return the reuslts of editing an XML document by removing all of the nodes that match an input XPath expression

Swagger operation ID: ConvertData_XmlRemoveWithXPath.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_edit_remove_all_child_nodes_with_x_path async
convert_data_xml_edit_remove_all_child_nodes_with_x_path(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Removes, deletes all children of nodes matching XPath expression, but

Return the reuslts of editing an XML document by removing all child nodes of the nodes that match an input XPath expression.

Swagger operation ID: ConvertData_XmlEditRemoveAllChildNodesWithXPath.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input XML file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_edit_replace_with_x_path async
convert_data_xml_edit_replace_with_x_path(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Replaces XML nodes matching XPath expression with new node

Return the reuslts of editing an XML document by replacing all of the nodes that match an input XPath expression with a new XML node expression.

Swagger operation ID: ConvertData_XmlEditReplaceWithXPath.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input XML file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_edit_set_value_with_x_path async
convert_data_xml_edit_set_value_with_x_path(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Sets the value contents of XML nodes matching XPath expression

Return the reuslts of editing an XML document by setting the contents of all of the nodes that match an input XPath expression. Supports elements and attributes.

Swagger operation ID: ConvertData_XmlEditSetValueWithXPath.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input XML file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_query_with_x_query async
convert_data_xml_query_with_x_query(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Query an XML file using XQuery query, get results

Return the reuslts of querying a single XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for a single XML document as input. Provided XML document is automatically loaded as the default context; to access elements in the document, simply refer to them without a document reference, such as bookstore/book

Swagger operation ID: ConvertData_XmlQueryWithXQuery.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input XML file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_query_with_x_query_multi async
convert_data_xml_query_with_x_query_multi(input_file1: MultipartFile | bytes, *, input_file2: Optional[MultipartFile | bytes] = None, input_file3: Optional[MultipartFile | bytes] = None, input_file4: Optional[MultipartFile | bytes] = None, input_file5: Optional[MultipartFile | bytes] = None, input_file6: Optional[MultipartFile | bytes] = None, input_file7: Optional[MultipartFile | bytes] = None, input_file8: Optional[MultipartFile | bytes] = None, input_file9: Optional[MultipartFile | bytes] = None, input_file10: Optional[MultipartFile | bytes] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Query multiple XML files using XQuery query, get results

Return the reuslts of querying an XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for multiple XML documents as input. You can refer to the contents of a given document by name, for example doc("books.xml") or doc("restaurants.xml") if you included two input files named books.xml and restaurants.xml. If input files contain no file name, they will default to file names input1.xml, input2.xml and so on.

Swagger operation ID: ConvertData_XmlQueryWithXQueryMulti.

Parameters:

Name Type Description Default
input_file1 MultipartFile | bytes

First input XML file to perform the operation on.

required
input_file2 Optional[MultipartFile | bytes]

Second input XML file to perform the operation on.

None
input_file3 Optional[MultipartFile | bytes]

Third input XML file to perform the operation on.

None
input_file4 Optional[MultipartFile | bytes]

Fourth input XML file to perform the operation on.

None
input_file5 Optional[MultipartFile | bytes]

Fifth input XML file to perform the operation on.

None
input_file6 Optional[MultipartFile | bytes]

Sixth input XML file to perform the operation on.

None
input_file7 Optional[MultipartFile | bytes]

Seventh input XML file to perform the operation on.

None
input_file8 Optional[MultipartFile | bytes]

Eighth input XML file to perform the operation on.

None
input_file9 Optional[MultipartFile | bytes]

Ninth input XML file to perform the operation on.

None
input_file10 Optional[MultipartFile | bytes]

Tenth input XML file to perform the operation on.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_filter_with_x_path async
convert_data_xml_filter_with_x_path(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Filter, select XML nodes using XPath expression, get results

Return the reuslts of filtering, selecting an XML document with an XPath expression

Swagger operation ID: ConvertData_XmlFilterWithXPath.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_to_json async
convert_data_xml_to_json(input_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Convert XML to JSON conversion

Convert an XML string or file into JSON

Swagger operation ID: ConvertData_XmlToJson.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input file to perform the operation on.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

convert_data_xml_transform_with_xslt_to_xml async
convert_data_xml_transform_with_xslt_to_xml(input_file: MultipartFile | bytes, transform_file: MultipartFile | bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Transform XML document file with XSLT into a new XML document

Convert an XML string or file into JSON

Swagger operation ID: ConvertData_XmlTransformWithXsltToXml.

Parameters:

Name Type Description Default
input_file MultipartFile | bytes

Input XML file to perform the operation on.

required
transform_file MultipartFile | bytes

Input XSLT file to use to transform the input XML file.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.