Skip to content

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] = 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] = field(default=None, 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] = field(default=None, 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] = field(default_factory=dict)

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

DocumentsWithFilenamesResponse dataclass 

DocumentsWithFilenamesResponse(result_files: Optional[List[DocumentContentWithFilenameResponse]] = None)

Response for Split PDF

Attributes

result_files class-attribute instance-attribute 
result_files: Optional[List[DocumentContentWithFilenameResponse]] = field(default=None, 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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = None

Name of the file

file_content class-attribute instance-attribute 
file_content: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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

AddPowerAutomateWebhookData dataclass 

AddPowerAutomateWebhookData(process_id: Optional[str] = None, hook_url: Optional[str] = None)

Definition: AddPowerAutomateWebhookData

Attributes

process_id class-attribute instance-attribute 
process_id: Optional[str] = field(default=None, metadata={'wire_name': 'processId'})

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

hook_url class-attribute instance-attribute 
hook_url: Optional[str] = field(default=None, metadata={'wire_name': 'hookUrl'})

HookUrl

Any2PdfRequest dataclass 

Any2PdfRequest(document_content: Optional[str] = None)

Definition: Any2PdfRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of document that should be converted

ApplyDocxTemplateRequest dataclass 

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

Definition: ApplyDocxTemplateRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of the template

data class-attribute instance-attribute 
data: Optional[Dict[str, Any]] = None

JSON data that should be applied to the template

output_type class-attribute instance-attribute 
output_type: Optional[str] = field(default=None, metadata={'wire_name': 'outputType'})

The required document type

locale class-attribute instance-attribute 
locale: Optional[str] = None

The locale that will be applyed to the document

timezone class-attribute instance-attribute 
timezone: Optional[str] = None

The time zone of the document

engine class-attribute instance-attribute 
engine: Optional[str] = None

The engine that will process the template

ApplyHtmlFlowTemplateRequest dataclass 

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

Definition: ApplyHtmlFlowTemplateRequest

Attributes

html class-attribute instance-attribute 
html: Optional[str] = None

Text HTML template or HTML file template

data class-attribute instance-attribute 
data: Optional[Dict[str, Any]] = None

JSON data that should be applied to the template

locale class-attribute instance-attribute 
locale: Optional[str] = None

The locale that will be applyed to the document

timezone class-attribute instance-attribute 
timezone: Optional[str] = None

The time zone of the document

ApplyPptxTemplateRequest dataclass 

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

Definition: ApplyPptxTemplateRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of the template

data class-attribute instance-attribute 
data: Optional[Dict[str, Any]] = None

JSON data that should be applied to the template

output_type class-attribute instance-attribute 
output_type: Optional[str] = field(default=None, metadata={'wire_name': 'outputType'})

The required document type

locale class-attribute instance-attribute 
locale: Optional[str] = None

The locale that will be applyed to the document

timezone class-attribute instance-attribute 
timezone: Optional[str] = None

The time zone of the document

ApplyXlsxTemplateRequest dataclass 

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

Definition: ApplyXlsxTemplateRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of the template

data class-attribute instance-attribute 
data: Optional[Dict[str, Any]] = None

JSON data that should be applied to the template

output_type class-attribute instance-attribute 
output_type: Optional[str] = field(default=None, metadata={'wire_name': 'outputType'})

The required document type

locale class-attribute instance-attribute 
locale: Optional[str] = None

The locale that will be applyed to the document

timezone class-attribute instance-attribute 
timezone: Optional[str] = None

The time zone of the document

CompressPdfRequest dataclass 

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

Definition: CompressPdfRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Raw content of PDF document

lossless_mode class-attribute instance-attribute 
lossless_mode: Optional[str] = field(default=None, 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] = None

Password to open PDF file

CreateArchiveRequest dataclass 

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

Definition: CreateArchiveRequest

Attributes

file_name class-attribute instance-attribute 
file_name: Optional[str] = field(default=None, metadata={'wire_name': 'fileName'})

Name of the archive without the file extension

data class-attribute instance-attribute 
data: Optional[List[FileData]] = None

Array of documents to add to the archive

password class-attribute instance-attribute 
password: Optional[str] = None

Archive password

Csv2XlsxColumnMapping dataclass 

Csv2XlsxColumnMapping(csv_column_index_or_name: Optional[str] = None, 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: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'xlsxColumnType'})

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

