PlumsailClient

Attributes

TRIGGER_OPERATIONS `module-attribute`

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'FlowV1ProcessesFlowTriggersPost': {'operation_id': 'FlowV1ProcessesFlowTriggersPost', 'path': '/{connectionId}/flow/v1/ProcessesFlow/triggers', 'method': 'post', 'required_parameters': ['data'], 'callback_payload_type': None}}

Classes

ProfileInfo `dataclass`

ProfileInfo(*, name: Optional[str] = None, email: Optional[str] = None, license_status: Optional[str] = None, team_name: Optional[str] = None, license_info: Optional[LicenseInfo | Mapping[str, Any]] = None, short_user_id: Optional[str] = None)

Response for Get Profile Info

DocumentProcessingResponse `dataclass`

DocumentProcessingResponse(*, file_content: Optional[str] = None)

Response for Create document from PPTX template

Attributes

file_content `class-attribute` `instance-attribute`

file_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileContent'})

The result as a file

ApplyHtmlTemplateResponse `dataclass`

ApplyHtmlTemplateResponse(*, html_result: Optional[str] = None)

Response for Create HTML from template

Attributes

html_result `class-attribute` `instance-attribute`

html_result: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'htmlResult'})

Raw HTML result

FlowDocumentsJobsSplitPdfInput `dataclass`

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

Split PDF

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

DocumentsWithFilenamesResponse `dataclass`

DocumentsWithFilenamesResponse(*, result_files: Optional[List[DocumentContentWithFilenameResponse | Mapping[str, Any]]] = None)

Response for Split PDF

Attributes

result_files `class-attribute` `instance-attribute`

result_files: Optional[List[DocumentContentWithFilenameResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resultFiles'})

Array of raw contents of result files with their filenames

FlowDocumentsJobsGetPdfFormPostResponse `dataclass`

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

Response for Get Form from PDF

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

GetPdfProtectionInfoResponse `dataclass`

GetPdfProtectionInfoResponse(*, is_password_protected: Optional[bool] = None)

Response for Get information about PDF protection

FlowDocumentsJobsAddWatermarkToPdfInput `dataclass`

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

Add a watermark to PDF

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

ParseCsvSchemaResponse `dataclass`

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

Response for Parse CSV

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

RegExpMatchSchemaResponseClass `dataclass`

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

Response for Regular Expression Match

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

StringResultResponse `dataclass`

StringResultResponse(*, result: Optional[str] = None)

Response for Regular Expression Replace

BooleanResultResponse `dataclass`

BooleanResultResponse(*, is_success: Optional[bool] = None)

Response for Regular Expression Test

DocumentContentWithFilenameResponse `dataclass`

DocumentContentWithFilenameResponse(*, filename: Optional[str] = None, file_content: Optional[str] = None)

Response for Create Archive

Attributes

filename `class-attribute` `instance-attribute`

filename: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of the file

file_content `class-attribute` `instance-attribute`

file_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileContent'})

File content

FlowProcessesFlowJobsExecuteProcessInput `dataclass`

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

Start document generation process with json

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

AddPowerAutomateWebhookData `dataclass`

AddPowerAutomateWebhookData(process_id: str, hook_url: str)

Definition: AddPowerAutomateWebhookData

Attributes

process_id `class-attribute` `instance-attribute`

process_id: str = dataclass_field(metadata={'wire_name': 'processId'})

Name of the process that, when finished, will trigger the flow

hook_url `class-attribute` `instance-attribute`

hook_url: str = dataclass_field(metadata={'wire_name': 'hookUrl'})

HookUrl

Any2PdfRequest `dataclass`

Any2PdfRequest(document_content: str)

Definition: Any2PdfRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of document that should be converted

ApplyDocxTemplateRequest `dataclass`

ApplyDocxTemplateRequest(document_content: str, data: Dict[str, Any], output_type: str, *, locale: Optional[str] = None, timezone: Optional[str] = None, engine: Optional[str] = None)

Definition: ApplyDocxTemplateRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of the template

data `instance-attribute`

data: Dict[str, Any]

JSON data that should be applied to the template

output_type `class-attribute` `instance-attribute`

output_type: str = dataclass_field(metadata={'wire_name': 'outputType'})

The required document type

locale `class-attribute` `instance-attribute`

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

The locale that will be applyed to the document

timezone `class-attribute` `instance-attribute`

timezone: Optional[str] = dataclass_field(default=None, kw_only=True)

The time zone of the document

engine `class-attribute` `instance-attribute`

engine: Optional[str] = dataclass_field(default=None, kw_only=True)

The engine that will process the template

ApplyHtmlFlowTemplateRequest `dataclass`

ApplyHtmlFlowTemplateRequest(html: str, data: Dict[str, Any], *, locale: Optional[str] = None, timezone: Optional[str] = None)

Definition: ApplyHtmlFlowTemplateRequest

Attributes

html `instance-attribute`

html: str

Text HTML template or HTML file template

data `instance-attribute`

data: Dict[str, Any]

JSON data that should be applied to the template

locale `class-attribute` `instance-attribute`

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

The locale that will be applyed to the document

timezone `class-attribute` `instance-attribute`

timezone: Optional[str] = dataclass_field(default=None, kw_only=True)

The time zone of the document

ApplyPptxTemplateRequest `dataclass`

ApplyPptxTemplateRequest(document_content: str, data: Dict[str, Any], output_type: str, *, locale: Optional[str] = None, timezone: Optional[str] = None)

Definition: ApplyPptxTemplateRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of the template

data `instance-attribute`

data: Dict[str, Any]

JSON data that should be applied to the template

output_type `class-attribute` `instance-attribute`

output_type: str = dataclass_field(metadata={'wire_name': 'outputType'})

The required document type

locale `class-attribute` `instance-attribute`

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

The locale that will be applyed to the document

timezone `class-attribute` `instance-attribute`

timezone: Optional[str] = dataclass_field(default=None, kw_only=True)

The time zone of the document

ApplyXlsxTemplateRequest `dataclass`

ApplyXlsxTemplateRequest(document_content: str, data: Dict[str, Any], output_type: str, *, locale: Optional[str] = None, timezone: Optional[str] = None)

Definition: ApplyXlsxTemplateRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of the template

data `instance-attribute`

data: Dict[str, Any]

JSON data that should be applied to the template

output_type `class-attribute` `instance-attribute`

output_type: str = dataclass_field(metadata={'wire_name': 'outputType'})

The required document type

locale `class-attribute` `instance-attribute`

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

The locale that will be applyed to the document

timezone `class-attribute` `instance-attribute`

timezone: Optional[str] = dataclass_field(default=None, kw_only=True)

The time zone of the document

CompressPdfRequest `dataclass`

CompressPdfRequest(document_content: str, *, lossless_mode: Optional[str] = None, password: Optional[str] = None)

Definition: CompressPdfRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Raw content of PDF document

lossless_mode `class-attribute` `instance-attribute`

lossless_mode: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'losslessMode'})