xlsx_column_name class-attribute instance-attribute 
xlsx_column_name: Optional[str] = field(default=None, metadata={'wire_name': 'xlsxColumnName'})

Optional. Rename CSV column to this name

Csv2XlsxRequest dataclass 

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

Definition: Csv2XlsxRequest

Attributes

content class-attribute instance-attribute 
content: Optional[str] = None

Content of CSV document

delimiter class-attribute instance-attribute 
delimiter: Optional[str] = None

Delimiter of columns (by default it is just comma)

locale class-attribute instance-attribute 
locale: Optional[str] = None

The locale that will be applyed to the document

limit class-attribute instance-attribute 
limit: Optional[int] = None

Returns the first "n" rows

has_header_records class-attribute instance-attribute 
has_header_records: Optional[bool] = field(default=None, 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]] = None

Rename headers and specify types for columns.

Doc2DocxRequest dataclass 

Doc2DocxRequest(document_content: Optional[str] = None)

Definition: Doc2DocxRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, 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]] = field(default=None, metadata={'wire_name': 'resultFilesContents'})

The array of raw content of result files

Docx2PdfRequest dataclass 

Docx2PdfRequest(document_content: Optional[str] = None)

Definition: Docx2PdfRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of document that should be converted

Email2PdfRequest dataclass 

Email2PdfRequest(document_content: Optional[str] = None, merge_attachments: Optional[bool] = None)

Definition: Email2PdfRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of the email that should be converted

merge_attachments class-attribute instance-attribute 
merge_attachments: Optional[bool] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'fileContent'})

Content of archive file

include_folders class-attribute instance-attribute 
include_folders: Optional[bool] = field(default=None, metadata={'wire_name': 'includeFolders'})

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

password class-attribute instance-attribute 
password: Optional[str] = None

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] = field(default=None, metadata={'wire_name': 'fileName'})

File name including the file extension

content class-attribute instance-attribute 
content: Optional[str] = None

Content of the document

FillInPdfFormRequest dataclass 

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

Definition: FillInPdfFormRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Raw content of PDF document

json_data class-attribute instance-attribute 
json_data: Optional[Dict[str, Any]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'lockFormFields'})

Disable fields editing after filling them

password class-attribute instance-attribute 
password: Optional[str] = None

Password to open PDF file

GetPdfFormRequest dataclass 

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

Definition: GetPdfFormRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Raw content of PDF document

password class-attribute instance-attribute 
password: Optional[str] = None

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] = field(default=None, metadata={'wire_name': 'fileContent'})

Binary content of the HTML file to convert to DOCX

raw_html class-attribute instance-attribute 
raw_html: Optional[str] = field(default=None, metadata={'wire_name': 'rawHtml'})

HTML Data to convert to DOCX

html_url class-attribute instance-attribute 
html_url: Optional[str] = field(default=None, metadata={'wire_name': 'htmlUrl'})

URL to the web page to convert to DOCX

paper_size class-attribute instance-attribute 
paper_size: Optional[str] = field(default=None, metadata={'wire_name': 'paperSize'})

Can be A4,A5 etc...

orientation class-attribute instance-attribute 
orientation: Optional[str] = None

Portrait or Landscape

decode_html class-attribute instance-attribute 
decode_html: Optional[bool] = field(default=None, metadata={'wire_name': 'decodeHtml'})

Whether HTML should be decoded prior to conversion

margins class-attribute instance-attribute 
margins: Optional[str] = None

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

Html2PdfFlowRequest dataclass 

Html2PdfFlowRequest(html: Optional[str] = None, 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 class-attribute instance-attribute 
html: Optional[str] = None

HTML markup that should be converted to PDF

engine class-attribute instance-attribute 
engine: Optional[str] = None

Conversion engine

size class-attribute instance-attribute 
size: Optional[str] = None

Can be A4,A5 etc...

orientation class-attribute instance-attribute 
orientation: Optional[str] = None

Portrait or Landscape

margins class-attribute instance-attribute 
margins: Optional[str] = None

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] = field(default=None, metadata={'wire_name': 'headerHtml'})

HTML markup that should be added as a header

footer_html class-attribute instance-attribute 
footer_html: Optional[str] = field(default=None, metadata={'wire_name': 'footerHtml'})

HTML markup that should be added as a footer

Image2PdfRequest dataclass 

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

Definition: Image2PdfRequest

Attributes

image_per_page class-attribute instance-attribute 
image_per_page: Optional[bool] = field(default=None, 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: Optional[List[str]] = field(default=None, 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] = None

Optional. Content of the JSON file

json_data class-attribute instance-attribute 
json_data: Optional[str] = field(default=None, metadata={'wire_name': 'jsonData'})

Optional. JSON data to process

locale class-attribute instance-attribute 
locale: Optional[str] = None

The locale that will be applyed to the document

path_to_json_array class-attribute instance-attribute 
path_to_json_array: Optional[str] = field(default=None, 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] = None

Delimiter of columns in CSV. Default is comma

Json2XlsxColumnMapping dataclass 

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

Definition: Json2XlsxColumnMapping

Attributes

json_property class-attribute instance-attribute 
json_property: Optional[str] = field(default=None, metadata={'wire_name': 'jsonProperty'})

Name of the JSON property

xlsx_column_type class-attribute instance-attribute 
xlsx_column_type: Optional[str] = field(default=None, metadata={'wire_name': 'xlsxColumnType'})

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

xlsx_column_name class-attribute instance-attribute 
xlsx_column_name: Optional[str] = field(default=None, 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]] = None)

Definition: Json2XlsxRequest

Attributes

content class-attribute instance-attribute 
content: Optional[str] = None

Optional. Content of the JSON file

json_data class-attribute instance-attribute 
json_data: Optional[str] = field(default=None, metadata={'wire_name': 'jsonData'})

Optional. JSON data to process

locale class-attribute instance-attribute 
locale: Optional[str] = None

The locale that will be applyed to the document

path_to_json_array class-attribute instance-attribute 
path_to_json_array: Optional[str] = field(default=None, 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]] = None

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: Optional[str] = None, content: Optional[str] = None)

Definition: MergeAny2PdfFileData

Attributes

file_name class-attribute instance-attribute 
file_name: Optional[str] = field(default=None, metadata={'wire_name': 'fileName'})

Name of the file, including extension

content class-attribute instance-attribute 
content: Optional[str] = None

Content of the file

MergeAny2PdfRequest dataclass 

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

Definition: MergeAny2PdfRequest

Attributes

documents_contents class-attribute instance-attribute 
documents_contents: Optional[List[str]] = field(default=None, metadata={'wire_name': 'documentsContents'})

The array of raw contents of files to merge

generate_bookmarks class-attribute instance-attribute 
generate_bookmarks: Optional[bool] = field(default=None, metadata={'wire_name': 'generateBookmarks'})

Generate a bookmark for each merged file

preserve_bookmarks class-attribute instance-attribute 
preserve_bookmarks: Optional[bool] = field(default=None, metadata={'wire_name': 'preserveBookmarks'})

Preserve bookmarks from each merged PDF

MergeDocxRequest dataclass 

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

Definition: MergeDocxRequest

Attributes

documents_contents class-attribute instance-attribute 
documents_contents: Optional[List[str]] = field(default=None, metadata={'wire_name': 'documentsContents'})

The array of raw content of Docx documents

apply_header_and_footer: Optional[bool] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'addPageBreak'})

Adds page breaks between merged documents.