When disabled, compresses the PDF file more effectively, but with a slight loss of image quality.

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Password to open PDF file

CreateArchiveRequest `dataclass`

CreateArchiveRequest(file_name: str, data: List[FileData | Mapping[str, Any]], *, password: Optional[str] = None)

Definition: CreateArchiveRequest

Attributes

file_name `class-attribute` `instance-attribute`

file_name: str = dataclass_field(metadata={'wire_name': 'fileName'})

Name of the archive without the file extension

data `instance-attribute`

data: List[FileData | Mapping[str, Any]]

Array of documents to add to the archive

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Archive password

Csv2XlsxColumnMapping `dataclass`

Csv2XlsxColumnMapping(csv_column_index_or_name: str, *, xlsx_column_type: Optional[str] = None, xlsx_column_name: Optional[str] = None)

Definition: Csv2XlsxColumnMapping

Attributes

csv_column_index_or_name `class-attribute` `instance-attribute`

csv_column_index_or_name: str = dataclass_field(metadata={'wire_name': 'csvColumnIndexOrName'})

CSV column name or column index (1, 2, etc.)

xlsx_column_type `class-attribute` `instance-attribute`

xlsx_column_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'xlsxColumnType'})

Optional. Column type (ShortDateTime, TwoDecimal, etc.)

xlsx_column_name `class-attribute` `instance-attribute`

xlsx_column_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'xlsxColumnName'})

Optional. Rename CSV column to this name

Csv2XlsxRequest `dataclass`

Csv2XlsxRequest(content: str, *, delimiter: Optional[str] = None, locale: Optional[str] = None, limit: Optional[int] = None, has_header_records: Optional[bool] = None, mappings: Optional[List[Csv2XlsxColumnMapping | Mapping[str, Any]]] = None)

Definition: Csv2XlsxRequest

Attributes

content `instance-attribute`

content: str

Content of CSV document

delimiter `class-attribute` `instance-attribute`

delimiter: Optional[str] = dataclass_field(default=None, kw_only=True)

Delimiter of columns (by default it is just comma)

locale `class-attribute` `instance-attribute`

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

The locale that will be applyed to the document

limit `class-attribute` `instance-attribute`

limit: Optional[int] = dataclass_field(default=None, kw_only=True)

Returns the first "n" rows

has_header_records `class-attribute` `instance-attribute`

has_header_records: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hasHeaderRecords'})

If set to "Yes" then headers will be read from the first line.

mappings `class-attribute` `instance-attribute`

mappings: Optional[List[Csv2XlsxColumnMapping | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Rename headers and specify types for columns.

Doc2DocxRequest `dataclass`

Doc2DocxRequest(document_content: str)

Definition: Doc2DocxRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of document that should be converted

DocumentsArrayResponse `dataclass`

DocumentsArrayResponse(*, result_files_contents: Optional[List[str]] = None)

Definition: DocumentsArrayResponse

Attributes

result_files_contents `class-attribute` `instance-attribute`

result_files_contents: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resultFilesContents'})

The array of raw content of result files

Docx2PdfRequest `dataclass`

Docx2PdfRequest(document_content: str)

Definition: Docx2PdfRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of document that should be converted

Email2PdfRequest `dataclass`

Email2PdfRequest(document_content: str, merge_attachments: bool)

Definition: Email2PdfRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of the email that should be converted

merge_attachments `class-attribute` `instance-attribute`

merge_attachments: bool = dataclass_field(metadata={'wire_name': 'mergeAttachments'})

Whether attachments should be converted to PDF and included in the output file

ExtractArchiveRequest `dataclass`

ExtractArchiveRequest(*, file_content: Optional[str] = None, include_folders: Optional[bool] = None, password: Optional[str] = None)

Definition: ExtractArchiveRequest

Attributes

file_content `class-attribute` `instance-attribute`

file_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileContent'})

Content of archive file

include_folders `class-attribute` `instance-attribute`

include_folders: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'includeFolders'})

If 'true' files contained in the folders will be extracted

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Archive password

FileData `dataclass`

FileData(*, file_name: Optional[str] = None, content: Optional[str] = None)

Definition: FileData

Attributes

file_name `class-attribute` `instance-attribute`

file_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileName'})

File name including the file extension

content `class-attribute` `instance-attribute`

content: Optional[str] = dataclass_field(default=None, kw_only=True)

Content of the document

FillInPdfFormRequest `dataclass`

FillInPdfFormRequest(document_content: str, json_data: Dict[str, Any], *, lock_form_fields: Optional[bool] = None, password: Optional[str] = None)

Definition: FillInPdfFormRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Raw content of PDF document

json_data `class-attribute` `instance-attribute`

json_data: Dict[str, Any] = dataclass_field(metadata={'wire_name': 'jsonData'})

The data that will be used to fill out the form

lock_form_fields `class-attribute` `instance-attribute`

lock_form_fields: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lockFormFields'})

Disable fields editing after filling them

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Password to open PDF file

GetPdfFormRequest `dataclass`

GetPdfFormRequest(document_content: str, *, password: Optional[str] = None)

Definition: GetPdfFormRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Raw content of PDF document

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Password to decrypt document

Html2DocxFlowRequest `dataclass`

Html2DocxFlowRequest(*, file_content: Optional[str] = None, raw_html: Optional[str] = None, html_url: Optional[str] = None, paper_size: Optional[str] = None, orientation: Optional[str] = None, decode_html: Optional[bool] = None, margins: Optional[str] = None)

Definition: Html2DocxFlowRequest

Attributes

file_content `class-attribute` `instance-attribute`

file_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileContent'})

Binary content of the HTML file to convert to DOCX

raw_html `class-attribute` `instance-attribute`

raw_html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'rawHtml'})

HTML Data to convert to DOCX

html_url `class-attribute` `instance-attribute`

html_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'htmlUrl'})

URL to the web page to convert to DOCX

paper_size `class-attribute` `instance-attribute`

paper_size: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'paperSize'})

Can be A4,A5 etc...

orientation `class-attribute` `instance-attribute`

orientation: Optional[str] = dataclass_field(default=None, kw_only=True)

Portrait or Landscape

decode_html `class-attribute` `instance-attribute`