MergeFieldsTemplateRequest dataclass 

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

Definition: MergeFieldsTemplateRequest

Attributes

docx_document class-attribute instance-attribute 
docx_document: Optional[str] = field(default=None, metadata={'wire_name': 'docxDocument'})

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

data class-attribute instance-attribute 
data: Optional[Dict[str, Any]] = None

JSON data that should be applied to the template

MergePdfRequest dataclass 

MergePdfRequest(documents_contents: Optional[List[str]] = None)

Definition: MergePdfRequest

Attributes

documents_contents class-attribute instance-attribute 
documents_contents: Optional[List[str]] = field(default=None, metadata={'wire_name': 'documentsContents'})

The array of raw content of PDF documents

MergeXlsxRequest dataclass 

MergeXlsxRequest(documents_contents: Optional[List[str]] = None)

Definition: MergeXlsxRequest

Attributes

documents_contents class-attribute instance-attribute 
documents_contents: Optional[List[str]] = field(default=None, metadata={'wire_name': 'documentsContents'})

The array of raw content of Xlsx documents

ParseCsvFlowRequest dataclass 

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

Definition: ParseCsvFlowRequest

Attributes

content class-attribute instance-attribute 
content: Optional[str] = None

Content of CSV document

delimiter class-attribute instance-attribute 
delimiter: Optional[str] = None

Delimiter of columns (by default it is just comma)

locale class-attribute instance-attribute 
locale: Optional[str] = None

The locale that will be applyed to the document

limit class-attribute instance-attribute 
limit: Optional[int] = None

Returns the first "n" rows

headers class-attribute instance-attribute 
headers: Optional[str] = None

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

skip_first_line class-attribute instance-attribute 
skip_first_line: Optional[bool] = field(default=None, metadata={'wire_name': 'skipFirstLine'})

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

Pdf2ImageRequest dataclass 

Pdf2ImageRequest(document_content: Optional[str] = None, 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: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Raw content of PDF document

filename_prefix class-attribute instance-attribute 
filename_prefix: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'startPage'})

The first page to start extraction (1 based)

end_page class-attribute instance-attribute 
end_page: Optional[int] = field(default=None, metadata={'wire_name': 'endPage'})

The last page to extract (inclusive)

pages class-attribute instance-attribute 
pages: Optional[str] = None

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

format class-attribute instance-attribute 
format: Optional[str] = None

The format of the result image

dpi class-attribute instance-attribute 
dpi: Optional[int] = None

The resolution of the result image

password class-attribute instance-attribute 
password: Optional[str] = None

Password to decrypt document

Pdf2TextRequest dataclass 