decode_html: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'decodeHtml'})

Whether HTML should be decoded prior to conversion

margins `class-attribute` `instance-attribute`

margins: Optional[str] = dataclass_field(default=None, kw_only=True)

Page margins in pt. The syntax is the same as in CSS. Example: 25 50 75 100.

Html2PdfFlowRequest `dataclass`

Html2PdfFlowRequest(html: str, *, engine: Optional[str] = None, size: Optional[str] = None, orientation: Optional[str] = None, margins: Optional[str] = None, header_html: Optional[str] = None, footer_html: Optional[str] = None)

Definition: Html2PdfFlowRequest

Attributes

html `instance-attribute`

html: str

HTML markup that should be converted to PDF

engine `class-attribute` `instance-attribute`

engine: Optional[str] = dataclass_field(default=None, kw_only=True)

Conversion engine

size `class-attribute` `instance-attribute`

size: Optional[str] = dataclass_field(default=None, kw_only=True)

Can be A4,A5 etc...

orientation `class-attribute` `instance-attribute`

orientation: Optional[str] = dataclass_field(default=None, kw_only=True)

Portrait or Landscape

margins `class-attribute` `instance-attribute`

margins: Optional[str] = dataclass_field(default=None, kw_only=True)

The page margins. The syntax is the same as in CSS. Example: 25 50 75 100.

header_html `class-attribute` `instance-attribute`

header_html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'headerHtml'})

HTML markup that should be added as a header

footer_html `class-attribute` `instance-attribute`

footer_html: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'footerHtml'})

HTML markup that should be added as a footer

Image2PdfRequest `dataclass`

Image2PdfRequest(image_content: List[str], *, image_per_page: Optional[bool] = None)

Definition: Image2PdfRequest

Attributes

image_per_page `class-attribute` `instance-attribute`

image_per_page: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imagePerPage'})

Select "No" if you don't want each image to be on a separate page. Default is "Yes"

image_content `class-attribute` `instance-attribute`

image_content: List[str] = dataclass_field(metadata={'wire_name': 'imageContent'})

Raw content of the image

Json2CsvRequest `dataclass`

Json2CsvRequest(*, content: Optional[str] = None, json_data: Optional[str] = None, locale: Optional[str] = None, path_to_json_array: Optional[str] = None, delimiter: Optional[str] = None)

Definition: Json2CsvRequest

Attributes

content `class-attribute` `instance-attribute`

content: Optional[str] = dataclass_field(default=None, kw_only=True)

Optional. Content of the JSON file

json_data `class-attribute` `instance-attribute`

json_data: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jsonData'})

Optional. JSON data to process

locale `class-attribute` `instance-attribute`

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

The locale that will be applyed to the document

path_to_json_array `class-attribute` `instance-attribute`

path_to_json_array: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pathToJsonArray'})

Dot separated path to array in JSON. E.g.: "data" or "prop1.prop2.prop3"

delimiter `class-attribute` `instance-attribute`

delimiter: Optional[str] = dataclass_field(default=None, kw_only=True)

Delimiter of columns in CSV. Default is comma

Json2XlsxColumnMapping `dataclass`

Json2XlsxColumnMapping(json_property: str, *, xlsx_column_type: Optional[str] = None, xlsx_column_name: Optional[str] = None)

Definition: Json2XlsxColumnMapping

Attributes

json_property `class-attribute` `instance-attribute`

json_property: str = dataclass_field(metadata={'wire_name': 'jsonProperty'})

Name of the JSON property

xlsx_column_type `class-attribute` `instance-attribute`

xlsx_column_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'xlsxColumnType'})

Optional. Column type (ShortDateTime, TwoDecimal, etc.)

xlsx_column_name `class-attribute` `instance-attribute`

xlsx_column_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'xlsxColumnName'})

Optional. Rename JSON property to this name

Json2XlsxRequest `dataclass`

Json2XlsxRequest(*, content: Optional[str] = None, json_data: Optional[str] = None, locale: Optional[str] = None, path_to_json_array: Optional[str] = None, mappings: Optional[List[Json2XlsxColumnMapping | Mapping[str, Any]]] = None)

Definition: Json2XlsxRequest

Attributes

content `class-attribute` `instance-attribute`

content: Optional[str] = dataclass_field(default=None, kw_only=True)

Optional. Content of the JSON file

json_data `class-attribute` `instance-attribute`

json_data: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jsonData'})

Optional. JSON data to process

locale `class-attribute` `instance-attribute`

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

The locale that will be applyed to the document

path_to_json_array `class-attribute` `instance-attribute`

path_to_json_array: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pathToJsonArray'})

Dot separated path to array in JSON. E.g.: "data" or "prop1.prop2.prop3"

mappings `class-attribute` `instance-attribute`

mappings: Optional[List[Json2XlsxColumnMapping | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Rename headers and specify types for columns.

LicenseInfo `dataclass`

LicenseInfo(*, type_: Optional[int] = None, credits: Optional[int] = None, additional_credits: Optional[int] = None, expiration_date: Optional[str] = None)

Definition: LicenseInfo

MergeAny2PdfFileData `dataclass`

MergeAny2PdfFileData(file_name: str, content: str)

Definition: MergeAny2PdfFileData

Attributes

file_name `class-attribute` `instance-attribute`

file_name: str = dataclass_field(metadata={'wire_name': 'fileName'})

Name of the file, including extension

content `instance-attribute`

content: str

Content of the file

MergeAny2PdfRequest `dataclass`

MergeAny2PdfRequest(documents_contents: List[str], *, generate_bookmarks: Optional[bool] = None, preserve_bookmarks: Optional[bool] = None)

Definition: MergeAny2PdfRequest

Attributes

documents_contents `class-attribute` `instance-attribute`

documents_contents: List[str] = dataclass_field(metadata={'wire_name': 'documentsContents'})

The array of raw contents of files to merge

generate_bookmarks `class-attribute` `instance-attribute`

generate_bookmarks: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'generateBookmarks'})

Generate a bookmark for each merged file

preserve_bookmarks `class-attribute` `instance-attribute`

preserve_bookmarks: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'preserveBookmarks'})

Preserve bookmarks from each merged PDF

MergeDocxRequest `dataclass`

MergeDocxRequest(documents_contents: List[str], apply_header_and_footer: bool, *, add_page_break: Optional[bool] = None)

Definition: MergeDocxRequest

Attributes

documents_contents `class-attribute` `instance-attribute`

documents_contents: List[str] = dataclass_field(metadata={'wire_name': 'documentsContents'})

The array of raw content of Docx documents

apply_header_and_footer `class-attribute` `instance-attribute`

apply_header_and_footer: bool = dataclass_field(metadata={'wire_name': 'applyHeaderAndFooter'})

Applies the header and footer from the first document to all the others. Ignored when "Add page break" is No (forces Yes).

add_page_break `class-attribute` `instance-attribute`

add_page_break: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'addPageBreak'})

Adds page breaks between merged documents.

MergeFieldsTemplateRequest `dataclass`

MergeFieldsTemplateRequest(docx_document: str, data: Dict[str, Any])

Definition: MergeFieldsTemplateRequest

Attributes

docx_document `class-attribute` `instance-attribute`

docx_document: str = dataclass_field(metadata={'wire_name': 'docxDocument'})

Raw content of docx document template. MergeField names should be the same as keys in template data

data `instance-attribute`

data: Dict[str, Any]

JSON data that should be applied to the template

MergePdfRequest `dataclass`

MergePdfRequest(documents_contents: List[str])

Definition: MergePdfRequest

Attributes

documents_contents `class-attribute` `instance-attribute`

documents_contents: List[str] = dataclass_field(metadata={'wire_name': 'documentsContents'})

The array of raw content of PDF documents

MergeXlsxRequest `dataclass`

MergeXlsxRequest(documents_contents: List[str])

Definition: MergeXlsxRequest

Attributes

documents_contents `class-attribute` `instance-attribute`

documents_contents: List[str] = dataclass_field(metadata={'wire_name': 'documentsContents'})

The array of raw content of Xlsx documents

ParseCsvFlowRequest `dataclass`

ParseCsvFlowRequest(content: str, headers: str, *, delimiter: Optional[str] = None, locale: Optional[str] = None, limit: Optional[int] = None, skip_first_line: Optional[bool] = None)

Definition: ParseCsvFlowRequest

Attributes

content `instance-attribute`

content: str

Content of CSV document

delimiter `class-attribute` `instance-attribute`

delimiter: Optional[str] = dataclass_field(default=None, kw_only=True)

Delimiter of columns (by default it is just comma)

locale `class-attribute` `instance-attribute`

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

The locale that will be applyed to the document

limit `class-attribute` `instance-attribute`

limit: Optional[int] = dataclass_field(default=None, kw_only=True)

Returns the first "n" rows

headers `instance-attribute`

headers: str

Comma separated list of headers in the same order as CSV columns

skip_first_line `class-attribute` `instance-attribute`

skip_first_line: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'skipFirstLine'})

Select "Yes" if your CSV has headers as a first line.

Pdf2ImageRequest `dataclass`

Pdf2ImageRequest(document_content: str, *, filename_prefix: Optional[str] = None, start_page: Optional[int] = None, end_page: Optional[int] = None, pages: Optional[str] = None, format: Optional[str] = None, dpi: Optional[int] = None, password: Optional[str] = None)

Definition: Pdf2ImageRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Raw content of PDF document

filename_prefix `class-attribute` `instance-attribute`

filename_prefix: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'filenamePrefix'})

Optional. Output files will have this prefix followed by an index number for name

start_page `class-attribute` `instance-attribute`

start_page: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startPage'})

The first page to start extraction (1 based)

end_page `class-attribute` `instance-attribute`

end_page: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endPage'})

The last page to extract (inclusive)

pages `class-attribute` `instance-attribute`

pages: Optional[str] = dataclass_field(default=None, kw_only=True)

Page numbers for extraction separated by ';' (only this pages will be extracted)

format `class-attribute` `instance-attribute`

format: Optional[str] = dataclass_field(default=None, kw_only=True)

The format of the result image

dpi `class-attribute` `instance-attribute`

dpi: Optional[int] = dataclass_field(default=None, kw_only=True)

The resolution of the result image

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Password to decrypt document

Pdf2TextRequest `dataclass`

Pdf2TextRequest(document_content: str, *, start_page: Optional[int] = None, end_page: Optional[int] = None, result_type: Optional[str] = None, password: Optional[str] = None)

Definition: Pdf2TextRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Raw content of PDF document

start_page `class-attribute` `instance-attribute`

start_page: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startPage'})

The first page to start extraction (1 based)

end_page `class-attribute` `instance-attribute`

end_page: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endPage'})

The last page to extract (inclusive)

result_type `class-attribute` `instance-attribute`

result_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resultType'})

Raw or HTML

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Password to decrypt document

PdfProtectionInfoRequest `dataclass`

PdfProtectionInfoRequest(document_content: str)

Definition: PdfProtectionInfoRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Raw content of PDF document

Ppt2PptxRequest `dataclass`

Ppt2PptxRequest(document_content: str)

Definition: Ppt2PptxRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of document that should be converted

Pptx2PdfRequest `dataclass`

Pptx2PdfRequest(document_content: str)

Definition: Pptx2PdfRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of document that should be converted

ProcessJsonData `dataclass`

ProcessJsonData(json_content: Dict[str, Any])

Definition: ProcessJsonData

Attributes

json_content `class-attribute` `instance-attribute`

json_content: Dict[str, Any] = dataclass_field(metadata={'wire_name': 'jsonContent'})

JSON data that should be applied to the template

ProcessSchemaDynamicType `dataclass`

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

Definition: ProcessSchemaDynamicType

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

ProtectPdfRequest `dataclass`

ProtectPdfRequest(document_content: str, allow_printing: bool, allow_modification: bool, allow_extract: bool, allow_annotate: bool, *, new_owner_password: Optional[str] = None, new_user_password: Optional[str] = None, password: Optional[str] = None)

Definition: ProtectPdfRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Raw content of PDF document

allow_printing `class-attribute` `instance-attribute`

allow_printing: bool = dataclass_field(metadata={'wire_name': 'allowPrinting'})

Protect the PDF file from being printed out

allow_modification `class-attribute` `instance-attribute`

allow_modification: bool = dataclass_field(metadata={'wire_name': 'allowModification'})

Protect the PDF file from being edited

allow_extract `class-attribute` `instance-attribute`

allow_extract: bool = dataclass_field(metadata={'wire_name': 'allowExtract'})

Allows extraction of text, images, and other media from the PDF file

allow_annotate `class-attribute` `instance-attribute`

allow_annotate: bool = dataclass_field(metadata={'wire_name': 'allowAnnotate'})

Allows annotation (e.g. comments, form fill-in, signing) of the PDF file

new_owner_password `class-attribute` `instance-attribute`

new_owner_password: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newOwnerPassword'})

Enter an optional owner password here. This password can be used to disable document restrictions

new_user_password `class-attribute` `instance-attribute`