Pdf2TextRequest(document_content: Optional[str] = None, 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: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Raw content of PDF document

start_page class-attribute instance-attribute 
start_page: Optional[int] = field(default=None, metadata={'wire_name': 'startPage'})

The first page to start extraction (1 based)

end_page class-attribute instance-attribute 
end_page: Optional[int] = field(default=None, metadata={'wire_name': 'endPage'})

The last page to extract (inclusive)

result_type class-attribute instance-attribute 
result_type: Optional[str] = field(default=None, metadata={'wire_name': 'resultType'})

Raw or HTML

password class-attribute instance-attribute 
password: Optional[str] = None

Password to decrypt document

PdfProtectionInfoRequest dataclass 

PdfProtectionInfoRequest(document_content: Optional[str] = None)

Definition: PdfProtectionInfoRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Raw content of PDF document

Ppt2PptxRequest dataclass 

Ppt2PptxRequest(document_content: Optional[str] = None)

Definition: Ppt2PptxRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of document that should be converted

Pptx2PdfRequest dataclass 

Pptx2PdfRequest(document_content: Optional[str] = None)

Definition: Pptx2PdfRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of document that should be converted

ProcessJsonData dataclass 

ProcessJsonData(json_content: Optional[Dict[str, Any]] = None)

Definition: ProcessJsonData

Attributes

json_content class-attribute instance-attribute 
json_content: Optional[Dict[str, Any]] = field(default=None, 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] = field(default_factory=dict)

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

ProtectPdfRequest dataclass 

ProtectPdfRequest(document_content: Optional[str] = None, allow_printing: Optional[bool] = None, allow_modification: Optional[bool] = None, allow_extract: Optional[bool] = None, allow_annotate: Optional[bool] = None, 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: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Raw content of PDF document

allow_printing class-attribute instance-attribute 
allow_printing: Optional[bool] = field(default=None, metadata={'wire_name': 'allowPrinting'})

Protect the PDF file from being printed out

allow_modification class-attribute instance-attribute 
allow_modification: Optional[bool] = field(default=None, metadata={'wire_name': 'allowModification'})

Protect the PDF file from being edited

allow_extract class-attribute instance-attribute 
allow_extract: Optional[bool] = field(default=None, metadata={'wire_name': 'allowExtract'})

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

allow_annotate class-attribute instance-attribute 
allow_annotate: Optional[bool] = field(default=None, 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] = field(default=None, 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] = field(default=None, 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] = None

Password to decrypt document

RegExpMatchRequest dataclass 

RegExpMatchRequest(pattern: Optional[str] = None, text: Optional[str] = None)

Definition: RegExpMatchRequest

Attributes

pattern class-attribute instance-attribute 
pattern: Optional[str] = None

Regular expression pattern

text class-attribute instance-attribute 
text: Optional[str] = None

String to search for matches

RegExpReplaceRequest dataclass 

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

Definition: RegExpReplaceRequest

Attributes

pattern class-attribute instance-attribute 
pattern: Optional[str] = None

Regular expression pattern

text class-attribute instance-attribute 
text: Optional[str] = None

String to search for matches

replacement class-attribute instance-attribute 
replacement: Optional[str] = None

Replacement string

RegExpTestRequest dataclass 

RegExpTestRequest(pattern: Optional[str] = None, text: Optional[str] = None)

Definition: RegExpTestRequest

Attributes

pattern class-attribute instance-attribute 
pattern: Optional[str] = None

Regular expression pattern

text class-attribute instance-attribute 
text: Optional[str] = None

String to search for matches

SplitPdfRequest dataclass 

SplitPdfRequest(document_content: Optional[str] = None, 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: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Raw content of PDF document

start_page class-attribute instance-attribute 
start_page: Optional[int] = field(default=None, metadata={'wire_name': 'startPage'})

The first page to start split (1 based)

end_page class-attribute instance-attribute 
end_page: Optional[int] = field(default=None, metadata={'wire_name': 'endPage'})

The last page to split (inclusive)

split_at_page class-attribute instance-attribute 
split_at_page: Optional[int] = field(default=None, metadata={'wire_name': 'splitAtPage'})

Number of pages per partition

password class-attribute instance-attribute 
password: Optional[str] = None

Password to decrypt document

Xls2XlsxRequest dataclass 

Xls2XlsxRequest(document_content: Optional[str] = None)

Definition: Xls2XlsxRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of document that should be converted

Xlsx2PdfRequest dataclass 

Xlsx2PdfRequest(document_content: Optional[str] = None)

Definition: Xlsx2PdfRequest

Attributes

document_content class-attribute instance-attribute 
document_content: Optional[str] = field(default=None, metadata={'wire_name': 'documentContent'})

Content of document that should be converted

PlumsailClient 

PlumsailClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

profiles_me_get_async async 
profiles_me_get_async() -> dict[str, Any] | None

Get Profile Info

Get Profile Info returns information about current user and license.

flow_v1_documents_jobs_apply_docx_template_async async 
flow_v1_documents_jobs_apply_docx_template_async(input: ApplyDocxTemplateRequest) -> 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

flow_v1_documents_jobs_apply_xlsx_template_async async 
flow_v1_documents_jobs_apply_xlsx_template_async(input: ApplyXlsxTemplateRequest) -> 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

flow_v1_documents_jobs_apply_pptx_async async 
flow_v1_documents_jobs_apply_pptx_async(input: ApplyPptxTemplateRequest) -> 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

flow_v1_documents_jobs_apply_docx_async async 
flow_v1_documents_jobs_apply_docx_async(input: MergeFieldsTemplateRequest) -> 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

flow_v1_documents_jobs_apply_html_async async 
flow_v1_documents_jobs_apply_html_async(input: ApplyHtmlFlowTemplateRequest) -> 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

flow_v1_documents_jobs_html2_pdf_async async 
flow_v1_documents_jobs_html2_pdf_async(input: Html2PdfFlowRequest) -> 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

flow_v1_documents_jobs_html2_docx_async async 
flow_v1_documents_jobs_html2_docx_async(input: Html2DocxFlowRequest) -> 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

flow_v1_documents_jobs_docx2_pdf_async async 
flow_v1_documents_jobs_docx2_pdf_async(input: Docx2PdfRequest) -> 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

flow_v1_documents_jobs_xslx2_pdf_async async 
flow_v1_documents_jobs_xslx2_pdf_async(input: Xlsx2PdfRequest) -> 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

flow_v1_documents_jobs_pptx2_pdf_async async 
flow_v1_documents_jobs_pptx2_pdf_async(input: Pptx2PdfRequest) -> 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

flow_v1_documents_jobs_any2_pdf_v2_async async 
flow_v1_documents_jobs_any2_pdf_v2_async(input: Any2PdfRequest) -> 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

flow_v1_documents_jobs_email2_pdf_async async 
flow_v1_documents_jobs_email2_pdf_async(input: Email2PdfRequest) -> 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

flow_v1_documents_jobs_doc2_docx_async async 
flow_v1_documents_jobs_doc2_docx_async(input: Doc2DocxRequest) -> 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

flow_v1_documents_jobs_xls2_xlsx_async async 
flow_v1_documents_jobs_xls2_xlsx_async(input: Xls2XlsxRequest) -> 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

flow_v1_documents_jobs_ppt2_pptx_async async 
flow_v1_documents_jobs_ppt2_pptx_async(input: Ppt2PptxRequest) -> 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

flow_v1_documents_jobs_split_pdf_v2_async async 
flow_v1_documents_jobs_split_pdf_v2_async(input: FlowDocumentsJobsSplitPdfInput, type_: str) -> 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

flow_v1_documents_jobs_merge_any_to_pdf_v2_async async 
flow_v1_documents_jobs_merge_any_to_pdf_v2_async(input: MergeAny2PdfRequest) -> 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

flow_v1_documents_jobs_extract_text_from_pdf_async async 
flow_v1_documents_jobs_extract_text_from_pdf_async(input: Pdf2TextRequest) -> 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

flow_v1_documents_jobs_pdf2_image_v2_async async 
flow_v1_documents_jobs_pdf2_image_v2_async(input: Pdf2ImageRequest) -> 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

flow_v1_documents_jobs_image2_pdf_async async 
flow_v1_documents_jobs_image2_pdf_async(input: Image2PdfRequest) -> bytes

Convert Images to PDF

It takes images and converts them to a PDF document

flow_v1_documents_jobs_fill_in_pdf_form_async async 
flow_v1_documents_jobs_fill_in_pdf_form_async(input: FillInPdfFormRequest) -> 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

flow_v1_documents_jobs_get_pdf_form_async async 
flow_v1_documents_jobs_get_pdf_form_async(input: GetPdfFormRequest) -> 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

flow_v1_documents_jobs_protect_pdf_async async 
flow_v1_documents_jobs_protect_pdf_async(input: ProtectPdfRequest) -> 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

flow_v1_documents_jobs_get_pdf_protection_info_async async 
flow_v1_documents_jobs_get_pdf_protection_info_async(input: PdfProtectionInfoRequest) -> 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

flow_v1_documents_jobs_compress_pdf_async async 
flow_v1_documents_jobs_compress_pdf_async(input: CompressPdfRequest) -> 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

flow_v1_documents_jobs_add_watermark_to_pdf_async async 
flow_v1_documents_jobs_add_watermark_to_pdf_async(input: FlowDocumentsJobsAddWatermarkToPdfInput, type_: str) -> 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

flow_v1_documents_jobs_merge_docx_async async 
flow_v1_documents_jobs_merge_docx_async(input: MergeDocxRequest) -> 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

flow_v1_documents_jobs_parse_csv_async async 
flow_v1_documents_jobs_parse_csv_async(input: ParseCsvFlowRequest) -> 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

flow_v1_documents_jobs_csv2_xlsx_async async 
flow_v1_documents_jobs_csv2_xlsx_async(input: Csv2XlsxRequest) -> 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

flow_v1_documents_jobs_json2_xlsx_async async 
flow_v1_documents_jobs_json2_xlsx_async(input: Json2XlsxRequest) -> 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

flow_v1_documents_jobs_json2_csv_async async 
flow_v1_documents_jobs_json2_csv_async(input: Json2CsvRequest) -> 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

flow_v1_documents_jobs_reg_exp_match_async async 
flow_v1_documents_jobs_reg_exp_match_async(input: RegExpMatchRequest) -> 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

flow_v1_documents_jobs_reg_exp_replace_async async 
flow_v1_documents_jobs_reg_exp_replace_async(input: RegExpReplaceRequest) -> 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

flow_v1_documents_jobs_reg_exp_test_async async 
flow_v1_documents_jobs_reg_exp_test_async(input: RegExpTestRequest) -> 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

flow_v1_documents_jobs_create_archive_async async 
flow_v1_documents_jobs_create_archive_async(input: CreateArchiveRequest) -> dict[str, Any] | None

Create Archive

Compresses and adds files to a ZIP archive.

flow_v1_documents_jobs_extract_archive_async async 
flow_v1_documents_jobs_extract_archive_async(input: ExtractArchiveRequest) -> dict[str, Any] | None

Extract Archive

Extract files from archive.

flow_v1_documents_jobs_merge_xlsx_async async 
flow_v1_documents_jobs_merge_xlsx_async(input: MergeXlsxRequest) -> 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

flow_v1_processes_flow_jobs_execute_process_async async 
flow_v1_processes_flow_jobs_execute_process_async(input: FlowProcessesFlowJobsExecuteProcessInput, process_id: str) -> 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

flow_v1_processes_flow_jobs_execute_process_with_generated_data_async async 
flow_v1_processes_flow_jobs_execute_process_with_generated_data_async(input: ProcessJsonData, process_id: str) -> 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

flow_v1_documents_flow_schema_split_pdf_async async 
flow_v1_documents_flow_schema_split_pdf_async(type_: str) -> None

SplitPdfSchema

System

flow_v1_documents_flow_schema_add_watermark_to_pdf_async async 
flow_v1_documents_flow_schema_add_watermark_to_pdf_async(type_: str) -> None

AddWatermarkToPdfSchema

System

flow_v1_processes_flow_schema_get_processes_async async 
flow_v1_processes_flow_schema_get_processes_async() -> None

GetProcessesSchema

System

flow_v1_documents_flow_schema_parse_csv_async async 
flow_v1_documents_flow_schema_parse_csv_async(headers: str) -> None

ParseCsv

System

flow_v1_processes_flow_schema_get_json_data_async async 
flow_v1_processes_flow_schema_get_json_data_async(process_id: str) -> None

GetJsonSchema

System

flow_v1_processes_flow_triggers_by_process_id_schema_get_async async 
flow_v1_processes_flow_triggers_by_process_id_schema_get_async(process_id: str) -> None

Get schema of a process

Returns schema of a process

flow_v1_documents_flow_schema_reg_exp_match_async async 
flow_v1_documents_flow_schema_reg_exp_match_async(pattern: str) -> None

RegexMatchSchema

System