new_user_password: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newUserPassword'})

Enter an optional user password here. Each time an user opens the PDF he will be asked for this password. If you do not want a password prompt then leave this field blank

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Password to decrypt document

RegExpMatchRequest `dataclass`

RegExpMatchRequest(pattern: str, text: str)

Definition: RegExpMatchRequest

Attributes

pattern `instance-attribute`

pattern: str

Regular expression pattern

text `instance-attribute`

text: str

String to search for matches

RegExpReplaceRequest `dataclass`

RegExpReplaceRequest(pattern: str, text: str, *, replacement: Optional[str] = None)

Definition: RegExpReplaceRequest

Attributes

pattern `instance-attribute`

pattern: str

Regular expression pattern

text `instance-attribute`

text: str

String to search for matches

replacement `class-attribute` `instance-attribute`

replacement: Optional[str] = dataclass_field(default=None, kw_only=True)

Replacement string

RegExpTestRequest `dataclass`

RegExpTestRequest(pattern: str, text: str)

Definition: RegExpTestRequest

Attributes

pattern `instance-attribute`

pattern: str

Regular expression pattern

text `instance-attribute`

text: str

String to search for matches

SplitPdfRequest `dataclass`

SplitPdfRequest(document_content: str, *, start_page: Optional[int] = None, end_page: Optional[int] = None, split_at_page: Optional[int] = None, password: Optional[str] = None)

Definition: SplitPdfRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Raw content of PDF document

start_page `class-attribute` `instance-attribute`

start_page: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startPage'})

The first page to start split (1 based)

end_page `class-attribute` `instance-attribute`

end_page: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endPage'})

The last page to split (inclusive)

split_at_page `class-attribute` `instance-attribute`

split_at_page: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'splitAtPage'})

Number of pages per partition

password `class-attribute` `instance-attribute`

password: Optional[str] = dataclass_field(default=None, kw_only=True)

Password to decrypt document

Xls2XlsxRequest `dataclass`

Xls2XlsxRequest(document_content: str)

Definition: Xls2XlsxRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of document that should be converted

Xlsx2PdfRequest `dataclass`

Xlsx2PdfRequest(document_content: str)

Definition: Xlsx2PdfRequest

Attributes

document_content `class-attribute` `instance-attribute`

document_content: str = dataclass_field(metadata={'wire_name': 'documentContent'})

Content of document that should be converted

PlumsailClient

PlumsailClient(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 plumsail connector.

Initialize a PlumsailClient.

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:

profiles_me_get `async`

profiles_me_get(*, 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 Profile Info

Get Profile Info returns information about current user and license.

Swagger operation ID: ProfilesMeGet.

Parameters:

Name	Type	Description	Default
`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.

begin_flow_v1_documents_jobs_apply_docx_template `async`

begin_flow_v1_documents_jobs_apply_docx_template(input: ApplyDocxTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Create document from DOCX template

Create document from DOCX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/docx/index.html

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsApplyDocxTemplatePost.

Parameters:

Name	Type	Description	Default
`input`	`ApplyDocxTemplateRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_apply_xlsx_template `async`

begin_flow_v1_documents_jobs_apply_xlsx_template(input: ApplyXlsxTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Create document from XLSX template

Create document from XLSX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/xlsx/index.html

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsApplyXlsxTemplatePost.

Parameters:

Name	Type	Description	Default
`input`	`ApplyXlsxTemplateRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_apply_pptx `async`

begin_flow_v1_documents_jobs_apply_pptx(input: ApplyPptxTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Create document from PPTX template

Create document from PPTX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/pptx/index.html

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsApplyPptxPost.

Parameters:

Name	Type	Description	Default
`input`	`ApplyPptxTemplateRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_apply_docx `async`

begin_flow_v1_documents_jobs_apply_docx(input: MergeFieldsTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Fill merge fields in DOCX document

Fill merge fields in DOCX document takes a DOCX document with merge fields and replaces them by specified data. The keys in data object should be the same as names of MergeFields (Express block) in document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-merge-fields-in-docx-document

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsApplyDocxPost.

Parameters:

Name	Type	Description	Default
`input`	`MergeFieldsTemplateRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_apply_html `async`

begin_flow_v1_documents_jobs_apply_html(input: ApplyHtmlFlowTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Create HTML from template

Create HTML takes input HTML template string or file and replaces special {{Tokens}} by specified data. We use Mustache framework for templates internally. More information about templates in Mustache docs: http://mustache.github.io/mustache.5.html. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#create-html-from-template

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsApplyHtmlPost.

Parameters:

Name	Type	Description	Default
`input`	`ApplyHtmlFlowTemplateRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_html2_pdf `async`

begin_flow_v1_documents_jobs_html2_pdf(input: Html2PdfFlowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Convert HTML to PDF

Convert HTML to PDF file. This action takes HTML markup, renders it and converts to PDF document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsHtml2PdfPost.

Parameters:

Name	Type	Description	Default
`input`	`Html2PdfFlowRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_html2_docx `async`

begin_flow_v1_documents_jobs_html2_docx(input: Html2DocxFlowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Convert HTML to DOCX

Convert HTML to DOCX document. This action takes HTML markup, renders it and converts to DOCX document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-docx

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsHtml2DocxPost.

Parameters:

Name	Type	Description	Default
`input`	`Html2DocxFlowRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_docx2_pdf `async`

begin_flow_v1_documents_jobs_docx2_pdf(input: Docx2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Convert DOCX to PDF

Convert DOCX to PDF files. This action takes DOCX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-docx-to-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsDocx2PdfPost.

Parameters:

Name	Type	Description	Default
`input`	`Docx2PdfRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_xslx2_pdf `async`

begin_flow_v1_documents_jobs_xslx2_pdf(input: Xlsx2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert XLSX to PDF

Convert XLSX to PDF files. This action takes XLSX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xlsx-to-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsXslx2PdfPost.

Parameters:

Name	Type	Description	Default
`input`	`Xlsx2PdfRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_pptx2_pdf `async`

begin_flow_v1_documents_jobs_pptx2_pdf(input: Pptx2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert PPTX to PDF

Convert PPTX to PDF files. This action takes PPTX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pptx-to-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsPptx2PdfPost.

Parameters:

Name	Type	Description	Default
`input`	`Pptx2PdfRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_any2_pdf_v2 `async`

begin_flow_v1_documents_jobs_any2_pdf_v2(input: Any2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert to PDF

Convert provided file to PDF file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-to-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsAny2PdfV2Post.

Parameters:

Name	Type	Description	Default
`input`	`Any2PdfRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_email2_pdf `async`

begin_flow_v1_documents_jobs_email2_pdf(input: Email2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert Email to PDF

Convert provided Email to PDF file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-email-to-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsEmail2PdfPost.

Parameters:

Name	Type	Description	Default
`input`	`Email2PdfRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_doc2_docx `async`

begin_flow_v1_documents_jobs_doc2_docx(input: Doc2DocxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert DOC to DOCX

Convert DOC to DOCX files. This action takes DOC document and converts it to DOCX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-doc-to-docx

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsDoc2DocxPost.

Parameters:

Name	Type	Description	Default
`input`	`Doc2DocxRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_xls2_xlsx `async`

begin_flow_v1_documents_jobs_xls2_xlsx(input: Xls2XlsxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert XLS to XLSX

Convert XLS to XLSX files. This action takes XLS document and converts it to XLSX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xls-to-xlsx

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsXls2XlsxPost.

Parameters:

Name	Type	Description	Default
`input`	`Xls2XlsxRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_ppt2_pptx `async`

begin_flow_v1_documents_jobs_ppt2_pptx(input: Ppt2PptxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert PPT to PPTX

Convert PPT to PPTX files. This action takes PPT document and converts it to PPTX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-ppt-to-pptx

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsPpt2PptxPost.

Parameters:

Name	Type	Description	Default
`input`	`Ppt2PptxRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_split_pdf_v2 `async`

begin_flow_v1_documents_jobs_split_pdf_v2(input: FlowDocumentsJobsSplitPdfInput | Mapping[str, Any], type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Split PDF

Split PDF takes PDF document and splits it. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#split-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsSplitPdfV2Post.

Parameters:

Name	Type	Description	Default
`input`	`FlowDocumentsJobsSplitPdfInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`type_`	`str`	How to split the 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_merge_any_to_pdf_v2 `async`

begin_flow_v1_documents_jobs_merge_any_to_pdf_v2(input: MergeAny2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Merge any files into PDF

Convert and merge multiple files into a single PDF document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-any-files-into-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsMergeAnyToPdfV2Post.

Parameters:

Name	Type	Description	Default
`input`	`MergeAny2PdfRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_extract_text_from_pdf `async`

begin_flow_v1_documents_jobs_extract_text_from_pdf(input: Pdf2TextRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Extract text from PDF document

Extract text from PDF takes PDF document and extracts text to Raw or HTML format. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#extract-text-from-pdf-document

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsExtractTextFromPdfPost.

Parameters:

Name	Type	Description	Default
`input`	`Pdf2TextRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_pdf2_image_v2 `async`

begin_flow_v1_documents_jobs_pdf2_image_v2(input: Pdf2ImageRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Convert PDF to Image

Convert PDF to image. This action takes PDF document and converts it to Image (jpeg, png, gif, bmp, etc). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsPdf2ImageV2Post.

Parameters:

Name	Type	Description	Default
`input`	`Pdf2ImageRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_image2_pdf `async`

begin_flow_v1_documents_jobs_image2_pdf(input: Image2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert Images to PDF

It takes images and converts them to a PDF document

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsImage2PdfPost.

Parameters:

Name	Type	Description	Default
`input`	`Image2PdfRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_fill_in_pdf_form `async`

begin_flow_v1_documents_jobs_fill_in_pdf_form(input: FillInPdfFormRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Fill in PDF Form

Fill in PDF Form fills out PDF from by provided data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-in-pdf-form

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsFillInPdfFormPost.

Parameters:

Name	Type	Description	Default
`input`	`FillInPdfFormRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_get_pdf_form `async`

begin_flow_v1_documents_jobs_get_pdf_form(input: GetPdfFormRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Get Form from PDF

Get Form from PDF returns fillable form data from PDF as JSON. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-form-from-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsGetPdfFormPost.

Parameters:

Name	Type	Description	Default
`input`	`GetPdfFormRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_protect_pdf `async`

begin_flow_v1_documents_jobs_protect_pdf(input: ProtectPdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Protect PDF document

Protect PDF document adds passwords, copy, printing, and other protections to PDF files. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#protect-pdf-document

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsProtectPdfPost.

Parameters:

Name	Type	Description	Default
`input`	`ProtectPdfRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_get_pdf_protection_info `async`

begin_flow_v1_documents_jobs_get_pdf_protection_info(input: PdfProtectionInfoRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Get information about PDF protection

Get information about PDF protection returns information whether the document is password protected. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-pdf-protection-information

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsGetPdfProtectionInfoPost.

Parameters:

Name	Type	Description	Default
`input`	`PdfProtectionInfoRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_compress_pdf `async`

begin_flow_v1_documents_jobs_compress_pdf(input: CompressPdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Compress PDF document

Compress PDF document size if possible and optimize it. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#compress-pdf-document

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsCompressPdfPost.

Parameters:

Name	Type	Description	Default
`input`	`CompressPdfRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_add_watermark_to_pdf `async`

begin_flow_v1_documents_jobs_add_watermark_to_pdf(input: FlowDocumentsJobsAddWatermarkToPdfInput | Mapping[str, Any], type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Add a watermark to PDF

Add a watermark to PDF as text, an image, HTML, or PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#add-watermark-to-pdf

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsAddWatermarkToPdfPost.

Parameters:

Name	Type	Description	Default
`input`	`FlowDocumentsJobsAddWatermarkToPdfInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`type_`	`str`	The type of the watermark.	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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_merge_docx `async`

begin_flow_v1_documents_jobs_merge_docx(input: MergeDocxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Merge DOCX files

Merge DOCX files takes an array of Docx documents and merge it into single file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-docx-files

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsMergeDocxPost.

Parameters:

Name	Type	Description	Default
`input`	`MergeDocxRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_parse_csv `async`

begin_flow_v1_documents_jobs_parse_csv(input: ParseCsvFlowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Parse CSV

Parse CSV works like Parse JSON but for CSV files. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#parse-csv

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsParseCsvPost.

Parameters:

Name	Type	Description	Default
`input`	`ParseCsvFlowRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_csv2_xlsx `async`

begin_flow_v1_documents_jobs_csv2_xlsx(input: Csv2XlsxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert CSV to Excel

Convert CSV to Excel file (XLSX). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#csv-to-excel

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsCsv2XlsxPost.

Parameters:

Name	Type	Description	Default
`input`	`Csv2XlsxRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_json2_xlsx `async`

begin_flow_v1_documents_jobs_json2_xlsx(input: Json2XlsxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert JSON to Excel

Convert JSON to Excel file (XLSX). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-excel

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsJson2XlsxPost.

Parameters:

Name	Type	Description	Default
`input`	`Json2XlsxRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_json2_csv `async`

begin_flow_v1_documents_jobs_json2_csv(input: Json2CsvRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Convert JSON to CSV

Convert JSON to CSV file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-csv

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsJson2CsvPost.

Parameters:

Name	Type	Description	Default
`input`	`Json2CsvRequest \| 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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_reg_exp_match `async`

begin_flow_v1_documents_jobs_reg_exp_match(input: RegExpMatchRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Regular Expression Match

Regular Expression Match searches for an input string for all occurrences of a regular expression and returns all the matches. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-match

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsRegExpMatchPost.

Parameters:

Name	Type	Description	Default
`input`	`RegExpMatchRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_reg_exp_replace `async`

begin_flow_v1_documents_jobs_reg_exp_replace(input: RegExpReplaceRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Regular Expression Replace

Regular Expression Replace replaces all strings that match a regular expression pattern with a specified replacement string in a specified input string. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-replace

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsRegExpReplacePost.

Parameters:

Name	Type	Description	Default
`input`	`RegExpReplaceRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_reg_exp_test `async`

begin_flow_v1_documents_jobs_reg_exp_test(input: RegExpTestRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Regular Expression Test

Regular Expression Test indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-test

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsRegExpTestPost.

Parameters:

Name	Type	Description	Default
`input`	`RegExpTestRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_create_archive `async`

begin_flow_v1_documents_jobs_create_archive(input: CreateArchiveRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Create Archive

Compresses and adds files to a ZIP archive.

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsCreateArchivePost.

Parameters:

Name	Type	Description	Default
`input`	`CreateArchiveRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_extract_archive `async`

begin_flow_v1_documents_jobs_extract_archive(input: ExtractArchiveRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Extract Archive

Extract files from archive.

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsExtractArchivePost.

Parameters:

Name	Type	Description	Default
`input`	`ExtractArchiveRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_documents_jobs_merge_xlsx `async`

begin_flow_v1_documents_jobs_merge_xlsx(input: MergeXlsxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[dict[str, Any] | None]

Merge XLSX files

Merge XLSX files takes an array of Xlsx documents and merge it into single file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-xlsx-files

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1DocumentsJobsMergeXlsxPost.

Parameters:

Name	Type	Description	Default
`input`	`MergeXlsxRequest \| 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
`AsyncLROPoller[dict[str, Any] \| None]`	AsyncLROPoller[dict[str, Any] \| None]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_processes_flow_jobs_execute_process `async`

begin_flow_v1_processes_flow_jobs_execute_process(input: FlowProcessesFlowJobsExecuteProcessInput | Mapping[str, Any], process_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Start document generation process with json

Start document generation process fills a DOCX, XLSX, PPTX or PDF template related to the selected process with the JSON data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html##start-process-json

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1ProcessesFlowJobsExecuteProcessPost.

Parameters:

Name	Type	Description	Default
`input`	`FlowProcessesFlowJobsExecuteProcessInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`process_id`	`str`	The name of process to be started.	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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

begin_flow_v1_processes_flow_jobs_execute_process_with_generated_data `async`

begin_flow_v1_processes_flow_jobs_execute_process_with_generated_data(input: ProcessJsonData | Mapping[str, Any], process_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncLROPoller[bytes]

Start document generation process

Start document generation process fills a DOCX, XLSX, PPTX or PDF template related to the selected process with the JSON data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#start-document-generation-process

Returns an Azure Core async poller for the connector operation.

Swagger operation ID: FlowV1ProcessesFlowJobsExecuteProcessWithGeneratedDataPost.

Parameters:

Name	Type	Description	Default
`input`	`ProcessJsonData \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`process_id`	`str`	The name of process to be started.	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
`AsyncLROPoller[bytes]`	AsyncLROPoller[bytes]: An Azure Core poller for the connector operation.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

flow_v1_documents_flow_schema_split_pdf `async`

flow_v1_documents_flow_schema_split_pdf(type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

SplitPdfSchema

System

Swagger operation ID: FlowV1DocumentsFlowSchemaSplitPdfPost.

Parameters:

Name	Type	Description	Default
`type_`	`str`	How to split the 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:

Name	Type	Description
`None`	`None`	The operation completes without a response body.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

flow_v1_documents_flow_schema_add_watermark_to_pdf `async`

flow_v1_documents_flow_schema_add_watermark_to_pdf(type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

AddWatermarkToPdfSchema

System

Swagger operation ID: FlowV1DocumentsFlowSchemaAddWatermarkToPdfPost.

Parameters:

Name	Type	Description	Default
`type_`	`str`	The type of the watermark.	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
`None`	`None`	The operation completes without a response body.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

flow_v1_processes_flow_schema_get_processes `async`

flow_v1_processes_flow_schema_get_processes(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

GetProcessesSchema

System

Swagger operation ID: FlowV1ProcessesFlowSchemaGetProcessesPost.

Parameters:

Name	Type	Description	Default
`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
`None`	`None`	The operation completes without a response body.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

flow_v1_documents_flow_schema_parse_csv `async`

flow_v1_documents_flow_schema_parse_csv(headers_parameter: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

ParseCsv

System

Swagger operation ID: FlowV1DocumentsFlowSchemaParseCsvPost.

Parameters:

Name	Type	Description	Default
`headers_parameter`	`str`	headers.	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
`None`	`None`	The operation completes without a response body.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

flow_v1_processes_flow_schema_get_json_data `async`

flow_v1_processes_flow_schema_get_json_data(process_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

GetJsonSchema

System

Swagger operation ID: FlowV1ProcessesFlowSchemaGetJsonDataPost.

Parameters:

Name	Type	Description	Default
`process_id`	`str`	The name of process to be started.	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
`None`	`None`	The operation completes without a response body.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

flow_v1_processes_flow_triggers_by_process_id_schema_get `async`

flow_v1_processes_flow_triggers_by_process_id_schema_get(process_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get schema of a process

Returns schema of a process

Swagger operation ID: FlowV1ProcessesFlowTriggersByProcessIdSchemaGet.

Parameters:

Name	Type	Description	Default
`process_id`	`str`	processId.	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
`None`	`None`	The operation completes without a response body.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

flow_v1_documents_flow_schema_reg_exp_match `async`

flow_v1_documents_flow_schema_reg_exp_match(pattern: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

RegexMatchSchema

System

Swagger operation ID: FlowV1DocumentsFlowSchemaRegExpMatchPost.

Parameters:

Name	Type	Description	Default
`pattern`	`str`	pattern.	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
`None`	`None`	The operation completes without a response body.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

PlumsailClient

Attributes

TRIGGER_OPERATIONS module-attribute

Classes

ProfileInfo dataclass

DocumentProcessingResponse dataclass

Attributes

file_content class-attribute instance-attribute

ApplyHtmlTemplateResponse dataclass

Attributes

html_result class-attribute instance-attribute

FlowDocumentsJobsSplitPdfInput dataclass

Attributes

additional_properties class-attribute instance-attribute

DocumentsWithFilenamesResponse dataclass

Attributes

result_files class-attribute instance-attribute

FlowDocumentsJobsGetPdfFormPostResponse dataclass

Attributes

additional_properties class-attribute instance-attribute

GetPdfProtectionInfoResponse dataclass

FlowDocumentsJobsAddWatermarkToPdfInput dataclass

Attributes

additional_properties class-attribute instance-attribute

ParseCsvSchemaResponse dataclass

Attributes

additional_properties class-attribute instance-attribute

RegExpMatchSchemaResponseClass dataclass

Attributes

additional_properties class-attribute instance-attribute

StringResultResponse dataclass

BooleanResultResponse dataclass

DocumentContentWithFilenameResponse dataclass

Attributes

filename class-attribute instance-attribute

file_content class-attribute instance-attribute

FlowProcessesFlowJobsExecuteProcessInput dataclass

Attributes

additional_properties class-attribute instance-attribute

AddPowerAutomateWebhookData dataclass

Attributes

process_id class-attribute instance-attribute

hook_url class-attribute instance-attribute

Any2PdfRequest dataclass

Attributes

document_content class-attribute instance-attribute

ApplyDocxTemplateRequest dataclass

Attributes

document_content class-attribute instance-attribute

data instance-attribute

output_type class-attribute instance-attribute

locale class-attribute instance-attribute

timezone class-attribute instance-attribute

engine class-attribute instance-attribute

ApplyHtmlFlowTemplateRequest dataclass

Attributes

html instance-attribute

data instance-attribute

locale class-attribute instance-attribute

timezone class-attribute instance-attribute

ApplyPptxTemplateRequest dataclass

Attributes

document_content class-attribute instance-attribute

data instance-attribute

output_type class-attribute instance-attribute

locale class-attribute instance-attribute

timezone class-attribute instance-attribute

ApplyXlsxTemplateRequest dataclass

Attributes

document_content class-attribute instance-attribute

data instance-attribute

output_type class-attribute instance-attribute

locale class-attribute instance-attribute

timezone class-attribute instance-attribute

CompressPdfRequest dataclass

Attributes

document_content class-attribute instance-attribute

lossless_mode class-attribute instance-attribute

password class-attribute instance-attribute

CreateArchiveRequest dataclass

TRIGGER_OPERATIONS `module-attribute`

ProfileInfo `dataclass`

DocumentProcessingResponse `dataclass`

file_content `class-attribute` `instance-attribute`

ApplyHtmlTemplateResponse `dataclass`

html_result `class-attribute` `instance-attribute`

FlowDocumentsJobsSplitPdfInput `dataclass`

additional_properties `class-attribute` `instance-attribute`

DocumentsWithFilenamesResponse `dataclass`

result_files `class-attribute` `instance-attribute`

FlowDocumentsJobsGetPdfFormPostResponse `dataclass`

additional_properties `class-attribute` `instance-attribute`

GetPdfProtectionInfoResponse `dataclass`

FlowDocumentsJobsAddWatermarkToPdfInput `dataclass`

additional_properties `class-attribute` `instance-attribute`

ParseCsvSchemaResponse `dataclass`

additional_properties `class-attribute` `instance-attribute`

RegExpMatchSchemaResponseClass `dataclass`

additional_properties `class-attribute` `instance-attribute`

StringResultResponse `dataclass`

BooleanResultResponse `dataclass`

DocumentContentWithFilenameResponse `dataclass`

filename `class-attribute` `instance-attribute`

file_content `class-attribute` `instance-attribute`

FlowProcessesFlowJobsExecuteProcessInput `dataclass`

additional_properties `class-attribute` `instance-attribute`

AddPowerAutomateWebhookData `dataclass`

process_id `class-attribute` `instance-attribute`

hook_url `class-attribute` `instance-attribute`

Any2PdfRequest `dataclass`

document_content `class-attribute` `instance-attribute`

ApplyDocxTemplateRequest `dataclass`

document_content `class-attribute` `instance-attribute`

data `instance-attribute`

output_type `class-attribute` `instance-attribute`

locale `class-attribute` `instance-attribute`

timezone `class-attribute` `instance-attribute`

engine `class-attribute` `instance-attribute`

ApplyHtmlFlowTemplateRequest `dataclass`

html `instance-attribute`

data `instance-attribute`

locale `class-attribute` `instance-attribute`

timezone `class-attribute` `instance-attribute`

ApplyPptxTemplateRequest `dataclass`

document_content `class-attribute` `instance-attribute`

data `instance-attribute`

output_type `class-attribute` `instance-attribute`

locale `class-attribute` `instance-attribute`

timezone `class-attribute` `instance-attribute`

ApplyXlsxTemplateRequest `dataclass`

document_content `class-attribute` `instance-attribute`

data `instance-attribute`

output_type `class-attribute` `instance-attribute`

locale `class-attribute` `instance-attribute`

timezone `class-attribute` `instance-attribute`

CompressPdfRequest `dataclass`

document_content `class-attribute` `instance-attribute`

lossless_mode `class-attribute` `instance-attribute`

password `class-attribute` `instance-attribute`

CreateArchiveRequest `dataclass`

file_name `class-attribute` `instance-attribute`

data `instance-attribute`

password `class-attribute` `instance-attribute`

Csv2XlsxColumnMapping `dataclass`

csv_column_index_or_name `class-attribute` `instance-attribute`

xlsx_column_type `class-attribute` `instance-attribute`

xlsx_column_name `class-attribute` `instance-attribute`

Csv2XlsxRequest `dataclass`

content `instance-attribute`

delimiter `class-attribute` `instance-attribute`

locale `class-attribute` `instance-attribute`

limit `class-attribute` `instance-attribute`

has_header_records `class-attribute` `instance-attribute`

mappings `class-attribute` `instance-attribute`

Doc2DocxRequest `dataclass`

document_content `class-attribute` `instance-attribute`

DocumentsArrayResponse `dataclass`

result_files_contents `class-attribute` `instance-attribute`

Docx2PdfRequest `dataclass`

document_content `class-attribute` `instance-attribute`