diff --git a/README.md b/README.md index 7b3b0a8..37f1102 100644 --- a/README.md +++ b/README.md @@ -163,6 +163,22 @@ The sample class ```export_pdf_to_jpeg_zip.py``` converts a PDF file's pages to python src/exportpdftoimages/export_pdf_to_jpeg_zip.py ``` +#### Import Form Data Into a PDF File + +The sample class ```import_pdf_form_data.py``` imports form data into a PDF file that contains form fields. + +```$xslt +python src/importpdfformdata/import_pdf_form_data.py +``` + +#### Export Form Data From a PDF File + +The sample class ```export_pdf_form_data.py``` extracts form data from a PDF file that contains filled form fields and returns the data in JSON format. + +```$xslt +python src/exportpdfformdata/export_pdf_form_data.py +``` + ### Combine PDF Files These samples illustrate how to combine multiple PDF files into a single PDF file. @@ -436,7 +452,7 @@ The output of SDK extract operation is Zip package. The Zip package consists of * The structuredData.json file with the extracted content & PDF element structure. See the [JSON schema](https://opensource.adobe.com/pdftools-sdk-docs/release/shared/extractJSONOutputSchema.json). Please refer the [Styling JSON schema](https://opensource.adobe.com/pdftools-sdk-docs/release/shared/extractJSONOutputSchemaStylingInfo.json) for a description of the output when the styling option is enabled. * A renditions' folder(s) containing renditions for each element type selected as input. - The folder name is either “tables” or “figures” depending on your specified element type. + The folder name is either "tables" or "figures" depending on your specified element type. Each folder contains renditions with filenames that correspond to the element information in the JSON file. #### Extract Text Elements diff --git a/docs/apidocs/4.2.0/.buildinfo b/docs/apidocs/4.2.0/.buildinfo new file mode 100644 index 0000000..9050063 --- /dev/null +++ b/docs/apidocs/4.2.0/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 8e1f14ee8280ff203288e3f0e3e231f3 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.auth.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.auth.rst.txt new file mode 100644 index 0000000..73be194 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.auth.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.auth package +======================================== + +Submodules +---------- + +adobe.pdfservices.operation.auth.credentials module +--------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.auth.credentials + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.auth.service\_principal\_credentials module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.auth.service_principal_credentials + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.auth + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.notifier.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.notifier.rst.txt new file mode 100644 index 0000000..34fb35b --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.notifier.rst.txt @@ -0,0 +1,45 @@ +adobe.pdfservices.operation.config.notifier package +=================================================== + +Submodules +---------- + +adobe.pdfservices.operation.config.notifier.callback\_notifier\_data module +--------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.notifier.callback_notifier_data + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.config.notifier.notifier\_config module +------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.notifier.notifier_config + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.config.notifier.notifier\_data module +----------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.notifier.notifier_data + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.config.notifier.notifier\_type module +----------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.notifier.notifier_type + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.config.notifier + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.proxy.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.proxy.rst.txt new file mode 100644 index 0000000..19431b7 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.proxy.rst.txt @@ -0,0 +1,45 @@ +adobe.pdfservices.operation.config.proxy package +================================================ + +Submodules +---------- + +adobe.pdfservices.operation.config.proxy.proxy\_authentication\_credentials module +---------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.config.proxy.proxy\_scheme module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.proxy.proxy_scheme + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.config.proxy.proxy\_server\_config module +--------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.proxy.proxy_server_config + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.config.proxy.username\_password\_credentials module +------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.proxy.username_password_credentials + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.config.proxy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.rst.txt new file mode 100644 index 0000000..c062032 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.config.rst.txt @@ -0,0 +1,30 @@ +adobe.pdfservices.operation.config package +========================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.config.notifier + adobe.pdfservices.operation.config.proxy + +Submodules +---------- + +adobe.pdfservices.operation.config.client\_config module +-------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.config.client_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.config + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.exception.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.exception.rst.txt new file mode 100644 index 0000000..3da0c6a --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.exception.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.exception package +============================================= + +Submodules +---------- + +adobe.pdfservices.operation.exception.exceptions module +------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.exception.exceptions + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.exception + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.rst.txt new file mode 100644 index 0000000..9dcdf20 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.autotagpdf package +======================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag\_pdf\_external\_asset\_request module +------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag\_pdf\_internal\_asset\_request module +------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag\_pdf\_params\_payload module +---------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.autotagpdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.combinepdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.combinepdf.rst.txt new file mode 100644 index 0000000..e07f154 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.combinepdf.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.internal.api.dto.request.combinepdf package +======================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine\_pdf\_external\_asset\_request module +------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine\_pdf\_internal\_asset\_request module +------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.combinepdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.compresspdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.compresspdf.rst.txt new file mode 100644 index 0000000..276cb76 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.compresspdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.compresspdf package +======================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress\_pdf\_external\_asset\_request module +--------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress\_pdf\_internal\_asset\_request module +--------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress\_pdf\_params\_payload module +------------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.compresspdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.createpdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.createpdf.rst.txt new file mode 100644 index 0000000..d4ba756 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.createpdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.createpdf package +====================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.createpdf.create\_pdf\_external\_asset\_request module +----------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.createpdf.create\_pdf\_internal\_asset\_request module +----------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.createpdf.create\_pdf\_params\_payload module +-------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.createpdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.document_generation.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.document_generation.rst.txt new file mode 100644 index 0000000..e69adc8 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.document_generation.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.document\_generation package +================================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.document\_generation.document\_generation\_external\_asset\_request module +------------------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.document\_generation.document\_generation\_internal\_asset\_request module +------------------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.document\_generation.document\_generation\_params\_payload module +---------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.document_generation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.esealpdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.esealpdf.rst.txt new file mode 100644 index 0000000..3f78138 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.esealpdf.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.internal.api.dto.request.esealpdf package +===================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal\_pdf\_external\_asset\_request module +--------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal\_pdf\_internal\_asset\_request module +--------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.esealpdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.exportpdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.exportpdf.rst.txt new file mode 100644 index 0000000..62656d9 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.exportpdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.exportpdf package +====================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export\_pdf\_external\_asset\_request module +----------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export\_pdf\_internal\_asset\_request module +----------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export\_pdf\_params\_payload module +-------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.exportpdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.rst.txt new file mode 100644 index 0000000..962b9fe --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.extract\_pdf package +========================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.extract\_pdf.extract\_pdf\_external\_asset\_request module +--------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.extract\_pdf.extract\_pdf\_internal\_asset\_request module +--------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.extract\_pdf.extract\_pdf\_params\_payload module +------------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.extract_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.rst.txt new file mode 100644 index 0000000..a18f716 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.htmltopdf package +====================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html\_to\_pdf\_external\_asset\_request module +------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html\_to\_pdf\_internal\_asset\_request module +------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html\_to\_pdf\_params\_payload module +---------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.htmltopdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.rst.txt new file mode 100644 index 0000000..44bb980 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.internal.api.dto.request.linearizepdf package +========================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize\_pdf\_external\_asset\_request module +----------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize\_pdf\_internal\_asset\_request module +----------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.linearizepdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.rst.txt new file mode 100644 index 0000000..b06081c --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.ocrpdf package +=================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr\_pdf\_external\_asset\_request module +----------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr\_pdf\_internal\_asset\_request module +----------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr\_pdf\_params\_payload module +-------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.ocrpdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rst.txt new file mode 100644 index 0000000..950407c --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rst.txt @@ -0,0 +1,85 @@ +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation package +============================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete\_page\_action module +------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page\_action module +----------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page\_action\_command module +-------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page\_action\_commands module +--------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page\_actions module +------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page\_manipulation\_external\_asset\_request module +------------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page\_manipulation\_internal\_asset\_request module +------------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page\_manipulation\_params\_payload module +---------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate\_page\_action module +------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.rst.txt new file mode 100644 index 0000000..1a1c5c2 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.pdf\_properties package +============================================================================ + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.pdf\_properties.pdf\_properties\_external\_asset\_request module +--------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pdf\_properties.pdf\_properties\_internal\_asset\_request module +--------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pdf\_properties.pdf\_properties\_params\_payload module +------------------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdf_properties + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.rst.txt new file mode 100644 index 0000000..9a2cb90 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.internal.api.dto.request.pdf\_services\_api package +=============================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.pdf\_services\_api.pdf\_services\_api\_request module +---------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.rst.txt new file mode 100644 index 0000000..cd75a3d --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.pdftoimage package +======================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf\_to\_image\_external\_asset\_request module +--------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf\_to\_image\_internal\_asset\_request module +--------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf\_to\_image\_params\_payload module +------------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.pdftoimage + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.rst.txt new file mode 100644 index 0000000..5d24aef --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.protect\_pdf package +========================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.protect\_pdf.protect\_pdf\_external\_asset\_request module +--------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.protect\_pdf.protect\_pdf\_internal\_asset\_request module +--------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.protect\_pdf.protect\_pdf\_params\_payload module +------------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.protect_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.remove_protection.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.remove_protection.rst.txt new file mode 100644 index 0000000..597d580 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.remove_protection.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.remove\_protection package +=============================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.remove\_protection.remove\_protection\_extenal\_asset\_request module +-------------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.remove\_protection.remove\_protection\_internal\_asset\_request module +--------------------------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.remove\_protection.remove\_protection\_params\_payload module +------------------------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.remove_protection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.rst.txt new file mode 100644 index 0000000..f88bbee --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.rst.txt @@ -0,0 +1,46 @@ +adobe.pdfservices.operation.internal.api.dto.request package +============================================================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf + adobe.pdfservices.operation.internal.api.dto.request.combinepdf + adobe.pdfservices.operation.internal.api.dto.request.compresspdf + adobe.pdfservices.operation.internal.api.dto.request.createpdf + adobe.pdfservices.operation.internal.api.dto.request.document_generation + adobe.pdfservices.operation.internal.api.dto.request.esealpdf + adobe.pdfservices.operation.internal.api.dto.request.exportpdf + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf + adobe.pdfservices.operation.internal.api.dto.request.linearizepdf + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties + adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf + adobe.pdfservices.operation.internal.api.dto.request.remove_protection + adobe.pdfservices.operation.internal.api.dto.request.splitpdf + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.asset\_upload\_uri\_request module +--------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.splitpdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.splitpdf.rst.txt new file mode 100644 index 0000000..5e87f38 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.request.splitpdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api.dto.request.splitpdf package +===================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split\_pdf\_external\_asset\_request module +--------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split\_pdf\_internal\_asset\_request module +--------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split\_pdf\_params\_payload module +------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.request.splitpdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.rst.txt new file mode 100644 index 0000000..93691ee --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.internal.api.dto.response.pdf\_services\_api package +================================================================================ + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.response.pdf\_services\_api.job\_error\_response module +---------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.dto.response.pdf\_services\_api.pdf\_services\_api\_response module +------------------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.response.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.response.rst.txt new file mode 100644 index 0000000..612bd43 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.response.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.internal.api.dto.response package +============================================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.dto.response.job\_status module +------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.response.job_status + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto.response + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.rst.txt new file mode 100644 index 0000000..e660ea7 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.dto.rst.txt @@ -0,0 +1,19 @@ +adobe.pdfservices.operation.internal.api.dto package +==================================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.internal.api.dto.request + adobe.pdfservices.operation.internal.api.dto.response + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api.dto + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.rst.txt new file mode 100644 index 0000000..c00aec2 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.api.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.internal.api package +================================================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.internal.api.dto + +Submodules +---------- + +adobe.pdfservices.operation.internal.api.pdf\_services\_api module +------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.pdf_services_api + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.api.storage\_api module +------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.api.storage_api + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.auth.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.auth.rst.txt new file mode 100644 index 0000000..bddf196 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.auth.rst.txt @@ -0,0 +1,61 @@ +adobe.pdfservices.operation.internal.auth package +================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.auth.auth\_factory module +-------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.auth.auth_factory + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.auth.authenticator module +-------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.auth.authenticator + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.auth.service\_principal\_authenticator module +---------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.auth.service_principal_authenticator + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.auth.service\_token\_authenticator module +------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.auth.service_token_authenticator + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.auth.service\_token\_credentials module +---------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.auth.service_token_credentials + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.auth.session\_token module +--------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.auth.session_token + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.auth + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.constants.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.constants.rst.txt new file mode 100644 index 0000000..a3f7c87 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.constants.rst.txt @@ -0,0 +1,53 @@ +adobe.pdfservices.operation.internal.constants package +====================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.constants.custom\_error\_messages module +----------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.constants.custom_error_messages + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.constants.operation\_header\_info\_endpoint\_map module +-------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.constants.pdf\_services\_uri module +------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.constants.pdf_services_uri + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.constants.request\_key module +------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.constants.request_key + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.constants.service\_constants module +------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.constants.service_constants + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.constants + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.http.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.http.rst.txt new file mode 100644 index 0000000..20f64ea --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.http.rst.txt @@ -0,0 +1,53 @@ +adobe.pdfservices.operation.internal.http package +================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.http.http\_client module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.http.http_client + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.http.http\_method module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.http.http_method + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.http.http\_request module +-------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.http.http_request + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.http.request\_header\_const module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.http.request_header_const + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.http.response\_util module +--------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.http.response_util + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.http + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.params.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.params.rst.txt new file mode 100644 index 0000000..0184e64 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.params.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.internal.params package +=================================================== + +Submodules +---------- + +adobe.pdfservices.operation.internal.params.combine\_pdf\_job\_input module +--------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.params.combine_pdf_job_input + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.params.page\_range module +-------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.params.page_range + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.params + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.rst.txt new file mode 100644 index 0000000..b8814c0 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.rst.txt @@ -0,0 +1,58 @@ +adobe.pdfservices.operation.internal package +============================================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.internal.api + adobe.pdfservices.operation.internal.auth + adobe.pdfservices.operation.internal.constants + adobe.pdfservices.operation.internal.http + adobe.pdfservices.operation.internal.params + adobe.pdfservices.operation.internal.util + +Submodules +---------- + +adobe.pdfservices.operation.internal.exceptions module +------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.exceptions + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.execution\_context module +-------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.execution_context + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.internal\_client\_config module +-------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.internal_client_config + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.pdf\_services\_helper module +----------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.pdf_services_helper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.util.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.util.rst.txt new file mode 100644 index 0000000..12d0bad --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.internal.util.rst.txt @@ -0,0 +1,77 @@ +adobe.pdfservices.operation.internal.util package +================================================= + +Submodules +---------- + +adobe.pdfservices.operation.internal.util.asset\_upload\_util module +-------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.util.asset_upload_util + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.util.enforce\_types module +--------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.util.enforce_types + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.util.file\_utils module +------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.internal.util.file_utils + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.util.json\_hint\_encoder module +-------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.util.json_hint_encoder + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.util.object\_util module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.util.object_util + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.util.path\_util module +----------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.util.path_util + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.util.string\_util module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.util.string_util + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.internal.util.validation\_util module +----------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.internal.util.validation_util + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.internal.util + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.io.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.io.rst.txt new file mode 100644 index 0000000..1ff5d6a --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.io.rst.txt @@ -0,0 +1,53 @@ +adobe.pdfservices.operation.io package +====================================== + +Submodules +---------- + +adobe.pdfservices.operation.io.asset module +------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.io.asset + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.io.cloud\_asset module +-------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.io.cloud_asset + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.io.external\_asset module +----------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.io.external_asset + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.io.external\_storage\_type module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.io.external_storage_type + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.io.stream\_asset module +--------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.io.stream_asset + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.io + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data.rst.txt new file mode 100644 index 0000000..95b028c --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.jobs.export\\_pdf\\_form\\_data package +========================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.jobs.export\\_pdf\\_form\\_data.export\\_pdf\\_form\\_data\\_job module +---------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job + :members: + :undoc-members: + :show-inheritance: + +Module contents +-------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.jobs.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.jobs.rst.txt new file mode 100644 index 0000000..4c73ce5 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.jobs.rst.txt @@ -0,0 +1,181 @@ +adobe.pdfservices.operation.pdfjobs.jobs package +================================================ + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.jobs.autotag\_pdf\_job module +----------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.combine\_pdf\_job module +----------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.compress\_pdf\_job module +------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.create\_pdf\_job module +---------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.delete\_pages\_job module +------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.document\_merge\_job module +-------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.eseal\_job module +---------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.eseal_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.export\_pdf\_job module +---------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.export\_pdf\_to\_images\_job module +---------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.extract\_pdf\_job module +----------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.html\_to\_pdf\_job module +------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.insert\_pages\_job module +------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.linearize\_pdf\_job module +------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.ocr\_pdf\_job module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.pdf\_properties\_job module +-------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.protect\_pdf\_job module +----------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.remove\_protection\_job module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.reorder\_pages\_job module +------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.replace\_pages\_job module +------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.rotate\_pages\_job module +------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.jobs.split\_pdf\_job module +--------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.jobs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.rst.txt new file mode 100644 index 0000000..32e6362 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.autotag\_pdf package +=============================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.autotag\_pdf.autotag\_pdf\_params module +----------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.autotag_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.combine_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.combine_pdf.rst.txt new file mode 100644 index 0000000..c204752 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.combine_pdf.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.combine\_pdf package +=============================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.combine\_pdf.combine\_pdf\_params module +----------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.combine_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.compress_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.compress_pdf.rst.txt new file mode 100644 index 0000000..a64fdf1 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.compress_pdf.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.pdfjobs.params.compress\_pdf package +================================================================ + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.compress\_pdf.compress\_pdf\_params module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.compress\_pdf.compression\_level module +---------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.compress_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.rst.txt new file mode 100644 index 0000000..4daf7ae --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.excel package +==================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.excel.create\_pdf\_from\_excel\_params module +---------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.excel.document\_language module +-------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.rst.txt new file mode 100644 index 0000000..5da7c14 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.ppt package +================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.ppt.create\_pdf\_from\_ppt\_params module +------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.ppt.document\_language module +------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.rst.txt new file mode 100644 index 0000000..df84ae9 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.rst.txt @@ -0,0 +1,31 @@ +adobe.pdfservices.operation.pdfjobs.params.create\_pdf package +============================================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel + adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt + adobe.pdfservices.operation.pdfjobs.params.create_pdf.word + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.CreatePDFParams module +----------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.rst.txt new file mode 100644 index 0000000..a6452f6 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.word package +=================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.word.create\_pdf\_from\_word\_params module +-------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.create\_pdf.word.document\_language module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.word + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.delete_pages.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.delete_pages.rst.txt new file mode 100644 index 0000000..48d1f51 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.delete_pages.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.delete\_pages package +================================================================ + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.delete\_pages.delete\_pages\_params module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.delete_pages + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.documentmerge.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.documentmerge.rst.txt new file mode 100644 index 0000000..7e3aaeb --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.documentmerge.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.pdfjobs.params.documentmerge package +================================================================ + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.documentmerge.document\_merge\_params module +--------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments module +------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.documentmerge.output\_format module +------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.documentmerge + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.eseal.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.eseal.rst.txt new file mode 100644 index 0000000..5597fa5 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.eseal.rst.txt @@ -0,0 +1,109 @@ +adobe.pdfservices.operation.pdfjobs.params.eseal package +======================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161\_tsa\_options module +----------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.appearance\_item module +------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.appearance\_options module +--------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.csc\_auth\_context module +-------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.csc\_credentials module +------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.document\_level\_permission module +----------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.electronic\_seal\_params module +-------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.field\_location module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.field_location + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.field\_options module +---------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.field_options + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.signature\_format module +------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.tsa\_basic\_auth\_credentials module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.eseal.tsa\_options module +-------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.export_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.export_pdf.rst.txt new file mode 100644 index 0000000..8e3269a --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.export_pdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.pdfjobs.params.export\_pdf package +============================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.export\_pdf.export\_ocr\_locale module +--------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.export\_pdf.export\_pdf\_params module +--------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.export\_pdf.export\_pdf\_target\_format module +----------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.export_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.extract_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.extract_pdf.rst.txt new file mode 100644 index 0000000..e3402ea --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.extract_pdf.rst.txt @@ -0,0 +1,45 @@ +adobe.pdfservices.operation.pdfjobs.params.extract\_pdf package +=============================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.extract\_pdf.extract\_element\_type module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.extract\_pdf.extract\_pdf\_params module +----------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.extract\_pdf.extract\_renditions\_element\_type module +------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.extract\_pdf.table\_structure\_type module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.rst.txt new file mode 100644 index 0000000..48ac664 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.pdfjobs.params.html\_to\_pdf package +================================================================ + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.html\_to\_pdf.html\_to\_pdf\_params module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.html\_to\_pdf.page\_layout module +---------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.html_to_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.rst.txt new file mode 100644 index 0000000..3834dcf --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.import\_pdf\_form\_data package +========================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.import\_pdf\_form\_data.import\_pdf\_form\_data\_params module +---------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +-------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.insert_pages.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.insert_pages.rst.txt new file mode 100644 index 0000000..5e78c22 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.insert_pages.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.insert\_pages package +================================================================ + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.insert\_pages.insert\_pages\_params module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.insert_pages + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.rst.txt new file mode 100644 index 0000000..4abef4b --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.pdfjobs.params.ocr\_pdf package +=========================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.ocr\_pdf.ocr\_params module +---------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.ocr\_pdf.ocr\_supported\_locale module +--------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.ocr\_pdf.ocr\_supported\_type module +------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.ocr_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.pdf_properties.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.pdf_properties.rst.txt new file mode 100644 index 0000000..e677198 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.pdf_properties.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.pdf\_properties package +================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.pdf\_properties.pdf\_properties\_params module +----------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_properties + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.rst.txt new file mode 100644 index 0000000..990cdb6 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.rst.txt @@ -0,0 +1,37 @@ +adobe.pdfservices.operation.pdfjobs.params.pdf\_to\_image package +================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.pdf\_to\_image.export\_pdf\_to\_images\_output\_type module +------------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.pdf\_to\_image.export\_pdf\_to\_images\_params module +------------------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.pdf\_to\_image.export\_pdf\_to\_images\_target\_format module +-------------------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_to_image + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.protect_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.protect_pdf.rst.txt new file mode 100644 index 0000000..cfbe7ba --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.protect_pdf.rst.txt @@ -0,0 +1,61 @@ +adobe.pdfservices.operation.pdfjobs.params.protect\_pdf package +=============================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.protect\_pdf.content\_encryption module +---------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.protect\_pdf.encryption\_algorithm module +------------------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.protect\_pdf.password\_protect\_params module +---------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.protect\_pdf.permission module +------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.protect\_pdf.permissions module +-------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.protect\_pdf.protect\_pdf\_params module +----------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.remove_protection.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.remove_protection.rst.txt new file mode 100644 index 0000000..d7c71fb --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.remove_protection.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.remove\_protection package +===================================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.remove\_protection.remove\_protection\_params module +---------------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.remove_protection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.reorder_pages.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.reorder_pages.rst.txt new file mode 100644 index 0000000..7bdbc0d --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.reorder_pages.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.reorder\_pages package +================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.reorder\_pages.reorder\_pages\_params module +--------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.reorder_pages + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.replace_pages.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.replace_pages.rst.txt new file mode 100644 index 0000000..7fe7494 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.replace_pages.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.replace\_pages package +================================================================= + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.replace\_pages.replace\_pages\_params module +--------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.replace_pages + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rst.txt new file mode 100644 index 0000000..bdaea3c --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rst.txt @@ -0,0 +1,29 @@ +adobe.pdfservices.operation.pdfjobs.params.rotate\_pages package +================================================================ + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.rotate\_pages.angle module +--------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.rotate\_pages.rotate\_pages\_params module +------------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.rotate_pages + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.rst.txt new file mode 100644 index 0000000..9980573 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.rst.txt @@ -0,0 +1,57 @@ +adobe.pdfservices.operation.pdfjobs.params package +================================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.pdfjobs.params.autotag_pdf + adobe.pdfservices.operation.pdfjobs.params.combine_pdf + adobe.pdfservices.operation.pdfjobs.params.compress_pdf + adobe.pdfservices.operation.pdfjobs.params.create_pdf + adobe.pdfservices.operation.pdfjobs.params.delete_pages + adobe.pdfservices.operation.pdfjobs.params.documentmerge + adobe.pdfservices.operation.pdfjobs.params.eseal + adobe.pdfservices.operation.pdfjobs.params.export_pdf + adobe.pdfservices.operation.pdfjobs.params.extract_pdf + adobe.pdfservices.operation.pdfjobs.params.html_to_pdf + adobe.pdfservices.operation.pdfjobs.params.insert_pages + adobe.pdfservices.operation.pdfjobs.params.ocr_pdf + adobe.pdfservices.operation.pdfjobs.params.pdf_properties + adobe.pdfservices.operation.pdfjobs.params.pdf_to_image + adobe.pdfservices.operation.pdfjobs.params.protect_pdf + adobe.pdfservices.operation.pdfjobs.params.remove_protection + adobe.pdfservices.operation.pdfjobs.params.reorder_pages + adobe.pdfservices.operation.pdfjobs.params.replace_pages + adobe.pdfservices.operation.pdfjobs.params.rotate_pages + adobe.pdfservices.operation.pdfjobs.params.split_pdf + adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.page\_ranges module +-------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.page_ranges + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.params.pdf\_services\_job\_params module +---------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.split_pdf.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.split_pdf.rst.txt new file mode 100644 index 0000000..c849069 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.params.split_pdf.rst.txt @@ -0,0 +1,21 @@ +adobe.pdfservices.operation.pdfjobs.params.split\_pdf package +============================================================= + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.params.split\_pdf.split\_pdf\_params module +------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.split_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.result.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.result.rst.txt new file mode 100644 index 0000000..0beb3de --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.result.rst.txt @@ -0,0 +1,189 @@ +adobe.pdfservices.operation.pdfjobs.result package +================================================== + +Submodules +---------- + +adobe.pdfservices.operation.pdfjobs.result.autotag\_pdf\_result module +---------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.combine\_pdf\_result module +---------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.compress\_pdf\_result module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.create\_pdf\_result module +--------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.create_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.delete\_pages\_result module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.delete_pages_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.document\_merge\_result module +------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.document_merge_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.eseal\_pdf\_result module +-------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.export\_pdf\_result module +--------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.export_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.export\_pdf\_to\_images\_result module +--------------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.extract\_pdf\_result module +---------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.html\_to\_pdf\_result module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.insert\_pages\_result module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.insert_pages_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.linearize\_pdf\_result module +------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.ocr\_pdf\_result module +------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.pdf\_properties\_result module +------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.pdf\_services\_job\_result module +---------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.protect\_pdf\_result module +---------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.remove\_protection\_result module +---------------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.remove_protection_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.reorder\_pages\_result module +------------------------------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.replace\_page\_result module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.replace_page_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.rotate\_pages\_result module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdfjobs.result.split\_pdf\_result module +-------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result.split_pdf_result + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs.result + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.rst.txt new file mode 100644 index 0000000..b0d3ecc --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.pdfjobs.rst.txt @@ -0,0 +1,20 @@ +adobe.pdfservices.operation.pdfjobs package +=========================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.pdfjobs.jobs + adobe.pdfservices.operation.pdfjobs.params + adobe.pdfservices.operation.pdfjobs.result + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation.pdfjobs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.rst.txt new file mode 100644 index 0000000..e4059dc --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.operation.rst.txt @@ -0,0 +1,82 @@ +adobe.pdfservices.operation package +=================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation.auth + adobe.pdfservices.operation.config + adobe.pdfservices.operation.exception + adobe.pdfservices.operation.internal + adobe.pdfservices.operation.io + adobe.pdfservices.operation.pdfjobs + +Submodules +---------- + +adobe.pdfservices.operation.pdf\_services module +------------------------------------------------ + +.. automodule:: adobe.pdfservices.operation.pdf_services + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdf\_services\_job module +----------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdf_services_job + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdf\_services\_job\_status module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdf_services_job_status + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdf\_services\_job\_status\_response module +----------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdf_services_job_status_response + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdf\_services\_media\_type module +------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdf_services_media_type + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.pdf\_services\_response module +---------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.pdf_services_response + :members: + :undoc-members: + :show-inheritance: + +adobe.pdfservices.operation.region module +----------------------------------------- + +.. automodule:: adobe.pdfservices.operation.region + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: adobe.pdfservices.operation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.pdfservices.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.rst.txt new file mode 100644 index 0000000..f90e3dd --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.pdfservices.rst.txt @@ -0,0 +1,18 @@ +adobe.pdfservices package +========================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices.operation + +Module contents +--------------- + +.. automodule:: adobe.pdfservices + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/adobe.rst.txt b/docs/apidocs/4.2.0/_sources/adobe.rst.txt new file mode 100644 index 0000000..0e54dea --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/adobe.rst.txt @@ -0,0 +1,18 @@ +adobe package +============= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + adobe.pdfservices + +Module contents +--------------- + +.. automodule:: adobe + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/index.rst.txt b/docs/apidocs/4.2.0/_sources/index.rst.txt new file mode 100644 index 0000000..d0edabc --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/index.rst.txt @@ -0,0 +1,20 @@ +.. pdfservices-sdk documentation master file, created by + sphinx-quickstart on Wed May 8 11:12:09 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to pdfservices-sdk's documentation! +=========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + reference/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/apidocs/4.2.0/_sources/modules.rst.txt b/docs/apidocs/4.2.0/_sources/modules.rst.txt new file mode 100644 index 0000000..acbba50 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/modules.rst.txt @@ -0,0 +1,7 @@ +src +=== + +.. toctree:: + :maxdepth: 4 + + adobe diff --git a/docs/apidocs/4.2.0/_sources/reference/auth.rst.txt b/docs/apidocs/4.2.0/_sources/reference/auth.rst.txt new file mode 100644 index 0000000..d80c250 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/auth.rst.txt @@ -0,0 +1,19 @@ +Authentication +================== +.. toctree:: + :maxdepth: 3 + + +Credentials +------------------- +.. autoclass:: adobe.pdfservices.operation.auth.credentials.Credentials + :members: + :undoc-members: + :show-inheritance: + +ServicePrincipalCredentials +------------------- +.. autoclass:: adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/reference/config.rst.txt b/docs/apidocs/4.2.0/_sources/reference/config.rst.txt new file mode 100644 index 0000000..0d4e7fc --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/config.rst.txt @@ -0,0 +1,17 @@ +Config +================== +.. toctree:: + :maxdepth: 3 + + config/notifier + config/proxy + +ClientConfig +------------------- +.. autoclass:: adobe.pdfservices.operation.config.client_config.ClientConfig + :members: + :undoc-members: + :show-inheritance: + :exclude-members: get_pdf_services_uri, validate + + diff --git a/docs/apidocs/4.2.0/_sources/reference/config/notifier.rst.txt b/docs/apidocs/4.2.0/_sources/reference/config/notifier.rst.txt new file mode 100644 index 0000000..f90910f --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/config/notifier.rst.txt @@ -0,0 +1,36 @@ +Notifier Config +================== +.. toctree:: + :maxdepth: 3 + + +CallbackNotifierData +------------------- +.. autoclass:: adobe.pdfservices.operation.config.notifier.callback_notifier_data.CallbackNotifierData + :members: + :undoc-members: + :show-inheritance: + :exclude-members: json_hint,to_json + +NotifierConfig +------------------- +.. autoclass:: adobe.pdfservices.operation.config.notifier.notifier_config.NotifierConfig + :members: + :undoc-members: + :show-inheritance: + :exclude-members: json_hint,to_json + +NotifierData +------------------- +.. autoclass:: adobe.pdfservices.operation.config.notifier.notifier_data.NotifierData + :members: + :undoc-members: + :show-inheritance: + +NotifierType +------------------- +.. autoclass:: adobe.pdfservices.operation.config.notifier.notifier_type.NotifierType + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/apidocs/4.2.0/_sources/reference/config/proxy.rst.txt b/docs/apidocs/4.2.0/_sources/reference/config/proxy.rst.txt new file mode 100644 index 0000000..b03452c --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/config/proxy.rst.txt @@ -0,0 +1,34 @@ +Proxy Config +================== +.. toctree:: + :maxdepth: 3 + + +ProxyAuthenticationCredentials +------------------- +.. autoclass:: adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials.ProxyAuthenticationCredentials + :members: + :undoc-members: + :show-inheritance: + +ProxyScheme +------------------- +.. autoclass:: adobe.pdfservices.operation.config.proxy.proxy_scheme.ProxyScheme + :members: + :undoc-members: + :show-inheritance: + +ProxyServerConfig +------------------- +.. autoclass:: adobe.pdfservices.operation.config.proxy.proxy_server_config.ProxyServerConfig + :members: + :undoc-members: + :show-inheritance: + :exclude-members: get_port_based_on_scheme, proxy_config_map + +UsernamePasswordCredentials +------------------- +.. autoclass:: adobe.pdfservices.operation.config.proxy.username_password_credentials.UsernamePasswordCredentials + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/reference/exception.rst.txt b/docs/apidocs/4.2.0/_sources/reference/exception.rst.txt new file mode 100644 index 0000000..95c6d99 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/exception.rst.txt @@ -0,0 +1,28 @@ +Exceptions +================== +.. toctree:: + :maxdepth: 3 + +ServiceUsageException +------------------- +.. automodule:: adobe.pdfservices.operation.exception.exceptions.ServiceUsageException + :members: + :undoc-members: + :show-inheritance: + +ServiceApiException +------------------- +.. automodule:: adobe.pdfservices.operation.exception.exceptions.ServiceApiException + :members: + :undoc-members: + :show-inheritance: + +SdkException +------------------- +.. automodule:: adobe.pdfservices.operation.exception.exceptions.SdkException + :members: + :undoc-members: + :show-inheritance: + + + diff --git a/docs/apidocs/4.2.0/_sources/reference/index.rst.txt b/docs/apidocs/4.2.0/_sources/reference/index.rst.txt new file mode 100644 index 0000000..9d58771 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/index.rst.txt @@ -0,0 +1,61 @@ +API Reference +============= + +.. toctree:: + :maxdepth: 3 + :caption: Contents: + + auth + config + exception + io + pdfjobs + +PDFServices +------------------- +.. autoclass:: adobe.pdfservices.operation.pdf_services.PDFServices + :members: + :undoc-members: + :show-inheritance: + +PDFServicesJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdf_services_job.PDFServicesJob + :members: + :undoc-members: + :show-inheritance: + +PDFServicesJobStatus +------------------- +.. autoclass:: adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus + :members: + :undoc-members: + :show-inheritance: + +PDFServicesJobStatusResponse +------------------- +.. autoclass:: adobe.pdfservices.operation.pdf_services_job_status_response.PDFServicesJobStatusResponse + :members: + :undoc-members: + :show-inheritance: + +PDFServicesMediaType +------------------- +.. autoclass:: adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType + :members: + :undoc-members: + :show-inheritance: + +PDFServicesResponse +------------------- +.. autoclass:: adobe.pdfservices.operation.pdf_services_response.PDFServicesResponse + :members: + :undoc-members: + :show-inheritance: + +Region +------------------- +.. autoclass:: adobe.pdfservices.operation.region.Region + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/reference/io.rst.txt b/docs/apidocs/4.2.0/_sources/reference/io.rst.txt new file mode 100644 index 0000000..9b5809b --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/io.rst.txt @@ -0,0 +1,41 @@ +IO +================== +.. toctree:: + :maxdepth: 3 + + +Asset +------------------- +.. autoclass:: adobe.pdfservices.operation.io.asset.Asset + :members: + :undoc-members: + :show-inheritance: + +CloudAsset +------------------- +.. autoclass:: adobe.pdfservices.operation.io.cloud_asset.CloudAsset + :members: + :undoc-members: + :show-inheritance: + +ExternalAsset +------------------- +.. autoclass:: adobe.pdfservices.operation.io.external_asset.ExternalAsset + :members: + :undoc-members: + :show-inheritance: + :exclude-members: json_hint, to_json + +ExternalStorageType +------------------- +.. autoclass:: adobe.pdfservices.operation.io.external_storage_type.ExternalStorageType + :members: + :undoc-members: + :show-inheritance: + +StreamAsset +------------------- +.. autoclass:: adobe.pdfservices.operation.io.stream_asset.StreamAsset + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_sources/reference/pdfjobs.rst.txt b/docs/apidocs/4.2.0/_sources/reference/pdfjobs.rst.txt new file mode 100644 index 0000000..032832a --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/pdfjobs.rst.txt @@ -0,0 +1,8 @@ +PDF Jobs +================== +.. toctree:: + :maxdepth: 3 + + pdfjobs/jobs + pdfjobs/params + pdfjobs/result \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_sources/reference/pdfjobs/jobs.rst.txt b/docs/apidocs/4.2.0/_sources/reference/pdfjobs/jobs.rst.txt new file mode 100644 index 0000000..45be3e0 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/pdfjobs/jobs.rst.txt @@ -0,0 +1,180 @@ +Jobs +================== +.. toctree:: + :maxdepth: 3 + + +AutotagPDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job.AutotagPDFJob + :members: + :undoc-members: + :show-inheritance: + +CombinePDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job.CombinePDFJob + :members: + :undoc-members: + :show-inheritance: + +CompressPDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job.CompressPDFJob + :members: + :undoc-members: + :show-inheritance: + +CreatePDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job.CreatePDFJob + :members: + :undoc-members: + :show-inheritance: + +DeletePagesJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job.DeletePagesJob + :members: + :undoc-members: + :show-inheritance: + +DocumentMergeJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job.DocumentMergeJob + :members: + :undoc-members: + :show-inheritance: + +PDFElectronicSealJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.eseal_job.PDFElectronicSealJob + :members: + :undoc-members: + :show-inheritance: + +ExportPDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job.ExportPDFJob + :members: + :undoc-members: + :show-inheritance: + +ExportPDFtoImagesJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job.ExportPDFtoImagesJob + :members: + :undoc-members: + :show-inheritance: + +ExtractPDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job.ExtractPDFJob + :members: + :undoc-members: + :show-inheritance: + +HTMLtoPDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job.HTMLtoPDFJob + :members: + :undoc-members: + :show-inheritance: + +InsertPagesJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job.InsertPagesJob + :members: + :undoc-members: + :show-inheritance: + +LinearizePDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job.LinearizePDFJob + :members: + :undoc-members: + :show-inheritance: + +OCRPDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job.OCRPDFJob + :members: + :undoc-members: + :show-inheritance: + +PDFPropertiesJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job.PDFPropertiesJob + :members: + :undoc-members: + :show-inheritance: + +ProtectPDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job.ProtectPDFJob + :members: + :undoc-members: + :show-inheritance: + +RemoveProtectionJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job.RemoveProtectionJob + :members: + :undoc-members: + :show-inheritance: + +ReorderPagesJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job.ReorderPagesJob + :members: + :undoc-members: + :show-inheritance: + +ReplacePagesJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job.ReplacePagesJob + :members: + :undoc-members: + :show-inheritance: + +RotatePagesJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job.RotatePagesJob + :members: + :undoc-members: + :show-inheritance: + +SplitPDFJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job.SplitPDFJob + :members: + :undoc-members: + :show-inheritance: + +PDFWatermarkJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.pdf_watermark_job.PDFWatermarkJob + :members: + :undoc-members: + :show-inheritance: + +PDFAccessibilityCheckerJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.pdf_accessibility_checker_job.PDFAccessibilityCheckerJob + :members: + :undoc-members: + :show-inheritance: + +ImportPDFFormDataJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.import_pdf_form_data_job.ImportPDFFormDataJob + :members: + :undoc-members: + :show-inheritance: + +ExportPDFFormDataJob +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job.ExportPDFFormDataJob + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_sources/reference/pdfjobs/params.rst.txt b/docs/apidocs/4.2.0/_sources/reference/pdfjobs/params.rst.txt new file mode 100644 index 0000000..7958606 --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/pdfjobs/params.rst.txt @@ -0,0 +1,465 @@ +Params +================== +.. toctree:: + :maxdepth: 3 + +AutotagPDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params + :members: + :undoc-members: + :show-inheritance: + +CombinePDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params + :members: + :undoc-members: + :show-inheritance: + +CompressPDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params + :members: + :undoc-members: + :show-inheritance: + +CompressionLevel +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level + :members: + :undoc-members: + :show-inheritance: + +CreatePDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams + :members: + :undoc-members: + :show-inheritance: + :exclude-members: get_create_tagged_pdf,get_document_language + + +CreatePDFFromExcelParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params + :members: + :undoc-members: + :show-inheritance: + :exclude-members: get_create_tagged_pdf + +DocumentLanguage +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language + :members: + :undoc-members: + :show-inheritance: + +CreatePDFFromPPTParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params + :members: + :undoc-members: + :show-inheritance: + :exclude-members: get_create_tagged_pdf + +DocumentLanguage +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language + :members: + :undoc-members: + :show-inheritance: + +CreatePDFFromWordParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params + :members: + :undoc-members: + :show-inheritance: + :exclude-members: get_create_tagged_pdf + +DocumentLanguage +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language + :members: + :undoc-members: + :show-inheritance: + +DeletePagesParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params + :members: + :undoc-members: + :show-inheritance: + +DocumentMergeParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params + :members: + :undoc-members: + :show-inheritance: + +Fragments +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments + :members: + :undoc-members: + :show-inheritance: + +OutputFormat +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format + :members: + :undoc-members: + :show-inheritance: + +PDFElectronicSealParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params + :members: + :undoc-members: + :show-inheritance: + :exclude-members: to_dict + +RFC3161TSAOptions +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options + :members: + :undoc-members: + :show-inheritance: + :exclude-members: to_dict + +AppearanceItem +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item + :members: + :undoc-members: + :show-inheritance: + :exclude-members: get_appearance_item + +AppearanceOptions +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options + :members: + :undoc-members: + :show-inheritance: + +CSCAuthContext +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context + :members: + :undoc-members: + :show-inheritance: + :exclude-members: to_dict + +CSCCredentials +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials + :members: + :undoc-members: + :show-inheritance: + :exclude-members: to_dict + +DocumentLevelPermission +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission + :members: + :undoc-members: + :show-inheritance: + +FieldLocation +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.field_location + :members: + :undoc-members: + :show-inheritance: + :exclude-members: to_dict + +FieldOptions +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.field_options + :members: + :undoc-members: + :show-inheritance: + :exclude-members: to_dict + +SignatureFormat +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format + :members: + :undoc-members: + :show-inheritance: + +TSABasicAuthCredentials +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials + :members: + :undoc-members: + :show-inheritance: + :exclude-members: to_dict + +ImportPDFFormDataParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params + :members: + :undoc-members: + :show-inheritance: + +ExportPDFFormDataParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.export_pdf_form_data.export_pdf_form_data_params + :members: + :undoc-members: + :show-inheritance: + +TSAOptions +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options + :members: + :undoc-members: + :show-inheritance: + :exclude-members: to_dict + +ExportPDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params + :members: + :undoc-members: + :show-inheritance: + +ExportOCRLocale +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale + :members: + :undoc-members: + :show-inheritance: + +ExportPDFTargetFormat +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format + :members: + :undoc-members: + :show-inheritance: + +ExtractPDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params + :members: + :undoc-members: + :show-inheritance: + +ExtractElementType +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type + :members: + :undoc-members: + :show-inheritance: + +ExtractRenditionsElementType +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type + :members: + :undoc-members: + :show-inheritance: + +TableStructureType +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type + :members: + :undoc-members: + :show-inheritance: + +HTMLtoPDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params + :members: + :undoc-members: + :show-inheritance: + +PageLayout +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout + :members: + :undoc-members: + :show-inheritance: + :exclude-members: json_hint,to_json + +InsertPagesParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params + :members: + :undoc-members: + :show-inheritance: + +OCRParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params + :members: + :undoc-members: + :show-inheritance: + +OCRSupportedLocale +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale + :members: + :undoc-members: + :show-inheritance: + +OCRSupportedType +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type + :members: + :undoc-members: + :show-inheritance: + +PDFPropertiesParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params + :members: + :undoc-members: + :show-inheritance: + +ExportPDFtoImagesParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params + :members: + :undoc-members: + :show-inheritance: + +ExportPDFToImagesOutputType +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type + :members: + :undoc-members: + :show-inheritance: + +ExportPDFToImagesTargetFormat +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format + :members: + :undoc-members: + :show-inheritance: + +ProtectPDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params + :members: + :undoc-members: + :show-inheritance: + +ContentEncryption +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption + :members: + :undoc-members: + :show-inheritance: + +EncryptionAlgorithm +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm + :members: + :undoc-members: + :show-inheritance: + +PasswordProtectParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params + :members: + :undoc-members: + :show-inheritance: + +Permission +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission + :members: + :undoc-members: + :show-inheritance: + +Permissions +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions + :members: + :undoc-members: + :show-inheritance: + +RemoveProtectionParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params + :members: + :undoc-members: + :show-inheritance: + +ReorderPagesParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params + :members: + :undoc-members: + :show-inheritance: + +ReplacePagesParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params + :members: + :undoc-members: + :show-inheritance: + +RotatePagesParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params + :members: + :undoc-members: + :show-inheritance: + +Angle +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle + :members: + :undoc-members: + :show-inheritance: + +SplitPDFParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params + :members: + :undoc-members: + :show-inheritance: + :exclude-members: json_hint,to_json + +PageRanges +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges + :members: + :undoc-members: + :show-inheritance: + :exclude-members: json_hint,validate,to_json + +PDFServicesJobParams +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params.PDFServicesJobParams + :members: + :undoc-members: + :show-inheritance: + +PDFWatermarkParams +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params.PDFWatermarkParams + :members: + :undoc-members: + :show-inheritance: + +WatermarkAppearance +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.WatermarkAppearance + :members: + :undoc-members: + :show-inheritance: + :exclude-members: json_hint,to_json + +PDFAccessibilityCheckerParams +------------------- +.. automodule:: adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params + :members: + :undoc-members: + :show-inheritance: + + diff --git a/docs/apidocs/4.2.0/_sources/reference/pdfjobs/result.rst.txt b/docs/apidocs/4.2.0/_sources/reference/pdfjobs/result.rst.txt new file mode 100644 index 0000000..5bd010a --- /dev/null +++ b/docs/apidocs/4.2.0/_sources/reference/pdfjobs/result.rst.txt @@ -0,0 +1,187 @@ +Result +================== +.. toctree:: + :maxdepth: 3 + + +AutotagPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result.AutotagPDFResult + :members: + :undoc-members: + :show-inheritance: + +CombinePDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result.CombinePDFResult + :members: + :undoc-members: + :show-inheritance: + +CompressPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result.CompressPDFResult + :members: + :undoc-members: + :show-inheritance: + +CreatePDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.create_pdf_result.CreatePDFResult + :members: + :undoc-members: + :show-inheritance: + +DeletePagesResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.delete_pages_result.DeletePagesResult + :members: + :undoc-members: + :show-inheritance: + +DocumentMergeResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.document_merge_result.DocumentMergePDFResult + :members: + :undoc-members: + :show-inheritance: + +ESealPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result.ESealPDFResult + :members: + :undoc-members: + :show-inheritance: + +ExportPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.export_pdf_result.ExportPDFResult + :members: + :undoc-members: + :show-inheritance: + +ExportPDFtoImagesResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result.ExportPDFtoImagesResult + :members: + :undoc-members: + :show-inheritance: + +ExtractPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result.ExtractPDFResult + :members: + :undoc-members: + :show-inheritance: + +HTMLtoPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result.HTMLtoPDFResult + :members: + :undoc-members: + :show-inheritance: + +InsertPagesResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.insert_pages_result.InsertPagesResult + :members: + :undoc-members: + :show-inheritance: + +LinearizePDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result.LinearizePDFResult + :members: + :undoc-members: + :show-inheritance: + +OCRPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result.OCRPDFResult + :members: + :undoc-members: + :show-inheritance: + +PDFPropertiesResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result.PDFPropertiesResult + :members: + :undoc-members: + :show-inheritance: + +ProtectPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result.ProtectPDFResult + :members: + :undoc-members: + :show-inheritance: + +RemoveProtectionResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.remove_protection_result.RemoveProtectionResult + :members: + :undoc-members: + :show-inheritance: + +ReorderPagesResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result.ReorderPagesResult + :members: + :undoc-members: + :show-inheritance: + +ReplacePagesResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.replace_page_result.ReplacePagesResult + :members: + :undoc-members: + :show-inheritance: + +RotatePagesResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result.RotatePagesResult + :members: + :undoc-members: + :show-inheritance: + +SplitPDFResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.split_pdf_result.SplitPDFResult + :members: + :undoc-members: + :show-inheritance: + +PDFServicesJobResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result.PDFServicesJobResult + :members: + :undoc-members: + :show-inheritance: + +PDFWatermarkResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.pdf_watermark_result.PDFWatermarkResult + :members: + :undoc-members: + :show-inheritance: + +PDFAccessibilityCheckerResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.pdf_accessibility_checker_result.PDFAccessibilityCheckerResult + :members: + :undoc-members: + :show-inheritance: + +ImportPDFFormDataResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.import_pdf_form_data_result.ImportPDFFormDataResult + :members: + :undoc-members: + :show-inheritance: + +ExportPDFFormDataResult +------------------- +.. autoclass:: adobe.pdfservices.operation.pdfjobs.result.export_pdf_form_data_result.ExportPDFFormDataResult + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/4.2.0/_static/_sphinx_javascript_frameworks_compat.js b/docs/apidocs/4.2.0/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8141580 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/docs/apidocs/4.2.0/_static/basic.css b/docs/apidocs/4.2.0/_static/basic.css new file mode 100644 index 0000000..7ebbd6d --- /dev/null +++ b/docs/apidocs/4.2.0/_static/basic.css @@ -0,0 +1,914 @@ +/* + * Sphinx stylesheet -- basic theme. + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin-top: 10px; +} + +ul.search li { + padding: 5px 0; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_static/css/badge_only.css b/docs/apidocs/4.2.0/_static/css/badge_only.css new file mode 100644 index 0000000..88ba55b --- /dev/null +++ b/docs/apidocs/4.2.0/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px} \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.eot b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.svg b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.ttf b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.woff b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.woff2 b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/lato-bold-italic.woff b/docs/apidocs/4.2.0/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/lato-bold-italic.woff differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/lato-bold-italic.woff2 b/docs/apidocs/4.2.0/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/lato-bold.woff b/docs/apidocs/4.2.0/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/lato-bold.woff differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/lato-bold.woff2 b/docs/apidocs/4.2.0/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/lato-bold.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/lato-normal-italic.woff b/docs/apidocs/4.2.0/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/lato-normal-italic.woff differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/lato-normal-italic.woff2 b/docs/apidocs/4.2.0/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/lato-normal.woff b/docs/apidocs/4.2.0/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/lato-normal.woff differ diff --git a/docs/apidocs/4.2.0/_static/css/fonts/lato-normal.woff2 b/docs/apidocs/4.2.0/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/css/fonts/lato-normal.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/css/theme.css b/docs/apidocs/4.2.0/_static/css/theme.css new file mode 100644 index 0000000..0f14f10 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search .wy-dropdown>aactive,.wy-side-nav-search .wy-dropdown>afocus,.wy-side-nav-search>a:hover,.wy-side-nav-search>aactive,.wy-side-nav-search>afocus{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon,.wy-side-nav-search>a.icon{display:block}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.switch-menus{position:relative;display:block;margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-side-nav-search>div.switch-menus>div.language-switch,.wy-side-nav-search>div.switch-menus>div.version-switch{display:inline-block;padding:.2em}.wy-side-nav-search>div.switch-menus>div.language-switch select,.wy-side-nav-search>div.switch-menus>div.version-switch select{display:inline-block;margin-right:-2rem;padding-right:2rem;max-width:240px;text-align-last:center;background:none;border:none;border-radius:0;box-shadow:none;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-size:1em;font-weight:400;color:hsla(0,0%,100%,.3);cursor:pointer;appearance:none;-webkit-appearance:none;-moz-appearance:none}.wy-side-nav-search>div.switch-menus>div.language-switch select:active,.wy-side-nav-search>div.switch-menus>div.language-switch select:focus,.wy-side-nav-search>div.switch-menus>div.language-switch select:hover,.wy-side-nav-search>div.switch-menus>div.version-switch select:active,.wy-side-nav-search>div.switch-menus>div.version-switch select:focus,.wy-side-nav-search>div.switch-menus>div.version-switch select:hover{background:hsla(0,0%,100%,.1);color:hsla(0,0%,100%,.5)}.wy-side-nav-search>div.switch-menus>div.language-switch select option,.wy-side-nav-search>div.switch-menus>div.version-switch select option{color:#000}.wy-side-nav-search>div.switch-menus>div.language-switch:has(>select):after,.wy-side-nav-search>div.switch-menus>div.version-switch:has(>select):after{display:inline-block;width:1.5em;height:100%;padding:.1em;content:"\f0d7";font-size:1em;line-height:1.2em;font-family:FontAwesome;text-align:center;pointer-events:none;box-sizing:border-box}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_static/custom.css b/docs/apidocs/4.2.0/_static/custom.css new file mode 100644 index 0000000..faea178 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/custom.css @@ -0,0 +1,3 @@ +.wy-nav-content { + max-width: 75% !important; +} \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_static/doctools.js b/docs/apidocs/4.2.0/_static/doctools.js new file mode 100644 index 0000000..0398ebb --- /dev/null +++ b/docs/apidocs/4.2.0/_static/doctools.js @@ -0,0 +1,149 @@ +/* + * Base JavaScript utilities for all Sphinx HTML documentation. + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/apidocs/4.2.0/_static/documentation_options.js b/docs/apidocs/4.2.0/_static/documentation_options.js new file mode 100644 index 0000000..e1ef608 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '3.0.0', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_static/file.png b/docs/apidocs/4.2.0/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/file.png differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.eot b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 0000000..3361183 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.eot differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.ttf b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 0000000..29f691d Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.ttf differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.woff b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.woff differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.woff2 b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.eot b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 0000000..3d41549 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.ttf b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 0000000..f402040 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.woff b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.woff2 b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.eot b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 0000000..3f82642 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.eot differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.ttf b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 0000000..b4bfc9b Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.ttf differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.woff b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.woff differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.woff2 b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.eot b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 0000000..11e3f2a Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.eot differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.ttf b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 0000000..74decd9 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.ttf differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.woff b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.woff differ diff --git a/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.woff2 b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 0000000..79dc8ef Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 0000000..df5d1df Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 0000000..2f7ca78 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 0000000..eb52a79 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/docs/apidocs/4.2.0/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/docs/apidocs/4.2.0/_static/jquery.js b/docs/apidocs/4.2.0/_static/jquery.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t a.language.name.localeCompare(b.language.name)); + + const languagesHTML = ` +
+
Languages
+ ${languages + .map( + (translation) => ` +
+ ${translation.language.code} +
+ `, + ) + .join("\n")} +
+ `; + return languagesHTML; + } + + function renderVersions(config) { + if (!config.versions.active.length) { + return ""; + } + const versionsHTML = ` +
+
Versions
+ ${config.versions.active + .map( + (version) => ` +
+ ${version.slug} +
+ `, + ) + .join("\n")} +
+ `; + return versionsHTML; + } + + function renderDownloads(config) { + if (!Object.keys(config.versions.current.downloads).length) { + return ""; + } + const downloadsNameDisplay = { + pdf: "PDF", + epub: "Epub", + htmlzip: "HTML", + }; + + const downloadsHTML = ` +
+
Downloads
+ ${Object.entries(config.versions.current.downloads) + .map( + ([name, url]) => ` +
+ ${downloadsNameDisplay[name]} +
+ `, + ) + .join("\n")} +
+ `; + return downloadsHTML; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const flyout = ` +
+ + Read the Docs + v: ${config.versions.current.slug} + + +
+
+ ${renderLanguages(config)} + ${renderVersions(config)} + ${renderDownloads(config)} +
+
On Read the Docs
+
+ Project Home +
+
+ Builds +
+
+ Downloads +
+
+
+
Search
+
+
+ +
+
+
+
+ + Hosted by Read the Docs + +
+
+ `; + + // Inject the generated flyout into the body HTML element. + document.body.insertAdjacentHTML("beforeend", flyout); + + // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout. + document + .querySelector("#flyout-search-form") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); + }) +} + +if (themeLanguageSelector || themeVersionSelector) { + function onSelectorSwitch(event) { + const option = event.target.selectedIndex; + const item = event.target.options[option]; + window.location.href = item.dataset.url; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const versionSwitch = document.querySelector( + "div.switch-menus > div.version-switch", + ); + if (themeVersionSelector) { + let versions = config.versions.active; + if (config.versions.current.hidden || config.versions.current.type === "external") { + versions.unshift(config.versions.current); + } + const versionSelect = ` + + `; + + versionSwitch.innerHTML = versionSelect; + versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + + const languageSwitch = document.querySelector( + "div.switch-menus > div.language-switch", + ); + + if (themeLanguageSelector) { + if (config.projects.translations.length) { + // Add the current language to the options on the selector + let languages = config.projects.translations.concat( + config.projects.current, + ); + languages = languages.sort((a, b) => + a.language.name.localeCompare(b.language.name), + ); + + const languageSelect = ` + + `; + + languageSwitch.innerHTML = languageSelect; + languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + else { + languageSwitch.remove(); + } + } + }); +} + +document.addEventListener("readthedocs-addons-data-ready", function (event) { + // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav. + document + .querySelector("[role='search'] input") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); +}); \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_static/language_data.js b/docs/apidocs/4.2.0/_static/language_data.js new file mode 100644 index 0000000..c7fe6c6 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/language_data.js @@ -0,0 +1,192 @@ +/* + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/docs/apidocs/4.2.0/_static/minus.png b/docs/apidocs/4.2.0/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/docs/apidocs/4.2.0/_static/minus.png differ diff --git a/docs/apidocs/4.2.0/_static/plus.png b/docs/apidocs/4.2.0/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/docs/apidocs/4.2.0/_static/plus.png differ diff --git a/docs/apidocs/4.2.0/_static/pygments.css b/docs/apidocs/4.2.0/_static/pygments.css new file mode 100644 index 0000000..5f2b0a2 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #eeffcc; } +.highlight .c { color: #408090; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #F00 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666 } /* Operator */ +.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408090; background-color: #FFF0F0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #F00 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #333 } /* Generic.Output */ +.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #04D } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070A0 } /* Literal.String */ +.highlight .na { color: #4070A0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0E84B5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60ADD5 } /* Name.Constant */ +.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #D55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287E } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0E84B5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #BB60D5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #BBB } /* Text.Whitespace */ +.highlight .mb { color: #208050 } /* Literal.Number.Bin */ +.highlight .mf { color: #208050 } /* Literal.Number.Float */ +.highlight .mh { color: #208050 } /* Literal.Number.Hex */ +.highlight .mi { color: #208050 } /* Literal.Number.Integer */ +.highlight .mo { color: #208050 } /* Literal.Number.Oct */ +.highlight .sa { color: #4070A0 } /* Literal.String.Affix */ +.highlight .sb { color: #4070A0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070A0 } /* Literal.String.Char */ +.highlight .dl { color: #4070A0 } /* Literal.String.Delimiter */ +.highlight .sd { color: #4070A0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070A0 } /* Literal.String.Double */ +.highlight .se { color: #4070A0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070A0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70A0D0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #C65D09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070A0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #06287E } /* Name.Function.Magic */ +.highlight .vc { color: #BB60D5 } /* Name.Variable.Class */ +.highlight .vg { color: #BB60D5 } /* Name.Variable.Global */ +.highlight .vi { color: #BB60D5 } /* Name.Variable.Instance */ +.highlight .vm { color: #BB60D5 } /* Name.Variable.Magic */ +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/apidocs/4.2.0/_static/searchtools.js b/docs/apidocs/4.2.0/_static/searchtools.js new file mode 100644 index 0000000..2c774d1 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/searchtools.js @@ -0,0 +1,632 @@ +/* + * Sphinx JavaScript utilities for the full-text search. + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename, kind] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename, kind] = item; + + let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + SearchResultKind.title, + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + SearchResultKind.index, + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + SearchResultKind.object, + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + SearchResultKind.text, + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/docs/apidocs/4.2.0/_static/sphinx_highlight.js b/docs/apidocs/4.2.0/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/docs/apidocs/4.2.0/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/apidocs/4.2.0/adobe.html b/docs/apidocs/4.2.0/adobe.html new file mode 100644 index 0000000..75d659d --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.html @@ -0,0 +1,1372 @@ + + + + + + + + + adobe package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.html b/docs/apidocs/4.2.0/adobe.pdfservices.html new file mode 100644 index 0000000..97f2d30 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.html @@ -0,0 +1,1489 @@ + + + + + + + + + adobe.pdfservices package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices package

+
+

Subpackages

+
+ +
+
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.auth.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.auth.html new file mode 100644 index 0000000..9d6ca48 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.auth.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.auth package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.auth package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.auth.credentials module

+
+
+class adobe.pdfservices.operation.auth.credentials.Credentials
+

Bases: ABC

+

This abstract class represents the basic contract for the credentials to be used with +ServicePrincipalCredentials.

+
+ +
+
+

adobe.pdfservices.operation.auth.service_principal_credentials module

+
+
+class adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials(client_id: str, client_secret: str)
+

Bases: Credentials

+

Service Principal credentials allow your application to call PDF Services API. For getting the credentials, +Click Here.

+

Constructs an instance of ServicePrincipalCredentials.

+
+
Parameters:
+
    +
  • client_id (str) – client ID for ServicePrincipalCredentials; can not be None or empty.

  • +
  • client_secret (str) – client secret for ServicePrincipalCredentials; can not be None or empty.

  • +
+
+
+
+
+get_client_id()
+
+
Returns:
+

Client Id

+
+
Return type:
+

str

+
+
+
+ +
+
+get_client_secret()
+
+
Returns:
+

Client Secret

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.html new file mode 100644 index 0000000..02db7ec --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.html @@ -0,0 +1,1543 @@ + + + + + + + + + adobe.pdfservices.operation.config package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.config package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

adobe.pdfservices.operation.config.client_config module

+
+
+class adobe.pdfservices.operation.config.client_config.ClientConfig(*, connect_timeout: int = 4000, read_timeout: int = 10000, region: Region = Region.US, proxy_server_config: ProxyServerConfig = None)
+

Bases: object

+

Encapsulates the API request configurations.

+

Constructs an instance of ClientConfig.

+
+
Parameters:
+
    +
  • connect_timeout (int) – determines the timeout in milliseconds until a connection is established in the API +calls. Default value is 4000 milliseconds.

  • +
  • read_timeout (int) – Defines the read timeout in milliseconds, The number of milliseconds the client will wait for the server to send a response after the connection is established. Default value is 10000 milliseconds

  • +
  • region (Region) – Default value is US.

  • +
  • proxy_server_config (ProxyServerConfig) – Sets the configuration for proxy server.

  • +
+
+
+
+
+from_file(client_config_file_path: str)
+

Sets the connect timeout and read timeout using the JSON client config file path. All the keys in the JSON structure are optional.

+
+
Parameters:
+

client_config_file_path (str) – JSON client config file path

+
+
Returns:
+

This Builder instance to add any additional parameters.

+
+
Return type:
+

ClientConfig.Builder

+
+
+

JSON structure:

+
{
+    "connectTimeout": "4000",
+    "readTimeout": "20000",
+    "proxyServerConfig": {
+        "host": "127.0.0.1",
+        "port": "8080",
+        "scheme": "https",
+        "usernamePasswordCredentials": {
+            "username": "username",
+            "password": "password"
+            }
+    },
+    "region": "EU"
+}
+
+
+
+ +
+
+get_connect_timeout()
+
+
Returns:
+

Connect timeout.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_pdf_services_uri()
+
+
Returns:
+

The PDF Service URI used.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_proxy_server_config()
+
+
Returns:
+

Proxy server config used.

+
+
Return type:
+

ProxyServerConfig

+
+
+
+ +
+
+get_read_timeout()
+
+
Returns:
+

Read timeout.

+
+
Return type:
+

int

+
+
+
+ +
+
+validate()
+

Validator for the created client config.

+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.notifier.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.notifier.html new file mode 100644 index 0000000..988fc72 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.notifier.html @@ -0,0 +1,1452 @@ + + + + + + + + + adobe.pdfservices.operation.config.notifier package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.config.notifier package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.config.notifier.callback_notifier_data module

+
+
+class adobe.pdfservices.operation.config.notifier.callback_notifier_data.CallbackNotifierData(url: str, *, headers: Dict = None)
+

Bases: NotifierData

+

Represents the configuration for the notifier data.

+

Constructs an instance of CallbackNotifierData.

+
+
Parameters:
+
    +
  • url (str) – Callback URL, can not be None

  • +
  • headers (dict) – Callback headers. (Optional, use key-value)

  • +
+
+
+
+
+json_hint = {'headers': 'headers', 'url': 'url'}
+

For JSON Representation of this class, used internally by SDK.

+
+ +
+
+to_json()
+
+
Returns:
+

Representation of CallbackNotifierData as a JSON string, used internally by the SDK.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.config.notifier.notifier_config module

+
+
+class adobe.pdfservices.operation.config.notifier.notifier_config.NotifierConfig(notifier_type: NotifierType, notifier_data: NotifierData)
+

Bases: object

+

Represents the configuration for a notifier to be used to notify user about the completion of a +PDFServicesJob.

+

Constructs an instance of NotifierConfig.

+
+
Parameters:
+
    +
  • notifier_type (NotifierType) – specifies the type of notifier; can not be None.

  • +
  • notifier_data (NotifierData) – encapsulates callback notifier data; can not be None.

  • +
+
+
+
+
+json_hint = {'notifier_data': 'data', 'notifier_type': 'type'}
+

For JSON Representation of this class, used internally by SDK.

+
+ +
+
+to_json()
+
+
Returns:
+

representation of NotifierConfig as a JSON string, used internally by the SDK.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.config.notifier.notifier_data module

+
+
+class adobe.pdfservices.operation.config.notifier.notifier_data.NotifierData
+

Bases: ABC

+

This abstract class represents the basic contract for the notifier data to be used with +NotifierConfig

+
+ +
+
+

adobe.pdfservices.operation.config.notifier.notifier_type module

+
+
+class adobe.pdfservices.operation.config.notifier.notifier_type.NotifierType(value)
+

Bases: Enum

+

Notifier Type Mapping.

+
+
+CALLBACK = 'CALLBACK'
+

Callback notifier type.

+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.proxy.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.proxy.html new file mode 100644 index 0000000..e95f132 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.config.proxy.html @@ -0,0 +1,1580 @@ + + + + + + + + + adobe.pdfservices.operation.config.proxy package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.config.proxy package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials module

+
+
+class adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials.ProxyAuthenticationCredentials
+

Bases: ABC

+

This abstract class represents the basic contract for the credentials to be used with +ProxyServerConfig.

+
+ +
+
+

adobe.pdfservices.operation.config.proxy.proxy_scheme module

+
+
+class adobe.pdfservices.operation.config.proxy.proxy_scheme.ProxyScheme(value)
+

Bases: Enum

+

Supported scheme types for +ProxyServerConfig.

+
+
+HTTP = 'http'
+

Represents HTTP scheme.

+
+ +
+
+HTTPS = 'https'
+

Represents HTTPS scheme.

+
+ +
+
+classmethod get(proxy_scheme)
+

Returns the instance of ProxyScheme for the input string.

+
+
Parameters:
+

proxy_scheme (str) – String value of the scheme.

+
+
Returns:
+

the instance of ProxyScheme for the input string.

+
+
Return type:
+

ProxyScheme

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.config.proxy.proxy_server_config module

+
+
+class adobe.pdfservices.operation.config.proxy.proxy_server_config.ProxyServerConfig(host: str, *, port: int = None, scheme: ProxyScheme = ProxyScheme.HTTP, credentials: ProxyAuthenticationCredentials = None)
+

Bases: object

+

Encapsulates the proxy server configurations.

+

Creates an instance of ProxyServerConfig.

+
+
Parameters:
+
    +
  • host (str) – Host name. (Optional, use key-value)

  • +
  • port (int) – port number of proxy server. It should be greater than 0. Scheme’s default port is used if not +provided. (Optional, use key-value)

  • +
  • scheme (ProxyScheme) – scheme of proxy server. Possible values are HTTP and HTTPS. Default value is HTTP. (Optional, +use key-value)

  • +
  • credentials (ProxyAuthenticationCredentials) – ProxyAuthenticationCredentials} instance. (Optional, use key-value)

  • +
+
+
+
+
+HTTPS_PORT = 443
+

Represents default port for HTTPS scheme.

+
+ +
+
+HTTP_PORT = 80
+

Represents default port for HTTP scheme.

+
+ +
+
+from_json(json_data: dict)
+

Creates a proxy server instance from a json file.

+
{
+"proxyServerConfig": {
+        "host": "127.0.0.1",
+        "port": "8080",
+        "scheme": "https",
+        "usernamePasswordCredentials": {
+            "username": "username",
+            "password": "password"
+        }
+    },
+}
+
+
+
+
Parameters:
+

json_data (dict) – A dictionary containing proxy server config in the specified format.

+
+
+
+ +
+
+get_credentials()
+
+
Returns:
+

the credentials for authenticating with a proxy server.

+
+
Return type:
+

ProxyAuthenticationCredentials

+
+
+
+ +
+
+get_host()
+
+
Returns:
+

the host name of proxy server.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_port()
+
+
Returns:
+

the port number of proxy server.

+
+
Return type:
+

int

+
+
+
+ +
+
+classmethod get_port_based_on_scheme(scheme: ProxyScheme)
+

Used internally by the SDK.

+
+ +
+
+get_proxy_scheme()
+
+
Returns:
+

the scheme of proxy server.

+
+
Return type:
+

ProxyScheme

+
+
+
+ +
+
+proxy_config_map() dict[str, str]
+

Used internally by the SDK.

+
+ +
+ +
+
+

adobe.pdfservices.operation.config.proxy.username_password_credentials module

+
+
+class adobe.pdfservices.operation.config.proxy.username_password_credentials.UsernamePasswordCredentials(username: str, password: str)
+

Bases: ProxyAuthenticationCredentials

+

Simple +ProxyAuthenticationCredentials +implementation based on a username and password.

+

Constructs an instance of UsernamePasswordCredentials.

+
+
Parameters:
+
    +
  • username (str) – Username. Cannot be none or empty.

  • +
  • password (str) – Password. Cannot be none or empty.

  • +
+
+
+
+
+from_json(json_data: dict)
+

Constructs a UsernamePasswordCredentials instance from a dictionary in the specified format.

+
+
Parameters:
+

json_data (dict) – JSON data in the form of a dictionary.

+
+
+
+ +
+
+get_password() str
+
+
Returns:
+

the password.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_username() str
+
+
Returns:
+

the username.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.exception.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.exception.html new file mode 100644 index 0000000..f60ef3f --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.exception.html @@ -0,0 +1,1441 @@ + + + + + + + + + adobe.pdfservices.operation.exception package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.exception package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.exception.exceptions module

+
+
+exception adobe.pdfservices.operation.exception.exceptions.SdkException(message, request_tracking_id=None)
+

Bases: Exception

+

SdkException is typically thrown for client-side or network errors.

+
+
+property request_tracking_id
+

The request tracking id of the exception.

+
+ +
+ +
+
+exception adobe.pdfservices.operation.exception.exceptions.ServiceApiException(message, request_tracking_id, status_code=0, error_code='UNKNOWN')
+

Bases: Exception

+

ServiceApiException is thrown when an underlying service API call results in an error.

+
+
+DEFAULT_ERROR_CODE = 'UNKNOWN'
+

Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.

+
+ +
+
+DEFAULT_STATUS_CODE = 0
+

The default value of status code if there is no status code for this service exception.

+
+ +
+
+property error_code
+

Returns the detailed message of this error.

+
+ +
+
+property request_tracking_id
+

The request tracking id of the exception.

+
+ +
+
+property status_code
+

Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the +error.

+
+ +
+ +
+
+exception adobe.pdfservices.operation.exception.exceptions.ServiceUsageException(message, request_tracking_id, status_code=429, error_code='UNKNOWN')
+

Bases: Exception

+

ServiceUsageError is thrown when either service usage limit has been reached or credentials quota has been +exhausted.

+
+
+DEFAULT_ERROR_CODE = 'UNKNOWN'
+

The default value of error code if there is no status code for this service failure.

+
+ +
+
+DEFAULT_STATUS_CODE = 429
+

The default value of status code if there is no status code for this service failure.

+
+ +
+
+property error_code
+

Returns the detailed message of this error.

+
+ +
+
+property request_tracking_id
+

The request tracking id of the exception.

+
+ +
+
+property status_code
+

Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the +error.

+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.html new file mode 100644 index 0000000..8d7fbec --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.html @@ -0,0 +1,2239 @@ + + + + + + + + + adobe.pdfservices.operation package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdf_services module

+
+
+class adobe.pdfservices.operation.pdf_services.PDFServices(credentials: Credentials, *, client_config: ClientConfig | None = None)
+

Bases: object

+

This class is the entry point for all the PDF Service utilities. +These utilities can be used to perform various functions such as submitting +PDFServicesJob, +getting status of a PDFServicesJob, +getting result of a PDFServicesJob, +uploading Asset, +getting content of an Asset, +deleting an Asset and refreshing an +Asset.

+

Constructs a new PDFServices instance with the given Credentials and ClientConfig.

+
+
Parameters:
+
    +
  • credentials (Credentials) – Credentials to be used for authentication; can not be None.

  • +
  • client_config (ClientConfig) – Client configuration for PDFServices. (Optional, use key-value)

  • +
+
+
+
+
+delete_asset(asset: Asset)
+

Deletes asset from PDF Services storage.

+
+
Parameters:
+

asset (Asset) – Asset to be deleted; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
+
+ +
+
+get_content(asset: Asset) StreamAsset
+
+
Parameters:
+

asset (Asset) – Asset to the content; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
Returns:
+

Returns the content of the asset.

+
+
Return type:
+

StreamAsset

+
+
+
+ +
+
+get_job_result(polling_url: str, result_type: ABCMeta) PDFServicesResponse
+

Returns PDFServicesResponse for the submitted +PDFServicesJob result.

+
+
Parameters:
+
    +
  • polling_url (str) – URL to be polled to get the job result; can not be None.

  • +
  • result_type (PDFServicesJobResult.__class__) – result class for +PDFServicesJob, it will be an +implementation of PDFServicesJobResult; can not be None.

  • +
+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
Returns:
+

PDFServicesResponse for the submitted job.

+
+
Return type:
+

PDFServicesResponse

+
+
+
+ +
+
+get_job_status(polling_url: str) PDFServicesJobStatusResponse
+
+
Parameters:
+

polling_url (str) – URL to be polled to get the job status; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
  • ServiceUsageException – If service usage limits have been reached or credentials quota has been +exhausted.

  • +
+
+
Returns:
+

Returns PDFServicesJobStatusResponse for the submitted +PDFServicesJob.

+
+
Return type:
+

PDFServicesJobStatusResponse

+
+
+
+ +
+
+refresh_download_uri(asset: Asset) Asset
+
+
Parameters:
+

asset (Asset) – asset to be refreshed; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
Returns:
+

a new Asset with a new valid download URI.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+submit(pdf_services_job: PDFServicesJob, *, notify_config_list: List | None = None) str
+

Creates the PDFServicesJob +and returns the polling URL.

+
+
Parameters:
+
    +
  • pdf_services_job (PDFServicesJob) – PDFServicesJob} to be submitted; can not be None.

  • +
  • notify_config_list (list) – List of +NotifierConfig +to be used for notification. (Optional, use key-value)

  • +
+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
  • ServiceUsageException – If service usage limits have been reached or credentials quota has been +exhausted.

  • +
+
+
Returns:
+

the polling URL.

+
+
Return type:
+

str

+
+
+
+ +
+
+upload(input_stream: Any, mime_type: str) Asset
+

Upload content from input stream and returns an Asset +to be used in PDF Services SDK.

+

Method will not close the input stream, responsibility of closing the input stream lies with the client.

+
+
Parameters:
+
    +
  • input_stream – input stream that is to be uploaded; can not be None.

  • +
  • mime_type (str) – mime type of the input stream; can not be None.

  • +
+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
  • ServiceUsageException – If service usage limits have been reached or credentials quota has been +exhausted.

  • +
+
+
Returns:
+

asset containing the uploaded content

+
+
Return type:
+

Asset

+
+
+
+ +
+
+upload_assets(upload_asset_list: List) []
+

Upload content from list of StreamAsset and +returns a list of Asset to be used in PDF Services +SDK.

+

Method will not close the input stream of the Stream Asset, responsibility of closing the input stream lies +with the client.

+
+
Parameters:
+

upload_asset_list (list) – StreamAsset +list that is to be uploaded; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
Returns:
+

returns a list of Asset to be used in PDF Services +SDK.

+
+
Return type:
+

list

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdf_services_job module

+
+
+class adobe.pdfservices.operation.pdf_services_job.PDFServicesJob
+

Bases: ABC

+

This abstract class represents the basic contract for all the PDF Services Jobs. +It imposes no restrictions or particular details on the job execution process and leaves the +specifics of setting up the jobs to their individual implementations.

+
+ +
+
+

adobe.pdfservices.operation.pdf_services_job_status module

+
+
+class adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus(value)
+

Bases: Enum

+

Status types for PDFServicesJob.

+

Constructs PDF Services job status using its string representation.

+
+
Parameters:
+

value (str) – string representation of PDF services job status.

+
+
+
+
+DONE = 'done'
+

Represents completed status

+
+ +
+
+FAILED = 'failed'
+

Represents failed status

+
+ +
+
+IN_PROGRESS = 'in progress'
+

Represents in progress status

+
+ +
+
+get_value()
+
+
Returns:
+

string representation of PDFServicesJobStatus.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdf_services_job_status_response module

+
+
+class adobe.pdfservices.operation.pdf_services_job_status_response.PDFServicesJobStatusResponse(status: str, headers: {})
+

Bases: object

+

Response object encapsulating PDFServicesJob +status and retry interval.

+

Constructs PDFServicesJob status response +with its status, headers.

+
+
Parameters:
+
    +
  • status (str) – Status of the +PDFServicesJob.

  • +
  • headers (dict) – Headers of the +PDFServicesResponse.

  • +
+
+
+
+
+get_retry_interval() int
+
+
Returns:
+

retry interval for status polling of the +PDFServicesJob in seconds.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_status()
+
+
Returns:
+

string representation of +PDFServicesJobStatus +for the PDFServicesJob.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdf_services_media_type module

+
+
+class adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType(value)
+

Bases: str, Enum

+

An enumeration.

+
+
+AI = 'application/illustrator'
+

Represents ai mime type.

+
+ +
+
+BMP = 'image/bmp'
+

Represents bmp mime type.

+
+ +
+
+CSV = 'text/csv'
+

Represents csv mime type.

+
+ +
+
+DOC = 'application/msword'
+

Represents msword mime type.

+
+ +
+
+DOCX = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+

Represents docx mime type.

+
+ +
+
+GIF = 'image/gif'
+

Represents gif mime type.

+
+ +
+
+HTML = 'text/html'
+

Represents html mime type.

+
+ +
+
+INDD = 'application/x-indesign'
+

Represents indd mime type.

+
+ +
+
+JPEG = 'image/jpeg'
+

Represents jpeg mime type.

+
+ +
+
+JPG = 'image/jpeg'
+

Represents jpg mime type.

+
+ +
+
+JSON = 'application/json'
+

Represents json mime type.

+
+ +
+
+PDF = 'application/pdf'
+

Represents pdf mime type.

+
+ +
+
+PNG = 'image/png'
+

Represents png mime type.

+
+ +
+
+PPT = 'application/vnd.ms-powerpoint'
+

Represents ppt mime type.

+
+ +
+
+PPTX = 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+

Represents pptx mime type.

+
+ +
+
+PSD = 'image/vnd.adobe.photoshop'
+

Represents psd mime type.

+
+ +
+
+RTF = 'text/rtf'
+

Represents rtf mime type.

+
+ +
+
+SVG = 'image/svg+xml'
+

Represents svg mime type.

+
+ +
+
+TIF = 'image/tiff'
+

Represents tif mime type.

+
+ +
+
+TIFF = 'image/tiff'
+

Represents tiff mime type.

+
+ +
+
+TXT = 'text/plain'
+

Represents txt mime type.

+
+ +
+
+XLS = 'application/vnd.ms-excel'
+

Represents xls mime type.

+
+ +
+
+XLSX = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+

Represents xlsx mime type.

+
+ +
+
+ZIP = 'application/zip'
+

Represents zip mime type.

+
+ +
+
+property extension
+
+
Returns:
+

Extension of PDFServicesMediaType.

+
+
+
+ +
+
+static get_from_extension(extension: str)
+
+
Returns:
+

PDFServicesMediaType for the given extension.

+
+
+
+ +
+
+property mime_type
+
+
Returns:
+

Media type of PDFServicesMediaType.

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdf_services_response module

+
+
+class adobe.pdfservices.operation.pdf_services_response.PDFServicesResponse(status: str, headers: {<class 'str'>: <class 'str'>}, result)
+

Bases: PDFServicesJobStatusResponse

+

Response object for PDFServicesJob.

+

Constructs PDFServicesJob response with +its status, headers and result.

+
+
Parameters:
+
+
+
+
+
+get_result()
+
+
Returns:
+

Returns instance of result of +PDFServicesJob.

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.region module

+
+
+class adobe.pdfservices.operation.region.Region(value)
+

Bases: str, Enum

+

Supported regions to be used with ClientConfig.

+
+
+EU = 'eu'
+

Represents +“Europe” +region

+
+ +
+
+US = 'us'
+

Represents +“US” +region

+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.html new file mode 100644 index 0000000..3938f79 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.html @@ -0,0 +1,1538 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto package

+
+

Subpackages

+
+ +
+
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.html new file mode 100644 index 0000000..91f1947 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.autotagpdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request.AutotagPDFExternalAssetRequest(input_asset: Asset, autotag_pdf_params: AutotagPDFParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request.AutotagPDFInternalAssetRequest(asset_id: str, autotag_pdf_params: AutotagPDFParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest, ABC

+
+
+json_hint = {'asset_id': 'assetID', 'generate_report': 'generateReport', 'notify_config_list': 'notifiers', 'shift_headings': 'shiftHeadings'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload.AutotagPDFParamsPayload(autotag_pdf_params: AutotagPDFParams)
+

Bases: object

+
+
+json_hint = {'generate_report': 'generateReport', 'shift_headings': 'shiftHeadings'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.combinepdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.combinepdf.html new file mode 100644 index 0000000..072a2c0 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.combinepdf.html @@ -0,0 +1,1386 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.combinepdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.combinepdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request.CombinePDFExternalAssetRequest(combine_pdf_params: CombinePDFParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'inputs': 'inputs', 'notify_config_list': 'notifiers', 'output': 'output'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request.CombinePDFInternalAssetRequest(combine_pdf_params: CombinePDFParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest, ABC

+
+
+json_hint = {'assets': 'assets', 'notify_config_list': 'notifiers'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.compresspdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.compresspdf.html new file mode 100644 index 0000000..abe3df2 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.compresspdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.compresspdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.compresspdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request.CompressPDFExternalAssetRequest(input_asset: Asset, compress_pdf_params: CompressPDFParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request.CompressPDFInternalAssetRequest(input_asset_id: str, compress_pdf_params: CompressPDFParams, notify_config_list: List[NotifierConfig])
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'compression_level': 'compressionLevel', 'notify_config_list': 'notifiers'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload.CompressPDFParamsPayload(compress_pdf_params: CompressPDFParams)
+

Bases: object

+
+
+json_hint = {'compression_level': 'compressionLevel'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.createpdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.createpdf.html new file mode 100644 index 0000000..9877f70 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.createpdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.createpdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.createpdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request.CreatePDFExternalAssetRequest(input_asset: Asset, create_pdf_params: CreatePDFParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request.CreatePDFInternalAssetRequest(asset_id, create_pdf_params: CreatePDFParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'create_tagged_pdf': 'createTaggedPDF', 'document_language': 'documentLanguage', 'notify_config_list': 'notifiers'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload.CreatePDFParamsPayload(create_pdf_params: CreatePDFParams)
+

Bases: object

+
+
+json_hint = {'create_tagged_pdf': 'createTaggedPDF', 'document_language': 'documentLanguage'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.document_generation.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.document_generation.html new file mode 100644 index 0000000..93905e8 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.document_generation.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.document_generation package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.document_generation package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request.DocumentMergeExternalAssetRequest(input_asset: Asset, document_merge_params: DocumentMergeParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request.DocumentMergeInternalAssetRequest(asset_id: str, document_merge_params: DocumentMergeParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'fragments': 'fragments', 'json_data_for_merge': 'jsonDataForMerge', 'notify_config_list': 'notifiers', 'output_format': 'outputFormat'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload.DocumentGenerationParamsPayload(document_merge_params: DocumentMergeParams)
+

Bases: object

+
+
+json_hint = {'fragments': 'fragments', 'json_data_for_merge': 'jsonDataForMerge', 'output_format': 'outputFormat'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.esealpdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.esealpdf.html new file mode 100644 index 0000000..7e2a728 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.esealpdf.html @@ -0,0 +1,1386 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.esealpdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.esealpdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request.ESealPDFExternalAssetRequest(input_asset: Asset, electronic_seal_params: PDFElectronicSealParams, seal_image_asset: Asset | None = None, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'inputs': 'inputs', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request.ESealPDFInternalAssetRequest(input_document_asset_id: str, seal_image_asset_id: str, electronic_seal_params: PDFElectronicSealParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input_document_asset_id': 'inputDocumentAssetID', 'notify_config_list': 'notifiers', 'seal_image_asset_id': 'sealImageAssetID', 'seal_options': 'sealOptions'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.exportpdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.exportpdf.html new file mode 100644 index 0000000..df2caec --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.exportpdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.exportpdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.exportpdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request.ExportPDFExternalAssetRequest(input_asset: Asset, export_pdf_params: ExportPDFParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request.ExportPDFInternalAssetRequest(input_asset_id: str, export_pdf_params: ExportPDFParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'notify_config_list': 'notifiers', 'ocr_lang': 'ocrLang', 'target_format': 'targetFormat'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload.ExportPDFParamsPayload(export_pdf_params: ExportPDFParams)
+

Bases: object

+
+
+json_hint = {'ocr_lang': 'ocrLang', 'target_format': 'targetFormat'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.html new file mode 100644 index 0000000..3865ded --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.extract_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request.ExtractPDFExternalAssetRequest(input_asset: Asset, extract_pdf_params: ExtractPDFParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request.ExtractPDFInternalAssetRequest(input_asset_id: str, extract_pdf_params: ExtractPDFParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'elements_to_extract': 'elementsToExtract', 'get_char_bounds': 'getCharBounds', 'include_styling': 'includeStyling', 'notify_config_list': 'notifiers', 'renditions_to_extract': 'renditionsToExtract', 'table_output_format': 'tableOutputFormat'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload.ExtractPDFParamsPayload(extract_pdf_params: ExtractPDFParams)
+

Bases: object

+
+
+json_hint = {'elements_to_extract': 'elementsToExtract', 'get_char_bounds': 'getCharBounds', 'include_styling': 'includeStyling', 'renditions_to_extract': 'renditionsToExtract', 'table_output_format': 'tableOutputFormat'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.html new file mode 100644 index 0000000..9c98b0e --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.html @@ -0,0 +1,1910 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request.AssetUploadURIRequest(media_type: str)
+

Bases: object

+
+
+json_hint = {'mediaType': 'mediaType'}
+
+ +
+
+property media_type
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html new file mode 100644 index 0000000..5728b7d --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.htmltopdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request.HTMLtoPDFExternalAssetRequest(input_asset: Asset, html_to_pdf_params: HTMLtoPDFParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request.HTMLtoPDFInternalAssetRequest(input_asset_id, input_url, html_to_pdf_params: HTMLtoPDFParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'include_header_footer': 'includeHeaderFooter', 'input_url': 'inputUrl', 'json': 'json', 'notify_config_list': 'notifiers', 'page_layout': 'pageLayout'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload.HTMLtoPDFParamsPayload(html_to_pdf_params: HTMLtoPDFParams)
+

Bases: object

+
+
+json_hint = {'include_header_footer': 'includeHeaderFooter', 'json': 'json', 'page_layout': 'pageLayout'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.html new file mode 100644 index 0000000..53475b7 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.html @@ -0,0 +1,1386 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.linearizepdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.linearizepdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request.LinearizePDFExternalAssetRequest(input_asset: Asset, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request.LinearizePDFInternalAssetRequest(input_asset_id: str, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'notify_config_list': 'notifiers'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.html new file mode 100644 index 0000000..ca2092d --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.ocrpdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request.OCRPDFExternalAssetRequest(input_asset: Asset, ocr_pdf_params: OCRParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request.OCRPDFInternalAssetRequest(input_asset_id: str, ocr_pdf_params: OCRParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'notify_config_list': 'notifiers', 'ocr_lang': 'ocrLang', 'ocr_type': 'ocrType'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload.OCRParamsPayload(ocr_params: OCRParams)
+

Bases: object

+
+
+json_hint = {'ocr_lang': 'ocrLang', 'ocr_type': 'ocrType'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.html new file mode 100644 index 0000000..726fe18 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.html @@ -0,0 +1,1529 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action.DeletePageAction(page_ranges)
+

Bases: PageAction

+
+
+get_type()
+
+ +
+
+json_hint = {'page_ranges': 'pageRanges'}
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action.PageAction(page_ranges: PageRanges)
+

Bases: ABC

+
+
+get_page_ranges()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command.PageActionCommand(*, delete_action: DeletePageAction | None = None, rotate_action: RotatePageAction | None = None)
+

Bases: object

+
+
+static create_from(action: PageAction)
+
+ +
+
+json_hint = {'delete_action': 'delete', 'rotate_action': 'rotate'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands.PageActionCommands
+

Bases: object

+
+
+add_command(command: PageActionCommand)
+
+ +
+
+get_commands()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions.PageActions
+

Bases: object

+
+
+add_action(action: PageAction)
+
+ +
+
+get_actions()
+
+ +
+
+get_length()
+
+ +
+
+is_empty()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request.PageManipulationExternalAssetRequest(input_asset: Asset, page_action_commands: PageActionCommands, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request.PageManipulationInternalAssetRequest(input_asset_id: str, page_action_commands: PageActionCommands, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'notify_config_list': 'notifiers', 'page_actions': 'pageActions'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload.PageManipulationParamsPayload(page_action_commands: PageActionCommands)
+

Bases: object

+
+
+json_hint = {'page_actions': 'pageActions'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action.RotatePageAction(page_ranges: PageRanges, rotation_angle: Angle)
+

Bases: PageAction

+
+
+get_rotation_angle()
+
+ +
+
+json_hint = {'page_ranges': 'pageRanges', 'rotation_angle': 'angle'}
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.html new file mode 100644 index 0000000..2233a2c --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.pdf_properties package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request.PDFPropertiesExternalAssetRequest(input_asset: Asset, pdf_properties_params: PDFPropertiesParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request.PDFPropertiesInternalAssetRequest(asset_id: str, pdf_properties_params: PDFPropertiesParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'include_page_level_properties': 'pageLevel', 'notify_config_list': 'notifiers'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload.PDFPropertiesParamsPayload(pdf_properties_params: PDFPropertiesParams)
+

Bases: object

+
+
+json_hint = {'page_level': 'pageLevel'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.html new file mode 100644 index 0000000..45b71bc --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.html @@ -0,0 +1,1362 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request.PDFServicesAPIRequest
+

Bases: ABC

+
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.html new file mode 100644 index 0000000..713267e --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.pdftoimage package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request.PDFtoImagesExternalAssetRequest(input_asset: Asset, export_pdf_to_images_params: ExportPDFtoImagesParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request.PDFToImagesInternalAssetRequest(input_asset_id: str, export_pdf_to_images_params: ExportPDFtoImagesParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'notify_config_list': 'notifiers', 'output_type': 'outputType', 'target_format': 'targetFormat'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload.PDFtoImageParamsPayload(export_pdf_to_images_params: ExportPDFtoImagesParams)
+

Bases: object

+
+
+json_hint = {'target_format': 'targetFormat'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.html new file mode 100644 index 0000000..ea53373 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.protect_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request.ProtectPDFExternalAssetRequest(input_asset: Asset, protect_pdf_params: PasswordProtectParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request.ProtectPDFInternalAssetRequest(asset_id: str, protect_pdf_params: PasswordProtectParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'content_to_encrypt': 'contentToEncrypt', 'encryption_algorithm': 'encryptionAlgorithm', 'notify_config_list': 'notifiers', 'password_protection': 'passwordProtection', 'permissions': 'permissions'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload.ProtectPDFParamsPayload(protect_pdf_params: PasswordProtectParams, notifier_config: NotifierConfig | None = None)
+

Bases: object

+
+
+json_hint = {'content_to_encrypt': 'contentToEncrypt', 'encryption_algorithm': 'encryptionAlgorithm', 'password_protection': 'passwordProtection', 'permissions': 'permissions'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.remove_protection.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.remove_protection.html new file mode 100644 index 0000000..9b78f0e --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.remove_protection.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.remove_protection package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.remove_protection package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request.RemoveProtectionExternalAssetRequest(input_asset: Asset, remove_protection_params: RemoveProtectionParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request.RemoveProtectionInternalAssetRequest(input_asset_id: str, params: RemoveProtectionParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'notify_config_list': 'notifiers', 'password': 'password'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload.RemoveProtectionParamsPayload(params: RemoveProtectionParams)
+

Bases: object

+
+
+json_hint = {'password': 'password'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.splitpdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.splitpdf.html new file mode 100644 index 0000000..0ff7100 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.request.splitpdf.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.request.splitpdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.request.splitpdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request.SplitPDFExternalAssetRequest(input_asset: Asset, split_pdf_params: SplitPDFParams, notify_config_list: List[NotifierConfig] | None = None, output_asset: ExternalAsset | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'input': 'input', 'notify_config_list': 'notifiers', 'output': 'output', 'params': 'params'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request.SplitPDFInternalAssetRequest(asset_id: str, split_pdf_params: SplitPDFParams, notify_config_list: List[NotifierConfig] | None = None)
+

Bases: PDFServicesAPIRequest

+
+
+json_hint = {'asset_id': 'assetID', 'notify_config_list': 'notifiers', 'split_pdf_params': 'splitoption'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload module

+
+
+class adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload.SplitPDFParamsPayload(split_pdf_params: SplitPDFParams)
+

Bases: object

+
+
+json_hint = {'splitoption': 'splitoption'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.response.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.response.html new file mode 100644 index 0000000..e8cf55d --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.response.html @@ -0,0 +1,1405 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.response package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.response package

+
+

Subpackages

+ +
+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.response.job_status module

+
+
+class adobe.pdfservices.operation.internal.api.dto.response.job_status.JobStatus(value)
+

Bases: str, Enum

+

enum of status of the response

+
+
+DONE = 'done'
+
+ +
+
+FAILED = 'failed'
+
+ +
+
+IN_PROGRESS = 'in_progress'
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.html new file mode 100644 index 0000000..fccf52a --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.html @@ -0,0 +1,1406 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response module

+
+
+class adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response.JobErrorResponse(error_response: {})
+

Bases: object

+
+
+get_code()
+
+ +
+
+get_message()
+
+ +
+
+get_status()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response module

+
+
+class adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response.PDFServicesAPIResponse(status: int, error: JobErrorResponse)
+

Bases: object

+
+
+static from_json(json_str)
+
+ +
+
+get_error_response()
+
+ +
+
+get_status()
+
+ +
+
+json_hint = {'error': 'error', 'status': 'status'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.html new file mode 100644 index 0000000..9670096 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.api.html @@ -0,0 +1,1459 @@ + + + + + + + + + adobe.pdfservices.operation.internal.api package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.api package

+
+

Subpackages

+ +
+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.api.pdf_services_api module

+
+
+class adobe.pdfservices.operation.internal.api.pdf_services_api.PDFServicesAPI
+

Bases: object

+
+
+POLLING_TIMEOUT_STATUS_CODE = 0
+
+ +
+
+assets = '/assets/'
+
+ +
+
+static delete_asset(context: ExecutionContext, asset_id: str, x_request_id: str)
+
+ +
+
+static get_response(context: ExecutionContext, location: str, x_request_id: str)
+
+ +
+
+static handle_error_response(response: Response)
+
+ +
+
+operation = '/operation/'
+
+ +
+
+static status_poll(context: ExecutionContext, location: str, x_request_id: str)
+
+ +
+
+static submit_job(context: ExecutionContext, platform_api_request: PDFServicesAPIRequest, operation_endpoint: str, x_request_id: str, operation_header_info: str)
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.api.storage_api module

+
+
+class adobe.pdfservices.operation.internal.api.storage_api.StorageApi
+

Bases: object

+
+
+assets = '/assets'
+
+ +
+
+static get_download_uri(context: ExecutionContext, asset_id: str, x_request_id: str)
+
+ +
+
+static get_upload_uri(context: ExecutionContext, media_type: str, x_request_id: str)
+
+ +
+
+static handle_error_response(response: Response)
+
+ +
+
+static upload_to_cloud(context: ExecutionContext, uri: str, input_stream, media_type)
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.auth.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.auth.html new file mode 100644 index 0000000..8c0be66 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.auth.html @@ -0,0 +1,1508 @@ + + + + + + + + + adobe.pdfservices.operation.internal.auth package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.auth package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.auth.auth_factory module

+
+
+class adobe.pdfservices.operation.internal.auth.auth_factory.AuthenticatorFactory
+

Bases: object

+
+
+static get_authenticator(credential: Credentials, client_config: ClientConfig)
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.auth.authenticator module

+
+
+class adobe.pdfservices.operation.internal.auth.authenticator.Authenticator
+

Bases: ABC

+
+
+abstract get_api_key()
+
+ +
+
+abstract refresh_token()
+
+ +
+
+abstract session_token()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.auth.service_principal_authenticator module

+
+
+class adobe.pdfservices.operation.internal.auth.service_principal_authenticator.ServicePrincipalAuthenticator(service_principal_configuration, client_config)
+

Bases: Authenticator

+

Authenticator for OAuth Server-to-Server based Service Principal credentials

+
+
+get_api_key()
+

API key for Service Principle credentials

+
+ +
+
+handle_ims_failure(response)
+

Handling of IMS failure during call to PDF Services API

+
+ +
+
+refresh_token()
+

Refreshes the access token sent to PDF Services API

+
+ +
+
+service_principal_configuration: ServicePrincipalCredentials
+
+ +
+
+session_token()
+

Access token for the PDF Services API

+
+ +
+
+time_to_expire()
+

Time remaining in minutes till token expiry

+
+ +
+
+token: SessionToken = None
+
+ +
+
+token_endpoint = ''
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.auth.service_token_authenticator module

+
+
+class adobe.pdfservices.operation.internal.auth.service_token_authenticator.ServiceTokenAuthenticator(service_token_credentials: ServiceTokenCredentials)
+

Bases: Authenticator

+
+
+get_api_key() str
+
+ +
+
+refresh_token() SessionToken
+
+ +
+
+session_token() SessionToken
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.auth.service_token_credentials module

+
+
+class adobe.pdfservices.operation.internal.auth.service_token_credentials.ServiceTokenCredentials(client_id: str, token: str)
+

Bases: Credentials

+
+
+get_client_id()
+
+ +
+
+get_token()
+
+ +
+
+set_client_id(client_id)
+
+ +
+
+set_token(token)
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.auth.session_token module

+
+
+class adobe.pdfservices.operation.internal.auth.session_token.SessionToken(access_token, expired_in_ms)
+

Bases: object

+
+
+expired_at: datetime
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.constants.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.constants.html new file mode 100644 index 0000000..b91f8ef --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.constants.html @@ -0,0 +1,1750 @@ + + + + + + + + + adobe.pdfservices.operation.internal.constants package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.constants package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.constants.custom_error_messages module

+
+
+class adobe.pdfservices.operation.internal.constants.custom_error_messages.CustomErrorMessages
+

Bases: object

+
+
+GENERIC_CAN_NOT_BE_NONE = '{} can not be none'
+
+ +
+
+GENERIC_CAN_NOT_BE_NONE_OR_EMPTY = '{} can not be none or empty'
+
+ +
+
+INVALID_INPUT_ASSET = 'Invalid input asset provided for the operation'
+
+ +
+
+INVALID_OUTPUT_ASSET = 'Invalid output asset provided for the operation'
+
+ +
+
+SET_OUTPUT_VALIDATE = 'External assets can be set as output only when input is external asset as well'
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map module

+
+
+class adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map.OperationHeaderInfoEndpointMap(value)
+

Bases: Enum

+

An enumeration.

+
+
+AUTO_TAG = ('PDF Autotag Operation', 'autotag')
+
+ +
+
+COMBINE_PDF = ('Combine Files Operation', 'combinepdf')
+
+ +
+
+COMPRESS_PDF = ('Compress PDF Operation', 'compresspdf')
+
+ +
+
+CREATE_PDF = ('Create PDF Operation', 'createpdf')
+
+ +
+
+DELETE_PAGES = ('Delete Pages Operation', 'pagemanipulation')
+
+ +
+
+EXPORT_PDF = ('Export PDF Operation', 'exportpdf')
+
+ +
+
+EXPORT_PDF_FORM_DATA = ('Export PDF Form Data Operation', 'getformdata')
+
+ +
+
+EXPORT_PDF_TO_IMAGES = ('Export PDF to Images Operation', 'pdftoimages')
+
+ +
+
+EXTRACT_PDF = ('Extract PDF Operation', 'extractpdf')
+
+ +
+
+E_SEAL = ('Electronic Seal Operation', 'electronicseal')
+
+ +
+
+HTML_TO_PDF = ('HTML to PDF Operation', 'htmltopdf')
+
+ +
+
+IMPORT_PDF_FORM_DATA = ('Import PDF Form Data Operation', 'setformdata')
+
+ +
+
+INSERT_PAGES = ('Insert Pages Operation', 'combinepdf')
+
+ +
+
+LINEARIZE_PDF = ('Linearize PDF Operation', 'linearizepdf')
+
+ +
+
+MERGE_DOCUMENT = ('Document Merge Operation', 'documentgeneration')
+
+ +
+
+OCR = ('OCR Operation', 'ocr')
+
+ +
+
+PDF_ACCESSIBILITY_CHECKER = ('Accessibility Checker Operation', 'accessibilitychecker')
+
+ +
+
+PDF_PROPERTIES = ('PDF Properties Operation', 'pdfproperties')
+
+ +
+
+PDF_WATERMARK = ('Watermark PDF Operation', 'addwatermark')
+
+ +
+
+PROTECT_PDF = ('Protect PDF Operation', 'protectpdf')
+
+ +
+
+REMOVE_PROTECTION = ('Remove Protection Operation', 'removeprotection')
+
+ +
+
+REORDER_PAGES = ('Reorder Pages Operation', 'combinepdf')
+
+ +
+
+REPLACE_PAGES = ('Replace Pages Operation', 'combinepdf')
+
+ +
+
+ROTATE_PAGES = ('Reorder Pages Operation', 'pagemanipulation')
+
+ +
+
+SPLIT_PDF = ('Split PDF Operation', 'splitpdf')
+
+ +
+
+get_endpoint()
+
+ +
+
+get_header_info()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.constants.pdf_services_uri module

+
+
+class adobe.pdfservices.operation.internal.constants.pdf_services_uri.PDFServicesURI
+

Bases: object

+
+
+EU_URI = 'https://pdf-services-ew1.adobe.io'
+
+ +
+
+REGION_URI_MAP = {Region.EU: 'https://pdf-services-ew1.adobe.io', Region.US: 'https://pdf-services-ue1.adobe.io'}
+
+ +
+
+URI = 'https://pdf-services.adobe.io'
+
+ +
+
+US_URI = 'https://pdf-services-ue1.adobe.io'
+
+ +
+
+static get_default_uri()
+
+ +
+
+static get_uri_for_region(region: Region)
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.constants.request_key module

+
+
+class adobe.pdfservices.operation.internal.constants.request_key.RequestKey(value)
+

Bases: str, Enum

+

enum of RequestKeys in the requests

+
+
+AUTHN = 'ims.session_token'
+
+ +
+
+DOWNLOAD = 'download'
+
+ +
+
+PLATFORM = 'pdf_services_api'
+
+ +
+
+STATUS = 'status'
+
+ +
+
+UPLOAD = 'upload'
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.constants.service_constants module

+
+
+class adobe.pdfservices.operation.internal.constants.service_constants.ServiceConstants
+

Bases: object

+
+
+AUTOTAG_OPERATION_NAME = 'AUTOTAG_PDF'
+
+ +
+
+COMBINE_PDF_NAME = 'COMBINE_PDF'
+
+ +
+
+COMPRESS_PDF_OPERATION_NAME = 'COMPRESS_PDF'
+
+ +
+
+CREATE_OPERATION_NAME = 'CREATE_PDF'
+
+ +
+
+DELETE_PAGES_OPERATION_NAME = 'DELETE_PAGES'
+
+ +
+
+DOCUMENT_MERGE_OPERATION_NAME = 'DOCUMENT_MERGE'
+
+ +
+
+ESEAL_PDF_NAME = 'ESEAL_PDF'
+
+ +
+
+EXPORT_PDF_FORM_DATA_OPERATION_NAME = 'EXPORT_PDF_FORM_DATA'
+
+ +
+
+EXPORT_PDF_OPERATION_NAME = 'EXPORT_PDF'
+
+ +
+
+EXTRACT_OPERATION_NAME = 'EXTRACT_PDF'
+
+ +
+
+HTML_TO_PDF_OPERATION_NAME = 'HTML_TO_PDF'
+
+ +
+
+HTTP_CONNECT_TIMEOUT = 4000
+
+ +
+
+HTTP_READ_TIMEOUT = 10000
+
+ +
+
+IMPORT_PDF_FORM_DATA_OPERATION_NAME = 'IMPORT_PDF_FORM_DATA'
+
+ +
+
+INSERT_PAGES_OPERATION_NAME = 'INSERT_PAGES'
+
+ +
+
+LINEARIZE_PDF_OPERATION_NAME = 'LINEARIZE_PDF'
+
+ +
+
+OCR_PDF_OPERATION_NAME = 'OCR_PDF'
+
+ +
+
+OPERATION_RESULT_TEMP_DIRECTORY = 'sdk_result'
+
+ +
+
+PDF_ACCESSIBILITY_CHECKER_OPERATION_NAME = 'PDF_ACCESSIBILITY_CHECKER'
+
+ +
+
+PDF_PROPERTIES_OPERATION_NAME = 'PDF_PROPERTIES'
+
+ +
+
+PDF_TO_IMAGES_OPERATION_NAME = 'PDF_TO_IMAGES'
+
+ +
+
+PDF_WATERMARK_OPERATION_NAME = 'PDF_WATERMARK'
+
+ +
+
+PROTECT_PDF_NAME = 'PROTECT_PDF'
+
+ +
+
+REMOVE_PROTECTION_OPERATION_NAME = 'REMOVE_PROTECTION'
+
+ +
+
+REORDER_PAGES_OPERATION_NAME = 'REORDER_PAGES'
+
+ +
+
+REPLACE_PAGES_OPERATION_NAME = 'REPLACE PAGES'
+
+ +
+
+ROTATE_PAGES_OPERATION_NAME = 'ROTATE_PAGES'
+
+ +
+
+SPLIT_PDF_OPERATION_NAME = 'SPLIT_PDF'
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.html new file mode 100644 index 0000000..4370097 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.html @@ -0,0 +1,1807 @@ + + + + + + + + + adobe.pdfservices.operation.internal package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.exceptions module

+
+
+exception adobe.pdfservices.operation.internal.exceptions.OperationException(message, error_message, request_tracking_id, status_code, error_code=None, report_error_code=None)
+

Bases: Exception

+
+
+property error_code
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.execution_context module

+
+
+class adobe.pdfservices.operation.internal.execution_context.ExecutionContext(credentials: Credentials, client_config: ClientConfig | None = None)
+

Bases: object

+
+
+property authenticator
+
+ +
+
+property client_config
+
+ +
+
+property credentials
+
+ +
+
+validate()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.internal_client_config module

+
+
+

adobe.pdfservices.operation.internal.pdf_services_helper module

+
+
+class adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper
+

Bases: object

+
+
+classmethod delete_asset(context: ExecutionContext, asset: Asset)
+
+ +
+
+classmethod get_content(context: ExecutionContext, asset: Asset) StreamAsset
+
+ +
+
+classmethod get_job_result(context: ExecutionContext, location: str, result_type) PDFServicesResponse
+
+ +
+
+classmethod get_job_status(context: ExecutionContext, location: str)
+
+ +
+
+classmethod refresh_download_uri(context: ExecutionContext, asset: Asset) CloudAsset
+
+ +
+
+classmethod submit_job(context: ExecutionContext, platform_api_request: PDFServicesAPIRequest, operation_endpoint: str, x_request_id: str, operation_header_info: str)
+
+ +
+
+classmethod upload(context: ExecutionContext, input_stream, media_type: str) Asset
+
+ +
+
+classmethod upload_assets(context: ExecutionContext, stream_asset_list: []) []
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.http.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.http.html new file mode 100644 index 0000000..5d1238a --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.http.html @@ -0,0 +1,1518 @@ + + + + + + + + + adobe.pdfservices.operation.internal.http package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.http package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.http.http_client module

+
+
+adobe.pdfservices.operation.internal.http.http_client.process_request(http_request: HttpRequest, success_status_codes: List, error_response_handler: Callable[[Response], None])
+
+ +
+
+

adobe.pdfservices.operation.internal.http.http_method module

+
+
+class adobe.pdfservices.operation.internal.http.http_method.HttpMethod(value)
+

Bases: Enum

+

An enumeration.

+
+
+DELETE = 'DELETE'
+
+ +
+
+GET = 'GET'
+
+ +
+
+POST = 'POST'
+
+ +
+
+PUT = 'PUT'
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.http.http_request module

+
+
+class adobe.pdfservices.operation.internal.http.http_request.HttpRequest(http_method: HttpMethod, request_key: str, url: str, headers: dict, data=None, files=None, authenticator: Authenticator | None = None, read_timeout=None, connect_timeout=None, retryable: bool = False, proxies: ProxyServerConfig | None = None)
+

Bases: object

+
+ +
+
+

adobe.pdfservices.operation.internal.http.request_header_const module

+
+
+class adobe.pdfservices.operation.internal.http.request_header_const.DefaultHeaders
+

Bases: object

+
+
+ACCEPT_HEADER_NAME = 'Accept'
+
+ +
+
+AUTHORIZATION_HEADER_NAME = 'Authorization'
+
+ +
+
+CONTENT_TYPE_HEADER_NAME = 'Content-Type'
+
+ +
+
+DC_APP_INFO_HEADER_KEY = 'x-api-app-info'
+
+ +
+
+DC_REQUEST_ID_HEADER_KEY = 'x-request-id'
+
+ +
+
+JSON_TXT_CONTENT_TYPE = 'application/json, text/plain, */*'
+
+ +
+
+LOCATION_HEADER_NAME = 'location'
+
+ +
+
+SESSION_TOKEN_REQUEST_ID_HEADER_KEY = 'X-DEBUG-ID'
+
+ +
+
+X_API_KEY_HEADER_NAME = 'x-api-key'
+
+ +
+
+X_DCSDK_OPS_INFO_HEADER_NAME = 'x-dcsdk-ops-info'
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.http.response_util module

+
+
+class adobe.pdfservices.operation.internal.http.response_util.ResponseUtil
+

Bases: object

+
+
+CUSTOM_ERROR_MESSAGES_STATUS_CODE_MAPPING = {413: {'error_code': 'RequestEntityTooLarge', 'message': 'Request entity too large'}, 502: {'error_code': 'BadGateway', 'message': 'Bad gateway'}, 503: {'error_code': 'ServiceUnavaibale', 'message': 'The Gateway servers are up, but overloaded with requests. Try again later.'}, 504: {'error_code': 'Gateway Timeout', 'message': "The Gateway servers are up, but the request couldn't be serviced due to some failure within our stack. Try again later."}}
+
+ +
+
+INTEGRATION_SERVICE_USAGE_LIMIT_REACHED_ERROR_MESSAGE = 'Service usage limit has been reached for the integration. Please retry after sometime.'
+
+ +
+
+QUOTA_ERROR_MESSAGE = 'Either Quota for this operation is not available or Free trial quota is exhausted. Please visit (www.adobe.com/go/pdftoolsapi_home) to start using free trial quota or (www.adobe.com/go/pdftoolsapi_err_quota) to upgrade to paid credentials.'
+
+ +
+
+SERVICE_USAGE_EXCEPTION_STATUS_CODE_429001_STRING = '429001'
+
+ +
+
+SERVICE_USAGE_EXCEPTION_STATUS_CODE_429002_STRING = '429002'
+
+ +
+
+SERVICE_USAGE_LIMIT_REACHED_ERROR_MESSAGE = 'Service usage limit has been reached. Please retry after sometime.'
+
+ +
+
+static get_request_tracking_id_from_response(response: Response, is_ims_api_call)
+
+ +
+
+static handle_api_failures(response: Response, request_key, is_ims_call=False)
+
+ +
+
+static handle_service_api_error_response(response)
+
+ +
+
+static handle_service_usage_failure(response: Response)
+
+ +
+
+static handle_upload_asset_failure(response: Response, request_key: str)
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.params.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.params.html new file mode 100644 index 0000000..01afc06 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.params.html @@ -0,0 +1,1411 @@ + + + + + + + + + adobe.pdfservices.operation.internal.params package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.params package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.params.combine_pdf_job_input module

+
+
+class adobe.pdfservices.operation.internal.params.combine_pdf_job_input.CombinePDFJobInput(asset: Asset, page_ranges: PageRanges)
+

Bases: object

+
+
+get_asset()
+
+ +
+
+get_page_ranges()
+
+ +
+
+json_hint = {'asset_id': 'assetID', 'external_asset': 'input', 'page_ranges': 'pageRanges'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.params.page_range module

+
+
+class adobe.pdfservices.operation.internal.params.page_range.PageRange(start: int | None = None, end: int | None = None)
+

Bases: object

+
+
+get_end()
+
+ +
+
+get_start()
+
+ +
+
+json_hint = {'end': 'end', 'start': 'start'}
+
+ +
+
+to_json()
+
+ +
+
+validate()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.util.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.util.html new file mode 100644 index 0000000..911ea18 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.internal.util.html @@ -0,0 +1,1578 @@ + + + + + + + + + adobe.pdfservices.operation.internal.util package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.internal.util package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.internal.util.asset_upload_util module

+
+
+class adobe.pdfservices.operation.internal.util.asset_upload_util.AssetUploadUtil(context: ExecutionContext, stream_asset: StreamAsset)
+

Bases: object

+
+ +
+
+

adobe.pdfservices.operation.internal.util.enforce_types module

+
+
+adobe.pdfservices.operation.internal.util.enforce_types.enforce_types(func: Callable) Callable
+
+ +
+
+

adobe.pdfservices.operation.internal.util.file_utils module

+
+
+adobe.pdfservices.operation.internal.util.file_utils.read_conf_file_content(file_path)
+
+ +
+
+

adobe.pdfservices.operation.internal.util.json_hint_encoder module

+
+
+class adobe.pdfservices.operation.internal.util.json_hint_encoder.JSONHintDecoder
+

Bases: object

+
+
+static as_class(dct)
+
+ +
+
+static rev(dct)
+
+ +
+ +
+
+class adobe.pdfservices.operation.internal.util.json_hint_encoder.JSONHintEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)
+

Bases: JSONEncoder

+

Constructor for JSONEncoder, with sensible defaults.

+

If skipkeys is false, then it is a TypeError to attempt +encoding of keys that are not str, int, float or None. If +skipkeys is True, such items are simply skipped.

+

If ensure_ascii is true, the output is guaranteed to be str +objects with all incoming non-ASCII characters escaped. If +ensure_ascii is false, the output can contain non-ASCII characters.

+

If check_circular is true, then lists, dicts, and custom encoded +objects will be checked for circular references during encoding to +prevent an infinite recursion (which would cause an RecursionError). +Otherwise, no such check takes place.

+

If allow_nan is true, then NaN, Infinity, and -Infinity will be +encoded as such. This behavior is not JSON specification compliant, +but is consistent with most JavaScript based encoders and decoders. +Otherwise, it will be a ValueError to encode such floats.

+

If sort_keys is true, then the output of dictionaries will be +sorted by key; this is useful for regression tests to ensure +that JSON serializations can be compared on a day-to-day basis.

+

If indent is a non-negative integer, then JSON array +elements and object members will be pretty-printed with that +indent level. An indent level of 0 will only insert newlines. +None is the most compact representation.

+

If specified, separators should be an (item_separator, key_separator) +tuple. The default is (’, ‘, ‘: ‘) if indent is None and +(‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, +you should specify (‘,’, ‘:’) to eliminate whitespace.

+

If specified, default is a function that gets called for objects +that can’t otherwise be serialized. It should return a JSON encodable +version of the object or raise a TypeError.

+
+
+default(obj)
+

Implement this method in a subclass such that it returns +a serializable object for o, or calls the base implementation +(to raise a TypeError).

+

For example, to support arbitrary iterators, you could +implement default like this:

+
def default(self, o):
+    try:
+        iterable = iter(o)
+    except TypeError:
+        pass
+    else:
+        return list(iterable)
+    # Let the base class default method raise the TypeError
+    return JSONEncoder.default(self, o)
+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.util.object_util module

+
+
+class adobe.pdfservices.operation.internal.util.object_util.ObjectUtil
+

Bases: object

+
+
+classmethod require_not_null(obj, err_msg)
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.util.path_util module

+
+
+adobe.pdfservices.operation.internal.util.path_util.get_file_path(file_path)
+
+ +
+
+

adobe.pdfservices.operation.internal.util.string_util module

+
+
+class adobe.pdfservices.operation.internal.util.string_util.StringUtil
+

Bases: object

+
+
+static is_blank(string: str)
+
+ +
+ +
+
+

adobe.pdfservices.operation.internal.util.validation_util module

+
+
+class adobe.pdfservices.operation.internal.util.validation_util.ValidationUtil
+

Bases: object

+
+
+classmethod validate_asset_with_page_options(combine_pdf_job_input: CombinePDFJobInput)
+
+ +
+
+classmethod validate_csc_credential(csc_credential: CSCCredentials)
+
+ +
+
+classmethod validate_document_merge_params(document_merge_params: DocumentMergeParams)
+
+ +
+
+classmethod validate_execution_context(context: ExecutionContext)
+
+ +
+
+classmethod validate_field_location(field_location: FieldLocation)
+
+ +
+
+classmethod validate_field_options(field_options: FieldOptions)
+
+ +
+
+classmethod validate_insert_asset_inputs(base_asset: ~adobe.pdfservices.operation.io.asset.Asset, assets_to_insert: {<class 'int'>, typing.List[adobe.pdfservices.operation.internal.params.combine_pdf_job_input.CombinePDFJobInput]})
+
+ +
+
+classmethod validate_page_options(combine_pdf_job_input: CombinePDFJobInput)
+
+ +
+
+classmethod validate_page_ranges(page_ranges: PageRanges)
+
+ +
+
+classmethod validate_page_ranges_overlap(page_ranges: PageRanges)
+
+ +
+
+classmethod validate_password(password: str, is_user_password: bool, encryption_algorithm: EncryptionAlgorithm)
+
+ +
+
+classmethod validate_password_to_remove_protection(password: str)
+
+ +
+
+classmethod validate_pdf_electronic_seal_params(pdf_electronic_seal_params: PDFElectronicSealParams)
+
+ +
+
+classmethod validate_protect_pdf_params(protect_pdf_params: ProtectPDFParams)
+
+ +
+
+classmethod validate_replace_files_inputs(base_asset: ~adobe.pdfservices.operation.io.asset.Asset, assets_to_replace: {<class 'int'>, <class 'adobe.pdfservices.operation.internal.params.combine_pdf_job_input.CombinePDFJobInput'>})
+
+ +
+
+classmethod validate_rotate_page_actions(page_actions: PageActions)
+
+ +
+
+classmethod validate_split_pdf_operation_params(page_ranges: PageRanges, page_count: int, file_count: int)
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.io.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.io.html new file mode 100644 index 0000000..92f52b6 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.io.html @@ -0,0 +1,1556 @@ + + + + + + + + + adobe.pdfservices.operation.io package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.io package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.io.asset module

+
+
+class adobe.pdfservices.operation.io.asset.Asset
+

Bases: ABC

+

Represents the basic contract for the assets to be used with +PDFServicesJob

+
+ +
+
+

adobe.pdfservices.operation.io.cloud_asset module

+
+
+class adobe.pdfservices.operation.io.cloud_asset.CloudAsset(asset_id, download_uri=None)
+

Bases: Asset

+

This class represents an asset stored in Adobe internal storage.

+

Constructs an instance of CloudAsset.

+
+
Parameters:
+
    +
  • asset_id (str) – assetId of the asset.

  • +
  • download_uri (str) – downloadURI of the asset.

  • +
+
+
+
+
+get_asset_id()
+
+
Returns:
+

the assetId of the asset.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_download_uri()
+
+
Returns:
+

the downloadURI of the asset.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.io.external_asset module

+
+
+class adobe.pdfservices.operation.io.external_asset.ExternalAsset(uri: str, *, external_storage_type: ExternalStorageType = None)
+

Bases: Asset

+

This class represents an asset stored in an external storage.

+

Constructs an instance of ExternalAsset.

+
+
Parameters:
+
    +
  • uri (str) – URI of the external asset, can not be None.

  • +
  • external_storage_type (ExternalStorageType) – external storage type. (Optional, use key-value)

  • +
+
+
+
+
+get_external_storage_type()
+
+
Returns:
+

the externalStorageType of the external asset.

+
+
Return type:
+

ExternalStorageType

+
+
+
+ +
+
+get_uri()
+
+
Returns:
+

the URI of the external asset.

+
+
Return type:
+

str

+
+
+
+ +
+
+json_hint = {'external_storage_type': 'storage', 'uri': 'uri'}
+

For JSON Representation of this class, used internally by SDK.

+
+ +
+
+to_json()
+
+
Returns:
+

representation of ExternalAsset as a JSON string, used internally by the SDK.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.io.external_storage_type module

+
+
+class adobe.pdfservices.operation.io.external_storage_type.ExternalStorageType(value)
+

Bases: Enum

+

Represents external storage types.

+
+
+BLOB = 'BLOB'
+

Represents Blob storage.

+
+ +
+
+DROPBOX = 'DROPBOX'
+

Represents Dropbox storage.

+
+ +
+
+S3 = 'S3'
+

Represents S3 storage.

+
+ +
+
+SHAREPOINT = 'SHAREPOINT'
+

Represents Sharepoint storage.

+
+ +
+
+classmethod get(storage_type: str)
+

Returns ExternalStorageType instance for its string representation.

+
+
Parameters:
+

storage_type (str) – Storage type code

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.io.stream_asset module

+
+
+class adobe.pdfservices.operation.io.stream_asset.StreamAsset(input_stream, mime_type)
+

Bases: object

+

This class encapsulates input stream and the media type of +Asset.

+

Constructs an instance of StreamAsset.

+
+
Parameters:
+
    +
  • input_stream – input stream of the asset; can not be None.

  • +
  • mime_type (str) – mime type of the input stream; can not be None.

  • +
+
+
+
+
+get_input_stream()
+
+
Returns:
+

the input stream of the asset.

+
+
+
+ +
+
+get_mime_type()
+
+
Returns:
+

the mime type of the asset.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.html new file mode 100644 index 0000000..51846af --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.html @@ -0,0 +1,1786 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs package

+
+

Subpackages

+
+ +
+
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data.html new file mode 100644 index 0000000..d913bda --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data.html @@ -0,0 +1,1407 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.jobs.export\_pdf\_form\_data package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.jobs.export\_pdf\_form\_data package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.jobs.export\_pdf\_form\_data.export\_pdf\_form\_data\_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job.ExportPDFFormDataJob(input_asset: Asset, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that exports form data from a PDF and retrieves it in JSON format.

+

This job demonstrates how to use Adobe PDF Services SDK to extract +form data from a PDF file. The process involves uploading a source PDF, +submitting an export form data job, and retrieving the extracted data.

+

Sample usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+
+export_pdf_form_data_job = ExportPDFFormDataJob(input_asset=input_asset)
+
+location = pdf_services.submit(export_pdf_form_data_job)
+pdf_services_response = pdf_services.get_job_result(location, ExportPDFFormDataResult)
+
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+# Save the form data JSON to a file
+output_file_path = "extracted_form_data.json"
+with open(output_file_path, 'wb') as output_file:
+    output_file.write(stream_asset.get_input_stream())
+
+
+

Constructs a new ExportPDFFormDataJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of ExportPDFFormDataJob.

+
+
Return type:
+

ExportPDFFormDataJob

+
+
+
+

Note

+

External assets can be set as output only when input is external asset as well

+
+
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.jobs.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.jobs.html new file mode 100644 index 0000000..6e02f17 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.jobs.html @@ -0,0 +1,2363 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.jobs package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.jobs package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job.AutotagPDFJob(input_asset: Asset, *, autotag_pdf_params: AutotagPDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that creates PDF documents with enhanced readability from existing PDF documents. +An optional tagging report can also be generated which contains the information about the tags that the tagged +output PDF document contains.

+

Accessibility tags, used by assistive technology such as screen reader are required to make PDF files compliant. +However, the generated PDF is not guaranteed to comply with accessibility standards such as WCAG and PDF/UA as +there could be a need to perform further downstream remediation to meet those standards.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+autotag_pdf_job = AutotagPDFJob(input_asset)
+location = pdf_services.submit(autotag_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, AutotagPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_tagged_pdf()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new instance of AutotagPDFJob.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • autotag_pdf_params (AutotagPDFParams) – AutotagPDFParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of AutotagPDFJob

+
+
Return type:
+

AutotagPDFJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job.CombinePDFJob(combine_pdf_params: CombinePDFParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that combines multiple PDF files into a single PDF file. Allows specifying which pages of the source +files to combine.

+

Sample usage.

+
file = open('SOURCE_PATH_1', 'rb')
+input_stream_1 = file.read()
+file.close()
+file = open('SOURCE_PATH_2', 'rb')
+input_stream_2 = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+stream_assets = [StreamAsset(input_stream_1, MediaType.PDF),
+                 StreamAsset(input_stream_2, MediaType.PDF)]
+assets = pdf_services.upload_assets(stream_assets)
+combine_pdf_params = ((CombinePDFParams()
+                      .add_asset(assets[0]))
+                      .add_asset(assets[1]))
+combine_pdf_job = CombinePDFJob(combine_pdf_params=combine_pdf_params)
+location = pdf_services.submit(combine_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, CombinePDFResult)
+result_asset: CombinePDFResult = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new CombinePDFJob instance.

+
+
Parameters:
+
    +
  • combine_pdf_params (CombinePDFParams) – CombinePDFParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of CombinePDFJob

+
+
Return type:
+

CombinePDFJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job.CompressPDFJob(input_asset: Asset, *, compress_pdf_params: CompressPDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that reduces the size of a PDF file. Allows specifying +CompressionLevel +for compressing pdf

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+compress_pdf_job = CompressPDFJob(input_asset=input_asset)
+location = pdf_services.submit(compress_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, CompressPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new CompressPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • compress_pdf_params (CompressPDFParams) – CompressPDFParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of CompressPDFJob

+
+
Return type:
+

CompressPDFJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job.CreatePDFJob(input_asset: Asset, *, create_pdf_params: CreatePDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that converts a non-PDF file to a PDF file. Some source formats may have associated conversion parameters.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.DOCX)
+create_pdf_job = CreatePDFJob(input_asset)
+location = pdf_services.submit(create_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, CreatePDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new instance of CreatePDFJob.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • create_pdf_params (CreatePDFParams) – CreatePDFParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of CreatePDFJob.

+
+
Return type:
+

CreatePDFJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job.DeletePagesJob(input_asset: Asset, delete_pages_params: DeletePagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job to delete pages in a PDF file.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+page_ranges_for_deletion = PageRanges()
+page_ranges.add_single_page(1)
+delete_pages_params = DeletePagesParams(page_ranges=page_ranges_for_deletion)
+delete_pages_job = DeletePagesJob(input_asset=input_asset,
+                                  delete_pages_params=delete_pages_params)
+location = pdf_services.submit(delete_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, CompressPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new DeletePagesJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • delete_pages_params (DeletePagesParams) – DeletePagesParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of DeletePagesJob

+
+
Return type:
+

DeletePagesJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job.DocumentMergeJob(input_asset: Asset, document_merge_params: DocumentMergeParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that enables the clients to produce high fidelity PDF and Word documents with dynamic data inputs. +This operation merges the JSON data with the Word template to create dynamic documents for contracts and +agreements, invoices, proposals, reports, forms, branded marketing documents and more.

+

To know more about document generation and document templates, +Click Here.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.DOCX)
+json_data_for_merge = {"customerName": "Kane Miller", "customerVisits": 100}
+document_merge_params = DocumentMergeParams(json_data_for_merge=json_data_for_merge,
+                                            output_format=OutputFormat.DOCX)
+document_merge_job = DocumentMergeJob(input_asset=input_asset,
+                                      document_merge_params=document_merge_params)
+location = pdf_services.submit(document_merge_job)
+pdf_services_response = pdf_services.get_job_result(location, DocumentMergePDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new DocumentMergeJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • document_merge_params (DocumentMergeParams) – DocumentMergeParams to set. can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of DocumentMergeJob

+
+
Return type:
+

DocumentMergeJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.eseal_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.eseal_job.PDFElectronicSealJob(input_asset: Asset, electronic_seal_params: PDFElectronicSealParams, *, seal_image_asset: Asset | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows clients to apply an electronic seal onto various PDF documents such as agreements, invoices, and more.

+

To know more about PDF Electronic Seal, Click Here.

+

Sample usage.

+
pdf_file = open('SOURCE_PATH', 'rb')
+file_input_stream = pdf_file.read()
+pdf_file.close()
+
+seal_image_file = open('IMAGE_SOURCE_PATH', 'rb')
+seal_image_input_stream = seal_image_file.read()
+seal_image_file.close()
+
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+asset = pdf_services.upload(input_stream=file_input_stream, mime_type=PDFServicesMediaType.PDF)
+seal_image_asset = pdf_services.upload(input_stream=seal_image_input_stream, mime_type=PDFServicesMediaType.PNG)
+document_level_permission = DocumentLevelPermission.FORM_FILLING
+seal_field_name = "Signature1"
+seal_page_number = 1
+seal_visible = True
+field_location = FieldLocation(150, 250, 350, 200)
+field_options = FieldOptions(
+    field_name=seal_field_name,
+    field_location=field_location,
+    page_number=seal_page_number,
+    visible=seal_visible
+)
+provider_name = "<PROVIDER_NAME>"
+access_token = "<ACCESS_TOKEN>"
+credential_id = "<CREDENTIAL_ID>"
+pin = "<PIN>"
+csc_auth_context = CSCAuthContext(
+    access_token=access_token,
+    token_type="Bearer",
+)
+certificate_credentials = CSCCredentials(
+    provider_name=provider_name,
+    credential_id=credential_id,
+    pin=pin,
+    csc_auth_context=csc_auth_context,
+)
+electronic_seal_params = PDFElectronicSealParams(
+    seal_certificate_credentials=certificate_credentials,
+    seal_field_options=field_options,
+)
+electronic_seal_job = PDFElectronicSealJob(input_asset=asset,
+                                           electronic_seal_params=electronic_seal_params,
+                                           seal_image_asset=seal_image_asset)
+location = pdf_services.submit(electronic_seal_job)
+pdf_services_response = pdf_services.get_job_result(location, ESealPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new PDFElectronicSealJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • electronic_seal_params (PDFElectronicSealParams) – Parameters for electronic seal; can not be None.

  • +
  • seal_image_asset (Asset) – Seal image asset for the job. (Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of PDFElectronicSealJob.

+
+
Return type:
+

PDFElectronicSealJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job.ExportPDFJob(input_asset: Asset, export_pdf_params: ExportPDFParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job which exports a source PDF file to a supported format specified by +ExportPDFTargetFormat

+

For example, a PDF can be exported to a DOCX file as follows:

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+export_pdf_params = ExportPDFParams(target_format=ExportPDFTargetFormat.DOCX)
+export_pdf_job = ExportPDFJob(input_asset=input_asset, export_pdf_params=export_pdf_params)
+location = pdf_services.submit(export_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, ExportPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ExportPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • export_pdf_params (ExportPDFParams) – ExportPDFParams object containing the export parameters; can not be None.

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of ExportPDFJob.

+
+
Return type:
+

ExportPDFJob

+
+
+
+

Note

+

External assets can be set as output only when input is external asset as well

+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job.ExportPDFtoImagesJob(input_asset: Asset, export_pdf_to_images_params: ExportPDFtoImagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job which exports a source PDF file to a supported format specified by ExportPDFToImagesTargetFormat

+

The result is a list of images or a list containing a zip of images. For example, a PDF file with 15 +pages will generate 15 image files. The first file’s name ends with “_0” and the last file’s name ends with “_14”.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+export_pdf_to_images_params = ExportPDFtoImagesParams(
+    export_pdf_to_images_target_format=ExportPDFToImagesTargetFormat.JPEG,
+    export_pdf_to_images_output_type=ExportPDFToImagesOutputType.LIST_OF_PAGE_IMAGES
+)
+export_pdf_to_images_job = ExportPDFtoImagesJob(
+    input_asset=input_asset,
+    export_pdf_to_images_params=export_pdf_to_images_params
+)
+location = pdf_services.submit(export_pdf_to_images_job)
+pdf_services_response = pdf_services.get_job_result(location, ExportPDFtoImagesResult)
+result_assets = pdf_services_response.get_result().get_assets()
+
+
+

Constructs a new ExportPDFToImagesJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • export_pdf_to_images_params (ExportPDFtoImagesParams) – ExportPDFToImagesParams object containing the export to images parameters; can not be None.

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job.ExtractPDFJob(input_asset: Asset, *, extract_pdf_params: ExtractPDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that extracts pdf elements such as text, images, tables in a structured format from a PDF.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+extract_pdf_params = ExtractPDFParams(
+    elements_to_extract=[ExtractElementType.TEXT],
+)
+extract_pdf_job = ExtractPDFJob(input_asset=input_asset, extract_pdf_params=extract_pdf_params)
+
+# Submit the job and gets the job result
+location = pdf_services.submit(extract_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, ExtractPDFResult)
+
+# Get content from the resulting asset(s)
+result_asset: CloudAsset = pdf_services_response.get_result().get_resource()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ExtractPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • extract_pdf_params (ExtractPDFParams) – ExtractPDFParams object containing the extract PDF parameters, (Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job.HTMLtoPDFJob(*, input_asset: Asset | None = None, input_url: str | None = None, html_to_pdf_params: HTMLtoPDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that converts a HTML file to a PDF file.

+

An HTML input can be provided either as a local zip archive or as a static HTML file with inline CSS. +Alternatively, an HTML can also be specified via URL.

+
+
While creating the corresponding Asset instance, the media type must be:
    +
  • “application/zip”, if the input is a local zip archive.

  • +
  • “text/html”, if the input is a static HTML file with inline CSS

  • +
+
+
In case the input is a local zip archive, it must have the following structure:
    +
  • The main HTML file must be named “index.html”.

  • +
  • “index.html” must exist at the top level of zip archive, not in a folder.

  • +
+
+
+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.ZIP)
+page_layout = PageLayout(page_height=11.5, page_width=8)
+html_to_pdf_params =  HTMLtoPDFParams(page_layout=page_layout, include_header_footer=True)
+html_to_pdf_job = HTMLtoPDFJob(input_asset=input_asset, html_to_pdf_params=html_to_pdf_params)
+location = pdf_services.submit(html_to_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, HTMLtoPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new HTMLtoPDFJob.

+

At least one of input_asset or input_url needs to be specified.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file. (Optional, use key-value)

  • +
  • input_url (str) – String representing the input URL. (Optional, use key-value)

  • +
  • html_to_pdf_params (HTMLtoPDFParams) – HTMLToPDFParams}. (Optional, use key-value)

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job.InsertPagesJob(insert_pages_params: InsertPagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that can be used to insert pages of multiple PDF files into a base PDF file.

+

For more complex use cases, refer the +CombinePDFJob.

+

Sample Usage:

+
base_file = open('SOURCE_PATH', 'rb')
+base_input_stream = base_file.read()
+base_file.close()
+file_to_insert = open('SOURCE_PATH_1', 'rb')
+input_stream_to_insert = file_to_insert.read()
+file_to_insert.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+base_asset = pdf_services.upload(input_stream=base_input_stream,
+                                 mime_type=MediaType.PDF)
+asset_to_insert = pdf_services.upload(input_stream=input_stream_to_insert,
+                              mime_type=MediaType.PDF)
+page_ranges = PageRanges().add_range(1, 3)
+insert_pages_params = InsertPagesParams(base_asset=base_asset)
+insert_pages_params.add_pages_to_insert(input_asset=asset_to_insert, page_ranges=page_ranges, base_page=2)
+insert_pages_job = InsertPagesJob(insert_pages_params=insert_pages_params)
+location = pdf_services.submit(insert_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, InsertPagesResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new InsertPagesPDFJob instance.

+
+
Parameters:
+
    +
  • insert_pages_params (InsertPagesParams) – Object containing the input files and the page numbers to insert at; +can not be None.

  • +
  • output_asset (Asset) – Object representing the output asset. (Optional, use key-value) +External assets can be set as output only when input is external asset as well

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job.LinearizePDFJob(input_asset: Asset, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that converts a PDF file into a linearized (also known as “web optimized”) PDF file. Such PDF files are +optimized for incremental access in network environments.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+linearize_pdf_job = LinearizePDFJob(input_asset=input_asset)
+location = pdf_services.submit(linearize_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, LinearizePDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new LinearizePDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job.OCRPDFJob(input_asset: Asset, *, ocr_pdf_params: OCRParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that convert a PDF file into a searchable PDF file. Allows specifying OCRSupportedLocale and OCR Type.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+ocr_pdf_job = OCRPDFJob(input_asset=input_asset)
+location = pdf_services.submit(ocr_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, OCRPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new OCRPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • ocr_pdf_params (OCRParams) – OCRParams} object containing the OCR parameters. (Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job.PDFPropertiesJob(input_asset: Asset, *, pdf_properties_params: PDFPropertiesParams | None = None)
+

Bases: PDFServicesJob

+

A job that is used to fetch properties from an input PDF file. The properties are returned in a dict.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+pdf_properties_params = PDFPropertiesParams(include_page_level_properties=True)
+pdf_properties_job = PDFPropertiesJob(input_asset=input_asset, pdf_properties_params=pdf_properties_params)
+location = pdf_services.submit(pdf_properties_job)
+pdf_services_response = pdf_services.get_job_result(location, PDFPropertiesResult)
+pdf_properties_result = pdf_services_response.get_result()
+
+
+

Constructs a new PDFPropertiesJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • pdf_properties_params (PDFPropertiesParams) – PDFPropertiesParams object containing the properties to be fetched. +(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job.ProtectPDFJob(input_asset: Asset, protect_pdf_params: PasswordProtectParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that is used for securing PDF document with password(s). +The password(s) is used for encrypting the PDF document and setting the restriction on certain features +like printing, editing and copying in the PDF document.

+

The supported algorithm for encrypting the PDF document are listed here. The EncryptionAlgorithm enum can +be used to set the encryption algorithm.

+
+
    +
  • AES-128

  • +
  • AES-256

  • +
+
+

For AES-128 encryption the password supports LATIN-I characters only. +For AES-256 encryption the password supports Unicode character set.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+protect_pdf_params = PasswordProtectParams(
+    user_password='password',
+    encryption_algorithm=EncryptionAlgorithm.AES_256,
+    content_encryption=ContentEncryption.ALL_CONTENT,
+)
+protect_pdf_job = ProtectPDFJob(input_asset=input_asset, protect_pdf_params=protect_pdf_params)
+location = pdf_services.submit(protect_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, ProtectPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ProtectPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • protect_pdf_params (PasswordProtectParams) – ProtectPDFParams object containing the protect PDF parameters; can not be None.

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job.RemoveProtectionJob(input_asset: Asset, remove_protection_params: RemoveProtectionParams, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows to remove password security from a PDF document.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+remove_protection_params = RemoveProtectionParams(password="password")
+remove_protection_job = RemoveProtectionJob(input_asset=input_asset,
+                                            remove_protection_params=remove_protection_params)
+location = pdf_services.submit(remove_protection_job)
+pdf_services_response = pdf_services.get_job_result(location, RemoveProtectionResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new RemoveProtectionJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job. (Mandatory, use key-value)

  • +
  • remove_protection_params (RemoveProtectionParams) – RemoveProtectionParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of RemoveProtectionJob.

+
+
Return type:
+

RemoveProtectionJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job.ReorderPagesJob(reorder_pages_params: ReorderPagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows to rearrange pages in a PDF file according to the specified order.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+pages_to_reorder = PageRanges().add_range(3, 4)
+                    .add_single_page(1)
+reorder_pages_params = ReorderPagesParams(asset=input_asset, page_ranges=pages_to_reorder)
+reorder_pages_job = ReorderPagesJob(reorder_pages_params=reorder_pages_params)
+location = pdf_services.submit(reorder_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, ReorderPagesResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ReorderPagesJob instance.

+
+
Parameters:
+
    +
  • reorder_pages_params (ReorderPagesParams) – ReorderPagesParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of ReorderPagesJob.

+
+
Return type:
+

ReorderPagesJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job.ReplacePagesJob(replace_pages_params: ReplacePagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows specific pages in a PDF file to be replaced with pages from multiple PDF files.

+

Sample usage.

+
base_file = open('SOURCE_PATH', 'rb')
+base_input_stream = base_file.read()
+base_file.close()
+file_1 = open('SOURCE_PATH', 'rb')
+input_stream_1 = file_1.read()
+file_1.close()
+file_2 = open('SOURCE_PATH', 'rb')
+input_stream_2 = file_2.read()
+file_2.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+base_asset = pdf_services.upload(input_stream=base_input_stream,
+                                  mime_type=MediaType.PDF)
+asset_1 = pdf_services.upload(input_stream=input_stream_1,
+                             mime_type=MediaType.PDF)
+asset_2 = pdf_services.upload(input_stream=input_stream_2,
+                              mime_type=MediaType.PDF)
+page_ranges = PageRanges().add_range(3, 4)
+                    .add_single_page(1)
+replace_pages_params = ReplacePagesParams(base_asset=base_asset)
+replace_pages_params.add_pages_to_replace(input_asset=asset_1, page_ranges=page_ranges, base_page=1)
+replace_pages_params.add_pages_to_replace(input_asset=asset_2, base_page=3)
+replace_pages_job = ReplacePagesJob(replace_pages_params=replace_pages_params)
+location = pdf_services.submit(replace_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, ReplacePagesResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ReplacePagesJob instance.

+
+
Parameters:
+
    +
  • replace_pages_params (ReplacePagesParams) – ReplacePagesParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of ReplacePagesJob.

+
+
Return type:
+

ReplacePagesJob

+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job.RotatePagesJob(input_asset: Asset, rotate_pages_params: RotatePagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows rotation of specific pages in a PDF file.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+rotate_pages_params = RotatePagesParams()
+rotate_pages_params.add_angle_to_rotate(angle=Angle.ANGLE_90)
+reorder_pages_job = RotatePagesJob(input_asset=input_asset, rotate_pages_params=rotate_pages_params)
+location = pdf_services.submit(reorder_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, RotatePagesResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new RotatePagesJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • rotate_pages_params (RotatePagesParams) – RotatePagesParams} object containing the rotation angle and page ranges; +can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job module

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job.SplitPDFJob(input_asset: Asset, split_pdf_params: SplitPDFParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that splits PDF document into multiple smaller documents by simply specifying either the number of files, +pages per file, or page ranges.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+base_input_stream = base_file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+split_pdf_params = SplitPDFParams(page_count=2)
+split_pdf_job = SplitPDFJob(input_asset, split_pdf_params)
+location = pdf_services.submit(split_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, SplitPDFResult)
+result_assets = pdf_services_response.get_result().get_assets()
+
+
+

Constructs a new SplitPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • split_pdf_params (SplitPDFParams) – SplitPDFParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of SplitPDFJob.

+
+
Return type:
+

SplitPDFJob

+
+
+
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.html new file mode 100644 index 0000000..66ccd17 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.html @@ -0,0 +1,1401 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.autotag_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.autotag_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params.AutotagPDFParams(*, shift_headings: bool = False, generate_report: bool = False)
+

Bases: PDFServicesJobParams

+

Parameters for creating a tagged PDF using +AutotagPDFJob.

+

Constructs a new instance of AutotagPDFParams.

+
+
Parameters:
+
    +
  • generate_report (bool) – If true, generates an additional tagging report which contains the information about the +tags that the tagged output PDF document contains.(Optional, use key-value)

  • +
  • shift_headings (bool) – If true, then the headings will be shifted in the output PDF document. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of AutotagPDFParams

+
+
Return type:
+

AutotagPDFParams

+
+
+
+
+get_generate_report()
+
+
Returns:
+

A boolean value specifying whether an additional tagging report needs to be generated.

+
+
Return type:
+

bool

+
+
+
+ +
+
+get_shift_headings()
+
+
Returns:
+

A boolean value specifying whether headings need to be shifted in the tagged PDF.

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.combine_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.combine_pdf.html new file mode 100644 index 0000000..bccf20d --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.combine_pdf.html @@ -0,0 +1,1396 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.combine_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.combine_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.CombinePDFParams
+

Bases: PDFServicesJobParams

+

Parameters for combining PDFs using +CombinePDFJob.

+

Constructs a new CombinePDFParams instance.

+
+
Returns:
+

A new instance of CombinePDFParams

+
+
Return type:
+

CombinePDFParams

+
+
+
+
+add_asset(asset: ~adobe.pdfservices.operation.io.asset.Asset, *, page_ranges: ~adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges = <adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges object>)
+

Adds an Asset with +PageRanges to combine.

+
+
Parameters:
+
+
+
+
+ +
+
+get_assets_to_combine()
+
+
Returns:
+

a list of +CombinePDFJobInput +instances.

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.compress_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.compress_pdf.html new file mode 100644 index 0000000..469bcd2 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.compress_pdf.html @@ -0,0 +1,1426 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.compress_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.compress_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params.CompressPDFParams(*, compression_level: CompressionLevel = CompressionLevel.MEDIUM)
+

Bases: PDFServicesJobParams

+

Parameters for reducing file size of a pdf using +CompressPDFJob

+

Creates an instance of CompressPDFParams

+
+
Parameters:
+

compression_level (CompressionLevel) – see CompressionLevel. (Optional, use key-value)

+
+
+
+
+get_compression_level()
+

Returns the compression level to be used for Compress PDF, specified by +CompressionLevel

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.CompressionLevel(value)
+

Bases: Enum

+

Supported compression levels for +CompressPDFJob

+

Constructs Compression Level from its string representation

+
+
Parameters:
+

compression_level – String representation

+
+
+
+
+HIGH = 'HIGH'
+

Reduces the file size of pdf by reducing resolution of the coloured and grayscale images above 100 dpi to 72 +dpi (dots per inch). +This option uses JPEG medium quality compression. +Output pdf will not contain hidden layers, document structure, metadata, javascript, user properties and print +settings.

+
+ +
+
+LOW = 'LOW'
+

Reduces the file size of pdf by reducing resolution of the coloured and grayscale images above 250 dpi to 200 +dpi (dots per inch). +This option uses JP2K high quality compression.

+
+ +
+
+MEDIUM = 'MEDIUM'
+

Reduces the file size of pdf by reducing resolution of the coloured and grayscale images above 200 dpi to 144 +dpi (dots per inch). +This option uses JP2K medium quality compression.

+
+ +
+
+get_compression_level()
+

Returns the string representation of this CompressionLevel

+
+
Returns:
+

String representation of this CompressionLevel

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.html new file mode 100644 index 0000000..0b79e2f --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.html @@ -0,0 +1,1629 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params.CreatePDFFromExcelParams(*, document_language: DocumentLanguage = DocumentLanguage.EN_US, create_tagged_pdf: bool = False)
+

Bases: CreatePDFParams

+

Constructs a new instance of CreatePDFFromExcelParams.

+
+
Parameters:
+
    +
  • document_language (DocumentLanguage) – Sets office preferred editing language to be used for conversion; can not be None.

  • +
  • create_tagged_pdf (bool) – Whether to create a tagged PDF. The default value is false. (Optional, use key-value)

  • +
+
+
+
+
+get_create_tagged_pdf()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+
+get_document_language()
+
+
Returns:
+

Language of the input document.

+
+
Return type:
+

DocumentLanguage

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage(value)
+

Bases: Enum

+

Supported locales for Excel to PDF.

+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale.

+

Please note that this locale is only supported for US(default) region.

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NO_NO = 'no-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HK = 'zh-HK'
+

Represents “Chinese (Hong Kong)” locale

+
+ +
+
+get_document_language()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.html new file mode 100644 index 0000000..aedcc4e --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.html @@ -0,0 +1,1551 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.create_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams.CreatePDFParams
+

Bases: PDFServicesJobParams, ABC

+

Marker base class for CreatePDFJob +params. The factory methods within this class can be used to create instances of params classes corresponding to +the source media type.

+
+
+abstract get_create_tagged_pdf()
+
+ +
+
+abstract get_document_language()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.html new file mode 100644 index 0000000..4eb80e5 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.html @@ -0,0 +1,1629 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params.CreatePDFFromPPTParams(*, document_language: DocumentLanguage = DocumentLanguage.EN_US, create_tagged_pdf: bool = False)
+

Bases: CreatePDFParams

+

Constructs a new instance of CreatePDFFromPPTParams.

+
+
Parameters:
+
    +
  • document_language (DocumentLanguage) – Sets office preferred editing language to be used for conversion; can not be None.

  • +
  • create_tagged_pdf (bool) – Whether to create a tagged PDF. The default value is false. (Optional, use key-value)

  • +
+
+
+
+
+get_create_tagged_pdf()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+
+get_document_language()
+
+
Returns:
+

Language of the input document.

+
+
Return type:
+

DocumentLanguage

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage(value)
+

Bases: Enum

+

Supported locales for PPT to PDF.

+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale.

+

Please note that this locale is only supported for US(default) region.

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NO_NO = 'no-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HK = 'zh-HK'
+

Represents “Chinese (Hong Kong)” locale

+
+ +
+
+get_document_language()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.html new file mode 100644 index 0000000..b87c4cd --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.html @@ -0,0 +1,1629 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.create_pdf.word package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.word package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params.CreatePDFFromWordParams(*, document_language: DocumentLanguage = DocumentLanguage.EN_US, create_tagged_pdf: bool = False)
+

Bases: CreatePDFParams

+

Constructs a new instance of CreatePDFFromWordParams.

+
+
Parameters:
+
    +
  • document_language (DocumentLanguage) – Sets office preferred editing language to be used for conversion; can not be None.

  • +
  • create_tagged_pdf (bool) – Whether to create a tagged PDF. The default value is false. (Optional, use key-value)

  • +
+
+
+
+
+get_create_tagged_pdf()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+
+get_document_language()
+
+
Returns:
+

Language of the input document.

+
+
Return type:
+

DocumentLanguage

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage(value)
+

Bases: Enum

+

Supported locales for Word to PDF.

+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale.

+

Please note that this locale is only supported for US(default) region.

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NO_NO = 'no-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HK = 'zh-HK'
+

Represents “Chinese (Hong Kong)” locale

+
+ +
+
+get_document_language()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.delete_pages.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.delete_pages.html new file mode 100644 index 0000000..6192439 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.delete_pages.html @@ -0,0 +1,1378 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.delete_pages package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.delete_pages package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params.DeletePagesParams(page_ranges: PageRanges)
+

Bases: PDFServicesJobParams

+

Parameters for deleting pages from a pdf using +DeletePagesJob

+

Creates an instance of DeletePagesParams with given PageRanges.

+
+
Parameters:
+

page_ranges (PageRanges) – the PageRanges to be used for deleting pages; can not be None.

+
+
+
+
+get_page_ranges()
+
+
Returns:
+

the PageRanges to be used for deleting pages.

+
+
Return type:
+

PageRanges

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.documentmerge.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.documentmerge.html new file mode 100644 index 0000000..58eaf7b --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.documentmerge.html @@ -0,0 +1,1484 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.documentmerge package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.documentmerge package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.DocumentMergeParams(json_data_for_merge: Any, *, output_format: OutputFormat = OutputFormat.PDF, fragments: Fragments = None)
+

Bases: PDFServicesJobParams

+

Parameters for document generation using +DocumentMergeJob

+

Constructs a new DocumentMergeParams instance

+
+
Parameters:
+
    +
  • json_data_for_merge (Any) – json to be used in the document merge job; can not be None.

  • +
  • output_format (OutputFormat) – output format for the document merge result; (Optional, use key-value)

  • +
  • fragments (Fragments) – fragments for document merge job; (Optional, use key-value)

  • +
+
+
Returns:
+

DocumentMergeParams

+
+
+
+
+get_fragments()
+
+
Returns:
+

fragments for document merge job

+
+
+
+ +
+
+get_json_data_for_merge()
+
+
Returns:
+

JSON data for the document merge process

+
+
+
+ +
+
+get_output_format()
+
+
Returns:
+

output format for the document merge result

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments
+

Bases: object

+

Class for providing support for Fragments. To know more about fragments +use-case in document generation and document templates, Click Here.

+

Constructs a new Fragments instance

+
+
+add_fragment(fragment)
+

To add fragment dictionary into the fragments list.

+
+
Parameters:
+

fragment – fragment dictionary to be added into the fragments list.

+
+
+
+ +
+
+add_fragments(fragments: List)
+

To add List of fragment dictionaries into the fragments list.

+
+
Parameters:
+

fragments – fragment dictionary list to be added into the fragments list.

+
+
+
+ +
+
+get_fragments_list()
+
+
Returns:
+

list of fragments.

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.OutputFormat(value)
+

Bases: Enum

+

Supported output formats for adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job.py

+

Constructs output format with its string representation

+
+
Parameters:
+

output_format – String representation

+
+
+
+
+DOCX = 'docx'
+

Represents “application/vnd.openxmlformats-officedocument.wordprocessingml.document” media type

+
+ +
+
+PDF = 'pdf'
+

Represents “application/pdf” media type

+
+ +
+
+get_format()
+
+
Returns:
+

String representation of this outputformat

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.eseal.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.eseal.html new file mode 100644 index 0000000..3cd93f4 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.eseal.html @@ -0,0 +1,2022 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.eseal package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.eseal package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options.RFC3161TSAOptions(url: str, *, tsa_basic_auth_credentials: TSABasicAuthCredentials | None = None)
+

Bases: TSAOptions

+

Parameters specifying RFC3161 compliant time stamp authority options required for +PDFElectronicSealParams.

+

Constructs a new RFC3161TSAOptions instance from url.

+
+
Parameters:
+
    +
  • url (str) – url to be used for timestamping, can not be None.

  • +
  • tsa_basic_auth_credentials (TSABasicAuthCredentials) – Credentials to be used for timestamping. (Optional, use key-value)

  • +
+
+
+
+
+get_tsa_basic_auth_credentials()
+

Returns the intended TSA authorization credentials to be used.

+
+
Returns:
+

A TSABasicAuthCredentials instance

+
+
Return type:
+

TSABasicAuthCredentials

+
+
+
+ +
+
+get_url()
+

Returns the timestamp url to be used.

+
+
Returns:
+

The timestamp url

+
+
Return type:
+

str

+
+
+
+ +
+
+to_dict()
+

Returns a dictionary representation of the RFC3161TSAOptions instance.

+
+
Returns:
+

A dictionary representing the RFC3161TSAOptions instance

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem(value)
+

Bases: Enum

+

Supported elements to represent electronic seal required for +AppearanceOptions.

+
+
+DATE = 'DATE'
+

Represents the date of applying the electronic seal.

+
+ +
+
+DISTINGUISHED_NAME = 'DISTINGUISHED_NAME'
+

Represents the distinguished name information of the certificate.

+
+ +
+
+LABELS = 'LABELS'
+

Represents labels for seal information.

+
+ +
+
+NAME = 'NAME'
+

Represents the name of the certificate owner.

+
+ +
+
+SEAL_IMAGE = 'SEAL_IMAGE'
+

Represents the background image to be used for sealing.

+
+ +
+
+get_appearance_item() str
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.AppearanceOptions
+

Bases: object

+

Parameters specifying set of elements (i.e. appearance items) to represent electronic seal required for +PDFElectronicSealParams.

+
+
+add_item(appearance_option: AppearanceItem)
+
+
Parameters:
+

appearance_option (AppearanceItem) – AppearanceItem to be added to AppearanceOptions, can not be None.

+
+
+
+ +
+
+get_appearance_options()
+
+
Returns:
+

List of Appearance Items

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.CSCAuthContext(access_token: str, token_type: str = 'Bearer')
+

Bases: object

+

Parameters for representing CSC authorization context.

+

Constructs a new instance of CSCAuthContext

+
+
Parameters:
+
    +
  • access_token (str) – The service access token used to authorize access to the CSC provider hosted APIs. +Cannot be None.

  • +
  • token_type (str) – The type of service access token used to authorize access to the CSC provider hosted APIs. +Default value is “Bearer”.

  • +
+
+
+
+
+get_access_token()
+
+
Returns:
+

The service access token.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_token_type()
+
+
Returns:
+

The type of service access token used.

+
+
Return type:
+

str

+
+
+
+ +
+
+to_dict()
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials(provider_name: str, credential_id: str, pin: str, csc_auth_context: CSCAuthContext)
+

Bases: object

+

Parameters for representing the CSC Provider based credentials as a subtype

+

Creates an instance of CSCCredentials.

+
+
Parameters:
+
    +
  • provider_name (str) – The name of the Trust Service Provider to be used for applying electronic seal. +Can not be None.

  • +
  • credential_id (str) – The digital ID stored with the TSP provider to be used for applying electronic seal. +Can not be None.

  • +
  • pin (str) – The pin associated with the credential ID. Can not be None.

  • +
  • csc_auth_context (CSCAuthContext) – The service authorization data required to communicate with the TSP. Can not be None.

  • +
+
+
+
+
+get_credential_id()
+
+
Returns:
+

The digital ID stored with the TSP provider.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_csc_auth_context()
+
+
Returns:
+

The service authorization data.

+
+
Return type:
+

CSCAuthContext

+
+
+
+ +
+
+get_pin()
+
+
Returns:
+

The pin associated with the credential ID.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_provider_name()
+
+
Returns:
+

The name of the Trust Service Provider.

+
+
Return type:
+

str

+
+
+
+ +
+
+to_dict()
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.DocumentLevelPermission(value)
+

Bases: Enum

+

A mapping of Document Level Permission used in +PDFElectronicSealParams.

+
+
+FORM_FILLING = 'FORM_FILLING'
+

Represents FORM_FILLING document level permission. +Allowed changes in output document are filling in forms, instantiating page templates, and performing approval +signatures.

+
+ +
+
+FORM_FILLING_AND_ANNOTATIONS = 'FORM_FILLING_AND_ANNOTATIONS'
+

Represents FORM_FILLING_AND_ANNOTATIONS document level permission. +In addition to changes allowed in FORM_FILLING, annotation creation, deletion, and modification are also allowed.

+
+ +
+
+NO_CHANGES_ALLOWED = 'NO_CHANGES_ALLOWED'
+

Represents NO_CHANGES_ALLOWED document level permission. +No changes to the output document are permitted.

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams(seal_certificate_credentials: CSCCredentials, seal_field_options: FieldOptions, *, seal_signature_format: SignatureFormat = SignatureFormat.PKCS7, document_level_permissions: DocumentLevelPermission = DocumentLevelPermission.FORM_FILLING, seal_appearance_options: AppearanceOptions | None = None, tsa_options: TSAOptions | None = None)
+

Bases: object

+

Parameters for electronically seal PDFs using +PDFElectronicSealJob.

+

Constructs a new PDFElectronicSealParams instance.

+
+
Parameters:
+
    +
  • seal_certificate_credentials (CSCCredentials) – CertificateCredentials to be used for applying electronic seal; can not be None.

  • +
  • seal_field_options (FieldOptions) – FieldOptions to be used for applying electronic seal; can not be None.

  • +
  • seal_signature_format (SignatureFormat) – SignatureFormat to be used for applying electronic seal. (Optional, use key-value)

  • +
  • document_level_permissions (DocumentLevelPermission) – Document level permission for changes allowed after sealing. (Optional, use key-value)

  • +
  • seal_appearance_options (AppearanceOptions) – AppearanceOptions for the seal. (Optional, use key-value)

  • +
  • tsa_options (TSAOptions) – Time stamp authority options. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of PDFElectronicSealParams

+
+
Return type:
+

PDFElectronicSealParams

+
+
+
+
+get_seal_appearance_options()
+
+
Returns:
+

AppearanceOptions for the seal.

+
+
Return type:
+

AppearanceOptions

+
+
+
+ +
+
+get_seal_certificate_credentials()
+
+
Returns:
+

CertificateCredentials to be used for applying electronic seal

+
+
Return type:
+

CSCCredentials

+
+
+
+ +
+
+get_seal_field_options()
+
+
Returns:
+

FieldOptions to be used for applying electronic seal.

+
+
Return type:
+

FieldOptions

+
+
+
+ +
+
+get_signature_format()
+
+
Returns:
+

SignatureFormat to be used for applying electronic seal.

+
+
Return type:
+

SignatureFormat

+
+
+
+ +
+
+to_dict()
+

For SDK’s internal use

+
+
Returns:
+

ElectronicSealParams as a dictionary.

+
+
Return type:
+

dict

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.field_location module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation(left: int, top: int, right: int, bottom: int)
+

Bases: object

+

Parameters specifying options related to seal field location coordinates required for +FieldOptions

+
+
Parameters:
+
    +
  • left (int) – the left coordinate of field location

  • +
  • top (int) – the top coordinate of field location

  • +
  • right (int) – the right coordinate of field location

  • +
  • bottom (int) – the bottom coordinate of field location

  • +
+
+
+
+
+get_bottom()
+
+
Returns:
+

the bottom coordinate of field location

+
+
Return type:
+

int

+
+
+
+ +
+
+get_left()
+
+
Returns:
+

the left coordinate of field location

+
+
Return type:
+

int

+
+
+
+ +
+
+get_right()
+
+
Returns:
+

the right coordinate of field location

+
+
Return type:
+

int

+
+
+
+ +
+
+get_top()
+
+
Returns:
+

the top coordinate of field location

+
+
Return type:
+

int

+
+
+
+ +
+
+to_dict()
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.field_options module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions(field_name: str, *, field_location: FieldLocation | None = None, page_number: int | None = None, visible: bool | None = True)
+

Bases: object

+

Parameters specifying options related to the seal field required for +PDFElectronicSealParams.

+

Constructs a new instance of FieldOptions.

+
+
Parameters:
+
    +
  • field_name (str) – The name of the field to be used for applying the electronic seal. If signature field with +this field name already exist, that field will be used. If it does not exist, a signature field with this +field name will be created. Can not be None.

  • +
  • field_location (FieldLocation) – A FieldLocation instance specifying coordinates for the electronic seal. The location +is only required for visible signatures if the signature field does not already exist in the PDF document. +If location is provided along with the existing signature field then it is ignored. (Optional, use key-value)

  • +
  • page_number (int) – The page number to which the signature field should be attached. Page numbers are 1-based. +The page number is only required for visible signatures if the signature field does not already exist in +the PDF document. If page number is provided along with the existing signature field then the page number +should be same on which signature field is present in the document, else an error is thrown. +(Optional, use key-value)

  • +
  • visible (bool) – The intended visibility flag for the electronic seal. Default value is true. +(Optional, use key-value)

  • +
+
+
+
+
+get_field_location()
+
+
Returns:
+

Field Location

+
+
Return type:
+

FieldLocation

+
+
+
+ +
+
+get_field_name()
+
+
Returns:
+

Field Name

+
+
Return type:
+

str

+
+
+
+ +
+
+get_page_number()
+
+
Returns:
+

Page Number

+
+
Return type:
+

int

+
+
+
+ +
+
+get_visible()
+
+
Returns:
+

Visibility flag for the electronic seal

+
+
Return type:
+

bool

+
+
+
+ +
+
+to_dict()
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.SignatureFormat(value)
+

Bases: Enum

+

Supported signature formats to create electronic seal required for +PDFElectronicSealParams.

+
+
+PADES = 'PADES'
+

Represents PADES format.

+
+ +
+
+PKCS7 = 'PKCS7'
+

Represents PKCS7 format.

+
+ +
+
+get_signature_format()
+
+
Returns:
+

String value of SignatureFormat

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.TSABasicAuthCredentials(username: str, password: str)
+

Bases: object

+

Parameters specifying options related to the time stamp authority credentials required for +RFC3161TSAOptions

+

Constructs a TSABasicAuthCredentials instance.

+
+
Parameters:
+
    +
  • username (str) – username to be used for timestamping

  • +
  • password (str) – password to be used for timestamping

  • +
+
+
+
+
+get_password()
+

Returns the intended password to be used for timestamping.

+
+
Returns:
+

The password

+
+
Return type:
+

str

+
+
+
+ +
+
+get_username()
+

Returns the intended username to be used for timestamping.

+
+
Returns:
+

The username

+
+
Return type:
+

str

+
+
+
+ +
+
+to_dict()
+

Returns a dictionary representation of the TSABasicAuthCredentials instance.

+
+
Returns:
+

A dictionary representing the TSABasicAuthCredentials instance

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options.TSAOptions
+

Bases: ABC

+

This abstract class represents the basic contract for the timestamp authority options to be used with +PDFElectronicSealParams.

+
+
+abstract to_dict()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.export_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.export_pdf.html new file mode 100644 index 0000000..52089a1 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.export_pdf.html @@ -0,0 +1,1724 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.export_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.export_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale(value)
+

Bases: Enum

+

Enum values representing different locales

+

Constructs a locale from a language code

+
+
Parameters:
+

locale – language code

+
+
+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale.

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+EU_ES = 'eu-ES'
+

Represents “Basque (Spain)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+GL_ES = 'gl-ES'
+

Represents “Galician (Spain)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NN_NO = 'nn-NO'
+

Represents “Norwegian Nynorsk (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+PT_PT = 'pt-PT'
+

Represents “European Portuguese” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HANT = 'zh-Hant'
+

Represents “Chinese (traditional)” locale

+
+ +
+
+get_export_ocr_locale()
+
+
Returns:
+

Language code of the ExportOCRLocale

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params.ExportPDFParams(target_format: ExportPDFTargetFormat, *, ocr_lang: ExportOCRLocale = ExportOCRLocale.EN_US)
+

Bases: PDFServicesJobParams

+

Parameters for exporting a source PDF file to a supported format using +ExportPDFJob

+

Constructs a new ExportPDFParams instance.

+
+
Parameters:
+
    +
  • target_format (ExportPDFTargetFormat) – Target format to which the source PDF file will be exported; can not be None

  • +
  • ocr_lang (ExportOCRLocale) – Sets OCR Locale level to be used for Export PDF. (Optional, use key-value)

  • +
+
+
+
+
+get_ocr_lang()
+
+
Returns:
+

Returns the OCR Locale to be used for Export PDF.

+
+
Return type:
+

ExportOCRLocale

+
+
+
+ +
+
+get_target_format()
+
+
Returns:
+

Returns the target format to which the source PDF file will be exported.

+
+
Return type:
+

ExportPDFTargetFormat

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat(value)
+

Bases: Enum

+

Supported target formats for +ExportPDFJob

+

Constructor.

+
+
Parameters:
+

file_ext – file extension

+
+
+
+
+DOC = 'doc'
+

Represents “application/msword” media type

+
+ +
+
+DOCX = 'docx'
+

Represents “application/vnd.openxmlformats-officedocument.wordprocessingml.document” media type

+
+ +
+
+PPTX = 'pptx'
+

Represents “application/vnd.openxmlformats-officedocument.presentationml.presentation” media type

+
+ +
+
+RTF = 'rtf'
+

Represents “text/rtf” media type

+
+ +
+
+XLSX = 'xlsx'
+

Represents “application/vnd.openxmlformats-officedocument.spreadsheetml.sheet” media type

+
+ +
+
+get_file_ext()
+

Returns the file extension of this format.

+
+
Returns:
+

file extension of this format

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.extract_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.extract_pdf.html new file mode 100644 index 0000000..e690efe --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.extract_pdf.html @@ -0,0 +1,1506 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.extract_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.extract_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type.ExtractElementType(value)
+

Bases: Enum

+

Supported inputs for Elements to Extract ExtractPDFJob.

+
+
+TABLES = 'tables'
+

Tabular Data

+
+ +
+
+TEXT = 'text'
+

Textual Data

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams(*, table_structure_type: TableStructureType = TableStructureType.XLSX, add_char_info: bool = False, styling_info: bool = False, elements_to_extract: List | None = None, elements_to_extract_renditions: List | None = None)
+

Bases: PDFServicesJobParams

+

Parameters to extract content from PDF using +ExtractPDFJob.

+

Construct a new ExtractPDFParams

+
+
Parameters:
+
    +
  • table_structure_type (TableStructureType) – TableStructureType for output type of table structure. (Optional, use key-value)

  • +
  • add_char_info (bool) – Boolean specifying whether to add character level bounding boxes to output json. +(Optional, use key-value)

  • +
  • styling_info (bool) – Boolean specifying whether to add styling information to output json. +(Optional, use key-value)

  • +
  • elements_to_extract (List) – List of ExtractElementType to be extracted. +(Optional, use key-value)

  • +
  • elements_to_extract_renditions (List) – List of ExtractElementType. +(Optional, use key-value)

  • +
+
+
+
+
+get_add_char_info()
+
+
Returns:
+

Whether character level information was invoked for operation.

+
+
Return type:
+

bool

+
+
+
+ +
+
+get_elements_to_extract()
+
+
Returns:
+

The list of elements (Text and/or Tables) invoked for operation

+
+
Return type:
+

list

+
+
+
+ +
+
+get_elements_to_extract_renditions()
+
+
Returns:
+

Returns the list of ExtractElementType invoked for job.

+
+
Return type:
+

list

+
+
+
+ +
+
+get_styling_info()
+
+
Returns:
+

Whether styling information was invoked for operation.

+
+
Return type:
+

bool

+
+
+
+ +
+
+get_table_structure_type()
+
+
Returns:
+

Returns the TableStructureType of the resulting rendition

+
+
Return type:
+

TableStructureType

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type.ExtractRenditionsElementType(value)
+

Bases: Enum

+

Supported inputs for Renditions To Extract ExtractPDFJob.

+
+
+FIGURES = 'figures'
+

Image Data

+
+ +
+
+TABLES = 'tables'
+

Tabular Data

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type.TableStructureType(value)
+

Bases: Enum

+

Supported Formats for exporting Table Data ExtractPDFJob.

+
+
+CSV = 'csv'
+

CSV Format

+
+ +
+
+XLSX = 'xlsx'
+

XLSX Format

+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.html new file mode 100644 index 0000000..01bc2a1 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.html @@ -0,0 +1,2098 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.page_ranges module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges
+

Bases: object

+

Page ranges of a file, inclusive of start and end page index, where page index starts from 1.

+

Constructs a new PageRanges instance with no pages added.

+
+
+add_all()
+

Adds a page range representing all pages.

+
+ +
+
+add_all_from(start: int)
+

Adds a page range from start page index to the last page. Page index starts from 1. +:param start: start page index +:type start: int

+
+ +
+
+add_range(start: int, end: int)
+

Adds a page range. Page indexes start from 1. +:param start: start page index, inclusive +:type start: int +:param end: end page index, inclusive +:type start: int

+
+ +
+
+add_single_page(page: int)
+

Adds a single page. Page index starts from 1. +:param page: single page index +:type page: int

+
+ +
+
+get_ranges()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+
+is_empty()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+
+json_hint = {'ranges': 'pageRanges'}
+
+ +
+
+to_json()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+
+validate()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params.PDFServicesJobParams
+

Bases: ABC

+

Represents the basic contract for the params to be used in +PDFServicesJob

+
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html new file mode 100644 index 0000000..2bbe1a3 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html @@ -0,0 +1,1481 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.html_to_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.html_to_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.HTMLtoPDFParams(*, json: str = '{}', include_header_footer: bool = False, page_layout: ~adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout = <adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout object>)
+

Bases: PDFServicesJobParams

+

Parameters for converting HTML to PDF using +HTMLtoPDFJob

+

Constructs a new HTMLtoPDFParams instance.

+
+
Parameters:
+
    +
  • json (str) –

    Sets the data to be used by the javascript in the source html file to manipulate the HTML DOM +before it gets converted to PDF. +This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests.

    +

    To make use of this mechanism, the source html file must include a script element such as:

    +

    <script src='./json.js' type='text/javascript'></script>

    +

    where json.js refers to the JSON data,</pre> +And also Requires javascript in the source html file to make use of this JSON data to manipulate the HTML +DOM. (Optional, use key-value)

    +

  • +
  • include_header_footer (bool) –

    includeHeaderFooter parameter. If true, default header and footer will be included +in resulting PDF.

    +
    +
      +
    • The default header consists of the date and the document title.

    • +
    • The default footer consists of the file name and page number.

    • +
    +
    +

    (Optional, use key-value)

    +

  • +
  • page_layout (PageLayout) – Intended page layout of the resulting PDF file. (Optional, use key-value)

  • +
+
+
+
+ +
+
Returns:
+

Returns true if default header and footer will be included in the resulting PDF file. +- The default header consists of the date and the document title. +- The default footer consists of the file name and page number.

+
+
Return type:
+

bool

+
+
+
+ +
+
+get_json()
+
+
Returns:
+

Returns JSON data that will be used to manipulate HTML DOM before it is converted into PDF file. +This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests.

+

To make use of this mechanism, the source html file must include a script element such as:

+

<script src='./json.js' type='text/javascript'></script>

+

where json.js refers to the JSON data,</pre> +And also Requires javascript in the source html file to make use of this JSON data to manipulate the HTML +DOM.

+

+
+
Return type:
+

str

+
+
+
+ +
+
+get_page_layout()
+
+
Returns:
+

Intended page layout of the resulting PDF file.

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout(page_height: float = 11.0, page_width: float = 8.5)
+

Bases: object

+

Represents a page layout with dimensions in inches.

+

Constructor to initialize a default page layout. +The default layout sets the height as 11 inches and width as 8.5 inches.

+
+
Parameters:
+
    +
  • page_height (float) – Height of the page in inches, can not be None

  • +
  • page_width (float) – Width of the page in inches

  • +
+
+
+
+
+DEFAULT_PAGE_HEIGHT = 11.0
+

Default value of the page height (in inches)

+
+ +
+
+DEFAULT_PAGE_WIDTH = 8.5
+

Default value of the page width (in inches)

+
+ +
+
+json_hint = {'page_height': 'pageHeight', 'page_width': 'pageWidth'}
+
+ +
+
+to_json()
+
+
Returns:
+

JSON representation of this class, used internally by sdk.

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.html new file mode 100644 index 0000000..791208f --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.html @@ -0,0 +1,1392 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params.ImportPDFFormDataParams(json_form_fields_data: dict)
+

Bases: PDFServicesJobParams

+

Parameters for importing form data into PDF using +ImportPDFFormDataJob

+

Constructs a new ImportPDFFormDataParams instance.

+
+
Parameters:
+

json_form_fields_data (dict) – Dictionary containing form field data to import into the PDF. +Keys should match the form field names in the target PDF, and values should be the data to fill.

+
+
+
+
+get_json_form_fields_data() Dict[str, Any]
+
+
Returns:
+

Returns the form field data dictionary that will be imported into the PDF.

+
+
Return type:
+

Dict[str, Any]

+
+
+
+ +
+
+get_json_form_fields_data_string() str
+
+
Returns:
+

Returns the form field data as a JSON string.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.insert_pages.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.insert_pages.html new file mode 100644 index 0000000..eb4cbbb --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.insert_pages.html @@ -0,0 +1,1409 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.insert_pages package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.insert_pages package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.InsertPagesParams(base_asset: Asset)
+

Bases: PDFServicesJobParams

+

Parameters for inserting pages in a PDF using +InsertPagesJob

+

Constructs a new InsertPagesParams instance.

+
+
Parameters:
+

base_asset (Asset) – Base asset into which the pages are to be inserted.

+
+
+
+
+add_pages_to_insert(input_asset: ~adobe.pdfservices.operation.io.asset.Asset, base_page: int, *, page_ranges: ~adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges = <adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges object>)
+

Adds the specified pages of the input PDF file to be inserted at the specified page of the base PDF file

+

This method can be invoked multiple times with the same or different input PDF files.

+

All the pages of the input PDF file will be inserted at the specified page of the base PDF file if page_ranges +is not specified.

+
+
Parameters:
+
    +
  • input_asset (Asset) – A PDF file for insertion; can not be None.

  • +
  • base_page (int) – Page of the base PDF file; can not be None.

  • +
  • page_ranges (PageRanges) – Page ranges of the input PDF file. (Optional, use key-value)

  • +
+
+
+
+ +
+
+get_assets_to_insert()
+
+
Returns:
+

Returns the mapping of base Asset’s page number and Asset to be inserted along with PageRanges .

+
+
Return type:
+

dict

+
+
+
+ +
+
+get_base_asset()
+
+
Returns:
+

base PDF Asset to which pages will be inserted.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.html new file mode 100644 index 0000000..e22a6f4 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.html @@ -0,0 +1,1686 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.ocr_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.ocr_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.OCRParams(*, ocr_locale: OCRSupportedLocale = OCRSupportedLocale.EN_US, ocr_type: OCRSupportedType = OCRSupportedType.SEARCHABLE_IMAGE)
+

Bases: PDFServicesJobParams

+

Parameters for converting PDF to a searchable PDF using +OCRPDFJob<adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job.OCRPDFJob

+

Constructs a new OCRParams instance.

+
+
Parameters:
+
+
+
+
+
+get_ocr_locale()
+
+
Returns:
+

OCRSupportedLocale to be used for OCR.

+
+
Return type:
+

OCRSupportedLocale

+
+
+
+ +
+
+get_ocr_type()
+
+
Returns:
+

OCRSupportedType to be used for OCR.

+
+
Return type:
+

OCRSupportedType

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale(value)
+

Bases: Enum

+

Supported locales for OCRJob

+

Construct a locale from a language code.

+
+
Parameters:
+

locale – language code

+
+
+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NO_NO = 'no-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HK = 'zh-HK'
+

Represents “Chinese (Hong Kong)” locale

+
+ +
+
+get_locale()
+

Returns the language code of this OCRSupportedLocale.

+
+
Returns:
+

language code of the locale

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.OCRSupportedType(value)
+

Bases: Enum

+

Supported OCR types for OCRJob

+

Constructs OCR Type from its string representation.

+
+
Parameters:
+

ocr_type – String representation

+
+
+
+
+SEARCHABLE_IMAGE = 'searchable_image'
+
+ +
+
+SEARCHABLE_IMAGE_EXACT = 'searchable_image_exact'
+
+ +
+
+get_type()
+

Returns the string representation of this OCRSupportedType.

+
+
Returns:
+

String representation of this OCRSupportedType

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.pdf_properties.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.pdf_properties.html new file mode 100644 index 0000000..387da82 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.pdf_properties.html @@ -0,0 +1,1379 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.pdf_properties package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.pdf_properties package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params.PDFPropertiesParams(*, include_page_level_properties: bool = False)
+

Bases: PDFServicesJobParams

+

Parameters for getting properties of a PDF using +PDFPropertiesJob

+

Constructs a new PDFPropertiesParams.

+
+
Parameters:
+

include_page_level_properties (bool) – If true, the page level properties of the input PDF will be included in +the resulting JSON file or JSON Object. (Optional, use key-value)

+
+
+
+
+get_include_page_level_properties()
+
+
Returns:
+

Page level properties

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.html new file mode 100644 index 0000000..cd86c18 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.html @@ -0,0 +1,1458 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.pdf_to_image package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.pdf_to_image package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.ExportPDFToImagesOutputType(value)
+

Bases: Enum

+

List of supported outputTypes for ExportPDFToImagesJob.

+
+
+LIST_OF_PAGE_IMAGES = 'listOfPageImages'
+

Represents List Output type.

+
+ +
+
+ZIP_OF_PAGE_IMAGES = 'zipOfPageImages'
+

Represents Zip Output type.

+
+ +
+
+get_output_type()
+
+
Returns:
+

output type.

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params.ExportPDFtoImagesParams(export_pdf_to_images_target_format: ExportPDFToImagesTargetFormat, export_pdf_to_images_output_type: ExportPDFToImagesOutputType)
+

Bases: PDFServicesJobParams

+

Parameters for exporting a source PDF file to images using +ExportPDFToImagesJob.

+

Constructs a new ExportPDFtoImagesParams instance.

+
+
Parameters:
+
    +
  • export_pdf_to_images_target_format (ExportPDFToImagesTargetFormat) – ExportPDFToImagesTargetFormat to which the source PDF file will be exported, can not be None.

  • +
  • export_pdf_to_images_output_type (ExportPDFToImagesOutputType) – ExportPDFToImagesOutputType to be used for Export PDF to Images, can not be None.

  • +
+
+
+
+
+get_export_pdf_to_images_output_type()
+
+
Returns:
+

ExportPDFToImagesOutputType to be used for Export PDF to Images.

+
+
Return type:
+

ExportPDFToImagesOutputType

+
+
+
+ +
+
+get_export_pdf_to_images_target_format()
+
+
Returns:
+

ExportPDFToImagesTargetFormat to which the source PDF file will be exported.

+
+
Return type:
+

ExportPDFToImagesTargetFormat

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.ExportPDFToImagesTargetFormat(value)
+

Bases: Enum

+

Supported target formats for ExportPDFToImagesJob.

+
+
+JPEG = 'jpeg'
+

Represents “image/jpeg” media type.

+
+ +
+
+PNG = 'png'
+

Represents “image/png” media type.

+
+ +
+
+get_file_ext()
+
+
Returns:
+

file extension of this format.

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.protect_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.protect_pdf.html new file mode 100644 index 0000000..93c9e75 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.protect_pdf.html @@ -0,0 +1,1596 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.protect_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.protect_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.ContentEncryption(value)
+

Bases: Enum

+

Supported types of content to encrypt for +ProtectPDFJob

+
+
+ALL_CONTENT = 'ALL_CONTENT'
+

Encrypts all the content of the PDF file

+
+ +
+
+ALL_CONTENT_EXCEPT_METADATA = 'ALL_CONTENT_EXCEPT_METADATA'
+

Encrypts all the content except the metadata of the PDF file

+
+ +
+
+ONLY_EMBEDDED_FILES = 'ONLY_EMBEDDED_FILES'
+

Encrypts only embedded files

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm.EncryptionAlgorithm(value)
+

Bases: Enum

+

Supported encryption algorithms for +ProtectPDFJob

+
+
+AES_128 = 'AES_128'
+

Represents AES-128 encryption algorithm

+
+ +
+
+AES_256 = 'AES_256'
+

Represents AES-256 encryption algorithm

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams(encryption_algorithm: EncryptionAlgorithm, *, content_encryption: ContentEncryption = ContentEncryption.ALL_CONTENT, permissions: Permissions | None = None, user_password: str | None = None, owner_password: str | None = None)
+

Bases: ProtectPDFParams

+

Parameters for securing PDF file with passwords and document permissions using +ProtectPDFJob

+

Constructs a new PasswordProtectParams instance.

+
+
Parameters:
+
    +
  • encryption_algorithm (EncryptionAlgorithm) – Sets the intended encryption algorithm required for encrypting the PDF file. For +AES-128 encryption, the password supports LATIN-I characters only. For AES-256 encryption, passwords supports +Unicode character set.

  • +
  • content_encryption (ContentEncryption) – Type of content to encrypt in the PDF file. (Optional, use key-value)

  • +
  • permissions (Permissions) – Sets the intended permissions for the encrypted PDF file. This includes permissions to allow +printing, editing and content copying in the PDF document. Permissions can only be used in case the owner +password is set. (Optional, use key-value)

  • +
  • user_password (str) – User password required for opening the encrypted PDF file. Allowed maximum length +for the user password is 128 bytes. (Optional, use key-value)

  • +
  • owner_password (str) – Owner password required to control access permissions in the encrypted PDF file. This +password can also be used to open/view the encrypted PDF file. Allowed maximum length for the owner +password is 128 bytes. (Optional, use key-value)

  • +
+
+
+
+
+get_content_encryption()
+
+
Returns:
+

ContentEncryption for the resulting encrypted PDF file as a string.

+
+
Return type:
+

ContentEncryption

+
+
+
+ +
+
+get_encryption_algorithm()
+
+
Returns:
+

EncryptionAlgorithm of the resulting encrypted PDF file.

+
+
Return type:
+

EncryptionAlgorithm

+
+
+
+ +
+
+get_owner_password()
+
+
Returns:
+

the intended owner password of the resulting encrypted PDF file.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_permissions()
+
+
Returns:
+

Permissions for the resulting encrypted PDF file.

+
+
Return type:
+

Permissions

+
+
+
+ +
+
+get_user_password()
+
+
Returns:
+

the intended user password of the resulting encrypted PDF file.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission(value)
+

Bases: Enum

+

Document Permissions for +ProtectPDFJob

+
+
+COPY_CONTENT = 'COPY_CONTENT'
+

Enables copying of content from the PDF document

+
+ +
+
+EDIT_ANNOTATIONS = 'EDIT_ANNOTATIONS'
+

Enables additions of comments, digital signatures and filling in of forms in a PDF document

+
+ +
+
+EDIT_CONTENT = 'EDIT_CONTENT'
+

Enables all the editing permissions in the PDF document except commenting and page extraction

+
+ +
+
+EDIT_DOCUMENT_ASSEMBLY = 'EDIT_DOCUMENT_ASSEMBLY'
+

Enables insertion, deletion and rotation of pages in a PDF document

+
+ +
+
+EDIT_FILL_AND_SIGN_FORM_FIELDS = 'EDIT_FILL_AND_SIGN_FORM_FIELDS'
+

Enables filling in of forms, digital signature and creation of template pages in a PDF document

+
+ +
+
+PRINT_HIGH_QUALITY = 'PRINT_HIGH_QUALITY'
+

Enables high quality printing of the PDF document

+
+ +
+
+PRINT_LOW_QUALITY = 'PRINT_LOW_QUALITY'
+

Enables low quality printing of the PDF document

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.Permissions
+

Bases: object

+

Document Permissions for +ProtectPDFJob

+

Constructs a new Permissions instance.

+
+
+add_permission(permission: Permission)
+

Adds a document Permission +in the permissions set.

+
+
Parameters:
+

permission (Permission) – A document permission; can not be None.

+
+
+
+ +
+
+get_values()
+
+
Returns:
+

the intended set of document permissions values.

+
+
Return type:
+

list

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params.ProtectPDFParams
+

Bases: PDFServicesJobParams, ABC

+

Marker base class for ProtectPDFJob +params.

+
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.remove_protection.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.remove_protection.html new file mode 100644 index 0000000..492be8d --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.remove_protection.html @@ -0,0 +1,1386 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.remove_protection package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.remove_protection package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params.RemoveProtectionParams(password: str)
+

Bases: PDFServicesJobParams

+

Parameters for removing protection from pdf using +RemoveProtectionJob

+
+

Constructs a new RemoveProtectionParams instance.

+
+
+
Parameters:
+

password (str) – the password to be used for removing protection from pdf.

+
+
Returns:
+

A new instance of RemoveProtectionParams

+
+
Return type:
+

RemoveProtectionParams

+
+
+
+
+get_password()
+
+
Returns:
+

Returns the password to be used for removing protection from pdf.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.reorder_pages.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.reorder_pages.html new file mode 100644 index 0000000..a601dfe --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.reorder_pages.html @@ -0,0 +1,1400 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.reorder_pages package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.reorder_pages package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params.ReorderPagesParams(asset: Asset, page_ranges: PageRanges)
+

Bases: PDFServicesJobParams

+

Parameters for reordering a pdf using +ReorderPagesJob

+

Constructs a new ReorderPagesParams instance.

+
+
Parameters:
+
    +
  • asset (Asset) – Asset to be reordered, can not be None.

  • +
  • page_ranges (PageRanges) – The page ranges to be used for reordering pages, can not be None.

  • +
+
+
Returns:
+

A new instance of ReorderPagesParams

+
+
Return type:
+

ReorderPagesParams

+
+
+
+
+get_asset()
+
+
Returns:
+

Asset to be reordered.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_page_ranges()
+
+
Returns:
+

PageRanges to be used for reordering pages.

+
+
Return type:
+

PageRanges

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.replace_pages.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.replace_pages.html new file mode 100644 index 0000000..1f03d82 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.replace_pages.html @@ -0,0 +1,1409 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.replace_pages package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.replace_pages package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.ReplacePagesParams(base_asset: Asset)
+

Bases: PDFServicesJobParams

+

Parameters for replacing pages of a pdf using +ReplacePagesJob

+

Constructs a new ReplacePagesParams instance.

+
+
Parameters:
+

base_asset (Asset) – The base asset to be used for replacing pages, can not be None.

+
+
Returns:
+

A new instance of ReplacePagesParams

+
+
Return type:
+

ReplacePagesParams

+
+
+
+
+add_pages_to_replace(input_asset: ~adobe.pdfservices.operation.io.asset.Asset, base_page: int, *, page_ranges: ~adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges = <adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges object>)
+
+
Parameters:
+
    +
  • input_asset (Asset) – a PDF file for insertion

  • +
  • page_ranges (PageRanges) – page ranges of the input PDF file

  • +
  • base_page (int) – page of the base PDF file

  • +
+
+
+
+ +
+
+get_assets_to_replace()
+
+
Returns:
+

Returns the mapping of base Asset’s page number and Asset to be replaced along +with PageRanges.

+
+
+
+ +
+
+get_base_asset()
+
+
Returns:
+

Returns the base PDF Asset to which pages will be replaced.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.rotate_pages.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.rotate_pages.html new file mode 100644 index 0000000..deada12 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.rotate_pages.html @@ -0,0 +1,1425 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.rotate_pages package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.rotate_pages package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.Angle(value)
+

Bases: Enum

+

Represents angles in degrees.

+
+
+ANGLE_180 = 180
+

Represents 180 degrees clockwise rotation

+
+ +
+
+ANGLE_270 = 270
+

Represents 270 degrees clockwise rotation

+
+ +
+
+ANGLE_90 = 90
+

Represents 90 degrees clockwise rotation

+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams
+

Bases: PDFServicesJobParams

+

Parameters to rotate pages of a pdf using +RotatePagesJob<adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job.>RotatePagesJob

+
+
+add_angle_to_rotate(angle: Angle)
+

Sets the Angle to be used for rotating pages.

+
+
Parameters:
+

angle (Angle) – Angle; can not be None.

+
+
+
+ +
+
+add_angle_to_rotate_for_page_ranges(angle: Angle, page_ranges: PageRanges)
+

Sets the Angle to be used for rotating pages specified in PageRanges.

+
+
Parameters:
+
    +
  • angle (Angle) – Angle; can not be None.

  • +
  • page_ranges (PageRanges) – PageRanges; can not be None.

  • +
+
+
+
+ +
+
+get_page_actions()
+
+
Returns:
+

PageActions to be used for rotating pages.

+
+
Return type:
+

PageActions

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.split_pdf.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.split_pdf.html new file mode 100644 index 0000000..d7d5713 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.params.split_pdf.html @@ -0,0 +1,1425 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.params.split_pdf package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.params.split_pdf package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params module

+
+
+class adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.SplitPDFParams(*, page_ranges: PageRanges | None = None, page_count: int | None = None, file_count: int | None = None)
+

Bases: PDFServicesJobParams

+

Parameters for splitting a pdf using +SplitPDFJob

+

Constructs a new SplitPDFParams instance.

+
+
Parameters:
+
    +
  • page_ranges (PageRanges) – see PageRanges. +(Optional, use key-value)

  • +
  • page_count (int) – The page count to be used for splitting pages. (Optional, use key-value)

  • +
  • file_count (int) – The file count to be used for splitting pages. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of SplitPDFParams

+
+
Return type:
+

SplitPDFParams

+
+
+
+
+get_file_count()
+
+
Returns:
+

Returns the file count to be used for splitting pages.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_page_count()
+
+
Returns:
+

Returns the page count to be used for splitting pages.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_page_ranges()
+
+
Returns:
+

PageRanges to be used for splitting pages.

+
+
Return type:
+

PageRanges

+
+
+
+ +
+
+json_hint = {'file_count': 'fileCount', 'page_count': 'pageCount', 'page_ranges': 'pageRanges'}
+
+ +
+
+to_json()
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.result.html b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.result.html new file mode 100644 index 0000000..0257944 --- /dev/null +++ b/docs/apidocs/4.2.0/adobe.pdfservices.operation.pdfjobs.result.html @@ -0,0 +1,2074 @@ + + + + + + + + + adobe.pdfservices.operation.pdfjobs.result package — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

adobe.pdfservices.operation.pdfjobs.result package

+
+

Submodules

+
+
+

adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result.AutotagPDFResult(tagged_pdf: Asset, report: Asset, resource: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +AutotagPDFJob.

+

Constructs a new AutotagPDFResult instance with the tagged PDF asset and report asset.

+
+
Parameters:
+
    +
  • tagged_pdf (Asset) – tagged PDF asset

  • +
  • report (Asset) – report asset

  • +
  • resource (Asset) – resource asset

  • +
+
+
+
+
+get_report()
+
+
Returns:
+

Returns report asset, if an internal asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_resource()
+
+
Returns:
+

The zipped asset associated with the +AutotagPDFJob result, +if an external asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_tagged_pdf()
+
+
Returns:
+

Returns tagged PDF asset, if an internal asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result.CombinePDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +CombinePDFJob.

+

Constructs a new CombinePDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result.CompressPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +CompressPDFJob

+

Constructs a new CompressPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.create_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.create_pdf_result.CreatePDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +CreatePDFJob .

+

Constructs a new CreatePDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.delete_pages_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.delete_pages_result.DeletePagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +DeletePagesJob

+

Constructs a new DeletePagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.document_merge_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.document_merge_result.DocumentMergePDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +DocumentMergeJob

+

Constructs a new DocumentMergePDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result.ESealPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +PDFElectronicSealJob.

+

Constructs a new ESealPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.export_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.export_pdf_result.ExportPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ExportPDFJob

+

Constructs a new ExportPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result.ExportPDFtoImagesResult(assets: [])
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ExportPDFToImagesJob.

+

Constructs a new ExportPDFToImagesResult instance

+
+
Parameters:
+

assets (list) – List of result assets

+
+
+
+
+get_assets()
+
+
Returns:
+

the list of result assets

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result.ExtractPDFResult(content: Asset, resource: Asset, content_json: {})
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ExtractPDFJob.

+

Constructs a new ExtractPDFResult instance with result content asset, resource asset and resource JSON +object

+
+
Parameters:
+
    +
  • content (Asset) – result content asset

  • +
  • resource (Asset) – result resource asset

  • +
  • content_json (dict) – result content json

  • +
+
+
+
+
+get_content()
+
+
Returns:
+

Returns the content asset containing extracted content of PDF file, if an internal asset was used as +input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_content_json()
+
+
Returns:
+

Returns the content json dictionary containing extracted content of PDF file, if an internal asset +was used as input PDF.

+
+
Return type:
+

dict

+
+
+
+ +
+
+get_resource()
+
+
Returns:
+

Returns the Asset of zip file containing generated resources from extract operation.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result.HTMLtoPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +HTMLtoPDFJob

+

Constructs a new HTMLtoPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.insert_pages_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.insert_pages_result.InsertPagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +InsertPagesJob

+

Constructs a new InsertPagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result.LinearizePDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +LinearizePDFJob

+

Constructs a new LinearizePDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result.OCRPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +OCRPDFJob<adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job.OCRPDFJob.

+

Constructs a new OCRPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result.PDFPropertiesResult(pdf_properties_dict: str)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +PDFPropertiesJob.

+

Constructs a new PDFPropertiesResult instance with PDF Properties JSON string.

+
+
Parameters:
+

pdf_properties_dict (str) – PDF Properties JSON String

+
+
+
+
+get_pdf_properties_dict()
+
+
Returns:
+

Returns PDF Properties JSON string.

+
+
Return type:
+

string

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result.PDFServicesJobResult
+

Bases: ABC

+

This is an abstract class that represents the PDFServicesJob +PDFServicesJob result.

+

It will encapsulate the result of +PDFServicesJob

+
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result.ProtectPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ProtectPDFJob.

+

Constructs a new ProtectPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.remove_protection_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.remove_protection_result.RemoveProtectionResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +RemoveProtectionJob

+

Constructs a new RemoveProtectionResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result.ReorderPagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ReorderPagesJob.

+

Constructs a new ReorderPagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.replace_page_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.replace_page_result.ReplacePagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ReplacePagesJob

+

Constructs a new ReplacePagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result.RotatePagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +RotatePagesJob.

+

Constructs a new RotatePagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

adobe.pdfservices.operation.pdfjobs.result.split_pdf_result module

+
+
+class adobe.pdfservices.operation.pdfjobs.result.split_pdf_result.SplitPDFResult(assets: [], asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +SplitPDFJob.

+

Constructs a new SplitPDFResult instance

+
+
Parameters:
+
    +
  • assets (list) – List of result assets

  • +
  • asset (Asset) – result asset, enclosing zipped output result

  • +
+
+
+
+
+get_asset()
+
+
Returns:
+

The zipped asset associated with the +SplitPDFJob result, if an +external asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_assets()
+
+
Returns:
+

Returns the list of result assets, if an internal asset was used as input PDF.

+
+
Return type:
+

list

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/genindex.html b/docs/apidocs/4.2.0/genindex.html new file mode 100644 index 0000000..44dd088 --- /dev/null +++ b/docs/apidocs/4.2.0/genindex.html @@ -0,0 +1,6391 @@ + + + + + + + + Index — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | F + | G + | H + | I + | J + | K + | L + | M + | N + | O + | P + | Q + | R + | S + | T + | U + | V + | W + | X + | Z + +
+

A

+ + + +
    +
  • ACCEPT_HEADER_NAME (adobe.pdfservices.operation.internal.http.request_header_const.DefaultHeaders attribute) +
  • +
  • add_action() (adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions.PageActions method) +
  • +
  • add_all() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges method), [1] +
  • +
  • add_all_from() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges method), [1] +
  • +
  • add_angle_to_rotate() (adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams method), [1] +
  • +
  • add_angle_to_rotate_for_page_ranges() (adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams method), [1] +
  • +
  • add_asset() (adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.CombinePDFParams method), [1] +
  • +
  • add_command() (adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands.PageActionCommands method) +
  • +
  • add_fragment() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments method), [1] +
  • +
  • add_fragments() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments method), [1] +
  • +
  • add_item() (adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.AppearanceOptions method), [1] +
  • +
  • add_pages_to_insert() (adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.InsertPagesParams method), [1] +
  • +
  • add_pages_to_replace() (adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.ReplacePagesParams method), [1] +
  • +
  • add_permission() (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.Permissions method), [1] +
  • +
  • add_range() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges method), [1] +
  • +
  • add_single_page() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges method), [1] +
  • +
  • + adobe + +
  • +
  • + adobe.pdfservices + +
  • +
  • + adobe.pdfservices.operation + +
  • +
  • + adobe.pdfservices.operation.auth + +
  • +
  • + adobe.pdfservices.operation.auth.credentials + +
  • +
  • + adobe.pdfservices.operation.auth.service_principal_credentials + +
  • +
  • + adobe.pdfservices.operation.config + +
  • +
  • + adobe.pdfservices.operation.config.client_config + +
  • +
  • + adobe.pdfservices.operation.config.notifier + +
  • +
  • + adobe.pdfservices.operation.config.notifier.callback_notifier_data + +
  • +
  • + adobe.pdfservices.operation.config.notifier.notifier_config + +
  • +
  • + adobe.pdfservices.operation.config.notifier.notifier_data + +
  • +
  • + adobe.pdfservices.operation.config.notifier.notifier_type + +
  • +
  • + adobe.pdfservices.operation.config.proxy + +
  • +
  • + adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials + +
  • +
  • + adobe.pdfservices.operation.config.proxy.proxy_scheme + +
  • +
  • + adobe.pdfservices.operation.config.proxy.proxy_server_config + +
  • +
  • + adobe.pdfservices.operation.config.proxy.username_password_credentials + +
  • +
  • + adobe.pdfservices.operation.exception + +
  • +
  • + adobe.pdfservices.operation.exception.exceptions + +
  • +
  • + adobe.pdfservices.operation.exception.exceptions.SdkException + +
  • +
  • + adobe.pdfservices.operation.exception.exceptions.ServiceApiException + +
  • +
  • + adobe.pdfservices.operation.exception.exceptions.ServiceUsageException + +
  • +
  • + adobe.pdfservices.operation.internal + +
  • +
  • + adobe.pdfservices.operation.internal.api + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.combinepdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.compresspdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.createpdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.document_generation + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.esealpdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.exportpdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.linearizepdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.remove_protection + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.splitpdf + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.response + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.response.job_status + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response + +
  • +
  • + adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response + +
  • +
  • + adobe.pdfservices.operation.internal.api.pdf_services_api + +
  • +
  • + adobe.pdfservices.operation.internal.api.storage_api + +
  • +
  • + adobe.pdfservices.operation.internal.auth + +
  • +
  • + adobe.pdfservices.operation.internal.auth.auth_factory + +
  • +
  • + adobe.pdfservices.operation.internal.auth.authenticator + +
  • +
  • + adobe.pdfservices.operation.internal.auth.service_principal_authenticator + +
  • +
  • + adobe.pdfservices.operation.internal.auth.service_token_authenticator + +
  • +
  • + adobe.pdfservices.operation.internal.auth.service_token_credentials + +
  • +
  • + adobe.pdfservices.operation.internal.auth.session_token + +
  • +
  • + adobe.pdfservices.operation.internal.constants + +
  • +
  • + adobe.pdfservices.operation.internal.constants.custom_error_messages + +
  • +
  • + adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map + +
  • +
  • + adobe.pdfservices.operation.internal.constants.pdf_services_uri + +
  • +
  • + adobe.pdfservices.operation.internal.constants.request_key + +
  • +
  • + adobe.pdfservices.operation.internal.constants.service_constants + +
  • +
  • + adobe.pdfservices.operation.internal.exceptions + +
  • +
  • + adobe.pdfservices.operation.internal.execution_context + +
  • +
  • + adobe.pdfservices.operation.internal.http + +
  • +
  • + adobe.pdfservices.operation.internal.http.http_client + +
  • +
  • + adobe.pdfservices.operation.internal.http.http_method + +
  • +
  • + adobe.pdfservices.operation.internal.http.http_request + +
  • +
  • + adobe.pdfservices.operation.internal.http.request_header_const + +
  • +
  • + adobe.pdfservices.operation.internal.http.response_util + +
  • +
  • + adobe.pdfservices.operation.internal.params + +
  • +
  • + adobe.pdfservices.operation.internal.params.combine_pdf_job_input + +
  • +
  • + adobe.pdfservices.operation.internal.params.page_range + +
  • +
  • + adobe.pdfservices.operation.internal.pdf_services_helper + +
  • +
  • + adobe.pdfservices.operation.internal.util + +
  • +
  • + adobe.pdfservices.operation.internal.util.asset_upload_util + +
  • +
  • + adobe.pdfservices.operation.internal.util.enforce_types + +
  • +
  • + adobe.pdfservices.operation.internal.util.file_utils + +
  • +
  • + adobe.pdfservices.operation.internal.util.json_hint_encoder + +
  • +
  • + adobe.pdfservices.operation.internal.util.object_util + +
  • +
  • + adobe.pdfservices.operation.internal.util.path_util + +
  • +
  • + adobe.pdfservices.operation.internal.util.string_util + +
  • +
  • + adobe.pdfservices.operation.internal.util.validation_util + +
  • +
  • + adobe.pdfservices.operation.io + +
  • +
  • + adobe.pdfservices.operation.io.asset + +
  • +
  • + adobe.pdfservices.operation.io.cloud_asset + +
  • +
  • + adobe.pdfservices.operation.io.external_asset + +
  • +
  • + adobe.pdfservices.operation.io.external_storage_type + +
  • +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

J

+ + + +
+ +

K

+ + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

Q

+ + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + + +
+ +

W

+ + +
+ +

X

+ + + +
+ +

Z

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/index.html b/docs/apidocs/4.2.0/index.html new file mode 100644 index 0000000..437c361 --- /dev/null +++ b/docs/apidocs/4.2.0/index.html @@ -0,0 +1,1371 @@ + + + + + + + + + Welcome to pdfservices-sdk’s documentation! — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

Welcome to pdfservices-sdk’s documentation!

+ +
+
+

Indices and tables

+ +
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/modules.html b/docs/apidocs/4.2.0/modules.html new file mode 100644 index 0000000..dcc9fe2 --- /dev/null +++ b/docs/apidocs/4.2.0/modules.html @@ -0,0 +1,1358 @@ + + + + + + + + + src — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+ +
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/objects.inv b/docs/apidocs/4.2.0/objects.inv new file mode 100644 index 0000000..fcf1803 Binary files /dev/null and b/docs/apidocs/4.2.0/objects.inv differ diff --git a/docs/apidocs/4.2.0/py-modindex.html b/docs/apidocs/4.2.0/py-modindex.html new file mode 100644 index 0000000..b8aee68 --- /dev/null +++ b/docs/apidocs/4.2.0/py-modindex.html @@ -0,0 +1,2789 @@ + + + + + + + + Python Module Index — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ a +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ a
+ adobe +
    + adobe.pdfservices +
    + adobe.pdfservices.operation +
    + adobe.pdfservices.operation.auth +
    + adobe.pdfservices.operation.auth.credentials +
    + adobe.pdfservices.operation.auth.service_principal_credentials +
    + adobe.pdfservices.operation.config +
    + adobe.pdfservices.operation.config.client_config +
    + adobe.pdfservices.operation.config.notifier +
    + adobe.pdfservices.operation.config.notifier.callback_notifier_data +
    + adobe.pdfservices.operation.config.notifier.notifier_config +
    + adobe.pdfservices.operation.config.notifier.notifier_data +
    + adobe.pdfservices.operation.config.notifier.notifier_type +
    + adobe.pdfservices.operation.config.proxy +
    + adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials +
    + adobe.pdfservices.operation.config.proxy.proxy_scheme +
    + adobe.pdfservices.operation.config.proxy.proxy_server_config +
    + adobe.pdfservices.operation.config.proxy.username_password_credentials +
    + adobe.pdfservices.operation.exception +
    + adobe.pdfservices.operation.exception.exceptions +
    + adobe.pdfservices.operation.exception.exceptions.SdkException +
    + adobe.pdfservices.operation.exception.exceptions.ServiceApiException +
    + adobe.pdfservices.operation.exception.exceptions.ServiceUsageException +
    + adobe.pdfservices.operation.internal +
    + adobe.pdfservices.operation.internal.api +
    + adobe.pdfservices.operation.internal.api.dto +
    + adobe.pdfservices.operation.internal.api.dto.request +
    + adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request +
    + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf +
    + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.combinepdf +
    + adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.compresspdf +
    + adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.createpdf +
    + adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.document_generation +
    + adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.esealpdf +
    + adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.exportpdf +
    + adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf +
    + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf +
    + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.linearizepdf +
    + adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf +
    + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action +
    + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties +
    + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api +
    + adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request +
    + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage +
    + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf +
    + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.remove_protection +
    + adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.request.splitpdf +
    + adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request +
    + adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload +
    + adobe.pdfservices.operation.internal.api.dto.response +
    + adobe.pdfservices.operation.internal.api.dto.response.job_status +
    + adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api +
    + adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response +
    + adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response +
    + adobe.pdfservices.operation.internal.api.pdf_services_api +
    + adobe.pdfservices.operation.internal.api.storage_api +
    + adobe.pdfservices.operation.internal.auth +
    + adobe.pdfservices.operation.internal.auth.auth_factory +
    + adobe.pdfservices.operation.internal.auth.authenticator +
    + adobe.pdfservices.operation.internal.auth.service_principal_authenticator +
    + adobe.pdfservices.operation.internal.auth.service_token_authenticator +
    + adobe.pdfservices.operation.internal.auth.service_token_credentials +
    + adobe.pdfservices.operation.internal.auth.session_token +
    + adobe.pdfservices.operation.internal.constants +
    + adobe.pdfservices.operation.internal.constants.custom_error_messages +
    + adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map +
    + adobe.pdfservices.operation.internal.constants.pdf_services_uri +
    + adobe.pdfservices.operation.internal.constants.request_key +
    + adobe.pdfservices.operation.internal.constants.service_constants +
    + adobe.pdfservices.operation.internal.exceptions +
    + adobe.pdfservices.operation.internal.execution_context +
    + adobe.pdfservices.operation.internal.http +
    + adobe.pdfservices.operation.internal.http.http_client +
    + adobe.pdfservices.operation.internal.http.http_method +
    + adobe.pdfservices.operation.internal.http.http_request +
    + adobe.pdfservices.operation.internal.http.request_header_const +
    + adobe.pdfservices.operation.internal.http.response_util +
    + adobe.pdfservices.operation.internal.params +
    + adobe.pdfservices.operation.internal.params.combine_pdf_job_input +
    + adobe.pdfservices.operation.internal.params.page_range +
    + adobe.pdfservices.operation.internal.pdf_services_helper +
    + adobe.pdfservices.operation.internal.util +
    + adobe.pdfservices.operation.internal.util.asset_upload_util +
    + adobe.pdfservices.operation.internal.util.enforce_types +
    + adobe.pdfservices.operation.internal.util.file_utils +
    + adobe.pdfservices.operation.internal.util.json_hint_encoder +
    + adobe.pdfservices.operation.internal.util.object_util +
    + adobe.pdfservices.operation.internal.util.path_util +
    + adobe.pdfservices.operation.internal.util.string_util +
    + adobe.pdfservices.operation.internal.util.validation_util +
    + adobe.pdfservices.operation.io +
    + adobe.pdfservices.operation.io.asset +
    + adobe.pdfservices.operation.io.cloud_asset +
    + adobe.pdfservices.operation.io.external_asset +
    + adobe.pdfservices.operation.io.external_storage_type +
    + adobe.pdfservices.operation.io.stream_asset +
    + adobe.pdfservices.operation.pdf_services +
    + adobe.pdfservices.operation.pdf_services_job +
    + adobe.pdfservices.operation.pdf_services_job_status +
    + adobe.pdfservices.operation.pdf_services_job_status_response +
    + adobe.pdfservices.operation.pdf_services_media_type +
    + adobe.pdfservices.operation.pdf_services_response +
    + adobe.pdfservices.operation.pdfjobs +
    + adobe.pdfservices.operation.pdfjobs.jobs +
    + adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.eseal_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job +
    + adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job +
    + adobe.pdfservices.operation.pdfjobs.params +
    + adobe.pdfservices.operation.pdfjobs.params.autotag_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params +
    + adobe.pdfservices.operation.pdfjobs.params.combine_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params +
    + adobe.pdfservices.operation.pdfjobs.params.compress_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params +
    + adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.word +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params +
    + adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language +
    + adobe.pdfservices.operation.pdfjobs.params.delete_pages +
    + adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params +
    + adobe.pdfservices.operation.pdfjobs.params.documentmerge +
    + adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params +
    + adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments +
    + adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format +
    + adobe.pdfservices.operation.pdfjobs.params.eseal +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.field_location +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.field_options +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials +
    + adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options +
    + adobe.pdfservices.operation.pdfjobs.params.export_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale +
    + adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params +
    + adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format +
    + adobe.pdfservices.operation.pdfjobs.params.extract_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type +
    + adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params +
    + adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type +
    + adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type +
    + adobe.pdfservices.operation.pdfjobs.params.html_to_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params +
    + adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout +
    + adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data +
    + adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params +
    + adobe.pdfservices.operation.pdfjobs.params.insert_pages +
    + adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params +
    + adobe.pdfservices.operation.pdfjobs.params.ocr_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params +
    + adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale +
    + adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type +
    + adobe.pdfservices.operation.pdfjobs.params.page_ranges +
    + adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params +
    + adobe.pdfservices.operation.pdfjobs.params.pdf_properties +
    + adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params +
    + adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params +
    + adobe.pdfservices.operation.pdfjobs.params.pdf_to_image +
    + adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type +
    + adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params +
    + adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format +
    + adobe.pdfservices.operation.pdfjobs.params.protect_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption +
    + adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm +
    + adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params +
    + adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission +
    + adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions +
    + adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params +
    + adobe.pdfservices.operation.pdfjobs.params.remove_protection +
    + adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params +
    + adobe.pdfservices.operation.pdfjobs.params.reorder_pages +
    + adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params +
    + adobe.pdfservices.operation.pdfjobs.params.replace_pages +
    + adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params +
    + adobe.pdfservices.operation.pdfjobs.params.rotate_pages +
    + adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle +
    + adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params +
    + adobe.pdfservices.operation.pdfjobs.params.split_pdf +
    + adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params +
    + adobe.pdfservices.operation.pdfjobs.result +
    + adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.create_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.delete_pages_result +
    + adobe.pdfservices.operation.pdfjobs.result.document_merge_result +
    + adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.export_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result +
    + adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.insert_pages_result +
    + adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result +
    + adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result +
    + adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result +
    + adobe.pdfservices.operation.pdfjobs.result.remove_protection_result +
    + adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result +
    + adobe.pdfservices.operation.pdfjobs.result.replace_page_result +
    + adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result +
    + adobe.pdfservices.operation.pdfjobs.result.split_pdf_result +
    + adobe.pdfservices.operation.region +
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/auth.html b/docs/apidocs/4.2.0/reference/auth.html new file mode 100644 index 0000000..5edd383 --- /dev/null +++ b/docs/apidocs/4.2.0/reference/auth.html @@ -0,0 +1,1404 @@ + + + + + + + + + Authentication — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Authentication

+
+
+
+

Credentials

+
+
+class adobe.pdfservices.operation.auth.credentials.Credentials
+

Bases: ABC

+

This abstract class represents the basic contract for the credentials to be used with +ServicePrincipalCredentials.

+
+ +
+
+

ServicePrincipalCredentials

+
+
+class adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials(client_id: str, client_secret: str)
+

Bases: Credentials

+

Service Principal credentials allow your application to call PDF Services API. For getting the credentials, +Click Here.

+

Constructs an instance of ServicePrincipalCredentials.

+
+
Parameters:
+
    +
  • client_id (str) – client ID for ServicePrincipalCredentials; can not be None or empty.

  • +
  • client_secret (str) – client secret for ServicePrincipalCredentials; can not be None or empty.

  • +
+
+
+
+
+get_client_id()
+
+
Returns:
+

Client Id

+
+
Return type:
+

str

+
+
+
+ +
+
+get_client_secret()
+
+
Returns:
+

Client Secret

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/config.html b/docs/apidocs/4.2.0/reference/config.html new file mode 100644 index 0000000..8e526e5 --- /dev/null +++ b/docs/apidocs/4.2.0/reference/config.html @@ -0,0 +1,1482 @@ + + + + + + + + + Config — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Config

+ +
+

ClientConfig

+
+
+class adobe.pdfservices.operation.config.client_config.ClientConfig(*, connect_timeout: int = 4000, read_timeout: int = 10000, region: Region = Region.US, proxy_server_config: ProxyServerConfig = None)
+

Bases: object

+

Encapsulates the API request configurations.

+

Constructs an instance of ClientConfig.

+
+
Parameters:
+
    +
  • connect_timeout (int) – determines the timeout in milliseconds until a connection is established in the API +calls. Default value is 4000 milliseconds.

  • +
  • read_timeout (int) – Defines the read timeout in milliseconds, The number of milliseconds the client will wait for the server to send a response after the connection is established. Default value is 10000 milliseconds

  • +
  • region (Region) – Default value is US.

  • +
  • proxy_server_config (ProxyServerConfig) – Sets the configuration for proxy server.

  • +
+
+
+
+
+from_file(client_config_file_path: str)
+

Sets the connect timeout and read timeout using the JSON client config file path. All the keys in the JSON structure are optional.

+
+
Parameters:
+

client_config_file_path (str) – JSON client config file path

+
+
Returns:
+

This Builder instance to add any additional parameters.

+
+
Return type:
+

ClientConfig.Builder

+
+
+

JSON structure:

+
{
+    "connectTimeout": "4000",
+    "readTimeout": "20000",
+    "proxyServerConfig": {
+        "host": "127.0.0.1",
+        "port": "8080",
+        "scheme": "https",
+        "usernamePasswordCredentials": {
+            "username": "username",
+            "password": "password"
+            }
+    },
+    "region": "EU"
+}
+
+
+
+ +
+
+get_connect_timeout()
+
+
Returns:
+

Connect timeout.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_proxy_server_config()
+
+
Returns:
+

Proxy server config used.

+
+
Return type:
+

ProxyServerConfig

+
+
+
+ +
+
+get_read_timeout()
+
+
Returns:
+

Read timeout.

+
+
Return type:
+

int

+
+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/config/notifier.html b/docs/apidocs/4.2.0/reference/config/notifier.html new file mode 100644 index 0000000..d55981f --- /dev/null +++ b/docs/apidocs/4.2.0/reference/config/notifier.html @@ -0,0 +1,1414 @@ + + + + + + + + + Notifier Config — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Notifier Config

+
+
+
+

CallbackNotifierData

+
+
+class adobe.pdfservices.operation.config.notifier.callback_notifier_data.CallbackNotifierData(url: str, *, headers: Dict = None)
+

Bases: NotifierData

+

Represents the configuration for the notifier data.

+

Constructs an instance of CallbackNotifierData.

+
+
Parameters:
+
    +
  • url (str) – Callback URL, can not be None

  • +
  • headers (dict) – Callback headers. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

NotifierConfig

+
+
+class adobe.pdfservices.operation.config.notifier.notifier_config.NotifierConfig(notifier_type: NotifierType, notifier_data: NotifierData)
+

Bases: object

+

Represents the configuration for a notifier to be used to notify user about the completion of a +PDFServicesJob.

+

Constructs an instance of NotifierConfig.

+
+
Parameters:
+
    +
  • notifier_type (NotifierType) – specifies the type of notifier; can not be None.

  • +
  • notifier_data (NotifierData) – encapsulates callback notifier data; can not be None.

  • +
+
+
+
+ +
+
+

NotifierData

+
+
+class adobe.pdfservices.operation.config.notifier.notifier_data.NotifierData
+

Bases: ABC

+

This abstract class represents the basic contract for the notifier data to be used with +NotifierConfig

+
+ +
+
+

NotifierType

+
+
+class adobe.pdfservices.operation.config.notifier.notifier_type.NotifierType(value)
+

Bases: Enum

+

Notifier Type Mapping.

+
+
+CALLBACK = 'CALLBACK'
+

Callback notifier type.

+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/config/proxy.html b/docs/apidocs/4.2.0/reference/config/proxy.html new file mode 100644 index 0000000..49491e3 --- /dev/null +++ b/docs/apidocs/4.2.0/reference/config/proxy.html @@ -0,0 +1,1568 @@ + + + + + + + + + Proxy Config — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Proxy Config

+
+
+
+

ProxyAuthenticationCredentials

+
+
+class adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials.ProxyAuthenticationCredentials
+

Bases: ABC

+

This abstract class represents the basic contract for the credentials to be used with +ProxyServerConfig.

+
+ +
+
+

ProxyScheme

+
+
+class adobe.pdfservices.operation.config.proxy.proxy_scheme.ProxyScheme(value)
+

Bases: Enum

+

Supported scheme types for +ProxyServerConfig.

+
+
+HTTP = 'http'
+

Represents HTTP scheme.

+
+ +
+
+HTTPS = 'https'
+

Represents HTTPS scheme.

+
+ +
+
+classmethod get(proxy_scheme)
+

Returns the instance of ProxyScheme for the input string.

+
+
Parameters:
+

proxy_scheme (str) – String value of the scheme.

+
+
Returns:
+

the instance of ProxyScheme for the input string.

+
+
Return type:
+

ProxyScheme

+
+
+
+ +
+ +
+
+

ProxyServerConfig

+
+
+class adobe.pdfservices.operation.config.proxy.proxy_server_config.ProxyServerConfig(host: str, *, port: int = None, scheme: ProxyScheme = ProxyScheme.HTTP, credentials: ProxyAuthenticationCredentials = None)
+

Bases: object

+

Encapsulates the proxy server configurations.

+

Creates an instance of ProxyServerConfig.

+
+
Parameters:
+
    +
  • host (str) – Host name. (Optional, use key-value)

  • +
  • port (int) – port number of proxy server. It should be greater than 0. Scheme’s default port is used if not +provided. (Optional, use key-value)

  • +
  • scheme (ProxyScheme) – scheme of proxy server. Possible values are HTTP and HTTPS. Default value is HTTP. (Optional, +use key-value)

  • +
  • credentials (ProxyAuthenticationCredentials) – ProxyAuthenticationCredentials} instance. (Optional, use key-value)

  • +
+
+
+
+
+HTTPS_PORT = 443
+

Represents default port for HTTPS scheme.

+
+ +
+
+HTTP_PORT = 80
+

Represents default port for HTTP scheme.

+
+ +
+
+from_json(json_data: dict)
+

Creates a proxy server instance from a json file.

+
{
+"proxyServerConfig": {
+        "host": "127.0.0.1",
+        "port": "8080",
+        "scheme": "https",
+        "usernamePasswordCredentials": {
+            "username": "username",
+            "password": "password"
+        }
+    },
+}
+
+
+
+
Parameters:
+

json_data (dict) – A dictionary containing proxy server config in the specified format.

+
+
+
+ +
+
+get_credentials()
+
+
Returns:
+

the credentials for authenticating with a proxy server.

+
+
Return type:
+

ProxyAuthenticationCredentials

+
+
+
+ +
+
+get_host()
+
+
Returns:
+

the host name of proxy server.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_port()
+
+
Returns:
+

the port number of proxy server.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_proxy_scheme()
+
+
Returns:
+

the scheme of proxy server.

+
+
Return type:
+

ProxyScheme

+
+
+
+ +
+ +
+
+

UsernamePasswordCredentials

+
+
+class adobe.pdfservices.operation.config.proxy.username_password_credentials.UsernamePasswordCredentials(username: str, password: str)
+

Bases: ProxyAuthenticationCredentials

+

Simple +ProxyAuthenticationCredentials +implementation based on a username and password.

+

Constructs an instance of UsernamePasswordCredentials.

+
+
Parameters:
+
    +
  • username (str) – Username. Cannot be none or empty.

  • +
  • password (str) – Password. Cannot be none or empty.

  • +
+
+
+
+
+from_json(json_data: dict)
+

Constructs a UsernamePasswordCredentials instance from a dictionary in the specified format.

+
+
Parameters:
+

json_data (dict) – JSON data in the form of a dictionary.

+
+
+
+ +
+
+get_password() str
+
+
Returns:
+

the password.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_username() str
+
+
Returns:
+

the username.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/exception.html b/docs/apidocs/4.2.0/reference/exception.html new file mode 100644 index 0000000..fc9d78e --- /dev/null +++ b/docs/apidocs/4.2.0/reference/exception.html @@ -0,0 +1,1381 @@ + + + + + + + + + Exceptions — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Exceptions

+
+
+
+

ServiceUsageException

+

ServiceUsageError is thrown when either service usage limit has been reached or credentials quota has been +exhausted.

+
+
+adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.with_traceback()
+

Exception.with_traceback(tb) – +set self.__traceback__ to tb and return self.

+
+ +
+
+

ServiceApiException

+

ServiceApiException is thrown when an underlying service API call results in an error.

+
+
+adobe.pdfservices.operation.exception.exceptions.ServiceApiException.with_traceback()
+

Exception.with_traceback(tb) – +set self.__traceback__ to tb and return self.

+
+ +
+
+

SdkException

+

SdkException is typically thrown for client-side or network errors.

+
+
+adobe.pdfservices.operation.exception.exceptions.SdkException.with_traceback()
+

Exception.with_traceback(tb) – +set self.__traceback__ to tb and return self.

+
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/index.html b/docs/apidocs/4.2.0/reference/index.html new file mode 100644 index 0000000..f779802 --- /dev/null +++ b/docs/apidocs/4.2.0/reference/index.html @@ -0,0 +1,2133 @@ + + + + + + + + + API Reference — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +
+

API Reference

+
+

Contents:

+ +
+
+

PDFServices

+
+
+class adobe.pdfservices.operation.pdf_services.PDFServices(credentials: Credentials, *, client_config: ClientConfig | None = None)
+

Bases: object

+

This class is the entry point for all the PDF Service utilities. +These utilities can be used to perform various functions such as submitting +PDFServicesJob, +getting status of a PDFServicesJob, +getting result of a PDFServicesJob, +uploading Asset, +getting content of an Asset, +deleting an Asset and refreshing an +Asset.

+

Constructs a new PDFServices instance with the given Credentials and ClientConfig.

+
+
Parameters:
+
    +
  • credentials (Credentials) – Credentials to be used for authentication; can not be None.

  • +
  • client_config (ClientConfig) – Client configuration for PDFServices. (Optional, use key-value)

  • +
+
+
+
+
+delete_asset(asset: Asset)
+

Deletes asset from PDF Services storage.

+
+
Parameters:
+

asset (Asset) – Asset to be deleted; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
+
+ +
+
+get_content(asset: Asset) StreamAsset
+
+
Parameters:
+

asset (Asset) – Asset to the content; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
Returns:
+

Returns the content of the asset.

+
+
Return type:
+

StreamAsset

+
+
+
+ +
+
+get_job_result(polling_url: str, result_type: ABCMeta) PDFServicesResponse
+

Returns PDFServicesResponse for the submitted +PDFServicesJob result.

+
+
Parameters:
+
    +
  • polling_url (str) – URL to be polled to get the job result; can not be None.

  • +
  • result_type (PDFServicesJobResult.__class__) – result class for +PDFServicesJob, it will be an +implementation of PDFServicesJobResult; can not be None.

  • +
+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
Returns:
+

PDFServicesResponse for the submitted job.

+
+
Return type:
+

PDFServicesResponse

+
+
+
+ +
+
+get_job_status(polling_url: str) PDFServicesJobStatusResponse
+
+
Parameters:
+

polling_url (str) – URL to be polled to get the job status; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
  • ServiceUsageException – If service usage limits have been reached or credentials quota has been +exhausted.

  • +
+
+
Returns:
+

Returns PDFServicesJobStatusResponse for the submitted +PDFServicesJob.

+
+
Return type:
+

PDFServicesJobStatusResponse

+
+
+
+ +
+
+refresh_download_uri(asset: Asset) Asset
+
+
Parameters:
+

asset (Asset) – asset to be refreshed; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
Returns:
+

a new Asset with a new valid download URI.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+submit(pdf_services_job: PDFServicesJob, *, notify_config_list: List | None = None) str
+

Creates the PDFServicesJob +and returns the polling URL.

+
+
Parameters:
+
    +
  • pdf_services_job (PDFServicesJob) – PDFServicesJob} to be submitted; can not be None.

  • +
  • notify_config_list (list) – List of +NotifierConfig +to be used for notification. (Optional, use key-value)

  • +
+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
  • ServiceUsageException – If service usage limits have been reached or credentials quota has been +exhausted.

  • +
+
+
Returns:
+

the polling URL.

+
+
Return type:
+

str

+
+
+
+ +
+
+upload(input_stream: Any, mime_type: str) Asset
+

Upload content from input stream and returns an Asset +to be used in PDF Services SDK.

+

Method will not close the input stream, responsibility of closing the input stream lies with the client.

+
+
Parameters:
+
    +
  • input_stream – input stream that is to be uploaded; can not be None.

  • +
  • mime_type (str) – mime type of the input stream; can not be None.

  • +
+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
  • ServiceUsageException – If service usage limits have been reached or credentials quota has been +exhausted.

  • +
+
+
Returns:
+

asset containing the uploaded content

+
+
Return type:
+

Asset

+
+
+
+ +
+
+upload_assets(upload_asset_list: List) []
+

Upload content from list of StreamAsset and +returns a list of Asset to be used in PDF Services +SDK.

+

Method will not close the input stream of the Stream Asset, responsibility of closing the input stream lies +with the client.

+
+
Parameters:
+

upload_asset_list (list) – StreamAsset +list that is to be uploaded; can not be None.

+
+
Raises:
+
    +
  • ServiceApiException – If an error is encountered while submitting the job.

  • +
  • SdkException – Is thrown for client-side or network errors.

  • +
+
+
Returns:
+

returns a list of Asset to be used in PDF Services +SDK.

+
+
Return type:
+

list

+
+
+
+ +
+ +
+
+

PDFServicesJob

+
+
+class adobe.pdfservices.operation.pdf_services_job.PDFServicesJob
+

Bases: ABC

+

This abstract class represents the basic contract for all the PDF Services Jobs. +It imposes no restrictions or particular details on the job execution process and leaves the +specifics of setting up the jobs to their individual implementations.

+
+ +
+
+

PDFServicesJobStatus

+
+
+class adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus(value)
+

Bases: Enum

+

Status types for PDFServicesJob.

+

Constructs PDF Services job status using its string representation.

+
+
Parameters:
+

value (str) – string representation of PDF services job status.

+
+
+
+
+DONE = 'done'
+

Represents completed status

+
+ +
+
+FAILED = 'failed'
+

Represents failed status

+
+ +
+
+IN_PROGRESS = 'in progress'
+

Represents in progress status

+
+ +
+
+get_value()
+
+
Returns:
+

string representation of PDFServicesJobStatus.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

PDFServicesJobStatusResponse

+
+
+class adobe.pdfservices.operation.pdf_services_job_status_response.PDFServicesJobStatusResponse(status: str, headers: {})
+

Bases: object

+

Response object encapsulating PDFServicesJob +status and retry interval.

+

Constructs PDFServicesJob status response +with its status, headers.

+
+
Parameters:
+
    +
  • status (str) – Status of the +PDFServicesJob.

  • +
  • headers (dict) – Headers of the +PDFServicesResponse.

  • +
+
+
+
+
+get_retry_interval() int
+
+
Returns:
+

retry interval for status polling of the +PDFServicesJob in seconds.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_status()
+
+
Returns:
+

string representation of +PDFServicesJobStatus +for the PDFServicesJob.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

PDFServicesMediaType

+
+
+class adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType(value)
+

Bases: str, Enum

+

An enumeration.

+
+
+AI = 'application/illustrator'
+

Represents ai mime type.

+
+ +
+
+BMP = 'image/bmp'
+

Represents bmp mime type.

+
+ +
+
+CSV = 'text/csv'
+

Represents csv mime type.

+
+ +
+
+DOC = 'application/msword'
+

Represents msword mime type.

+
+ +
+
+DOCX = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+

Represents docx mime type.

+
+ +
+
+GIF = 'image/gif'
+

Represents gif mime type.

+
+ +
+
+HTML = 'text/html'
+

Represents html mime type.

+
+ +
+
+INDD = 'application/x-indesign'
+

Represents indd mime type.

+
+ +
+
+JPEG = 'image/jpeg'
+

Represents jpeg mime type.

+
+ +
+
+JPG = 'image/jpeg'
+

Represents jpg mime type.

+
+ +
+
+JSON = 'application/json'
+

Represents json mime type.

+
+ +
+
+PDF = 'application/pdf'
+

Represents pdf mime type.

+
+ +
+
+PNG = 'image/png'
+

Represents png mime type.

+
+ +
+
+PPT = 'application/vnd.ms-powerpoint'
+

Represents ppt mime type.

+
+ +
+
+PPTX = 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+

Represents pptx mime type.

+
+ +
+
+PSD = 'image/vnd.adobe.photoshop'
+

Represents psd mime type.

+
+ +
+
+RTF = 'text/rtf'
+

Represents rtf mime type.

+
+ +
+
+SVG = 'image/svg+xml'
+

Represents svg mime type.

+
+ +
+
+TIF = 'image/tiff'
+

Represents tif mime type.

+
+ +
+
+TIFF = 'image/tiff'
+

Represents tiff mime type.

+
+ +
+
+TXT = 'text/plain'
+

Represents txt mime type.

+
+ +
+
+XLS = 'application/vnd.ms-excel'
+

Represents xls mime type.

+
+ +
+
+XLSX = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+

Represents xlsx mime type.

+
+ +
+
+ZIP = 'application/zip'
+

Represents zip mime type.

+
+ +
+
+property extension
+
+
Returns:
+

Extension of PDFServicesMediaType.

+
+
+
+ +
+
+static get_from_extension(extension: str)
+
+
Returns:
+

PDFServicesMediaType for the given extension.

+
+
+
+ +
+
+property mime_type
+
+
Returns:
+

Media type of PDFServicesMediaType.

+
+
+
+ +
+ +
+
+

PDFServicesResponse

+
+
+class adobe.pdfservices.operation.pdf_services_response.PDFServicesResponse(status: str, headers: {<class 'str'>: <class 'str'>}, result)
+

Bases: PDFServicesJobStatusResponse

+

Response object for PDFServicesJob.

+

Constructs PDFServicesJob response with +its status, headers and result.

+
+
Parameters:
+
+
+
+
+
+get_result()
+
+
Returns:
+

Returns instance of result of +PDFServicesJob.

+
+
+
+ +
+ +
+
+

Region

+
+
+class adobe.pdfservices.operation.region.Region(value)
+

Bases: str, Enum

+

Supported regions to be used with ClientConfig.

+
+
+EU = 'eu'
+

Represents +“Europe” +region

+
+ +
+
+US = 'us'
+

Represents +“US” +region

+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/io.html b/docs/apidocs/4.2.0/reference/io.html new file mode 100644 index 0000000..f21673f --- /dev/null +++ b/docs/apidocs/4.2.0/reference/io.html @@ -0,0 +1,1536 @@ + + + + + + + + + IO — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

IO

+
+
+
+

Asset

+
+
+class adobe.pdfservices.operation.io.asset.Asset
+

Bases: ABC

+

Represents the basic contract for the assets to be used with +PDFServicesJob

+
+ +
+
+

CloudAsset

+
+
+class adobe.pdfservices.operation.io.cloud_asset.CloudAsset(asset_id, download_uri=None)
+

Bases: Asset

+

This class represents an asset stored in Adobe internal storage.

+

Constructs an instance of CloudAsset.

+
+
Parameters:
+
    +
  • asset_id (str) – assetId of the asset.

  • +
  • download_uri (str) – downloadURI of the asset.

  • +
+
+
+
+
+get_asset_id()
+
+
Returns:
+

the assetId of the asset.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_download_uri()
+
+
Returns:
+

the downloadURI of the asset.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

ExternalAsset

+
+
+class adobe.pdfservices.operation.io.external_asset.ExternalAsset(uri: str, *, external_storage_type: ExternalStorageType = None)
+

Bases: Asset

+

This class represents an asset stored in an external storage.

+

Constructs an instance of ExternalAsset.

+
+
Parameters:
+
    +
  • uri (str) – URI of the external asset, can not be None.

  • +
  • external_storage_type (ExternalStorageType) – external storage type. (Optional, use key-value)

  • +
+
+
+
+
+get_external_storage_type()
+
+
Returns:
+

the externalStorageType of the external asset.

+
+
Return type:
+

ExternalStorageType

+
+
+
+ +
+
+get_uri()
+
+
Returns:
+

the URI of the external asset.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

ExternalStorageType

+
+
+class adobe.pdfservices.operation.io.external_storage_type.ExternalStorageType(value)
+

Bases: Enum

+

Represents external storage types.

+
+
+BLOB = 'BLOB'
+

Represents Blob storage.

+
+ +
+
+DROPBOX = 'DROPBOX'
+

Represents Dropbox storage.

+
+ +
+
+S3 = 'S3'
+

Represents S3 storage.

+
+ +
+
+SHAREPOINT = 'SHAREPOINT'
+

Represents Sharepoint storage.

+
+ +
+
+classmethod get(storage_type: str)
+

Returns ExternalStorageType instance for its string representation.

+
+
Parameters:
+

storage_type (str) – Storage type code

+
+
+
+ +
+ +
+
+

StreamAsset

+
+
+class adobe.pdfservices.operation.io.stream_asset.StreamAsset(input_stream, mime_type)
+

Bases: object

+

This class encapsulates input stream and the media type of +Asset.

+

Constructs an instance of StreamAsset.

+
+
Parameters:
+
    +
  • input_stream – input stream of the asset; can not be None.

  • +
  • mime_type (str) – mime type of the input stream; can not be None.

  • +
+
+
+
+
+get_input_stream()
+
+
Returns:
+

the input stream of the asset.

+
+
+
+ +
+
+get_mime_type()
+
+
Returns:
+

the mime type of the asset.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/pdfjobs.html b/docs/apidocs/4.2.0/reference/pdfjobs.html new file mode 100644 index 0000000..47e485c --- /dev/null +++ b/docs/apidocs/4.2.0/reference/pdfjobs.html @@ -0,0 +1,1811 @@ + + + + + + + + + PDF Jobs — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

PDF Jobs

+
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/pdfjobs/jobs.html b/docs/apidocs/4.2.0/reference/pdfjobs/jobs.html new file mode 100644 index 0000000..93d1adf --- /dev/null +++ b/docs/apidocs/4.2.0/reference/pdfjobs/jobs.html @@ -0,0 +1,2650 @@ + + + + + + + + + Jobs — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Jobs

+
+
+
+

AutotagPDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job.AutotagPDFJob(input_asset: Asset, *, autotag_pdf_params: AutotagPDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that creates PDF documents with enhanced readability from existing PDF documents. +An optional tagging report can also be generated which contains the information about the tags that the tagged +output PDF document contains.

+

Accessibility tags, used by assistive technology such as screen reader are required to make PDF files compliant. +However, the generated PDF is not guaranteed to comply with accessibility standards such as WCAG and PDF/UA as +there could be a need to perform further downstream remediation to meet those standards.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+autotag_pdf_job = AutotagPDFJob(input_asset)
+location = pdf_services.submit(autotag_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, AutotagPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_tagged_pdf()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new instance of AutotagPDFJob.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • autotag_pdf_params (AutotagPDFParams) – AutotagPDFParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of AutotagPDFJob

+
+
Return type:
+

AutotagPDFJob

+
+
+
+ +
+
+

CombinePDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job.CombinePDFJob(combine_pdf_params: CombinePDFParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that combines multiple PDF files into a single PDF file. Allows specifying which pages of the source +files to combine.

+

Sample usage.

+
file = open('SOURCE_PATH_1', 'rb')
+input_stream_1 = file.read()
+file.close()
+file = open('SOURCE_PATH_2', 'rb')
+input_stream_2 = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+stream_assets = [StreamAsset(input_stream_1, MediaType.PDF),
+                 StreamAsset(input_stream_2, MediaType.PDF)]
+assets = pdf_services.upload_assets(stream_assets)
+combine_pdf_params = ((CombinePDFParams()
+                      .add_asset(assets[0]))
+                      .add_asset(assets[1]))
+combine_pdf_job = CombinePDFJob(combine_pdf_params=combine_pdf_params)
+location = pdf_services.submit(combine_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, CombinePDFResult)
+result_asset: CombinePDFResult = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new CombinePDFJob instance.

+
+
Parameters:
+
    +
  • combine_pdf_params (CombinePDFParams) – CombinePDFParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of CombinePDFJob

+
+
Return type:
+

CombinePDFJob

+
+
+
+ +
+
+

CompressPDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job.CompressPDFJob(input_asset: Asset, *, compress_pdf_params: CompressPDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that reduces the size of a PDF file. Allows specifying +CompressionLevel +for compressing pdf

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+compress_pdf_job = CompressPDFJob(input_asset=input_asset)
+location = pdf_services.submit(compress_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, CompressPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new CompressPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • compress_pdf_params (CompressPDFParams) – CompressPDFParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of CompressPDFJob

+
+
Return type:
+

CompressPDFJob

+
+
+
+ +
+
+

CreatePDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job.CreatePDFJob(input_asset: Asset, *, create_pdf_params: CreatePDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that converts a non-PDF file to a PDF file. Some source formats may have associated conversion parameters.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.DOCX)
+create_pdf_job = CreatePDFJob(input_asset)
+location = pdf_services.submit(create_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, CreatePDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new instance of CreatePDFJob.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • create_pdf_params (CreatePDFParams) – CreatePDFParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of CreatePDFJob.

+
+
Return type:
+

CreatePDFJob

+
+
+
+ +
+
+

DeletePagesJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job.DeletePagesJob(input_asset: Asset, delete_pages_params: DeletePagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job to delete pages in a PDF file.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+page_ranges_for_deletion = PageRanges()
+page_ranges.add_single_page(1)
+delete_pages_params = DeletePagesParams(page_ranges=page_ranges_for_deletion)
+delete_pages_job = DeletePagesJob(input_asset=input_asset,
+                                  delete_pages_params=delete_pages_params)
+location = pdf_services.submit(delete_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, CompressPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new DeletePagesJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • delete_pages_params (DeletePagesParams) – DeletePagesParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of DeletePagesJob

+
+
Return type:
+

DeletePagesJob

+
+
+
+ +
+
+

DocumentMergeJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job.DocumentMergeJob(input_asset: Asset, document_merge_params: DocumentMergeParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that enables the clients to produce high fidelity PDF and Word documents with dynamic data inputs. +This operation merges the JSON data with the Word template to create dynamic documents for contracts and +agreements, invoices, proposals, reports, forms, branded marketing documents and more.

+

To know more about document generation and document templates, +Click Here.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.DOCX)
+json_data_for_merge = {"customerName": "Kane Miller", "customerVisits": 100}
+document_merge_params = DocumentMergeParams(json_data_for_merge=json_data_for_merge,
+                                            output_format=OutputFormat.DOCX)
+document_merge_job = DocumentMergeJob(input_asset=input_asset,
+                                      document_merge_params=document_merge_params)
+location = pdf_services.submit(document_merge_job)
+pdf_services_response = pdf_services.get_job_result(location, DocumentMergePDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new DocumentMergeJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • document_merge_params (DocumentMergeParams) – DocumentMergeParams to set. can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of DocumentMergeJob

+
+
Return type:
+

DocumentMergeJob

+
+
+
+ +
+
+

PDFElectronicSealJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.eseal_job.PDFElectronicSealJob(input_asset: Asset, electronic_seal_params: PDFElectronicSealParams, *, seal_image_asset: Asset | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows clients to apply an electronic seal onto various PDF documents such as agreements, invoices, and more.

+

To know more about PDF Electronic Seal, Click Here.

+

Sample usage.

+
pdf_file = open('SOURCE_PATH', 'rb')
+file_input_stream = pdf_file.read()
+pdf_file.close()
+
+seal_image_file = open('IMAGE_SOURCE_PATH', 'rb')
+seal_image_input_stream = seal_image_file.read()
+seal_image_file.close()
+
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+asset = pdf_services.upload(input_stream=file_input_stream, mime_type=PDFServicesMediaType.PDF)
+seal_image_asset = pdf_services.upload(input_stream=seal_image_input_stream, mime_type=PDFServicesMediaType.PNG)
+document_level_permission = DocumentLevelPermission.FORM_FILLING
+seal_field_name = "Signature1"
+seal_page_number = 1
+seal_visible = True
+field_location = FieldLocation(150, 250, 350, 200)
+field_options = FieldOptions(
+    field_name=seal_field_name,
+    field_location=field_location,
+    page_number=seal_page_number,
+    visible=seal_visible
+)
+provider_name = "<PROVIDER_NAME>"
+access_token = "<ACCESS_TOKEN>"
+credential_id = "<CREDENTIAL_ID>"
+pin = "<PIN>"
+csc_auth_context = CSCAuthContext(
+    access_token=access_token,
+    token_type="Bearer",
+)
+certificate_credentials = CSCCredentials(
+    provider_name=provider_name,
+    credential_id=credential_id,
+    pin=pin,
+    csc_auth_context=csc_auth_context,
+)
+electronic_seal_params = PDFElectronicSealParams(
+    seal_certificate_credentials=certificate_credentials,
+    seal_field_options=field_options,
+)
+electronic_seal_job = PDFElectronicSealJob(input_asset=asset,
+                                           electronic_seal_params=electronic_seal_params,
+                                           seal_image_asset=seal_image_asset)
+location = pdf_services.submit(electronic_seal_job)
+pdf_services_response = pdf_services.get_job_result(location, ESealPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new PDFElectronicSealJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • electronic_seal_params (PDFElectronicSealParams) – Parameters for electronic seal; can not be None.

  • +
  • seal_image_asset (Asset) – Seal image asset for the job. (Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of PDFElectronicSealJob.

+
+
Return type:
+

PDFElectronicSealJob

+
+
+
+ +
+
+

ExportPDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job.ExportPDFJob(input_asset: Asset, export_pdf_params: ExportPDFParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job which exports a source PDF file to a supported format specified by +ExportPDFTargetFormat

+

For example, a PDF can be exported to a DOCX file as follows:

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+export_pdf_params = ExportPDFParams(target_format=ExportPDFTargetFormat.DOCX)
+export_pdf_job = ExportPDFJob(input_asset=input_asset, export_pdf_params=export_pdf_params)
+location = pdf_services.submit(export_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, ExportPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ExportPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • export_pdf_params (ExportPDFParams) – ExportPDFParams object containing the export parameters; can not be None.

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of ExportPDFJob.

+
+
Return type:
+

ExportPDFJob

+
+
+
+

Note

+

External assets can be set as output only when input is external asset as well

+
+
+ +
+
+

ExportPDFtoImagesJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job.ExportPDFtoImagesJob(input_asset: Asset, export_pdf_to_images_params: ExportPDFtoImagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job which exports a source PDF file to a supported format specified by ExportPDFToImagesTargetFormat

+

The result is a list of images or a list containing a zip of images. For example, a PDF file with 15 +pages will generate 15 image files. The first file’s name ends with “_0” and the last file’s name ends with “_14”.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+export_pdf_to_images_params = ExportPDFtoImagesParams(
+    export_pdf_to_images_target_format=ExportPDFToImagesTargetFormat.JPEG,
+    export_pdf_to_images_output_type=ExportPDFToImagesOutputType.LIST_OF_PAGE_IMAGES
+)
+export_pdf_to_images_job = ExportPDFtoImagesJob(
+    input_asset=input_asset,
+    export_pdf_to_images_params=export_pdf_to_images_params
+)
+location = pdf_services.submit(export_pdf_to_images_job)
+pdf_services_response = pdf_services.get_job_result(location, ExportPDFtoImagesResult)
+result_assets = pdf_services_response.get_result().get_assets()
+
+
+

Constructs a new ExportPDFToImagesJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • export_pdf_to_images_params (ExportPDFtoImagesParams) – ExportPDFToImagesParams object containing the export to images parameters; can not be None.

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

ExtractPDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job.ExtractPDFJob(input_asset: Asset, *, extract_pdf_params: ExtractPDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that extracts pdf elements such as text, images, tables in a structured format from a PDF.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+extract_pdf_params = ExtractPDFParams(
+    elements_to_extract=[ExtractElementType.TEXT],
+)
+extract_pdf_job = ExtractPDFJob(input_asset=input_asset, extract_pdf_params=extract_pdf_params)
+
+# Submit the job and gets the job result
+location = pdf_services.submit(extract_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, ExtractPDFResult)
+
+# Get content from the resulting asset(s)
+result_asset: CloudAsset = pdf_services_response.get_result().get_resource()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ExtractPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • extract_pdf_params (ExtractPDFParams) – ExtractPDFParams object containing the extract PDF parameters, (Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

HTMLtoPDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job.HTMLtoPDFJob(*, input_asset: Asset | None = None, input_url: str | None = None, html_to_pdf_params: HTMLtoPDFParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that converts a HTML file to a PDF file.

+

An HTML input can be provided either as a local zip archive or as a static HTML file with inline CSS. +Alternatively, an HTML can also be specified via URL.

+
+
While creating the corresponding Asset instance, the media type must be:
    +
  • “application/zip”, if the input is a local zip archive.

  • +
  • “text/html”, if the input is a static HTML file with inline CSS

  • +
+
+
In case the input is a local zip archive, it must have the following structure:
    +
  • The main HTML file must be named “index.html”.

  • +
  • “index.html” must exist at the top level of zip archive, not in a folder.

  • +
+
+
+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.ZIP)
+page_layout = PageLayout(page_height=11.5, page_width=8)
+html_to_pdf_params =  HTMLtoPDFParams(page_layout=page_layout, include_header_footer=True)
+html_to_pdf_job = HTMLtoPDFJob(input_asset=input_asset, html_to_pdf_params=html_to_pdf_params)
+location = pdf_services.submit(html_to_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, HTMLtoPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new HTMLtoPDFJob.

+

At least one of input_asset or input_url needs to be specified.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file. (Optional, use key-value)

  • +
  • input_url (str) – String representing the input URL. (Optional, use key-value)

  • +
  • html_to_pdf_params (HTMLtoPDFParams) – HTMLToPDFParams}. (Optional, use key-value)

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

InsertPagesJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job.InsertPagesJob(insert_pages_params: InsertPagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that can be used to insert pages of multiple PDF files into a base PDF file.

+

For more complex use cases, refer the +CombinePDFJob.

+

Sample Usage:

+
base_file = open('SOURCE_PATH', 'rb')
+base_input_stream = base_file.read()
+base_file.close()
+file_to_insert = open('SOURCE_PATH_1', 'rb')
+input_stream_to_insert = file_to_insert.read()
+file_to_insert.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+base_asset = pdf_services.upload(input_stream=base_input_stream,
+                                 mime_type=MediaType.PDF)
+asset_to_insert = pdf_services.upload(input_stream=input_stream_to_insert,
+                              mime_type=MediaType.PDF)
+page_ranges = PageRanges().add_range(1, 3)
+insert_pages_params = InsertPagesParams(base_asset=base_asset)
+insert_pages_params.add_pages_to_insert(input_asset=asset_to_insert, page_ranges=page_ranges, base_page=2)
+insert_pages_job = InsertPagesJob(insert_pages_params=insert_pages_params)
+location = pdf_services.submit(insert_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, InsertPagesResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new InsertPagesPDFJob instance.

+
+
Parameters:
+
    +
  • insert_pages_params (InsertPagesParams) – Object containing the input files and the page numbers to insert at; +can not be None.

  • +
  • output_asset (Asset) – Object representing the output asset. (Optional, use key-value) +External assets can be set as output only when input is external asset as well

  • +
+
+
+
+ +
+
+

LinearizePDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job.LinearizePDFJob(input_asset: Asset, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that converts a PDF file into a linearized (also known as “web optimized”) PDF file. Such PDF files are +optimized for incremental access in network environments.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+linearize_pdf_job = LinearizePDFJob(input_asset=input_asset)
+location = pdf_services.submit(linearize_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, LinearizePDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new LinearizePDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

OCRPDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job.OCRPDFJob(input_asset: Asset, *, ocr_pdf_params: OCRParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that convert a PDF file into a searchable PDF file. Allows specifying OCRSupportedLocale and OCR Type.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+ocr_pdf_job = OCRPDFJob(input_asset=input_asset)
+location = pdf_services.submit(ocr_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, OCRPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new OCRPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • ocr_pdf_params (OCRParams) – OCRParams} object containing the OCR parameters. (Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

PDFPropertiesJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job.PDFPropertiesJob(input_asset: Asset, *, pdf_properties_params: PDFPropertiesParams | None = None)
+

Bases: PDFServicesJob

+

A job that is used to fetch properties from an input PDF file. The properties are returned in a dict.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream,
+                                  mime_type=MediaType.PDF)
+pdf_properties_params = PDFPropertiesParams(include_page_level_properties=True)
+pdf_properties_job = PDFPropertiesJob(input_asset=input_asset, pdf_properties_params=pdf_properties_params)
+location = pdf_services.submit(pdf_properties_job)
+pdf_services_response = pdf_services.get_job_result(location, PDFPropertiesResult)
+pdf_properties_result = pdf_services_response.get_result()
+
+
+

Constructs a new PDFPropertiesJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • pdf_properties_params (PDFPropertiesParams) – PDFPropertiesParams object containing the properties to be fetched. +(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

ProtectPDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job.ProtectPDFJob(input_asset: Asset, protect_pdf_params: PasswordProtectParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that is used for securing PDF document with password(s). +The password(s) is used for encrypting the PDF document and setting the restriction on certain features +like printing, editing and copying in the PDF document.

+

The supported algorithm for encrypting the PDF document are listed here. The EncryptionAlgorithm enum can +be used to set the encryption algorithm.

+
+
    +
  • AES-128

  • +
  • AES-256

  • +
+
+

For AES-128 encryption the password supports LATIN-I characters only. +For AES-256 encryption the password supports Unicode character set.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+protect_pdf_params = PasswordProtectParams(
+    user_password='password',
+    encryption_algorithm=EncryptionAlgorithm.AES_256,
+    content_encryption=ContentEncryption.ALL_CONTENT,
+)
+protect_pdf_job = ProtectPDFJob(input_asset=input_asset, protect_pdf_params=protect_pdf_params)
+location = pdf_services.submit(protect_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, ProtectPDFResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ProtectPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • protect_pdf_params (PasswordProtectParams) – ProtectPDFParams object containing the protect PDF parameters; can not be None.

  • +
  • output_asset (ExternalAsset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

RemoveProtectionJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job.RemoveProtectionJob(input_asset: Asset, remove_protection_params: RemoveProtectionParams, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows to remove password security from a PDF document.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+remove_protection_params = RemoveProtectionParams(password="password")
+remove_protection_job = RemoveProtectionJob(input_asset=input_asset,
+                                            remove_protection_params=remove_protection_params)
+location = pdf_services.submit(remove_protection_job)
+pdf_services_response = pdf_services.get_job_result(location, RemoveProtectionResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new RemoveProtectionJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job. (Mandatory, use key-value)

  • +
  • remove_protection_params (RemoveProtectionParams) – RemoveProtectionParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of RemoveProtectionJob.

+
+
Return type:
+

RemoveProtectionJob

+
+
+
+ +
+
+

ReorderPagesJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job.ReorderPagesJob(reorder_pages_params: ReorderPagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows to rearrange pages in a PDF file according to the specified order.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+pages_to_reorder = PageRanges().add_range(3, 4)
+                    .add_single_page(1)
+reorder_pages_params = ReorderPagesParams(asset=input_asset, page_ranges=pages_to_reorder)
+reorder_pages_job = ReorderPagesJob(reorder_pages_params=reorder_pages_params)
+location = pdf_services.submit(reorder_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, ReorderPagesResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ReorderPagesJob instance.

+
+
Parameters:
+
    +
  • reorder_pages_params (ReorderPagesParams) – ReorderPagesParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of ReorderPagesJob.

+
+
Return type:
+

ReorderPagesJob

+
+
+
+ +
+
+

ReplacePagesJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job.ReplacePagesJob(replace_pages_params: ReplacePagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows specific pages in a PDF file to be replaced with pages from multiple PDF files.

+

Sample usage.

+
base_file = open('SOURCE_PATH', 'rb')
+base_input_stream = base_file.read()
+base_file.close()
+file_1 = open('SOURCE_PATH', 'rb')
+input_stream_1 = file_1.read()
+file_1.close()
+file_2 = open('SOURCE_PATH', 'rb')
+input_stream_2 = file_2.read()
+file_2.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+base_asset = pdf_services.upload(input_stream=base_input_stream,
+                                  mime_type=MediaType.PDF)
+asset_1 = pdf_services.upload(input_stream=input_stream_1,
+                             mime_type=MediaType.PDF)
+asset_2 = pdf_services.upload(input_stream=input_stream_2,
+                              mime_type=MediaType.PDF)
+page_ranges = PageRanges().add_range(3, 4)
+                    .add_single_page(1)
+replace_pages_params = ReplacePagesParams(base_asset=base_asset)
+replace_pages_params.add_pages_to_replace(input_asset=asset_1, page_ranges=page_ranges, base_page=1)
+replace_pages_params.add_pages_to_replace(input_asset=asset_2, base_page=3)
+replace_pages_job = ReplacePagesJob(replace_pages_params=replace_pages_params)
+location = pdf_services.submit(replace_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, ReplacePagesResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new ReplacePagesJob instance.

+
+
Parameters:
+
    +
  • replace_pages_params (ReplacePagesParams) – ReplacePagesParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of ReplacePagesJob.

+
+
Return type:
+

ReplacePagesJob

+
+
+
+ +
+
+

RotatePagesJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job.RotatePagesJob(input_asset: Asset, rotate_pages_params: RotatePagesParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that allows rotation of specific pages in a PDF file.

+

Sample Usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+rotate_pages_params = RotatePagesParams()
+rotate_pages_params.add_angle_to_rotate(angle=Angle.ANGLE_90)
+reorder_pages_job = RotatePagesJob(input_asset=input_asset, rotate_pages_params=rotate_pages_params)
+location = pdf_services.submit(reorder_pages_job)
+pdf_services_response = pdf_services.get_job_result(location, RotatePagesResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+
+

Constructs a new RotatePagesJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • rotate_pages_params (RotatePagesParams) – RotatePagesParams} object containing the rotation angle and page ranges; +can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
+
+ +
+
+

SplitPDFJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job.SplitPDFJob(input_asset: Asset, split_pdf_params: SplitPDFParams, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that splits PDF document into multiple smaller documents by simply specifying either the number of files, +pages per file, or page ranges.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+base_input_stream = base_file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+split_pdf_params = SplitPDFParams(page_count=2)
+split_pdf_job = SplitPDFJob(input_asset, split_pdf_params)
+location = pdf_services.submit(split_pdf_job)
+pdf_services_response = pdf_services.get_job_result(location, SplitPDFResult)
+result_assets = pdf_services_response.get_result().get_assets()
+
+
+

Constructs a new SplitPDFJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • split_pdf_params (SplitPDFParams) – SplitPDFParams to set; can not be None.

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of SplitPDFJob.

+
+
Return type:
+

SplitPDFJob

+
+
+
+ +
+
+

PDFWatermarkJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.pdf_watermark_job.PDFWatermarkJob(input_asset: Asset, watermark_asset: Asset, *, pdf_watermark_params: PDFWatermarkParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

PDF Watermark API will add a watermark on specified pages of PDF document using a source watermark PDF. +The first page of source watermark PDF will be added as a watermark in input PDF document.

+

Sample usage.

+
pdf_file = open('SOURCE_PATH', 'rb')
+input_stream = pdf_file.read()
+pdf_file.close()
+
+pdf_file = open('SOURCE_PATH', 'rb')
+watermark_asset = pdf_file.read()
+watermark_asset.close()
+
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=PDFServicesMediaType.PDF)
+watermark_asset = pdf_services.upload(input_stream=watermark_asset, mime_type=PDFServicesMediaType.PDF)
+
+watermark_appearance = WatermarkAppearance(appear_on_foreground=True, opacity=100)
+
+page_ranges = PageRanges()
+page_ranges.add_range(1, 4)
+# Create parameters for the job
+pdf_watermark_params = PDFWatermarkParams(page_ranges=page_ranges, watermark_appearance=watermark_appearance)
+
+# Creates a new job instance
+pdf_watermark_job = PDFWatermarkJob(input_asset=input_asset, watermark_asset=watermark_asset,
+                             pdf_watermark_params=pdf_watermark_params)
+location = pdf_services.submit(pdf_watermark_job)
+pdf_services_response = pdf_services.get_job_result(location, PDFWatermarkResult)
+pdf_watermark_result: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(pdf_watermark_result)
+
+
+

Constructs a new PDFWatermarkJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • watermark_asset (Asset) – The watermark asset for the job; can not be None.

  • +
  • pdf_watermark_params (PDFWatermarkParams) – Parameters for water mark (Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of PDFWatermarkJob.

+
+
Return type:
+

PDFWatermarkJob

+
+
+
+ +
+
+

PDFAccessibilityCheckerJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.pdf_accessibility_checker_job.PDFAccessibilityCheckerJob(input_asset: Asset, *, pdf_accessibility_checker_params: PDFAccessibilityCheckerParams | None = None, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements +of PDF/UA and WCAG 2.0. It will generate a report that summarizes the findings of the accessibility checks. +Additional human remediation may be required to ensure that the reading order of elements is correct and +that alternative text tags properly convey the meaning of an image.

+

The report contains links to documentation that assist in manually fixing problems using Adobe Acrobat Pro.

+

Sample usage.

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+pdf_accessibility_checker_job = PDFAccessibilityCheckerJob(input_asset)
+location = pdf_services.submit(pdf_accessibility_checker_job)
+pdf_services_response = pdf_services.get_job_result(location, PDFAccessibilityCheckerResult)
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+report_asset: CloudAsset = pdf_services_response.get_result().get_report()
+stream_report: StreamAsset = pdf_services.get_content(report_asset)
+
+
+

Constructs a new instance of PDFAccessibilityCheckerJob.

+
+
Parameters:
+
    +
  • input_asset (Asset) – The input asset for the job; can not be None.

  • +
  • pdf_accessibility_checker_params (PDFAccessibilityCheckerParams) – PDFAccessibilityCheckerParams to set.(Optional, use key-value)

  • +
  • output_asset (ExternalAsset) – The output asset for the job. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of PDFAccessibilityCheckerJob

+
+
Return type:
+

PDFAccessibilityCheckerJob

+
+
+
+ +
+
+

ImportPDFFormDataJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.import_pdf_form_data_job.ImportPDFFormDataJob(input_asset: Asset, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that imports form data into a PDF using the provided JSON input.

+

This sample demonstrates how to use Adobe PDF Services SDK to import form data +into a PDF form. The process involves uploading a source PDF, providing form data +in JSON format, and submitting an import form data job.

+
+
Sample Usage:

```python +import json +from pathlib import Path

+

from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials +from adobe.pdfservices.operation.pdf_services import PDFServices +from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType +from adobe.pdfservices.operation.pdfjobs.jobs.import_pdf_form_data_job import ImportPDFFormDataJob +from adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params import ImportPDFFormDataParams +from adobe.pdfservices.operation.pdfjobs.result.import_pdf_form_data_result import ImportPDFFormDataResult

+

# Initialize credentials +credentials = ServicePrincipalCredentials(

+
+

client_id=os.getenv(‘PDF_SERVICES_CLIENT_ID’), +client_secret=os.getenv(‘PDF_SERVICES_CLIENT_SECRET’)

+
+

)

+

# Create PDF services instance +pdf_services = PDFServices(credentials=credentials)

+

# Upload the input PDF +with open(‘input_form.pdf’, ‘rb’) as file:

+
+

input_stream = file.read()

+
+
+
input_asset = pdf_services.upload(

input_stream=input_stream, +mime_type=PDFServicesMediaType.PDF.mime_type

+
+
+

)

+

# Create form data to import +form_data = {

+
+

“option_two”: “Yes”, +“option_one”: “Yes”, +“name”: “sufia”, +“option_three”: “Off”, +“age”: “25”, +“favorite_movie”: “Star Wars Again”

+
+

}

+

# Create import parameters +import_params = ImportPDFFormDataParams(json_form_fields_data=form_data)

+

# Create and configure the job +import_job = ImportPDFFormDataJob(input_asset) +import_job.set_params(import_params)

+

# Submit the job +location = pdf_services.submit(import_job) +pdf_services_response = pdf_services.get_job_result(location, ImportPDFFormDataResult)

+

# Get the result asset +result_asset = pdf_services_response.get_result().get_asset() +stream_asset = pdf_services.get_content(result_asset)

+

# Save the result PDF +with open(‘output_filled_form.pdf’, ‘wb’) as output_file:

+
+

output_file.write(stream_asset.get_input_stream())

+
+

```

+
+
+

Constructs a new ImportPDFFormDataJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object representing the input PDF with form fields; cannot be None.

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
+
+
+set_output(output_asset: Asset)
+

Sets the output asset for the job. +Note: External assets can be set as output only when input is external asset as well.

+
+
Parameters:
+

output_asset (Asset) – Asset object representing the output asset; cannot be None.

+
+
Returns:
+

ImportPDFFormDataJob instance for method chaining

+
+
Return type:
+

ImportPDFFormDataJob

+
+
+
+ +
+
+set_params(import_pdf_form_data_params: ImportPDFFormDataParams)
+

Sets the Import PDF Form Data parameters.

+
+
Parameters:
+

import_pdf_form_data_params (ImportPDFFormDataParams) – ImportPDFFormDataParams instance; cannot be None.

+
+
Returns:
+

ImportPDFFormDataJob instance for method chaining

+
+
Return type:
+

ImportPDFFormDataJob

+
+
+
+ +
+ +
+
+

ExportPDFFormDataJob

+
+
+class adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job.ExportPDFFormDataJob(input_asset: Asset, *, output_asset: Asset | None = None)
+

Bases: PDFServicesJob

+

A job that exports form data from a PDF and retrieves it in JSON format.

+

This job demonstrates how to use Adobe PDF Services SDK to extract +form data from a PDF file. The process involves uploading a source PDF, +submitting an export form data job, and retrieving the extracted data.

+

Sample usage:

+
file = open('SOURCE_PATH', 'rb')
+input_stream = file.read()
+file.close()
+
+credentials = ServicePrincipalCredentials(
+    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
+    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
+)
+
+pdf_services = PDFServices(credentials=credentials)
+input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.PDF)
+
+export_pdf_form_data_job = ExportPDFFormDataJob(input_asset=input_asset)
+
+location = pdf_services.submit(export_pdf_form_data_job)
+pdf_services_response = pdf_services.get_job_result(location, ExportPDFFormDataResult)
+
+result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
+stream_asset: StreamAsset = pdf_services.get_content(result_asset)
+
+# Save the form data JSON to a file
+output_file_path = "extracted_form_data.json"
+with open(output_file_path, 'wb') as output_file:
+    output_file.write(stream_asset.get_input_stream())
+
+
+

Constructs a new ExportPDFFormDataJob instance.

+
+
Parameters:
+
    +
  • input_asset (Asset) – Asset object containing the input file; can not be None.

  • +
  • output_asset (Asset) – Asset object representing the output asset. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of ExportPDFFormDataJob.

+
+
Return type:
+

ExportPDFFormDataJob

+
+
+
+

Note

+

External assets can be set as output only when input is external asset as well

+
+
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/pdfjobs/params.html b/docs/apidocs/4.2.0/reference/pdfjobs/params.html new file mode 100644 index 0000000..c2fd197 --- /dev/null +++ b/docs/apidocs/4.2.0/reference/pdfjobs/params.html @@ -0,0 +1,5136 @@ + + + + + + + + + Params — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Params

+
+
+
+

AutotagPDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params.AutotagPDFParams(*, shift_headings: bool = False, generate_report: bool = False)
+

Bases: PDFServicesJobParams

+

Parameters for creating a tagged PDF using +AutotagPDFJob.

+

Constructs a new instance of AutotagPDFParams.

+
+
Parameters:
+
    +
  • generate_report (bool) – If true, generates an additional tagging report which contains the information about the +tags that the tagged output PDF document contains.(Optional, use key-value)

  • +
  • shift_headings (bool) – If true, then the headings will be shifted in the output PDF document. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of AutotagPDFParams

+
+
Return type:
+

AutotagPDFParams

+
+
+
+
+get_generate_report()
+
+
Returns:
+

A boolean value specifying whether an additional tagging report needs to be generated.

+
+
Return type:
+

bool

+
+
+
+ +
+
+get_shift_headings()
+
+
Returns:
+

A boolean value specifying whether headings need to be shifted in the tagged PDF.

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+
+

CombinePDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.CombinePDFParams
+

Bases: PDFServicesJobParams

+

Parameters for combining PDFs using +CombinePDFJob.

+

Constructs a new CombinePDFParams instance.

+
+
Returns:
+

A new instance of CombinePDFParams

+
+
Return type:
+

CombinePDFParams

+
+
+
+
+add_asset(asset: ~adobe.pdfservices.operation.io.asset.Asset, *, page_ranges: ~adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges = <adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges object>)
+

Adds an Asset with +PageRanges to combine.

+
+
Parameters:
+
+
+
+
+ +
+
+get_assets_to_combine()
+
+
Returns:
+

a list of +CombinePDFJobInput +instances.

+
+
+
+ +
+ +
+
+

CompressPDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params.CompressPDFParams(*, compression_level: CompressionLevel = CompressionLevel.MEDIUM)
+

Bases: PDFServicesJobParams

+

Parameters for reducing file size of a pdf using +CompressPDFJob

+

Creates an instance of CompressPDFParams

+
+
Parameters:
+

compression_level (CompressionLevel) – see CompressionLevel. (Optional, use key-value)

+
+
+
+
+get_compression_level()
+

Returns the compression level to be used for Compress PDF, specified by +CompressionLevel

+
+ +
+ +
+
+

CompressionLevel

+
+
+class adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.CompressionLevel(value)
+

Bases: Enum

+

Supported compression levels for +CompressPDFJob

+

Constructs Compression Level from its string representation

+
+
Parameters:
+

compression_level – String representation

+
+
+
+
+HIGH = 'HIGH'
+

Reduces the file size of pdf by reducing resolution of the coloured and grayscale images above 100 dpi to 72 +dpi (dots per inch). +This option uses JPEG medium quality compression. +Output pdf will not contain hidden layers, document structure, metadata, javascript, user properties and print +settings.

+
+ +
+
+LOW = 'LOW'
+

Reduces the file size of pdf by reducing resolution of the coloured and grayscale images above 250 dpi to 200 +dpi (dots per inch). +This option uses JP2K high quality compression.

+
+ +
+
+MEDIUM = 'MEDIUM'
+

Reduces the file size of pdf by reducing resolution of the coloured and grayscale images above 200 dpi to 144 +dpi (dots per inch). +This option uses JP2K medium quality compression.

+
+ +
+
+get_compression_level()
+

Returns the string representation of this CompressionLevel

+
+
Returns:
+

String representation of this CompressionLevel

+
+
+
+ +
+ +
+
+

CreatePDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams.CreatePDFParams
+

Bases: PDFServicesJobParams, ABC

+

Marker base class for CreatePDFJob +params. The factory methods within this class can be used to create instances of params classes corresponding to +the source media type.

+
+ +
+
+

CreatePDFFromExcelParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params.CreatePDFFromExcelParams(*, document_language: DocumentLanguage = DocumentLanguage.EN_US, create_tagged_pdf: bool = False)
+

Bases: CreatePDFParams

+

Constructs a new instance of CreatePDFFromExcelParams.

+
+
Parameters:
+
    +
  • document_language (DocumentLanguage) – Sets office preferred editing language to be used for conversion; can not be None.

  • +
  • create_tagged_pdf (bool) – Whether to create a tagged PDF. The default value is false. (Optional, use key-value)

  • +
+
+
+
+
+get_document_language()
+
+
Returns:
+

Language of the input document.

+
+
Return type:
+

DocumentLanguage

+
+
+
+ +
+ +
+
+

DocumentLanguage

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage(value)
+

Bases: Enum

+

Supported locales for Excel to PDF.

+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale.

+

Please note that this locale is only supported for US(default) region.

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NO_NO = 'no-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HK = 'zh-HK'
+

Represents “Chinese (Hong Kong)” locale

+
+ +
+
+get_document_language()
+
+ +
+ +
+
+

CreatePDFFromPPTParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params.CreatePDFFromPPTParams(*, document_language: DocumentLanguage = DocumentLanguage.EN_US, create_tagged_pdf: bool = False)
+

Bases: CreatePDFParams

+

Constructs a new instance of CreatePDFFromPPTParams.

+
+
Parameters:
+
    +
  • document_language (DocumentLanguage) – Sets office preferred editing language to be used for conversion; can not be None.

  • +
  • create_tagged_pdf (bool) – Whether to create a tagged PDF. The default value is false. (Optional, use key-value)

  • +
+
+
+
+
+get_document_language()
+
+
Returns:
+

Language of the input document.

+
+
Return type:
+

DocumentLanguage

+
+
+
+ +
+ +
+
+

DocumentLanguage

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage(value)
+

Bases: Enum

+

Supported locales for PPT to PDF.

+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale.

+

Please note that this locale is only supported for US(default) region.

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NO_NO = 'no-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HK = 'zh-HK'
+

Represents “Chinese (Hong Kong)” locale

+
+ +
+
+get_document_language()
+
+ +
+ +
+
+

CreatePDFFromWordParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params.CreatePDFFromWordParams(*, document_language: DocumentLanguage = DocumentLanguage.EN_US, create_tagged_pdf: bool = False)
+

Bases: CreatePDFParams

+

Constructs a new instance of CreatePDFFromWordParams.

+
+
Parameters:
+
    +
  • document_language (DocumentLanguage) – Sets office preferred editing language to be used for conversion; can not be None.

  • +
  • create_tagged_pdf (bool) – Whether to create a tagged PDF. The default value is false. (Optional, use key-value)

  • +
+
+
+
+
+get_document_language()
+
+
Returns:
+

Language of the input document.

+
+
Return type:
+

DocumentLanguage

+
+
+
+ +
+ +
+
+

DocumentLanguage

+
+
+class adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage(value)
+

Bases: Enum

+

Supported locales for Word to PDF.

+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale.

+

Please note that this locale is only supported for US(default) region.

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NO_NO = 'no-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HK = 'zh-HK'
+

Represents “Chinese (Hong Kong)” locale

+
+ +
+
+get_document_language()
+
+ +
+ +
+
+

DeletePagesParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params.DeletePagesParams(page_ranges: PageRanges)
+

Bases: PDFServicesJobParams

+

Parameters for deleting pages from a pdf using +DeletePagesJob

+

Creates an instance of DeletePagesParams with given PageRanges.

+
+
Parameters:
+

page_ranges (PageRanges) – the PageRanges to be used for deleting pages; can not be None.

+
+
+
+
+get_page_ranges()
+
+
Returns:
+

the PageRanges to be used for deleting pages.

+
+
Return type:
+

PageRanges

+
+
+
+ +
+ +
+
+

DocumentMergeParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.DocumentMergeParams(json_data_for_merge: Any, *, output_format: OutputFormat = OutputFormat.PDF, fragments: Fragments = None)
+

Bases: PDFServicesJobParams

+

Parameters for document generation using +DocumentMergeJob

+

Constructs a new DocumentMergeParams instance

+
+
Parameters:
+
    +
  • json_data_for_merge (Any) – json to be used in the document merge job; can not be None.

  • +
  • output_format (OutputFormat) – output format for the document merge result; (Optional, use key-value)

  • +
  • fragments (Fragments) – fragments for document merge job; (Optional, use key-value)

  • +
+
+
Returns:
+

DocumentMergeParams

+
+
+
+
+get_fragments()
+
+
Returns:
+

fragments for document merge job

+
+
+
+ +
+
+get_json_data_for_merge()
+
+
Returns:
+

JSON data for the document merge process

+
+
+
+ +
+
+get_output_format()
+
+
Returns:
+

output format for the document merge result

+
+
+
+ +
+ +
+
+

Fragments

+
+
+class adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments
+

Bases: object

+

Class for providing support for Fragments. To know more about fragments +use-case in document generation and document templates, Click Here.

+

Constructs a new Fragments instance

+
+
+add_fragment(fragment)
+

To add fragment dictionary into the fragments list.

+
+
Parameters:
+

fragment – fragment dictionary to be added into the fragments list.

+
+
+
+ +
+
+add_fragments(fragments: List)
+

To add List of fragment dictionaries into the fragments list.

+
+
Parameters:
+

fragments – fragment dictionary list to be added into the fragments list.

+
+
+
+ +
+
+get_fragments_list()
+
+
Returns:
+

list of fragments.

+
+
+
+ +
+ +
+
+

OutputFormat

+
+
+class adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.OutputFormat(value)
+

Bases: Enum

+

Supported output formats for adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job.py

+

Constructs output format with its string representation

+
+
Parameters:
+

output_format – String representation

+
+
+
+
+DOCX = 'docx'
+

Represents “application/vnd.openxmlformats-officedocument.wordprocessingml.document” media type

+
+ +
+
+PDF = 'pdf'
+

Represents “application/pdf” media type

+
+ +
+
+get_format()
+
+
Returns:
+

String representation of this outputformat

+
+
+
+ +
+ +
+
+

PDFElectronicSealParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams(seal_certificate_credentials: CSCCredentials, seal_field_options: FieldOptions, *, seal_signature_format: SignatureFormat = SignatureFormat.PKCS7, document_level_permissions: DocumentLevelPermission = DocumentLevelPermission.FORM_FILLING, seal_appearance_options: AppearanceOptions | None = None, tsa_options: TSAOptions | None = None)
+

Bases: object

+

Parameters for electronically seal PDFs using +PDFElectronicSealJob.

+

Constructs a new PDFElectronicSealParams instance.

+
+
Parameters:
+
    +
  • seal_certificate_credentials (CSCCredentials) – CertificateCredentials to be used for applying electronic seal; can not be None.

  • +
  • seal_field_options (FieldOptions) – FieldOptions to be used for applying electronic seal; can not be None.

  • +
  • seal_signature_format (SignatureFormat) – SignatureFormat to be used for applying electronic seal. (Optional, use key-value)

  • +
  • document_level_permissions (DocumentLevelPermission) – Document level permission for changes allowed after sealing. (Optional, use key-value)

  • +
  • seal_appearance_options (AppearanceOptions) – AppearanceOptions for the seal. (Optional, use key-value)

  • +
  • tsa_options (TSAOptions) – Time stamp authority options. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of PDFElectronicSealParams

+
+
Return type:
+

PDFElectronicSealParams

+
+
+
+
+get_seal_appearance_options()
+
+
Returns:
+

AppearanceOptions for the seal.

+
+
Return type:
+

AppearanceOptions

+
+
+
+ +
+
+get_seal_certificate_credentials()
+
+
Returns:
+

CertificateCredentials to be used for applying electronic seal

+
+
Return type:
+

CSCCredentials

+
+
+
+ +
+
+get_seal_field_options()
+
+
Returns:
+

FieldOptions to be used for applying electronic seal.

+
+
Return type:
+

FieldOptions

+
+
+
+ +
+
+get_signature_format()
+
+
Returns:
+

SignatureFormat to be used for applying electronic seal.

+
+
Return type:
+

SignatureFormat

+
+
+
+ +
+ +
+
+

RFC3161TSAOptions

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options.RFC3161TSAOptions(url: str, *, tsa_basic_auth_credentials: TSABasicAuthCredentials | None = None)
+

Bases: TSAOptions

+

Parameters specifying RFC3161 compliant time stamp authority options required for +PDFElectronicSealParams.

+

Constructs a new RFC3161TSAOptions instance from url.

+
+
Parameters:
+
    +
  • url (str) – url to be used for timestamping, can not be None.

  • +
  • tsa_basic_auth_credentials (TSABasicAuthCredentials) – Credentials to be used for timestamping. (Optional, use key-value)

  • +
+
+
+
+
+get_tsa_basic_auth_credentials()
+

Returns the intended TSA authorization credentials to be used.

+
+
Returns:
+

A TSABasicAuthCredentials instance

+
+
Return type:
+

TSABasicAuthCredentials

+
+
+
+ +
+
+get_url()
+

Returns the timestamp url to be used.

+
+
Returns:
+

The timestamp url

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

AppearanceItem

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem(value)
+

Bases: Enum

+

Supported elements to represent electronic seal required for +AppearanceOptions.

+
+
+DATE = 'DATE'
+

Represents the date of applying the electronic seal.

+
+ +
+
+DISTINGUISHED_NAME = 'DISTINGUISHED_NAME'
+

Represents the distinguished name information of the certificate.

+
+ +
+
+LABELS = 'LABELS'
+

Represents labels for seal information.

+
+ +
+
+NAME = 'NAME'
+

Represents the name of the certificate owner.

+
+ +
+
+SEAL_IMAGE = 'SEAL_IMAGE'
+

Represents the background image to be used for sealing.

+
+ +
+ +
+
+

AppearanceOptions

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.AppearanceOptions
+

Bases: object

+

Parameters specifying set of elements (i.e. appearance items) to represent electronic seal required for +PDFElectronicSealParams.

+
+
+add_item(appearance_option: AppearanceItem)
+
+
Parameters:
+

appearance_option (AppearanceItem) – AppearanceItem to be added to AppearanceOptions, can not be None.

+
+
+
+ +
+
+get_appearance_options()
+
+
Returns:
+

List of Appearance Items

+
+
+
+ +
+ +
+
+

CSCAuthContext

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.CSCAuthContext(access_token: str, token_type: str = 'Bearer')
+

Bases: object

+

Parameters for representing CSC authorization context.

+

Constructs a new instance of CSCAuthContext

+
+
Parameters:
+
    +
  • access_token (str) – The service access token used to authorize access to the CSC provider hosted APIs. +Cannot be None.

  • +
  • token_type (str) – The type of service access token used to authorize access to the CSC provider hosted APIs. +Default value is “Bearer”.

  • +
+
+
+
+
+get_access_token()
+
+
Returns:
+

The service access token.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_token_type()
+
+
Returns:
+

The type of service access token used.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

CSCCredentials

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials(provider_name: str, credential_id: str, pin: str, csc_auth_context: CSCAuthContext)
+

Bases: object

+

Parameters for representing the CSC Provider based credentials as a subtype

+

Creates an instance of CSCCredentials.

+
+
Parameters:
+
    +
  • provider_name (str) – The name of the Trust Service Provider to be used for applying electronic seal. +Can not be None.

  • +
  • credential_id (str) – The digital ID stored with the TSP provider to be used for applying electronic seal. +Can not be None.

  • +
  • pin (str) – The pin associated with the credential ID. Can not be None.

  • +
  • csc_auth_context (CSCAuthContext) – The service authorization data required to communicate with the TSP. Can not be None.

  • +
+
+
+
+
+get_credential_id()
+
+
Returns:
+

The digital ID stored with the TSP provider.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_csc_auth_context()
+
+
Returns:
+

The service authorization data.

+
+
Return type:
+

CSCAuthContext

+
+
+
+ +
+
+get_pin()
+
+
Returns:
+

The pin associated with the credential ID.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_provider_name()
+
+
Returns:
+

The name of the Trust Service Provider.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

DocumentLevelPermission

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.DocumentLevelPermission(value)
+

Bases: Enum

+

A mapping of Document Level Permission used in +PDFElectronicSealParams.

+
+
+FORM_FILLING = 'FORM_FILLING'
+

Represents FORM_FILLING document level permission. +Allowed changes in output document are filling in forms, instantiating page templates, and performing approval +signatures.

+
+ +
+
+FORM_FILLING_AND_ANNOTATIONS = 'FORM_FILLING_AND_ANNOTATIONS'
+

Represents FORM_FILLING_AND_ANNOTATIONS document level permission. +In addition to changes allowed in FORM_FILLING, annotation creation, deletion, and modification are also allowed.

+
+ +
+
+NO_CHANGES_ALLOWED = 'NO_CHANGES_ALLOWED'
+

Represents NO_CHANGES_ALLOWED document level permission. +No changes to the output document are permitted.

+
+ +
+ +
+
+

FieldLocation

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation(left: int, top: int, right: int, bottom: int)
+

Bases: object

+

Parameters specifying options related to seal field location coordinates required for +FieldOptions

+
+
Parameters:
+
    +
  • left (int) – the left coordinate of field location

  • +
  • top (int) – the top coordinate of field location

  • +
  • right (int) – the right coordinate of field location

  • +
  • bottom (int) – the bottom coordinate of field location

  • +
+
+
+
+
+get_bottom()
+
+
Returns:
+

the bottom coordinate of field location

+
+
Return type:
+

int

+
+
+
+ +
+
+get_left()
+
+
Returns:
+

the left coordinate of field location

+
+
Return type:
+

int

+
+
+
+ +
+
+get_right()
+
+
Returns:
+

the right coordinate of field location

+
+
Return type:
+

int

+
+
+
+ +
+
+get_top()
+
+
Returns:
+

the top coordinate of field location

+
+
Return type:
+

int

+
+
+
+ +
+ +
+
+

FieldOptions

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions(field_name: str, *, field_location: FieldLocation | None = None, page_number: int | None = None, visible: bool | None = True)
+

Bases: object

+

Parameters specifying options related to the seal field required for +PDFElectronicSealParams.

+

Constructs a new instance of FieldOptions.

+
+
Parameters:
+
    +
  • field_name (str) – The name of the field to be used for applying the electronic seal. If signature field with +this field name already exist, that field will be used. If it does not exist, a signature field with this +field name will be created. Can not be None.

  • +
  • field_location (FieldLocation) – A FieldLocation instance specifying coordinates for the electronic seal. The location +is only required for visible signatures if the signature field does not already exist in the PDF document. +If location is provided along with the existing signature field then it is ignored. (Optional, use key-value)

  • +
  • page_number (int) – The page number to which the signature field should be attached. Page numbers are 1-based. +The page number is only required for visible signatures if the signature field does not already exist in +the PDF document. If page number is provided along with the existing signature field then the page number +should be same on which signature field is present in the document, else an error is thrown. +(Optional, use key-value)

  • +
  • visible (bool) – The intended visibility flag for the electronic seal. Default value is true. +(Optional, use key-value)

  • +
+
+
+
+
+get_field_location()
+
+
Returns:
+

Field Location

+
+
Return type:
+

FieldLocation

+
+
+
+ +
+
+get_field_name()
+
+
Returns:
+

Field Name

+
+
Return type:
+

str

+
+
+
+ +
+
+get_page_number()
+
+
Returns:
+

Page Number

+
+
Return type:
+

int

+
+
+
+ +
+
+get_visible()
+
+
Returns:
+

Visibility flag for the electronic seal

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+
+

SignatureFormat

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.SignatureFormat(value)
+

Bases: Enum

+

Supported signature formats to create electronic seal required for +PDFElectronicSealParams.

+
+
+PADES = 'PADES'
+

Represents PADES format.

+
+ +
+
+PKCS7 = 'PKCS7'
+

Represents PKCS7 format.

+
+ +
+
+get_signature_format()
+
+
Returns:
+

String value of SignatureFormat

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

TSABasicAuthCredentials

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.TSABasicAuthCredentials(username: str, password: str)
+

Bases: object

+

Parameters specifying options related to the time stamp authority credentials required for +RFC3161TSAOptions

+

Constructs a TSABasicAuthCredentials instance.

+
+
Parameters:
+
    +
  • username (str) – username to be used for timestamping

  • +
  • password (str) – password to be used for timestamping

  • +
+
+
+
+
+get_password()
+

Returns the intended password to be used for timestamping.

+
+
Returns:
+

The password

+
+
Return type:
+

str

+
+
+
+ +
+
+get_username()
+

Returns the intended username to be used for timestamping.

+
+
Returns:
+

The username

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

ImportPDFFormDataParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params.ImportPDFFormDataParams(json_form_fields_data: dict)
+

Bases: PDFServicesJobParams

+

Parameters for importing form data into PDF using +ImportPDFFormDataJob

+

Constructs a new ImportPDFFormDataParams instance.

+
+
Parameters:
+

json_form_fields_data (dict) – Dictionary containing form field data to import into the PDF. +Keys should match the form field names in the target PDF, and values should be the data to fill.

+
+
+
+
+get_json_form_fields_data() Dict[str, Any]
+
+
Returns:
+

Returns the form field data dictionary that will be imported into the PDF.

+
+
Return type:
+

Dict[str, Any]

+
+
+
+ +
+
+get_json_form_fields_data_string() str
+
+
Returns:
+

Returns the form field data as a JSON string.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

ExportPDFFormDataParams

+
+
+

TSAOptions

+
+
+class adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options.TSAOptions
+

Bases: ABC

+

This abstract class represents the basic contract for the timestamp authority options to be used with +PDFElectronicSealParams.

+
+ +
+
+

ExportPDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params.ExportPDFParams(target_format: ExportPDFTargetFormat, *, ocr_lang: ExportOCRLocale = ExportOCRLocale.EN_US)
+

Bases: PDFServicesJobParams

+

Parameters for exporting a source PDF file to a supported format using +ExportPDFJob

+

Constructs a new ExportPDFParams instance.

+
+
Parameters:
+
    +
  • target_format (ExportPDFTargetFormat) – Target format to which the source PDF file will be exported; can not be None

  • +
  • ocr_lang (ExportOCRLocale) – Sets OCR Locale level to be used for Export PDF. (Optional, use key-value)

  • +
+
+
+
+
+get_ocr_lang()
+
+
Returns:
+

Returns the OCR Locale to be used for Export PDF.

+
+
Return type:
+

ExportOCRLocale

+
+
+
+ +
+
+get_target_format()
+
+
Returns:
+

Returns the target format to which the source PDF file will be exported.

+
+
Return type:
+

ExportPDFTargetFormat

+
+
+
+ +
+ +
+
+

ExportOCRLocale

+
+
+class adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale(value)
+

Bases: Enum

+

Enum values representing different locales

+

Constructs a locale from a language code

+
+
Parameters:
+

locale – language code

+
+
+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale.

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+EU_ES = 'eu-ES'
+

Represents “Basque (Spain)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+GL_ES = 'gl-ES'
+

Represents “Galician (Spain)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NN_NO = 'nn-NO'
+

Represents “Norwegian Nynorsk (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+PT_PT = 'pt-PT'
+

Represents “European Portuguese” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HANT = 'zh-Hant'
+

Represents “Chinese (traditional)” locale

+
+ +
+
+get_export_ocr_locale()
+
+
Returns:
+

Language code of the ExportOCRLocale

+
+
+
+ +
+ +
+
+

ExportPDFTargetFormat

+
+
+class adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat(value)
+

Bases: Enum

+

Supported target formats for +ExportPDFJob

+

Constructor.

+
+
Parameters:
+

file_ext – file extension

+
+
+
+
+DOC = 'doc'
+

Represents “application/msword” media type

+
+ +
+
+DOCX = 'docx'
+

Represents “application/vnd.openxmlformats-officedocument.wordprocessingml.document” media type

+
+ +
+
+PPTX = 'pptx'
+

Represents “application/vnd.openxmlformats-officedocument.presentationml.presentation” media type

+
+ +
+
+RTF = 'rtf'
+

Represents “text/rtf” media type

+
+ +
+
+XLSX = 'xlsx'
+

Represents “application/vnd.openxmlformats-officedocument.spreadsheetml.sheet” media type

+
+ +
+
+get_file_ext()
+

Returns the file extension of this format.

+
+
Returns:
+

file extension of this format

+
+
+
+ +
+ +
+
+

ExtractPDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams(*, table_structure_type: TableStructureType = TableStructureType.XLSX, add_char_info: bool = False, styling_info: bool = False, elements_to_extract: List | None = None, elements_to_extract_renditions: List | None = None)
+

Bases: PDFServicesJobParams

+

Parameters to extract content from PDF using +ExtractPDFJob.

+

Construct a new ExtractPDFParams

+
+
Parameters:
+
    +
  • table_structure_type (TableStructureType) – TableStructureType for output type of table structure. (Optional, use key-value)

  • +
  • add_char_info (bool) – Boolean specifying whether to add character level bounding boxes to output json. +(Optional, use key-value)

  • +
  • styling_info (bool) – Boolean specifying whether to add styling information to output json. +(Optional, use key-value)

  • +
  • elements_to_extract (List) – List of ExtractElementType to be extracted. +(Optional, use key-value)

  • +
  • elements_to_extract_renditions (List) – List of ExtractElementType. +(Optional, use key-value)

  • +
+
+
+
+
+get_add_char_info()
+
+
Returns:
+

Whether character level information was invoked for operation.

+
+
Return type:
+

bool

+
+
+
+ +
+
+get_elements_to_extract()
+
+
Returns:
+

The list of elements (Text and/or Tables) invoked for operation

+
+
Return type:
+

list

+
+
+
+ +
+
+get_elements_to_extract_renditions()
+
+
Returns:
+

Returns the list of ExtractElementType invoked for job.

+
+
Return type:
+

list

+
+
+
+ +
+
+get_styling_info()
+
+
Returns:
+

Whether styling information was invoked for operation.

+
+
Return type:
+

bool

+
+
+
+ +
+
+get_table_structure_type()
+
+
Returns:
+

Returns the TableStructureType of the resulting rendition

+
+
Return type:
+

TableStructureType

+
+
+
+ +
+ +
+
+

ExtractElementType

+
+
+class adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type.ExtractElementType(value)
+

Bases: Enum

+

Supported inputs for Elements to Extract ExtractPDFJob.

+
+
+TABLES = 'tables'
+

Tabular Data

+
+ +
+
+TEXT = 'text'
+

Textual Data

+
+ +
+ +
+
+

ExtractRenditionsElementType

+
+
+class adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type.ExtractRenditionsElementType(value)
+

Bases: Enum

+

Supported inputs for Renditions To Extract ExtractPDFJob.

+
+
+FIGURES = 'figures'
+

Image Data

+
+ +
+
+TABLES = 'tables'
+

Tabular Data

+
+ +
+ +
+
+

TableStructureType

+
+
+class adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type.TableStructureType(value)
+

Bases: Enum

+

Supported Formats for exporting Table Data ExtractPDFJob.

+
+
+CSV = 'csv'
+

CSV Format

+
+ +
+
+XLSX = 'xlsx'
+

XLSX Format

+
+ +
+ +
+
+

HTMLtoPDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.HTMLtoPDFParams(*, json: str = '{}', include_header_footer: bool = False, page_layout: ~adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout = <adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout object>)
+

Bases: PDFServicesJobParams

+

Parameters for converting HTML to PDF using +HTMLtoPDFJob

+

Constructs a new HTMLtoPDFParams instance.

+
+
Parameters:
+
    +
  • json (str) –

    Sets the data to be used by the javascript in the source html file to manipulate the HTML DOM +before it gets converted to PDF. +This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests.

    +

    To make use of this mechanism, the source html file must include a script element such as:

    +

    <script src='./json.js' type='text/javascript'></script>

    +

    where json.js refers to the JSON data,</pre> +And also Requires javascript in the source html file to make use of this JSON data to manipulate the HTML +DOM. (Optional, use key-value)

    +

  • +
  • include_header_footer (bool) –

    includeHeaderFooter parameter. If true, default header and footer will be included +in resulting PDF.

    +
    +
      +
    • The default header consists of the date and the document title.

    • +
    • The default footer consists of the file name and page number.

    • +
    +
    +

    (Optional, use key-value)

    +

  • +
  • page_layout (PageLayout) – Intended page layout of the resulting PDF file. (Optional, use key-value)

  • +
+
+
+
+ +
+
Returns:
+

Returns true if default header and footer will be included in the resulting PDF file. +- The default header consists of the date and the document title. +- The default footer consists of the file name and page number.

+
+
Return type:
+

bool

+
+
+
+ +
+
+get_json()
+
+
Returns:
+

Returns JSON data that will be used to manipulate HTML DOM before it is converted into PDF file. +This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests.

+

To make use of this mechanism, the source html file must include a script element such as:

+

<script src='./json.js' type='text/javascript'></script>

+

where json.js refers to the JSON data,</pre> +And also Requires javascript in the source html file to make use of this JSON data to manipulate the HTML +DOM.

+

+
+
Return type:
+

str

+
+
+
+ +
+
+get_page_layout()
+
+
Returns:
+

Intended page layout of the resulting PDF file.

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+
+

PageLayout

+
+
+class adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout(page_height: float = 11.0, page_width: float = 8.5)
+

Bases: object

+

Represents a page layout with dimensions in inches.

+

Constructor to initialize a default page layout. +The default layout sets the height as 11 inches and width as 8.5 inches.

+
+
Parameters:
+
    +
  • page_height (float) – Height of the page in inches, can not be None

  • +
  • page_width (float) – Width of the page in inches

  • +
+
+
+
+
+DEFAULT_PAGE_HEIGHT = 11.0
+

Default value of the page height (in inches)

+
+ +
+
+DEFAULT_PAGE_WIDTH = 8.5
+

Default value of the page width (in inches)

+
+ +
+ +
+
+

InsertPagesParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.InsertPagesParams(base_asset: Asset)
+

Bases: PDFServicesJobParams

+

Parameters for inserting pages in a PDF using +InsertPagesJob

+

Constructs a new InsertPagesParams instance.

+
+
Parameters:
+

base_asset (Asset) – Base asset into which the pages are to be inserted.

+
+
+
+
+add_pages_to_insert(input_asset: ~adobe.pdfservices.operation.io.asset.Asset, base_page: int, *, page_ranges: ~adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges = <adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges object>)
+

Adds the specified pages of the input PDF file to be inserted at the specified page of the base PDF file

+

This method can be invoked multiple times with the same or different input PDF files.

+

All the pages of the input PDF file will be inserted at the specified page of the base PDF file if page_ranges +is not specified.

+
+
Parameters:
+
    +
  • input_asset (Asset) – A PDF file for insertion; can not be None.

  • +
  • base_page (int) – Page of the base PDF file; can not be None.

  • +
  • page_ranges (PageRanges) – Page ranges of the input PDF file. (Optional, use key-value)

  • +
+
+
+
+ +
+
+get_assets_to_insert()
+
+
Returns:
+

Returns the mapping of base Asset’s page number and Asset to be inserted along with PageRanges .

+
+
Return type:
+

dict

+
+
+
+ +
+
+get_base_asset()
+
+
Returns:
+

base PDF Asset to which pages will be inserted.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

OCRParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.OCRParams(*, ocr_locale: OCRSupportedLocale = OCRSupportedLocale.EN_US, ocr_type: OCRSupportedType = OCRSupportedType.SEARCHABLE_IMAGE)
+

Bases: PDFServicesJobParams

+

Parameters for converting PDF to a searchable PDF using +OCRPDFJob<adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job.OCRPDFJob

+

Constructs a new OCRParams instance.

+
+
Parameters:
+
+
+
+
+
+get_ocr_locale()
+
+
Returns:
+

OCRSupportedLocale to be used for OCR.

+
+
Return type:
+

OCRSupportedLocale

+
+
+
+ +
+
+get_ocr_type()
+
+
Returns:
+

OCRSupportedType to be used for OCR.

+
+
Return type:
+

OCRSupportedType

+
+
+
+ +
+ +
+
+

OCRSupportedLocale

+
+
+class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale(value)
+

Bases: Enum

+

Supported locales for OCRJob

+

Construct a locale from a language code.

+
+
Parameters:
+

locale – language code

+
+
+
+
+BG_BG = 'bg-BG'
+

Represents “Bulgarian (Bulgaria)” locale

+
+ +
+
+CA_CA = 'ca-CA'
+

Represents “Catalan (Canada)” locale

+
+ +
+
+CS_CZ = 'cs-CZ'
+

Represents “Czech (Czech Republic)” locale

+
+ +
+
+DA_DK = 'da-DK'
+

Represents “Danish (Denmark)” locale

+
+ +
+
+DE_CH = 'de-CH'
+

Represents “German (Switzerland)” locale

+
+ +
+
+DE_DE = 'de-DE'
+

Represents “German (Germany)” locale

+
+ +
+
+EL_GR = 'el-GR'
+

Represents “Greek (Greece)” locale

+
+ +
+
+EN_GB = 'en-GB'
+

Represents “English (United Kingdom)” locale

+
+ +
+
+EN_US = 'en-US'
+

Represents “English (United States)” locale

+
+ +
+
+ES_ES = 'es-ES'
+

Represents “Spanish (Spain)” locale

+
+ +
+
+ET_EE = 'et-EE'
+

Represents “Estonian (Estonia)” locale

+
+ +
+
+FI_FI = 'fi-FI'
+

Represents “Finnish (Finland)” locale

+
+ +
+
+FR_FR = 'fr-FR'
+

Represents “French (France)” locale

+
+ +
+
+HR_HR = 'hr-HR'
+

Represents “Croatian (Croatia)” locale

+
+ +
+
+HU_HU = 'hu-HU'
+

Represents “Hungarian (Hungary)” locale

+
+ +
+
+IT_IT = 'it-IT'
+

Represents “Italian (Italy)” locale

+
+ +
+
+IW_IL = 'iw-IL'
+

Represents “Hebrew (Israel)” locale

+
+ +
+
+JA_JP = 'ja-JP'
+

Represents “Japanese (Japan)” locale

+
+ +
+
+KO_KR = 'ko-KR'
+

Represents “Korean (Korea)” locale

+
+ +
+
+LT_LT = 'lt-LT'
+

Represents “Lithuanian (Lithuania)” locale

+
+ +
+
+LV_LV = 'lv-LV'
+

Represents “Latvian (Latvia)” locale

+
+ +
+
+MK_MK = 'mk-MK'
+

Represents “Macedonian (Macedonia)” locale

+
+ +
+
+MT_MT = 'mt-MT'
+

Represents “Maltese (Malta)” locale

+
+ +
+
+NB_NO = 'nb-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+NL_NL = 'nl-NL'
+

Represents “Dutch (Netherlands)” locale

+
+ +
+
+NO_NO = 'no-NO'
+

Represents “Norwegian (Norway)” locale

+
+ +
+
+PL_PL = 'pl-PL'
+

Represents “Polish (Poland)” locale

+
+ +
+
+PT_BR = 'pt-BR'
+

Represents “Portuguese (Brazil)” locale

+
+ +
+
+RO_RO = 'ro-RO'
+

Represents “Romanian (Romania)” locale

+
+ +
+
+RU_RU = 'ru-RU'
+

Represents “Russian (Russia)” locale

+
+ +
+
+SK_SK = 'sk-SK'
+

Represents “Slovak (Slovakia)” locale

+
+ +
+
+SL_SI = 'sl-SI'
+

Represents “Slovenian (Slovenia)” locale

+
+ +
+
+SR_SR = 'sr-SR'
+

Represents “Serbian (Serbia)” locale

+
+ +
+
+SV_SE = 'sv-SE'
+

Represents “Swedish (Sweden)” locale

+
+ +
+
+TR_TR = 'tr-TR'
+

Represents “Turkish (Turkey)” locale

+
+ +
+
+UK_UA = 'uk-UA'
+

Represents “Ukrainian (Ukraine)” locale

+
+ +
+
+ZH_CN = 'zh-CN'
+

Represents “Chinese (China)” locale

+
+ +
+
+ZH_HK = 'zh-HK'
+

Represents “Chinese (Hong Kong)” locale

+
+ +
+
+get_locale()
+

Returns the language code of this OCRSupportedLocale.

+
+
Returns:
+

language code of the locale

+
+
+
+ +
+ +
+
+

OCRSupportedType

+
+
+class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.OCRSupportedType(value)
+

Bases: Enum

+

Supported OCR types for OCRJob

+

Constructs OCR Type from its string representation.

+
+
Parameters:
+

ocr_type – String representation

+
+
+
+
+SEARCHABLE_IMAGE = 'searchable_image'
+
+ +
+
+SEARCHABLE_IMAGE_EXACT = 'searchable_image_exact'
+
+ +
+
+get_type()
+

Returns the string representation of this OCRSupportedType.

+
+
Returns:
+

String representation of this OCRSupportedType

+
+
+
+ +
+ +
+
+

PDFPropertiesParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params.PDFPropertiesParams(*, include_page_level_properties: bool = False)
+

Bases: PDFServicesJobParams

+

Parameters for getting properties of a PDF using +PDFPropertiesJob

+

Constructs a new PDFPropertiesParams.

+
+
Parameters:
+

include_page_level_properties (bool) – If true, the page level properties of the input PDF will be included in +the resulting JSON file or JSON Object. (Optional, use key-value)

+
+
+
+
+get_include_page_level_properties()
+
+
Returns:
+

Page level properties

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+
+

ExportPDFtoImagesParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params.ExportPDFtoImagesParams(export_pdf_to_images_target_format: ExportPDFToImagesTargetFormat, export_pdf_to_images_output_type: ExportPDFToImagesOutputType)
+

Bases: PDFServicesJobParams

+

Parameters for exporting a source PDF file to images using +ExportPDFToImagesJob.

+

Constructs a new ExportPDFtoImagesParams instance.

+
+
Parameters:
+
    +
  • export_pdf_to_images_target_format (ExportPDFToImagesTargetFormat) – ExportPDFToImagesTargetFormat to which the source PDF file will be exported, can not be None.

  • +
  • export_pdf_to_images_output_type (ExportPDFToImagesOutputType) – ExportPDFToImagesOutputType to be used for Export PDF to Images, can not be None.

  • +
+
+
+
+
+get_export_pdf_to_images_output_type()
+
+
Returns:
+

ExportPDFToImagesOutputType to be used for Export PDF to Images.

+
+
Return type:
+

ExportPDFToImagesOutputType

+
+
+
+ +
+
+get_export_pdf_to_images_target_format()
+
+
Returns:
+

ExportPDFToImagesTargetFormat to which the source PDF file will be exported.

+
+
Return type:
+

ExportPDFToImagesTargetFormat

+
+
+
+ +
+ +
+
+

ExportPDFToImagesOutputType

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.ExportPDFToImagesOutputType(value)
+

Bases: Enum

+

List of supported outputTypes for ExportPDFToImagesJob.

+
+
+LIST_OF_PAGE_IMAGES = 'listOfPageImages'
+

Represents List Output type.

+
+ +
+
+ZIP_OF_PAGE_IMAGES = 'zipOfPageImages'
+

Represents Zip Output type.

+
+ +
+
+get_output_type()
+
+
Returns:
+

output type.

+
+
+
+ +
+ +
+
+

ExportPDFToImagesTargetFormat

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.ExportPDFToImagesTargetFormat(value)
+

Bases: Enum

+

Supported target formats for ExportPDFToImagesJob.

+
+
+JPEG = 'jpeg'
+

Represents “image/jpeg” media type.

+
+ +
+
+PNG = 'png'
+

Represents “image/png” media type.

+
+ +
+
+get_file_ext()
+
+
Returns:
+

file extension of this format.

+
+
+
+ +
+ +
+
+

ProtectPDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params.ProtectPDFParams
+

Bases: PDFServicesJobParams, ABC

+

Marker base class for ProtectPDFJob +params.

+
+ +
+
+

ContentEncryption

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.ContentEncryption(value)
+

Bases: Enum

+

Supported types of content to encrypt for +ProtectPDFJob

+
+
+ALL_CONTENT = 'ALL_CONTENT'
+

Encrypts all the content of the PDF file

+
+ +
+
+ALL_CONTENT_EXCEPT_METADATA = 'ALL_CONTENT_EXCEPT_METADATA'
+

Encrypts all the content except the metadata of the PDF file

+
+ +
+
+ONLY_EMBEDDED_FILES = 'ONLY_EMBEDDED_FILES'
+

Encrypts only embedded files

+
+ +
+ +
+
+

EncryptionAlgorithm

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm.EncryptionAlgorithm(value)
+

Bases: Enum

+

Supported encryption algorithms for +ProtectPDFJob

+
+
+AES_128 = 'AES_128'
+

Represents AES-128 encryption algorithm

+
+ +
+
+AES_256 = 'AES_256'
+

Represents AES-256 encryption algorithm

+
+ +
+ +
+
+

PasswordProtectParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams(encryption_algorithm: EncryptionAlgorithm, *, content_encryption: ContentEncryption = ContentEncryption.ALL_CONTENT, permissions: Permissions | None = None, user_password: str | None = None, owner_password: str | None = None)
+

Bases: ProtectPDFParams

+

Parameters for securing PDF file with passwords and document permissions using +ProtectPDFJob

+

Constructs a new PasswordProtectParams instance.

+
+
Parameters:
+
    +
  • encryption_algorithm (EncryptionAlgorithm) – Sets the intended encryption algorithm required for encrypting the PDF file. For +AES-128 encryption, the password supports LATIN-I characters only. For AES-256 encryption, passwords supports +Unicode character set.

  • +
  • content_encryption (ContentEncryption) – Type of content to encrypt in the PDF file. (Optional, use key-value)

  • +
  • permissions (Permissions) – Sets the intended permissions for the encrypted PDF file. This includes permissions to allow +printing, editing and content copying in the PDF document. Permissions can only be used in case the owner +password is set. (Optional, use key-value)

  • +
  • user_password (str) – User password required for opening the encrypted PDF file. Allowed maximum length +for the user password is 128 bytes. (Optional, use key-value)

  • +
  • owner_password (str) – Owner password required to control access permissions in the encrypted PDF file. This +password can also be used to open/view the encrypted PDF file. Allowed maximum length for the owner +password is 128 bytes. (Optional, use key-value)

  • +
+
+
+
+
+get_content_encryption()
+
+
Returns:
+

ContentEncryption for the resulting encrypted PDF file as a string.

+
+
Return type:
+

ContentEncryption

+
+
+
+ +
+
+get_encryption_algorithm()
+
+
Returns:
+

EncryptionAlgorithm of the resulting encrypted PDF file.

+
+
Return type:
+

EncryptionAlgorithm

+
+
+
+ +
+
+get_owner_password()
+
+
Returns:
+

the intended owner password of the resulting encrypted PDF file.

+
+
Return type:
+

str

+
+
+
+ +
+
+get_permissions()
+
+
Returns:
+

Permissions for the resulting encrypted PDF file.

+
+
Return type:
+

Permissions

+
+
+
+ +
+
+get_user_password()
+
+
Returns:
+

the intended user password of the resulting encrypted PDF file.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

Permission

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission(value)
+

Bases: Enum

+

Document Permissions for +ProtectPDFJob

+
+
+COPY_CONTENT = 'COPY_CONTENT'
+

Enables copying of content from the PDF document

+
+ +
+
+EDIT_ANNOTATIONS = 'EDIT_ANNOTATIONS'
+

Enables additions of comments, digital signatures and filling in of forms in a PDF document

+
+ +
+
+EDIT_CONTENT = 'EDIT_CONTENT'
+

Enables all the editing permissions in the PDF document except commenting and page extraction

+
+ +
+
+EDIT_DOCUMENT_ASSEMBLY = 'EDIT_DOCUMENT_ASSEMBLY'
+

Enables insertion, deletion and rotation of pages in a PDF document

+
+ +
+
+EDIT_FILL_AND_SIGN_FORM_FIELDS = 'EDIT_FILL_AND_SIGN_FORM_FIELDS'
+

Enables filling in of forms, digital signature and creation of template pages in a PDF document

+
+ +
+
+PRINT_HIGH_QUALITY = 'PRINT_HIGH_QUALITY'
+

Enables high quality printing of the PDF document

+
+ +
+
+PRINT_LOW_QUALITY = 'PRINT_LOW_QUALITY'
+

Enables low quality printing of the PDF document

+
+ +
+ +
+
+

Permissions

+
+
+class adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.Permissions
+

Bases: object

+

Document Permissions for +ProtectPDFJob

+

Constructs a new Permissions instance.

+
+
+add_permission(permission: Permission)
+

Adds a document Permission +in the permissions set.

+
+
Parameters:
+

permission (Permission) – A document permission; can not be None.

+
+
+
+ +
+
+get_values()
+
+
Returns:
+

the intended set of document permissions values.

+
+
Return type:
+

list

+
+
+
+ +
+ +
+
+

RemoveProtectionParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params.RemoveProtectionParams(password: str)
+

Bases: PDFServicesJobParams

+

Parameters for removing protection from pdf using +RemoveProtectionJob

+
+

Constructs a new RemoveProtectionParams instance.

+
+
+
Parameters:
+

password (str) – the password to be used for removing protection from pdf.

+
+
Returns:
+

A new instance of RemoveProtectionParams

+
+
Return type:
+

RemoveProtectionParams

+
+
+
+
+get_password()
+
+
Returns:
+

Returns the password to be used for removing protection from pdf.

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

ReorderPagesParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params.ReorderPagesParams(asset: Asset, page_ranges: PageRanges)
+

Bases: PDFServicesJobParams

+

Parameters for reordering a pdf using +ReorderPagesJob

+

Constructs a new ReorderPagesParams instance.

+
+
Parameters:
+
    +
  • asset (Asset) – Asset to be reordered, can not be None.

  • +
  • page_ranges (PageRanges) – The page ranges to be used for reordering pages, can not be None.

  • +
+
+
Returns:
+

A new instance of ReorderPagesParams

+
+
Return type:
+

ReorderPagesParams

+
+
+
+
+get_asset()
+
+
Returns:
+

Asset to be reordered.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_page_ranges()
+
+
Returns:
+

PageRanges to be used for reordering pages.

+
+
Return type:
+

PageRanges

+
+
+
+ +
+ +
+
+

ReplacePagesParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.ReplacePagesParams(base_asset: Asset)
+

Bases: PDFServicesJobParams

+

Parameters for replacing pages of a pdf using +ReplacePagesJob

+

Constructs a new ReplacePagesParams instance.

+
+
Parameters:
+

base_asset (Asset) – The base asset to be used for replacing pages, can not be None.

+
+
Returns:
+

A new instance of ReplacePagesParams

+
+
Return type:
+

ReplacePagesParams

+
+
+
+
+add_pages_to_replace(input_asset: ~adobe.pdfservices.operation.io.asset.Asset, base_page: int, *, page_ranges: ~adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges = <adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges object>)
+
+
Parameters:
+
    +
  • input_asset (Asset) – a PDF file for insertion

  • +
  • page_ranges (PageRanges) – page ranges of the input PDF file

  • +
  • base_page (int) – page of the base PDF file

  • +
+
+
+
+ +
+
+get_assets_to_replace()
+
+
Returns:
+

Returns the mapping of base Asset’s page number and Asset to be replaced along +with PageRanges.

+
+
+
+ +
+
+get_base_asset()
+
+
Returns:
+

Returns the base PDF Asset to which pages will be replaced.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

RotatePagesParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams
+

Bases: PDFServicesJobParams

+

Parameters to rotate pages of a pdf using +RotatePagesJob<adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job.>RotatePagesJob

+
+
+add_angle_to_rotate(angle: Angle)
+

Sets the Angle to be used for rotating pages.

+
+
Parameters:
+

angle (Angle) – Angle; can not be None.

+
+
+
+ +
+
+add_angle_to_rotate_for_page_ranges(angle: Angle, page_ranges: PageRanges)
+

Sets the Angle to be used for rotating pages specified in PageRanges.

+
+
Parameters:
+
    +
  • angle (Angle) – Angle; can not be None.

  • +
  • page_ranges (PageRanges) – PageRanges; can not be None.

  • +
+
+
+
+ +
+
+get_page_actions()
+
+
Returns:
+

PageActions to be used for rotating pages.

+
+
Return type:
+

PageActions

+
+
+
+ +
+ +
+
+

Angle

+
+
+class adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.Angle(value)
+

Bases: Enum

+

Represents angles in degrees.

+
+
+ANGLE_180 = 180
+

Represents 180 degrees clockwise rotation

+
+ +
+
+ANGLE_270 = 270
+

Represents 270 degrees clockwise rotation

+
+ +
+
+ANGLE_90 = 90
+

Represents 90 degrees clockwise rotation

+
+ +
+ +
+
+

SplitPDFParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.SplitPDFParams(*, page_ranges: PageRanges | None = None, page_count: int | None = None, file_count: int | None = None)
+

Bases: PDFServicesJobParams

+

Parameters for splitting a pdf using +SplitPDFJob

+

Constructs a new SplitPDFParams instance.

+
+
Parameters:
+
    +
  • page_ranges (PageRanges) – see PageRanges. +(Optional, use key-value)

  • +
  • page_count (int) – The page count to be used for splitting pages. (Optional, use key-value)

  • +
  • file_count (int) – The file count to be used for splitting pages. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of SplitPDFParams

+
+
Return type:
+

SplitPDFParams

+
+
+
+
+get_file_count()
+
+
Returns:
+

Returns the file count to be used for splitting pages.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_page_count()
+
+
Returns:
+

Returns the page count to be used for splitting pages.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_page_ranges()
+
+
Returns:
+

PageRanges to be used for splitting pages.

+
+
Return type:
+

PageRanges

+
+
+
+ +
+ +
+
+

PageRanges

+
+
+class adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges
+

Bases: object

+

Page ranges of a file, inclusive of start and end page index, where page index starts from 1.

+

Constructs a new PageRanges instance with no pages added.

+
+
+add_all()
+

Adds a page range representing all pages.

+
+ +
+
+add_all_from(start: int)
+

Adds a page range from start page index to the last page. Page index starts from 1. +:param start: start page index +:type start: int

+
+ +
+
+add_range(start: int, end: int)
+

Adds a page range. Page indexes start from 1. +:param start: start page index, inclusive +:type start: int +:param end: end page index, inclusive +:type start: int

+
+ +
+
+add_single_page(page: int)
+

Adds a single page. Page index starts from 1. +:param page: single page index +:type page: int

+
+ +
+
+get_ranges()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+
+is_empty()
+

Used internally by this SDK, not intended to be called by clients.

+
+ +
+ +
+
+

PDFServicesJobParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params.PDFServicesJobParams
+

Bases: ABC

+

Represents the basic contract for the params to be used in +PDFServicesJob

+
+ +
+
+

PDFWatermarkParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params.PDFWatermarkParams(*, page_ranges: ~adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges | None = None, watermark_appearance: ~adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.WatermarkAppearance | None = <class 'adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.WatermarkAppearance'>)
+

Bases: PDFServicesJobParams

+

Parameters to Watermark pdf using +PDFWatermarkJob.

+

Constructs a new PDFWatermarkParams instance.

+
+
Parameters:
+
    +
  • page_ranges (PageRanges) – see PageRanges. +(Optional, use key-value)

  • +
  • WatermarkAppearance (WatermarkAppearance) – WatermarkAppearance; Specifies the appearance parameters for watermark +(Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of PDFWatermarkParams

+
+
Return type:
+

PDFWatermarkParams

+
+
+
+
+get_page_ranges()
+
+
Returns:
+

Specifies the page ranges on which watermark has to be applied in the input PDF file.

+
+
Return type:
+

PageRanges

+
+
+
+ +
+
+get_watermark_appearance()
+
+
Parameters:
+

WatermarkAppearance (WatermarkAppearance) – WatermarkAppearance; Specifies the appearance parameters for watermark +(Optional, use key-value)

+
+
+
+ +
+ +
+
+

WatermarkAppearance

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.WatermarkAppearance(*, appear_on_foreground: bool | None = True, opacity: int | None = 100)
+

Bases: object

+

Parameters to Watermark pdf using +PDFWatermarkJob.

+

Constructs a new WatermarkAppearance instance.

+
+
Parameters:
+
    +
  • appear_on_foreground (boolean) – Placement of watermark on the page. Watermark will be either foreground or background on the page. Default is foreground. (Optional, use key-value)

  • +
  • opacity – opacity; Percentage value specifying watermark opacity. Specified as an Integer value from 0 to 100. (Optional, use key-value)

  • +
+
+
Returns:
+

A new instance of PDFWatermarkParams

+
+
Return type:
+

PDFWatermarkParams

+
+
+
+
+get_appear_on_foreground()
+
+
Returns:
+

Placement of watermark on the page. Watermark will be either foreground or background on the page. Default is foreground.

+
+
Return type:
+

boolean

+
+
+
+ +
+
+get_opacity()
+
+
Returns:
+

Percentage value specifying watermark opacity. Specified as an Integer value from 0 to 100 in SDK docs for opacity

+
+
Return type:
+

number

+
+
+
+ +
+ +
+
+

PDFAccessibilityCheckerParams

+
+
+class adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params.PDFAccessibilityCheckerParams(*, page_start: int | None = None, page_end: int | None = None)
+

Bases: PDFServicesJobParams

+

Parameters for Accessibility Checker PDFs using +PDFAccessibilityCheckerJob.

+

Constructs a new PDFAccessibilityCheckerParams instance.

+
+
Parameters:
+
    +
  • page_start (int) – The start page number.

  • +
  • page_end (int) – The end page number.

  • +
+
+
+
+
+get_page_end()
+
+
Returns:
+

return the end page number.

+
+
Return type:
+

int

+
+
+
+ +
+
+get_page_start()
+
+
Returns:
+

return the start page number.

+
+
Return type:
+

int

+
+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/reference/pdfjobs/result.html b/docs/apidocs/4.2.0/reference/pdfjobs/result.html new file mode 100644 index 0000000..3e19d02 --- /dev/null +++ b/docs/apidocs/4.2.0/reference/pdfjobs/result.html @@ -0,0 +1,2209 @@ + + + + + + + + + Result — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Result

+
+
+
+

AutotagPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result.AutotagPDFResult(tagged_pdf: Asset, report: Asset, resource: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +AutotagPDFJob.

+

Constructs a new AutotagPDFResult instance with the tagged PDF asset and report asset.

+
+
Parameters:
+
    +
  • tagged_pdf (Asset) – tagged PDF asset

  • +
  • report (Asset) – report asset

  • +
  • resource (Asset) – resource asset

  • +
+
+
+
+
+get_report()
+
+
Returns:
+

Returns report asset, if an internal asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_resource()
+
+
Returns:
+

The zipped asset associated with the +AutotagPDFJob result, +if an external asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_tagged_pdf()
+
+
Returns:
+

Returns tagged PDF asset, if an internal asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

CombinePDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result.CombinePDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +CombinePDFJob.

+

Constructs a new CombinePDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

CompressPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result.CompressPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +CompressPDFJob

+

Constructs a new CompressPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

CreatePDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.create_pdf_result.CreatePDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +CreatePDFJob .

+

Constructs a new CreatePDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

DeletePagesResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.delete_pages_result.DeletePagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +DeletePagesJob

+

Constructs a new DeletePagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

DocumentMergeResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.document_merge_result.DocumentMergePDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +DocumentMergeJob

+

Constructs a new DocumentMergePDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

ESealPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result.ESealPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +PDFElectronicSealJob.

+

Constructs a new ESealPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

ExportPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.export_pdf_result.ExportPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ExportPDFJob

+

Constructs a new ExportPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

ExportPDFtoImagesResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result.ExportPDFtoImagesResult(assets: [])
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ExportPDFToImagesJob.

+

Constructs a new ExportPDFToImagesResult instance

+
+
Parameters:
+

assets (list) – List of result assets

+
+
+
+
+get_assets()
+
+
Returns:
+

the list of result assets

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

ExtractPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result.ExtractPDFResult(content: Asset, resource: Asset, content_json: {})
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ExtractPDFJob.

+

Constructs a new ExtractPDFResult instance with result content asset, resource asset and resource JSON +object

+
+
Parameters:
+
    +
  • content (Asset) – result content asset

  • +
  • resource (Asset) – result resource asset

  • +
  • content_json (dict) – result content json

  • +
+
+
+
+
+get_content()
+
+
Returns:
+

Returns the content asset containing extracted content of PDF file, if an internal asset was used as +input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_content_json()
+
+
Returns:
+

Returns the content json dictionary containing extracted content of PDF file, if an internal asset +was used as input PDF.

+
+
Return type:
+

dict

+
+
+
+ +
+
+get_resource()
+
+
Returns:
+

Returns the Asset of zip file containing generated resources from extract operation.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

HTMLtoPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result.HTMLtoPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +HTMLtoPDFJob

+

Constructs a new HTMLtoPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

InsertPagesResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.insert_pages_result.InsertPagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +InsertPagesJob

+

Constructs a new InsertPagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

LinearizePDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result.LinearizePDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +LinearizePDFJob

+

Constructs a new LinearizePDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

OCRPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result.OCRPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +OCRPDFJob<adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job.OCRPDFJob.

+

Constructs a new OCRPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

PDFPropertiesResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result.PDFPropertiesResult(pdf_properties_dict: str)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +PDFPropertiesJob.

+

Constructs a new PDFPropertiesResult instance with PDF Properties JSON string.

+
+
Parameters:
+

pdf_properties_dict (str) – PDF Properties JSON String

+
+
+
+
+get_pdf_properties_dict()
+
+
Returns:
+

Returns PDF Properties JSON string.

+
+
Return type:
+

string

+
+
+
+ +
+ +
+
+

ProtectPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result.ProtectPDFResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ProtectPDFJob.

+

Constructs a new ProtectPDFResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

RemoveProtectionResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.remove_protection_result.RemoveProtectionResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +RemoveProtectionJob

+

Constructs a new RemoveProtectionResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

ReorderPagesResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result.ReorderPagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ReorderPagesJob.

+

Constructs a new ReorderPagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

ReplacePagesResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.replace_page_result.ReplacePagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ReplacePagesJob

+

Constructs a new ReplacePagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

RotatePagesResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result.RotatePagesResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +RotatePagesJob.

+

Constructs a new RotatePagesResult instance.

+
+
Parameters:
+

asset (Asset) – result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

SplitPDFResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.split_pdf_result.SplitPDFResult(assets: [], asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +SplitPDFJob.

+

Constructs a new SplitPDFResult instance

+
+
Parameters:
+
    +
  • assets (list) – List of result assets

  • +
  • asset (Asset) – result asset, enclosing zipped output result

  • +
+
+
+
+
+get_asset()
+
+
Returns:
+

The zipped asset associated with the +SplitPDFJob result, if an +external asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_assets()
+
+
Returns:
+

Returns the list of result assets, if an internal asset was used as input PDF.

+
+
Return type:
+

list

+
+
+
+ +
+ +
+
+

PDFServicesJobResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result.PDFServicesJobResult
+

Bases: ABC

+

This is an abstract class that represents the PDFServicesJob +PDFServicesJob result.

+

It will encapsulate the result of +PDFServicesJob

+
+ +
+
+

PDFWatermarkResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.pdf_watermark_result.PDFWatermarkResult(pdf_watermark: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +PDFWatermarkJob.

+

Constructs a new PDFWatermarkResult instance.

+
+
Parameters:
+

asset (Asset) – Result asset

+
+
+
+
+get_asset()
+
+
Returns:
+

Returns watermark PDF asset, if an internal asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

PDFAccessibilityCheckerResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.pdf_accessibility_checker_result.PDFAccessibilityCheckerResult(asset: Asset, report: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +PDFAccessibilityCheckerJob.

+

Constructs a new PDFAccessibilityCheckerResult instance

+
+
Parameters:
+
    +
  • asset (Asset) – result asset, enclosing zipped output result

  • +
  • report – result asset, enclosing zipped output result

  • +
+
+
+
+
+get_asset()
+
+
Returns:
+

The zipped asset associated with the PDFAccessibilityCheckerJob result, if an external asset was used as input PDF.

+
+
Return type:
+

Asset

+
+
+
+ +
+
+get_report()
+
+
Returns:
+

The report contains links to documentation that assist in manually fixing problems using Adobe Acrobat Pro.

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

ImportPDFFormDataResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.import_pdf_form_data_result.ImportPDFFormDataResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ImportPDFFormDataJob

+

Constructs a new ImportPDFFormDataResult instance.

+
+
Parameters:
+

asset (Asset) – result asset containing the PDF with imported form data

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset containing the PDF with imported form data

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+

ExportPDFFormDataResult

+
+
+class adobe.pdfservices.operation.pdfjobs.result.export_pdf_form_data_result.ExportPDFFormDataResult(asset: Asset)
+

Bases: PDFServicesJobResult

+

This class encapsulates the result of +ExportPDFFormDataJob

+

Constructs a new ExportPDFFormDataResult instance.

+
+
Parameters:
+

asset (Asset) – result asset containing the extracted form data

+
+
+
+
+get_asset()
+
+
Returns:
+

the result Asset containing the extracted form data in JSON format

+
+
Return type:
+

Asset

+
+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/search.html b/docs/apidocs/4.2.0/search.html new file mode 100644 index 0000000..fcdcf8c --- /dev/null +++ b/docs/apidocs/4.2.0/search.html @@ -0,0 +1,1359 @@ + + + + + + + + Search — pdfservices-sdk 3.0.0 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2024, adobe.

+
+ + + +
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/docs/apidocs/4.2.0/searchindex.js b/docs/apidocs/4.2.0/searchindex.js new file mode 100644 index 0000000..a83c5f9 --- /dev/null +++ b/docs/apidocs/4.2.0/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"API Reference": [[74, null]], "Angle": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle"]], "AppearanceItem": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item"]], "AppearanceOptions": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options"]], "Asset": [[75, "asset"]], "Authentication": [[69, null]], "AutotagPDFJob": [[77, "autotagpdfjob"]], "AutotagPDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params"]], "AutotagPDFResult": [[79, "autotagpdfresult"]], "CSCAuthContext": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context"]], "CSCCredentials": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials"]], "CallbackNotifierData": [[71, "callbacknotifierdata"]], "ClientConfig": [[70, "clientconfig"]], "CloudAsset": [[75, "cloudasset"]], "CombinePDFJob": [[77, "combinepdfjob"]], "CombinePDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params"]], "CombinePDFResult": [[79, "combinepdfresult"]], "CompressPDFJob": [[77, "compresspdfjob"]], "CompressPDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params"]], "CompressPDFResult": [[79, "compresspdfresult"]], "CompressionLevel": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level"]], "Config": [[70, null]], "ContentEncryption": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption"]], "Contents:": [[67, null], [74, null]], "CreatePDFFromExcelParams": [[78, "createpdffromexcelparams"]], "CreatePDFFromPPTParams": [[78, "createpdffrompptparams"]], "CreatePDFFromWordParams": [[78, "createpdffromwordparams"]], "CreatePDFJob": [[77, "createpdfjob"]], "CreatePDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams"]], "CreatePDFResult": [[79, "createpdfresult"]], "Credentials": [[69, "credentials"]], "DeletePagesJob": [[77, "deletepagesjob"]], "DeletePagesParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params"]], "DeletePagesResult": [[79, "deletepagesresult"]], "DocumentLanguage": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language"], [78, "id1"], [78, "id2"]], "DocumentLevelPermission": [[78, "documentlevelpermission"]], "DocumentMergeJob": [[77, "documentmergejob"]], "DocumentMergeParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params"]], "DocumentMergeResult": [[79, "documentmergeresult"]], "ESealPDFResult": [[79, "esealpdfresult"]], "EncryptionAlgorithm": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm"]], "Exceptions": [[73, null]], "ExportOCRLocale": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale"]], "ExportPDFFormDataJob": [[77, "exportpdfformdatajob"]], "ExportPDFFormDataParams": [[78, "exportpdfformdataparams"]], "ExportPDFFormDataResult": [[79, "exportpdfformdataresult"]], "ExportPDFJob": [[77, "exportpdfjob"]], "ExportPDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params"]], "ExportPDFResult": [[79, "exportpdfresult"]], "ExportPDFTargetFormat": [[78, "exportpdftargetformat"]], "ExportPDFToImagesOutputType": [[78, "exportpdftoimagesoutputtype"]], "ExportPDFToImagesTargetFormat": [[78, "exportpdftoimagestargetformat"]], "ExportPDFtoImagesJob": [[77, "exportpdftoimagesjob"]], "ExportPDFtoImagesParams": [[78, "exportpdftoimagesparams"]], "ExportPDFtoImagesResult": [[79, "exportpdftoimagesresult"]], "ExternalAsset": [[75, "externalasset"]], "ExternalStorageType": [[75, "externalstoragetype"]], "ExtractElementType": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type"]], "ExtractPDFJob": [[77, "extractpdfjob"]], "ExtractPDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params"]], "ExtractPDFResult": [[79, "extractpdfresult"]], "ExtractRenditionsElementType": [[78, "extractrenditionselementtype"]], "FieldLocation": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.field_location"]], "FieldOptions": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.field_options"]], "Fragments": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments"]], "HTMLtoPDFJob": [[77, "htmltopdfjob"]], "HTMLtoPDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params"]], "HTMLtoPDFResult": [[79, "htmltopdfresult"]], "IO": [[75, null]], "ImportPDFFormDataJob": [[77, "importpdfformdatajob"]], "ImportPDFFormDataParams": [[78, "importpdfformdataparams"]], "ImportPDFFormDataResult": [[79, "importpdfformdataresult"]], "Indices and tables": [[67, "indices-and-tables"]], "InsertPagesJob": [[77, "insertpagesjob"]], "InsertPagesParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params"]], "InsertPagesResult": [[79, "insertpagesresult"]], "Jobs": [[77, null]], "LinearizePDFJob": [[77, "linearizepdfjob"]], "LinearizePDFResult": [[79, "linearizepdfresult"]], "Module contents": [[0, "module-adobe"], [1, "module-adobe.pdfservices"], [2, "module-adobe.pdfservices.operation"], [3, "module-adobe.pdfservices.operation.auth"], [4, "module-adobe.pdfservices.operation.config"], [5, "module-adobe.pdfservices.operation.config.notifier"], [6, "module-adobe.pdfservices.operation.config.proxy"], [7, "module-adobe.pdfservices.operation.exception"], [8, "module-adobe.pdfservices.operation.internal"], [9, "module-adobe.pdfservices.operation.internal.api"], [10, "module-adobe.pdfservices.operation.internal.api.dto"], [11, "module-adobe.pdfservices.operation.internal.api.dto.request"], [12, "module-adobe.pdfservices.operation.internal.api.dto.request.autotagpdf"], [13, "module-adobe.pdfservices.operation.internal.api.dto.request.combinepdf"], [14, "module-adobe.pdfservices.operation.internal.api.dto.request.compresspdf"], [15, "module-adobe.pdfservices.operation.internal.api.dto.request.createpdf"], [16, "module-adobe.pdfservices.operation.internal.api.dto.request.document_generation"], [17, "module-adobe.pdfservices.operation.internal.api.dto.request.esealpdf"], [18, "module-adobe.pdfservices.operation.internal.api.dto.request.exportpdf"], [19, "module-adobe.pdfservices.operation.internal.api.dto.request.extract_pdf"], [20, "module-adobe.pdfservices.operation.internal.api.dto.request.htmltopdf"], [21, "module-adobe.pdfservices.operation.internal.api.dto.request.linearizepdf"], [22, "module-adobe.pdfservices.operation.internal.api.dto.request.ocrpdf"], [23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation"], [24, "module-adobe.pdfservices.operation.internal.api.dto.request.pdf_properties"], [25, "module-adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api"], [26, "module-adobe.pdfservices.operation.internal.api.dto.request.pdftoimage"], [27, "module-adobe.pdfservices.operation.internal.api.dto.request.protect_pdf"], [28, "module-adobe.pdfservices.operation.internal.api.dto.request.remove_protection"], [29, "module-adobe.pdfservices.operation.internal.api.dto.request.splitpdf"], [30, "module-adobe.pdfservices.operation.internal.api.dto.response"], [31, "module-adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api"], [32, "module-adobe.pdfservices.operation.internal.auth"], [33, "module-adobe.pdfservices.operation.internal.constants"], [34, "module-adobe.pdfservices.operation.internal.http"], [35, "module-adobe.pdfservices.operation.internal.params"], [36, "module-adobe.pdfservices.operation.internal.util"], [37, "module-adobe.pdfservices.operation.io"], [38, "module-adobe.pdfservices.operation.pdfjobs"], [39, "module-adobe.pdfservices.operation.pdfjobs.jobs"], [40, "module-contents"], [41, "module-adobe.pdfservices.operation.pdfjobs.params"], [42, "module-adobe.pdfservices.operation.pdfjobs.params.autotag_pdf"], [43, "module-adobe.pdfservices.operation.pdfjobs.params.combine_pdf"], [44, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf"], [45, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf"], [46, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel"], [47, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt"], [48, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.word"], [49, "module-adobe.pdfservices.operation.pdfjobs.params.delete_pages"], [50, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge"], [51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal"], [52, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf"], [53, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf"], [54, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf"], [55, "module-contents"], [56, "module-adobe.pdfservices.operation.pdfjobs.params.insert_pages"], [57, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf"], [58, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_properties"], [59, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image"], [60, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf"], [61, "module-adobe.pdfservices.operation.pdfjobs.params.remove_protection"], [62, "module-adobe.pdfservices.operation.pdfjobs.params.reorder_pages"], [63, "module-adobe.pdfservices.operation.pdfjobs.params.replace_pages"], [64, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages"], [65, "module-adobe.pdfservices.operation.pdfjobs.params.split_pdf"], [66, "module-adobe.pdfservices.operation.pdfjobs.result"]], "Notifier Config": [[71, null]], "NotifierConfig": [[71, "notifierconfig"]], "NotifierData": [[71, "notifierdata"]], "NotifierType": [[71, "notifiertype"]], "OCRPDFJob": [[77, "ocrpdfjob"]], "OCRPDFResult": [[79, "ocrpdfresult"]], "OCRParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params"]], "OCRSupportedLocale": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale"]], "OCRSupportedType": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type"]], "OutputFormat": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format"]], "PDF Jobs": [[76, null]], "PDFAccessibilityCheckerJob": [[77, "pdfaccessibilitycheckerjob"]], "PDFAccessibilityCheckerParams": [[78, "pdfaccessibilitycheckerparams"]], "PDFAccessibilityCheckerResult": [[79, "pdfaccessibilitycheckerresult"]], "PDFElectronicSealJob": [[77, "pdfelectronicsealjob"]], "PDFElectronicSealParams": [[78, "pdfelectronicsealparams"]], "PDFPropertiesJob": [[77, "pdfpropertiesjob"]], "PDFPropertiesParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params"]], "PDFPropertiesResult": [[79, "pdfpropertiesresult"]], "PDFServices": [[74, "pdfservices"]], "PDFServicesJob": [[74, "pdfservicesjob"]], "PDFServicesJobParams": [[78, "pdfservicesjobparams"]], "PDFServicesJobResult": [[79, "pdfservicesjobresult"]], "PDFServicesJobStatus": [[74, "pdfservicesjobstatus"]], "PDFServicesJobStatusResponse": [[74, "pdfservicesjobstatusresponse"]], "PDFServicesMediaType": [[74, "pdfservicesmediatype"]], "PDFServicesResponse": [[74, "pdfservicesresponse"]], "PDFWatermarkJob": [[77, "pdfwatermarkjob"]], "PDFWatermarkParams": [[78, "pdfwatermarkparams"]], "PDFWatermarkResult": [[79, "pdfwatermarkresult"]], "PageLayout": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout"]], "PageRanges": [[78, "pageranges"]], "Params": [[78, null]], "PasswordProtectParams": [[78, "passwordprotectparams"]], "Permission": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission"]], "Permissions": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions"]], "ProtectPDFJob": [[77, "protectpdfjob"]], "ProtectPDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params"]], "ProtectPDFResult": [[79, "protectpdfresult"]], "Proxy Config": [[72, null]], "ProxyAuthenticationCredentials": [[72, "proxyauthenticationcredentials"]], "ProxyScheme": [[72, "proxyscheme"]], "ProxyServerConfig": [[72, "proxyserverconfig"]], "RFC3161TSAOptions": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options"]], "Region": [[74, "region"]], "RemoveProtectionJob": [[77, "removeprotectionjob"]], "RemoveProtectionParams": [[78, "removeprotectionparams"]], "RemoveProtectionResult": [[79, "removeprotectionresult"]], "ReorderPagesJob": [[77, "reorderpagesjob"]], "ReorderPagesParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params"]], "ReorderPagesResult": [[79, "reorderpagesresult"]], "ReplacePagesJob": [[77, "replacepagesjob"]], "ReplacePagesParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params"]], "ReplacePagesResult": [[79, "replacepagesresult"]], "Result": [[79, null]], "RotatePagesJob": [[77, "rotatepagesjob"]], "RotatePagesParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params"]], "RotatePagesResult": [[79, "rotatepagesresult"]], "SdkException": [[73, "module-adobe.pdfservices.operation.exception.exceptions.SdkException"]], "ServiceApiException": [[73, "module-adobe.pdfservices.operation.exception.exceptions.ServiceApiException"]], "ServicePrincipalCredentials": [[69, "serviceprincipalcredentials"]], "ServiceUsageException": [[73, "serviceusageexception"]], "SignatureFormat": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format"]], "SplitPDFJob": [[77, "splitpdfjob"]], "SplitPDFParams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params"]], "SplitPDFResult": [[79, "splitpdfresult"]], "StreamAsset": [[75, "streamasset"]], "Submodules": [[2, "submodules"], [3, "submodules"], [4, "submodules"], [5, "submodules"], [6, "submodules"], [7, "submodules"], [8, "submodules"], [9, "submodules"], [11, "submodules"], [12, "submodules"], [13, "submodules"], [14, "submodules"], [15, "submodules"], [16, "submodules"], [17, "submodules"], [18, "submodules"], [19, "submodules"], [20, "submodules"], [21, "submodules"], [22, "submodules"], [23, "submodules"], [24, "submodules"], [25, "submodules"], [26, "submodules"], [27, "submodules"], [28, "submodules"], [29, "submodules"], [30, "submodules"], [31, "submodules"], [32, "submodules"], [33, "submodules"], [34, "submodules"], [35, "submodules"], [36, "submodules"], [37, "submodules"], [39, "submodules"], [40, "submodules"], [41, "submodules"], [42, "submodules"], [43, "submodules"], [44, "submodules"], [45, "submodules"], [46, "submodules"], [47, "submodules"], [48, "submodules"], [49, "submodules"], [50, "submodules"], [51, "submodules"], [52, "submodules"], [53, "submodules"], [54, "submodules"], [55, "submodules"], [56, "submodules"], [57, "submodules"], [58, "submodules"], [59, "submodules"], [60, "submodules"], [61, "submodules"], [62, "submodules"], [63, "submodules"], [64, "submodules"], [65, "submodules"], [66, "submodules"]], "Subpackages": [[0, "subpackages"], [1, "subpackages"], [2, "subpackages"], [4, "subpackages"], [8, "subpackages"], [9, "subpackages"], [10, "subpackages"], [11, "subpackages"], [30, "subpackages"], [38, "subpackages"], [41, "subpackages"], [45, "subpackages"]], "TSABasicAuthCredentials": [[78, "tsabasicauthcredentials"]], "TSAOptions": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options"]], "TableStructureType": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type"]], "UsernamePasswordCredentials": [[72, "usernamepasswordcredentials"]], "WatermarkAppearance": [[78, "watermarkappearance"]], "Welcome to pdfservices-sdk\u2019s documentation!": [[67, null]], "adobe package": [[0, null]], "adobe.pdfservices package": [[1, null]], "adobe.pdfservices.operation package": [[2, null]], "adobe.pdfservices.operation.auth package": [[3, null]], "adobe.pdfservices.operation.auth.credentials module": [[3, "module-adobe.pdfservices.operation.auth.credentials"]], "adobe.pdfservices.operation.auth.service_principal_credentials module": [[3, "module-adobe.pdfservices.operation.auth.service_principal_credentials"]], "adobe.pdfservices.operation.config package": [[4, null]], "adobe.pdfservices.operation.config.client_config module": [[4, "module-adobe.pdfservices.operation.config.client_config"]], "adobe.pdfservices.operation.config.notifier package": [[5, null]], "adobe.pdfservices.operation.config.notifier.callback_notifier_data module": [[5, "module-adobe.pdfservices.operation.config.notifier.callback_notifier_data"]], "adobe.pdfservices.operation.config.notifier.notifier_config module": [[5, "module-adobe.pdfservices.operation.config.notifier.notifier_config"]], "adobe.pdfservices.operation.config.notifier.notifier_data module": [[5, "module-adobe.pdfservices.operation.config.notifier.notifier_data"]], "adobe.pdfservices.operation.config.notifier.notifier_type module": [[5, "module-adobe.pdfservices.operation.config.notifier.notifier_type"]], "adobe.pdfservices.operation.config.proxy package": [[6, null]], "adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials module": [[6, "module-adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials"]], "adobe.pdfservices.operation.config.proxy.proxy_scheme module": [[6, "module-adobe.pdfservices.operation.config.proxy.proxy_scheme"]], "adobe.pdfservices.operation.config.proxy.proxy_server_config module": [[6, "module-adobe.pdfservices.operation.config.proxy.proxy_server_config"]], "adobe.pdfservices.operation.config.proxy.username_password_credentials module": [[6, "module-adobe.pdfservices.operation.config.proxy.username_password_credentials"]], "adobe.pdfservices.operation.exception package": [[7, null]], "adobe.pdfservices.operation.exception.exceptions module": [[7, "module-adobe.pdfservices.operation.exception.exceptions"]], "adobe.pdfservices.operation.internal package": [[8, null]], "adobe.pdfservices.operation.internal.api package": [[9, null]], "adobe.pdfservices.operation.internal.api.dto package": [[10, null]], "adobe.pdfservices.operation.internal.api.dto.request package": [[11, null]], "adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request module": [[11, "module-adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf package": [[12, null]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request module": [[12, "module-adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request module": [[12, "module-adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload module": [[12, "module-adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.combinepdf package": [[13, null]], "adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request module": [[13, "module-adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request module": [[13, "module-adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf package": [[14, null]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request module": [[14, "module-adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request module": [[14, "module-adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload module": [[14, "module-adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf package": [[15, null]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request module": [[15, "module-adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request module": [[15, "module-adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload module": [[15, "module-adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation package": [[16, null]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request module": [[16, "module-adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request module": [[16, "module-adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload module": [[16, "module-adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.esealpdf package": [[17, null]], "adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request module": [[17, "module-adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request module": [[17, "module-adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf package": [[18, null]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request module": [[18, "module-adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request module": [[18, "module-adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload module": [[18, "module-adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf package": [[19, null]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request module": [[19, "module-adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request module": [[19, "module-adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload module": [[19, "module-adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf package": [[20, null]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request module": [[20, "module-adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request module": [[20, "module-adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload module": [[20, "module-adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf package": [[21, null]], "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request module": [[21, "module-adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request module": [[21, "module-adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf package": [[22, null]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request module": [[22, "module-adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request module": [[22, "module-adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload module": [[22, "module-adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation package": [[23, null]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action module": [[23, "module-adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties package": [[24, null]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request module": [[24, "module-adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request module": [[24, "module-adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload module": [[24, "module-adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api package": [[25, null]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request module": [[25, "module-adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage package": [[26, null]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request module": [[26, "module-adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request module": [[26, "module-adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload module": [[26, "module-adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf package": [[27, null]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request module": [[27, "module-adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request module": [[27, "module-adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload module": [[27, "module-adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection package": [[28, null]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request module": [[28, "module-adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request module": [[28, "module-adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload module": [[28, "module-adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf package": [[29, null]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request module": [[29, "module-adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request module": [[29, "module-adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload module": [[29, "module-adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.response package": [[30, null]], "adobe.pdfservices.operation.internal.api.dto.response.job_status module": [[30, "module-adobe.pdfservices.operation.internal.api.dto.response.job_status"]], "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api package": [[31, null]], "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response module": [[31, "module-adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response"]], "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response module": [[31, "module-adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response"]], "adobe.pdfservices.operation.internal.api.pdf_services_api module": [[9, "module-adobe.pdfservices.operation.internal.api.pdf_services_api"]], "adobe.pdfservices.operation.internal.api.storage_api module": [[9, "module-adobe.pdfservices.operation.internal.api.storage_api"]], "adobe.pdfservices.operation.internal.auth package": [[32, null]], "adobe.pdfservices.operation.internal.auth.auth_factory module": [[32, "module-adobe.pdfservices.operation.internal.auth.auth_factory"]], "adobe.pdfservices.operation.internal.auth.authenticator module": [[32, "module-adobe.pdfservices.operation.internal.auth.authenticator"]], "adobe.pdfservices.operation.internal.auth.service_principal_authenticator module": [[32, "module-adobe.pdfservices.operation.internal.auth.service_principal_authenticator"]], "adobe.pdfservices.operation.internal.auth.service_token_authenticator module": [[32, "module-adobe.pdfservices.operation.internal.auth.service_token_authenticator"]], "adobe.pdfservices.operation.internal.auth.service_token_credentials module": [[32, "module-adobe.pdfservices.operation.internal.auth.service_token_credentials"]], "adobe.pdfservices.operation.internal.auth.session_token module": [[32, "module-adobe.pdfservices.operation.internal.auth.session_token"]], "adobe.pdfservices.operation.internal.constants package": [[33, null]], "adobe.pdfservices.operation.internal.constants.custom_error_messages module": [[33, "module-adobe.pdfservices.operation.internal.constants.custom_error_messages"]], "adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map module": [[33, "module-adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map"]], "adobe.pdfservices.operation.internal.constants.pdf_services_uri module": [[33, "module-adobe.pdfservices.operation.internal.constants.pdf_services_uri"]], "adobe.pdfservices.operation.internal.constants.request_key module": [[33, "module-adobe.pdfservices.operation.internal.constants.request_key"]], "adobe.pdfservices.operation.internal.constants.service_constants module": [[33, "module-adobe.pdfservices.operation.internal.constants.service_constants"]], "adobe.pdfservices.operation.internal.exceptions module": [[8, "module-adobe.pdfservices.operation.internal.exceptions"]], "adobe.pdfservices.operation.internal.execution_context module": [[8, "module-adobe.pdfservices.operation.internal.execution_context"]], "adobe.pdfservices.operation.internal.http package": [[34, null]], "adobe.pdfservices.operation.internal.http.http_client module": [[34, "module-adobe.pdfservices.operation.internal.http.http_client"]], "adobe.pdfservices.operation.internal.http.http_method module": [[34, "module-adobe.pdfservices.operation.internal.http.http_method"]], "adobe.pdfservices.operation.internal.http.http_request module": [[34, "module-adobe.pdfservices.operation.internal.http.http_request"]], "adobe.pdfservices.operation.internal.http.request_header_const module": [[34, "module-adobe.pdfservices.operation.internal.http.request_header_const"]], "adobe.pdfservices.operation.internal.http.response_util module": [[34, "module-adobe.pdfservices.operation.internal.http.response_util"]], "adobe.pdfservices.operation.internal.internal_client_config module": [[8, "adobe-pdfservices-operation-internal-internal-client-config-module"]], "adobe.pdfservices.operation.internal.params package": [[35, null]], "adobe.pdfservices.operation.internal.params.combine_pdf_job_input module": [[35, "module-adobe.pdfservices.operation.internal.params.combine_pdf_job_input"]], "adobe.pdfservices.operation.internal.params.page_range module": [[35, "module-adobe.pdfservices.operation.internal.params.page_range"]], "adobe.pdfservices.operation.internal.pdf_services_helper module": [[8, "module-adobe.pdfservices.operation.internal.pdf_services_helper"]], "adobe.pdfservices.operation.internal.util package": [[36, null]], "adobe.pdfservices.operation.internal.util.asset_upload_util module": [[36, "module-adobe.pdfservices.operation.internal.util.asset_upload_util"]], "adobe.pdfservices.operation.internal.util.enforce_types module": [[36, "module-adobe.pdfservices.operation.internal.util.enforce_types"]], "adobe.pdfservices.operation.internal.util.file_utils module": [[36, "module-adobe.pdfservices.operation.internal.util.file_utils"]], "adobe.pdfservices.operation.internal.util.json_hint_encoder module": [[36, "module-adobe.pdfservices.operation.internal.util.json_hint_encoder"]], "adobe.pdfservices.operation.internal.util.object_util module": [[36, "module-adobe.pdfservices.operation.internal.util.object_util"]], "adobe.pdfservices.operation.internal.util.path_util module": [[36, "module-adobe.pdfservices.operation.internal.util.path_util"]], "adobe.pdfservices.operation.internal.util.string_util module": [[36, "module-adobe.pdfservices.operation.internal.util.string_util"]], "adobe.pdfservices.operation.internal.util.validation_util module": [[36, "module-adobe.pdfservices.operation.internal.util.validation_util"]], "adobe.pdfservices.operation.io package": [[37, null]], "adobe.pdfservices.operation.io.asset module": [[37, "module-adobe.pdfservices.operation.io.asset"]], "adobe.pdfservices.operation.io.cloud_asset module": [[37, "module-adobe.pdfservices.operation.io.cloud_asset"]], "adobe.pdfservices.operation.io.external_asset module": [[37, "module-adobe.pdfservices.operation.io.external_asset"]], "adobe.pdfservices.operation.io.external_storage_type module": [[37, "module-adobe.pdfservices.operation.io.external_storage_type"]], "adobe.pdfservices.operation.io.stream_asset module": [[37, "module-adobe.pdfservices.operation.io.stream_asset"]], "adobe.pdfservices.operation.pdf_services module": [[2, "module-adobe.pdfservices.operation.pdf_services"]], "adobe.pdfservices.operation.pdf_services_job module": [[2, "module-adobe.pdfservices.operation.pdf_services_job"]], "adobe.pdfservices.operation.pdf_services_job_status module": [[2, "module-adobe.pdfservices.operation.pdf_services_job_status"]], "adobe.pdfservices.operation.pdf_services_job_status_response module": [[2, "module-adobe.pdfservices.operation.pdf_services_job_status_response"]], "adobe.pdfservices.operation.pdf_services_media_type module": [[2, "module-adobe.pdfservices.operation.pdf_services_media_type"]], "adobe.pdfservices.operation.pdf_services_response module": [[2, "module-adobe.pdfservices.operation.pdf_services_response"]], "adobe.pdfservices.operation.pdfjobs package": [[38, null]], "adobe.pdfservices.operation.pdfjobs.jobs package": [[39, null]], "adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.eseal_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.eseal_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.export\\_pdf\\_form\\_data package": [[40, null]], "adobe.pdfservices.operation.pdfjobs.jobs.export\\_pdf\\_form\\_data.export\\_pdf\\_form\\_data\\_job module": [[40, "adobe-pdfservices-operation-pdfjobs-jobs-export-pdf-form-data-export-pdf-form-data-job-module"]], "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job module": [[39, "module-adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.params package": [[41, null]], "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf package": [[42, null]], "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params module": [[42, "module-adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.combine_pdf package": [[43, null]], "adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params module": [[43, "module-adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf package": [[44, null]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params module": [[44, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level module": [[44, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf package": [[45, null]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams module": [[45, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel package": [[46, null]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params module": [[46, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language module": [[46, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt package": [[47, null]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params module": [[47, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language module": [[47, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word package": [[48, null]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params module": [[48, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language module": [[48, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language"]], "adobe.pdfservices.operation.pdfjobs.params.delete_pages package": [[49, null]], "adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params module": [[49, "module-adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge package": [[50, null]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params module": [[50, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments module": [[50, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format module": [[50, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format"]], "adobe.pdfservices.operation.pdfjobs.params.eseal package": [[51, null]], "adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.field_location"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.field_options"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options module": [[51, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf package": [[52, null]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale module": [[52, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params module": [[52, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format module": [[52, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf package": [[53, null]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type module": [[53, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params module": [[53, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type module": [[53, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type module": [[53, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type"]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf package": [[54, null]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params module": [[54, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout module": [[54, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout"]], "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data package": [[55, null]], "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params module": [[55, "adobe-pdfservices-operation-pdfjobs-params-import-pdf-form-data-import-pdf-form-data-params-module"]], "adobe.pdfservices.operation.pdfjobs.params.insert_pages package": [[56, null]], "adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params module": [[56, "module-adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf package": [[57, null]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params module": [[57, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale module": [[57, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type module": [[57, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type"]], "adobe.pdfservices.operation.pdfjobs.params.page_ranges module": [[41, "module-adobe.pdfservices.operation.pdfjobs.params.page_ranges"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_properties package": [[58, null]], "adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params module": [[58, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params module": [[41, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image package": [[59, null]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type module": [[59, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params module": [[59, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format module": [[59, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf package": [[60, null]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption module": [[60, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm module": [[60, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params module": [[60, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission module": [[60, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions module": [[60, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params module": [[60, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.remove_protection package": [[61, null]], "adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params module": [[61, "adobe-pdfservices-operation-pdfjobs-params-remove-protection-remove-protection-params-module"]], "adobe.pdfservices.operation.pdfjobs.params.reorder_pages package": [[62, null]], "adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params module": [[62, "module-adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.replace_pages package": [[63, null]], "adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params module": [[63, "module-adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages package": [[64, null]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle module": [[64, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle"]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params module": [[64, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.split_pdf package": [[65, null]], "adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params module": [[65, "module-adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.result package": [[66, null]], "adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.create_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.create_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.delete_pages_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.delete_pages_result"]], "adobe.pdfservices.operation.pdfjobs.result.document_merge_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.document_merge_result"]], "adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.export_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.export_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result"]], "adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.insert_pages_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.insert_pages_result"]], "adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result"]], "adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.remove_protection_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.remove_protection_result"]], "adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result"]], "adobe.pdfservices.operation.pdfjobs.result.replace_page_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.replace_page_result"]], "adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result"]], "adobe.pdfservices.operation.pdfjobs.result.split_pdf_result module": [[66, "module-adobe.pdfservices.operation.pdfjobs.result.split_pdf_result"]], "adobe.pdfservices.operation.region module": [[2, "module-adobe.pdfservices.operation.region"]], "src": [[68, null]]}, "docnames": ["adobe", "adobe.pdfservices", "adobe.pdfservices.operation", "adobe.pdfservices.operation.auth", "adobe.pdfservices.operation.config", "adobe.pdfservices.operation.config.notifier", "adobe.pdfservices.operation.config.proxy", "adobe.pdfservices.operation.exception", "adobe.pdfservices.operation.internal", "adobe.pdfservices.operation.internal.api", "adobe.pdfservices.operation.internal.api.dto", "adobe.pdfservices.operation.internal.api.dto.request", "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf", "adobe.pdfservices.operation.internal.api.dto.request.combinepdf", "adobe.pdfservices.operation.internal.api.dto.request.compresspdf", "adobe.pdfservices.operation.internal.api.dto.request.createpdf", "adobe.pdfservices.operation.internal.api.dto.request.document_generation", "adobe.pdfservices.operation.internal.api.dto.request.esealpdf", "adobe.pdfservices.operation.internal.api.dto.request.exportpdf", "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf", "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf", "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf", "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf", "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation", "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties", "adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api", "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage", "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf", "adobe.pdfservices.operation.internal.api.dto.request.remove_protection", "adobe.pdfservices.operation.internal.api.dto.request.splitpdf", "adobe.pdfservices.operation.internal.api.dto.response", "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api", "adobe.pdfservices.operation.internal.auth", "adobe.pdfservices.operation.internal.constants", "adobe.pdfservices.operation.internal.http", "adobe.pdfservices.operation.internal.params", "adobe.pdfservices.operation.internal.util", "adobe.pdfservices.operation.io", "adobe.pdfservices.operation.pdfjobs", "adobe.pdfservices.operation.pdfjobs.jobs", "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data", "adobe.pdfservices.operation.pdfjobs.params", "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf", "adobe.pdfservices.operation.pdfjobs.params.combine_pdf", "adobe.pdfservices.operation.pdfjobs.params.compress_pdf", "adobe.pdfservices.operation.pdfjobs.params.create_pdf", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word", "adobe.pdfservices.operation.pdfjobs.params.delete_pages", "adobe.pdfservices.operation.pdfjobs.params.documentmerge", "adobe.pdfservices.operation.pdfjobs.params.eseal", "adobe.pdfservices.operation.pdfjobs.params.export_pdf", "adobe.pdfservices.operation.pdfjobs.params.extract_pdf", "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf", "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data", "adobe.pdfservices.operation.pdfjobs.params.insert_pages", "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf", "adobe.pdfservices.operation.pdfjobs.params.pdf_properties", "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image", "adobe.pdfservices.operation.pdfjobs.params.protect_pdf", "adobe.pdfservices.operation.pdfjobs.params.remove_protection", "adobe.pdfservices.operation.pdfjobs.params.reorder_pages", "adobe.pdfservices.operation.pdfjobs.params.replace_pages", "adobe.pdfservices.operation.pdfjobs.params.rotate_pages", "adobe.pdfservices.operation.pdfjobs.params.split_pdf", "adobe.pdfservices.operation.pdfjobs.result", "index", "modules", "reference/auth", "reference/config", "reference/config/notifier", "reference/config/proxy", "reference/exception", "reference/index", "reference/io", "reference/pdfjobs", "reference/pdfjobs/jobs", "reference/pdfjobs/params", "reference/pdfjobs/result"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["adobe.rst", "adobe.pdfservices.rst", "adobe.pdfservices.operation.rst", "adobe.pdfservices.operation.auth.rst", "adobe.pdfservices.operation.config.rst", "adobe.pdfservices.operation.config.notifier.rst", "adobe.pdfservices.operation.config.proxy.rst", "adobe.pdfservices.operation.exception.rst", "adobe.pdfservices.operation.internal.rst", "adobe.pdfservices.operation.internal.api.rst", "adobe.pdfservices.operation.internal.api.dto.rst", "adobe.pdfservices.operation.internal.api.dto.request.rst", "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.combinepdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.createpdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.document_generation.rst", "adobe.pdfservices.operation.internal.api.dto.request.esealpdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rst", "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.rst", "adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.rst", "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.rst", "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.rst", "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.rst", "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.rst", "adobe.pdfservices.operation.internal.api.dto.response.rst", "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.rst", "adobe.pdfservices.operation.internal.auth.rst", "adobe.pdfservices.operation.internal.constants.rst", "adobe.pdfservices.operation.internal.http.rst", "adobe.pdfservices.operation.internal.params.rst", "adobe.pdfservices.operation.internal.util.rst", "adobe.pdfservices.operation.io.rst", "adobe.pdfservices.operation.pdfjobs.rst", "adobe.pdfservices.operation.pdfjobs.jobs.rst", "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data.rst", "adobe.pdfservices.operation.pdfjobs.params.rst", "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.combine_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.rst", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.rst", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.rst", "adobe.pdfservices.operation.pdfjobs.params.delete_pages.rst", "adobe.pdfservices.operation.pdfjobs.params.documentmerge.rst", "adobe.pdfservices.operation.pdfjobs.params.eseal.rst", "adobe.pdfservices.operation.pdfjobs.params.export_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.rst", "adobe.pdfservices.operation.pdfjobs.params.insert_pages.rst", "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.pdf_properties.rst", "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.rst", "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.rst", "adobe.pdfservices.operation.pdfjobs.params.remove_protection.rst", "adobe.pdfservices.operation.pdfjobs.params.reorder_pages.rst", "adobe.pdfservices.operation.pdfjobs.params.replace_pages.rst", "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rst", "adobe.pdfservices.operation.pdfjobs.params.split_pdf.rst", "adobe.pdfservices.operation.pdfjobs.result.rst", "index.rst", "modules.rst", "reference/auth.rst", "reference/config.rst", "reference/config/notifier.rst", "reference/config/proxy.rst", "reference/exception.rst", "reference/index.rst", "reference/io.rst", "reference/pdfjobs.rst", "reference/pdfjobs/jobs.rst", "reference/pdfjobs/params.rst", "reference/pdfjobs/result.rst"], "indexentries": {"add_all() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.pageranges method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges.add_all", false]], "add_all_from() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.pageranges method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges.add_all_from", false]], "add_angle_to_rotate() (adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.rotatepagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams.add_angle_to_rotate", false]], "add_angle_to_rotate_for_page_ranges() (adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.rotatepagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams.add_angle_to_rotate_for_page_ranges", false]], "add_asset() (adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.combinepdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.CombinePDFParams.add_asset", false]], "add_fragment() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.fragments method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments.add_fragment", false]], "add_fragments() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.fragments method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments.add_fragments", false]], "add_item() (adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.appearanceoptions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.AppearanceOptions.add_item", false]], "add_pages_to_insert() (adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.insertpagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.InsertPagesParams.add_pages_to_insert", false]], "add_pages_to_replace() (adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.replacepagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.ReplacePagesParams.add_pages_to_replace", false]], "add_permission() (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.permissions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.Permissions.add_permission", false]], "add_range() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.pageranges method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges.add_range", false]], "add_single_page() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.pageranges method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges.add_single_page", false]], "adobe.pdfservices.operation": [[2, "module-adobe.pdfservices.operation", false]], "adobe.pdfservices.operation.internal": [[8, "module-adobe.pdfservices.operation.internal", false]], "adobe.pdfservices.operation.internal.exceptions": [[8, "module-adobe.pdfservices.operation.internal.exceptions", false]], "adobe.pdfservices.operation.internal.execution_context": [[8, "module-adobe.pdfservices.operation.internal.execution_context", false]], "adobe.pdfservices.operation.internal.pdf_services_helper": [[8, "module-adobe.pdfservices.operation.internal.pdf_services_helper", false]], "adobe.pdfservices.operation.pdf_services": [[2, "module-adobe.pdfservices.operation.pdf_services", false]], "adobe.pdfservices.operation.pdf_services_job": [[2, "module-adobe.pdfservices.operation.pdf_services_job", false]], "adobe.pdfservices.operation.pdf_services_job_status": [[2, "module-adobe.pdfservices.operation.pdf_services_job_status", false]], "adobe.pdfservices.operation.pdf_services_job_status_response": [[2, "module-adobe.pdfservices.operation.pdf_services_job_status_response", false]], "adobe.pdfservices.operation.pdf_services_media_type": [[2, "module-adobe.pdfservices.operation.pdf_services_media_type", false]], "adobe.pdfservices.operation.pdf_services_response": [[2, "module-adobe.pdfservices.operation.pdf_services_response", false]], "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job": [[40, "module-adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job", false]], "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params", false]], "adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params", false]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params", false]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level", false]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.createpdfparams": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams", false]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params", false]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language", false]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params", false]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language", false]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params", false]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language", false]], "adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params", false]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params", false]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments", false]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.field_location", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.field_options", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.rfc3161_tsa_options": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials", false]], "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options", false]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale", false]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params", false]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format", false]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type", false]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params", false]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type", false]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type", false]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params", false]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout", false]], "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params", false]], "adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params", false]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params", false]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale", false]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type", false]], "adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params", false]], "adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params", false]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type", false]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params", false]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format", false]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption", false]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm", false]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params", false]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission", false]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions", false]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params", false]], "adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params", false]], "adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params", false]], "adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params", false]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle", false]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params", false]], "adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params": [[78, "module-adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params", false]], "adobe.pdfservices.operation.region": [[2, "module-adobe.pdfservices.operation.region", false]], "aes_128 (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm.encryptionalgorithm attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm.EncryptionAlgorithm.AES_128", false]], "aes_256 (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm.encryptionalgorithm attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm.EncryptionAlgorithm.AES_256", false]], "ai (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.AI", false]], "all_content (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.contentencryption attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.ContentEncryption.ALL_CONTENT", false]], "all_content_except_metadata (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.contentencryption attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.ContentEncryption.ALL_CONTENT_EXCEPT_METADATA", false]], "angle (class in adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle)": [[78, "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.Angle", false]], "angle_180 (adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.angle attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.Angle.ANGLE_180", false]], "angle_270 (adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.angle attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.Angle.ANGLE_270", false]], "angle_90 (adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.angle attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.Angle.ANGLE_90", false]], "appearanceitem (class in adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem", false]], "appearanceoptions (class in adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.AppearanceOptions", false]], "authenticator (adobe.pdfservices.operation.internal.execution_context.executioncontext property)": [[8, "adobe.pdfservices.operation.internal.execution_context.ExecutionContext.authenticator", false]], "autotagpdfparams (class in adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params.AutotagPDFParams", false]], "bg_bg (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.BG_BG", false]], "bg_bg (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.BG_BG", false]], "bg_bg (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.BG_BG", false]], "bg_bg (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.BG_BG", false]], "bg_bg (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.BG_BG", false]], "bmp (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.BMP", false]], "ca_ca (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.CA_CA", false]], "ca_ca (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.CA_CA", false]], "ca_ca (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.CA_CA", false]], "ca_ca (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.CA_CA", false]], "ca_ca (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.CA_CA", false]], "client_config (adobe.pdfservices.operation.internal.execution_context.executioncontext property)": [[8, "adobe.pdfservices.operation.internal.execution_context.ExecutionContext.client_config", false]], "combinepdfparams (class in adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.CombinePDFParams", false]], "compressionlevel (class in adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level)": [[78, "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.CompressionLevel", false]], "compresspdfparams (class in adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params.CompressPDFParams", false]], "contentencryption (class in adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.ContentEncryption", false]], "copy_content (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.permission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission.COPY_CONTENT", false]], "createpdffromexcelparams (class in adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params.CreatePDFFromExcelParams", false]], "createpdffrompptparams (class in adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params.CreatePDFFromPPTParams", false]], "createpdffromwordparams (class in adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params.CreatePDFFromWordParams", false]], "createpdfparams (class in adobe.pdfservices.operation.pdfjobs.params.create_pdf.createpdfparams)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams.CreatePDFParams", false]], "credentials (adobe.pdfservices.operation.internal.execution_context.executioncontext property)": [[8, "adobe.pdfservices.operation.internal.execution_context.ExecutionContext.credentials", false]], "cs_cz (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.CS_CZ", false]], "cs_cz (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.CS_CZ", false]], "cs_cz (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.CS_CZ", false]], "cs_cz (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.CS_CZ", false]], "cs_cz (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.CS_CZ", false]], "cscauthcontext (class in adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.CSCAuthContext", false]], "csccredentials (class in adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials", false]], "csv (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.CSV", false]], "csv (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type.tablestructuretype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type.TableStructureType.CSV", false]], "da_dk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.DA_DK", false]], "da_dk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.DA_DK", false]], "da_dk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.DA_DK", false]], "da_dk (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.DA_DK", false]], "da_dk (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.DA_DK", false]], "date (adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.appearanceitem attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem.DATE", false]], "de_ch (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.DE_CH", false]], "de_ch (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.DE_CH", false]], "de_ch (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.DE_CH", false]], "de_ch (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.DE_CH", false]], "de_ch (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.DE_CH", false]], "de_de (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.DE_DE", false]], "de_de (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.DE_DE", false]], "de_de (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.DE_DE", false]], "de_de (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.DE_DE", false]], "de_de (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.DE_DE", false]], "default_page_height (adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.pagelayout attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout.DEFAULT_PAGE_HEIGHT", false]], "default_page_width (adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.pagelayout attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout.DEFAULT_PAGE_WIDTH", false]], "delete_asset() (adobe.pdfservices.operation.internal.pdf_services_helper.pdfserviceshelper class method)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper.delete_asset", false]], "delete_asset() (adobe.pdfservices.operation.pdf_services.pdfservices method)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices.delete_asset", false]], "deletepagesparams (class in adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params.DeletePagesParams", false]], "distinguished_name (adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.appearanceitem attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem.DISTINGUISHED_NAME", false]], "doc (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.DOC", false]], "doc (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.exportpdftargetformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat.DOC", false]], "documentlanguage (class in adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage", false]], "documentlanguage (class in adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage", false]], "documentlanguage (class in adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage", false]], "documentlevelpermission (class in adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.DocumentLevelPermission", false]], "documentmergeparams (class in adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.DocumentMergeParams", false]], "docx (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.DOCX", false]], "docx (adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.outputformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.OutputFormat.DOCX", false]], "docx (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.exportpdftargetformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat.DOCX", false]], "done (adobe.pdfservices.operation.pdf_services_job_status.pdfservicesjobstatus attribute)": [[2, "adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus.DONE", false]], "edit_annotations (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.permission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission.EDIT_ANNOTATIONS", false]], "edit_content (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.permission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission.EDIT_CONTENT", false]], "edit_document_assembly (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.permission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission.EDIT_DOCUMENT_ASSEMBLY", false]], "edit_fill_and_sign_form_fields (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.permission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission.EDIT_FILL_AND_SIGN_FORM_FIELDS", false]], "el_gr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.EL_GR", false]], "el_gr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.EL_GR", false]], "el_gr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.EL_GR", false]], "el_gr (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.EL_GR", false]], "el_gr (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.EL_GR", false]], "en_gb (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.EN_GB", false]], "en_gb (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.EN_GB", false]], "en_gb (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.EN_GB", false]], "en_gb (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.EN_GB", false]], "en_gb (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.EN_GB", false]], "en_us (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.EN_US", false]], "en_us (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.EN_US", false]], "en_us (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.EN_US", false]], "en_us (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.EN_US", false]], "en_us (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.EN_US", false]], "encryptionalgorithm (class in adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm.EncryptionAlgorithm", false]], "error_code (adobe.pdfservices.operation.internal.exceptions.operationexception property)": [[8, "adobe.pdfservices.operation.internal.exceptions.OperationException.error_code", false]], "es_es (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.ES_ES", false]], "es_es (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.ES_ES", false]], "es_es (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.ES_ES", false]], "es_es (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.ES_ES", false]], "es_es (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.ES_ES", false]], "et_ee (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.ET_EE", false]], "et_ee (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.ET_EE", false]], "et_ee (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.ET_EE", false]], "et_ee (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.ET_EE", false]], "et_ee (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.ET_EE", false]], "eu (adobe.pdfservices.operation.region.region attribute)": [[2, "adobe.pdfservices.operation.region.Region.EU", false]], "eu_es (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.EU_ES", false]], "executioncontext (class in adobe.pdfservices.operation.internal.execution_context)": [[8, "adobe.pdfservices.operation.internal.execution_context.ExecutionContext", false]], "exportocrlocale (class in adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale", false]], "exportpdfformdatajob (class in adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job)": [[40, "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job.ExportPDFFormDataJob", false]], "exportpdfparams (class in adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params.ExportPDFParams", false]], "exportpdftargetformat (class in adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat", false]], "exportpdftoimagesoutputtype (class in adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.ExportPDFToImagesOutputType", false]], "exportpdftoimagesparams (class in adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params.ExportPDFtoImagesParams", false]], "exportpdftoimagestargetformat (class in adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.ExportPDFToImagesTargetFormat", false]], "extension (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype property)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.extension", false]], "extractelementtype (class in adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type.ExtractElementType", false]], "extractpdfparams (class in adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams", false]], "extractrenditionselementtype (class in adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type.ExtractRenditionsElementType", false]], "failed (adobe.pdfservices.operation.pdf_services_job_status.pdfservicesjobstatus attribute)": [[2, "adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus.FAILED", false]], "fi_fi (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.FI_FI", false]], "fi_fi (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.FI_FI", false]], "fi_fi (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.FI_FI", false]], "fi_fi (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.FI_FI", false]], "fi_fi (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.FI_FI", false]], "fieldlocation (class in adobe.pdfservices.operation.pdfjobs.params.eseal.field_location)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation", false]], "fieldoptions (class in adobe.pdfservices.operation.pdfjobs.params.eseal.field_options)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions", false]], "figures (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type.extractrenditionselementtype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type.ExtractRenditionsElementType.FIGURES", false]], "form_filling (adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.documentlevelpermission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.DocumentLevelPermission.FORM_FILLING", false]], "form_filling_and_annotations (adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.documentlevelpermission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.DocumentLevelPermission.FORM_FILLING_AND_ANNOTATIONS", false]], "fr_fr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.FR_FR", false]], "fr_fr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.FR_FR", false]], "fr_fr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.FR_FR", false]], "fr_fr (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.FR_FR", false]], "fr_fr (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.FR_FR", false]], "fragments (class in adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments", false]], "get_access_token() (adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.cscauthcontext method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.CSCAuthContext.get_access_token", false]], "get_add_char_info() (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.extractpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams.get_add_char_info", false]], "get_appear_on_foreground() (adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.watermarkappearance method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.WatermarkAppearance.get_appear_on_foreground", false]], "get_appearance_options() (adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.appearanceoptions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.AppearanceOptions.get_appearance_options", false]], "get_asset() (adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params.reorderpagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params.ReorderPagesParams.get_asset", false]], "get_assets_to_combine() (adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.combinepdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.CombinePDFParams.get_assets_to_combine", false]], "get_assets_to_insert() (adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.insertpagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.InsertPagesParams.get_assets_to_insert", false]], "get_assets_to_replace() (adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.replacepagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.ReplacePagesParams.get_assets_to_replace", false]], "get_base_asset() (adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.insertpagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.InsertPagesParams.get_base_asset", false]], "get_base_asset() (adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.replacepagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.ReplacePagesParams.get_base_asset", false]], "get_bottom() (adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.fieldlocation method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation.get_bottom", false]], "get_compression_level() (adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params.compresspdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params.CompressPDFParams.get_compression_level", false]], "get_compression_level() (adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.compressionlevel method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.CompressionLevel.get_compression_level", false]], "get_content() (adobe.pdfservices.operation.internal.pdf_services_helper.pdfserviceshelper class method)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper.get_content", false]], "get_content() (adobe.pdfservices.operation.pdf_services.pdfservices method)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices.get_content", false]], "get_content_encryption() (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.passwordprotectparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams.get_content_encryption", false]], "get_credential_id() (adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.csccredentials method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials.get_credential_id", false]], "get_csc_auth_context() (adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.csccredentials method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials.get_csc_auth_context", false]], "get_document_language() (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params.createpdffromexcelparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params.CreatePDFFromExcelParams.get_document_language", false]], "get_document_language() (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.get_document_language", false]], "get_document_language() (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params.createpdffrompptparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params.CreatePDFFromPPTParams.get_document_language", false]], "get_document_language() (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.get_document_language", false]], "get_document_language() (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params.createpdffromwordparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params.CreatePDFFromWordParams.get_document_language", false]], "get_document_language() (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.get_document_language", false]], "get_elements_to_extract() (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.extractpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams.get_elements_to_extract", false]], "get_elements_to_extract_renditions() (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.extractpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams.get_elements_to_extract_renditions", false]], "get_encryption_algorithm() (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.passwordprotectparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams.get_encryption_algorithm", false]], "get_export_ocr_locale() (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.get_export_ocr_locale", false]], "get_export_pdf_to_images_output_type() (adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params.exportpdftoimagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params.ExportPDFtoImagesParams.get_export_pdf_to_images_output_type", false]], "get_export_pdf_to_images_target_format() (adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params.exportpdftoimagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params.ExportPDFtoImagesParams.get_export_pdf_to_images_target_format", false]], "get_field_location() (adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.fieldoptions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions.get_field_location", false]], "get_field_name() (adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.fieldoptions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions.get_field_name", false]], "get_file_count() (adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.splitpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.SplitPDFParams.get_file_count", false]], "get_file_ext() (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.exportpdftargetformat method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat.get_file_ext", false]], "get_file_ext() (adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.exportpdftoimagestargetformat method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.ExportPDFToImagesTargetFormat.get_file_ext", false]], "get_format() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.outputformat method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.OutputFormat.get_format", false]], "get_fragments() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.documentmergeparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.DocumentMergeParams.get_fragments", false]], "get_fragments_list() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.fragments method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments.get_fragments_list", false]], "get_from_extension() (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype static method)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.get_from_extension", false]], "get_generate_report() (adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params.autotagpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params.AutotagPDFParams.get_generate_report", false]], "get_include_header_footer() (adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.htmltopdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.HTMLtoPDFParams.get_include_header_footer", false]], "get_include_page_level_properties() (adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params.pdfpropertiesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params.PDFPropertiesParams.get_include_page_level_properties", false]], "get_job_result() (adobe.pdfservices.operation.internal.pdf_services_helper.pdfserviceshelper class method)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper.get_job_result", false]], "get_job_result() (adobe.pdfservices.operation.pdf_services.pdfservices method)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices.get_job_result", false]], "get_job_status() (adobe.pdfservices.operation.internal.pdf_services_helper.pdfserviceshelper class method)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper.get_job_status", false]], "get_job_status() (adobe.pdfservices.operation.pdf_services.pdfservices method)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices.get_job_status", false]], "get_json() (adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.htmltopdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.HTMLtoPDFParams.get_json", false]], "get_json_data_for_merge() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.documentmergeparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.DocumentMergeParams.get_json_data_for_merge", false]], "get_json_form_fields_data() (adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params.importpdfformdataparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params.ImportPDFFormDataParams.get_json_form_fields_data", false]], "get_json_form_fields_data_string() (adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params.importpdfformdataparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params.ImportPDFFormDataParams.get_json_form_fields_data_string", false]], "get_left() (adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.fieldlocation method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation.get_left", false]], "get_locale() (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.get_locale", false]], "get_ocr_lang() (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params.exportpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params.ExportPDFParams.get_ocr_lang", false]], "get_ocr_locale() (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.ocrparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.OCRParams.get_ocr_locale", false]], "get_ocr_type() (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.ocrparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.OCRParams.get_ocr_type", false]], "get_opacity() (adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.watermarkappearance method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.WatermarkAppearance.get_opacity", false]], "get_output_format() (adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.documentmergeparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.DocumentMergeParams.get_output_format", false]], "get_output_type() (adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.exportpdftoimagesoutputtype method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.ExportPDFToImagesOutputType.get_output_type", false]], "get_owner_password() (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.passwordprotectparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams.get_owner_password", false]], "get_page_actions() (adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.rotatepagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams.get_page_actions", false]], "get_page_count() (adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.splitpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.SplitPDFParams.get_page_count", false]], "get_page_end() (adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params.pdfaccessibilitycheckerparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params.PDFAccessibilityCheckerParams.get_page_end", false]], "get_page_layout() (adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.htmltopdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.HTMLtoPDFParams.get_page_layout", false]], "get_page_number() (adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.fieldoptions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions.get_page_number", false]], "get_page_ranges() (adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params.deletepagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params.DeletePagesParams.get_page_ranges", false]], "get_page_ranges() (adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params.pdfwatermarkparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params.PDFWatermarkParams.get_page_ranges", false]], "get_page_ranges() (adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params.reorderpagesparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params.ReorderPagesParams.get_page_ranges", false]], "get_page_ranges() (adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.splitpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.SplitPDFParams.get_page_ranges", false]], "get_page_start() (adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params.pdfaccessibilitycheckerparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params.PDFAccessibilityCheckerParams.get_page_start", false]], "get_password() (adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.tsabasicauthcredentials method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.TSABasicAuthCredentials.get_password", false]], "get_password() (adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params.removeprotectionparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params.RemoveProtectionParams.get_password", false]], "get_permissions() (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.passwordprotectparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams.get_permissions", false]], "get_pin() (adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.csccredentials method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials.get_pin", false]], "get_provider_name() (adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.csccredentials method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials.get_provider_name", false]], "get_ranges() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.pageranges method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges.get_ranges", false]], "get_result() (adobe.pdfservices.operation.pdf_services_response.pdfservicesresponse method)": [[2, "adobe.pdfservices.operation.pdf_services_response.PDFServicesResponse.get_result", false]], "get_retry_interval() (adobe.pdfservices.operation.pdf_services_job_status_response.pdfservicesjobstatusresponse method)": [[2, "adobe.pdfservices.operation.pdf_services_job_status_response.PDFServicesJobStatusResponse.get_retry_interval", false]], "get_right() (adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.fieldlocation method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation.get_right", false]], "get_seal_appearance_options() (adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.pdfelectronicsealparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams.get_seal_appearance_options", false]], "get_seal_certificate_credentials() (adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.pdfelectronicsealparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams.get_seal_certificate_credentials", false]], "get_seal_field_options() (adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.pdfelectronicsealparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams.get_seal_field_options", false]], "get_shift_headings() (adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params.autotagpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params.AutotagPDFParams.get_shift_headings", false]], "get_signature_format() (adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.pdfelectronicsealparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams.get_signature_format", false]], "get_signature_format() (adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.signatureformat method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.SignatureFormat.get_signature_format", false]], "get_status() (adobe.pdfservices.operation.pdf_services_job_status_response.pdfservicesjobstatusresponse method)": [[2, "adobe.pdfservices.operation.pdf_services_job_status_response.PDFServicesJobStatusResponse.get_status", false]], "get_styling_info() (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.extractpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams.get_styling_info", false]], "get_table_structure_type() (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.extractpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams.get_table_structure_type", false]], "get_target_format() (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params.exportpdfparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params.ExportPDFParams.get_target_format", false]], "get_token_type() (adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.cscauthcontext method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.CSCAuthContext.get_token_type", false]], "get_top() (adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.fieldlocation method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation.get_top", false]], "get_tsa_basic_auth_credentials() (adobe.pdfservices.operation.pdfjobs.params.eseal.rfc3161_tsa_options.rfc3161tsaoptions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options.RFC3161TSAOptions.get_tsa_basic_auth_credentials", false]], "get_type() (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.ocrsupportedtype method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.OCRSupportedType.get_type", false]], "get_url() (adobe.pdfservices.operation.pdfjobs.params.eseal.rfc3161_tsa_options.rfc3161tsaoptions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options.RFC3161TSAOptions.get_url", false]], "get_user_password() (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.passwordprotectparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams.get_user_password", false]], "get_username() (adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.tsabasicauthcredentials method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.TSABasicAuthCredentials.get_username", false]], "get_value() (adobe.pdfservices.operation.pdf_services_job_status.pdfservicesjobstatus method)": [[2, "adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus.get_value", false]], "get_values() (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.permissions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.Permissions.get_values", false]], "get_visible() (adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.fieldoptions method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions.get_visible", false]], "get_watermark_appearance() (adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params.pdfwatermarkparams method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params.PDFWatermarkParams.get_watermark_appearance", false]], "gif (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.GIF", false]], "gl_es (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.GL_ES", false]], "high (adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.compressionlevel attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.CompressionLevel.HIGH", false]], "hr_hr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.HR_HR", false]], "hr_hr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.HR_HR", false]], "hr_hr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.HR_HR", false]], "hr_hr (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.HR_HR", false]], "hr_hr (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.HR_HR", false]], "html (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.HTML", false]], "htmltopdfparams (class in adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.HTMLtoPDFParams", false]], "hu_hu (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.HU_HU", false]], "hu_hu (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.HU_HU", false]], "hu_hu (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.HU_HU", false]], "hu_hu (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.HU_HU", false]], "hu_hu (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.HU_HU", false]], "importpdfformdataparams (class in adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params.ImportPDFFormDataParams", false]], "in_progress (adobe.pdfservices.operation.pdf_services_job_status.pdfservicesjobstatus attribute)": [[2, "adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus.IN_PROGRESS", false]], "indd (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.INDD", false]], "insertpagesparams (class in adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.InsertPagesParams", false]], "is_empty() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.pageranges method)": [[78, "adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges.is_empty", false]], "it_it (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.IT_IT", false]], "it_it (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.IT_IT", false]], "it_it (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.IT_IT", false]], "it_it (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.IT_IT", false]], "it_it (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.IT_IT", false]], "iw_il (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.IW_IL", false]], "iw_il (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.IW_IL", false]], "iw_il (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.IW_IL", false]], "iw_il (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.IW_IL", false]], "iw_il (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.IW_IL", false]], "ja_jp (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.JA_JP", false]], "ja_jp (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.JA_JP", false]], "ja_jp (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.JA_JP", false]], "ja_jp (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.JA_JP", false]], "ja_jp (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.JA_JP", false]], "jpeg (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.JPEG", false]], "jpeg (adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.exportpdftoimagestargetformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.ExportPDFToImagesTargetFormat.JPEG", false]], "jpg (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.JPG", false]], "json (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.JSON", false]], "ko_kr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.KO_KR", false]], "ko_kr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.KO_KR", false]], "ko_kr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.KO_KR", false]], "ko_kr (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.KO_KR", false]], "ko_kr (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.KO_KR", false]], "labels (adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.appearanceitem attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem.LABELS", false]], "list_of_page_images (adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.exportpdftoimagesoutputtype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.ExportPDFToImagesOutputType.LIST_OF_PAGE_IMAGES", false]], "low (adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.compressionlevel attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.CompressionLevel.LOW", false]], "lt_lt (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.LT_LT", false]], "lt_lt (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.LT_LT", false]], "lt_lt (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.LT_LT", false]], "lt_lt (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.LT_LT", false]], "lt_lt (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.LT_LT", false]], "lv_lv (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.LV_LV", false]], "lv_lv (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.LV_LV", false]], "lv_lv (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.LV_LV", false]], "lv_lv (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.LV_LV", false]], "lv_lv (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.LV_LV", false]], "medium (adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.compressionlevel attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.CompressionLevel.MEDIUM", false]], "mime_type (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype property)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.mime_type", false]], "mk_mk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.MK_MK", false]], "mk_mk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.MK_MK", false]], "mk_mk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.MK_MK", false]], "mk_mk (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.MK_MK", false]], "mk_mk (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.MK_MK", false]], "module": [[2, "module-adobe.pdfservices.operation", false], [2, "module-adobe.pdfservices.operation.pdf_services", false], [2, "module-adobe.pdfservices.operation.pdf_services_job", false], [2, "module-adobe.pdfservices.operation.pdf_services_job_status", false], [2, "module-adobe.pdfservices.operation.pdf_services_job_status_response", false], [2, "module-adobe.pdfservices.operation.pdf_services_media_type", false], [2, "module-adobe.pdfservices.operation.pdf_services_response", false], [2, "module-adobe.pdfservices.operation.region", false], [8, "module-adobe.pdfservices.operation.internal", false], [8, "module-adobe.pdfservices.operation.internal.exceptions", false], [8, "module-adobe.pdfservices.operation.internal.execution_context", false], [8, "module-adobe.pdfservices.operation.internal.pdf_services_helper", false], [40, "module-adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.field_location", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.field_options", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params", false], [78, "module-adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params", false]], "mt_mt (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.MT_MT", false]], "mt_mt (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.MT_MT", false]], "mt_mt (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.MT_MT", false]], "mt_mt (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.MT_MT", false]], "mt_mt (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.MT_MT", false]], "name (adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.appearanceitem attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem.NAME", false]], "nb_no (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.NB_NO", false]], "nb_no (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.NB_NO", false]], "nb_no (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.NB_NO", false]], "nb_no (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.NB_NO", false]], "nb_no (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.NB_NO", false]], "nl_nl (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.NL_NL", false]], "nl_nl (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.NL_NL", false]], "nl_nl (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.NL_NL", false]], "nl_nl (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.NL_NL", false]], "nl_nl (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.NL_NL", false]], "nn_no (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.NN_NO", false]], "no_changes_allowed (adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.documentlevelpermission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.DocumentLevelPermission.NO_CHANGES_ALLOWED", false]], "no_no (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.NO_NO", false]], "no_no (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.NO_NO", false]], "no_no (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.NO_NO", false]], "no_no (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.NO_NO", false]], "ocrparams (class in adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.OCRParams", false]], "ocrsupportedlocale (class in adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale", false]], "ocrsupportedtype (class in adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.OCRSupportedType", false]], "only_embedded_files (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.contentencryption attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.ContentEncryption.ONLY_EMBEDDED_FILES", false]], "operationexception": [[8, "adobe.pdfservices.operation.internal.exceptions.OperationException", false]], "outputformat (class in adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.OutputFormat", false]], "pades (adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.signatureformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.SignatureFormat.PADES", false]], "pagelayout (class in adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout)": [[78, "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout", false]], "pageranges (class in adobe.pdfservices.operation.pdfjobs.params.page_ranges)": [[78, "adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges", false]], "passwordprotectparams (class in adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams", false]], "pdf (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.PDF", false]], "pdf (adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.outputformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.OutputFormat.PDF", false]], "pdfaccessibilitycheckerparams (class in adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params.PDFAccessibilityCheckerParams", false]], "pdfelectronicsealparams (class in adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams", false]], "pdfpropertiesparams (class in adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params.PDFPropertiesParams", false]], "pdfservices (class in adobe.pdfservices.operation.pdf_services)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices", false]], "pdfserviceshelper (class in adobe.pdfservices.operation.internal.pdf_services_helper)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper", false]], "pdfservicesjob (class in adobe.pdfservices.operation.pdf_services_job)": [[2, "adobe.pdfservices.operation.pdf_services_job.PDFServicesJob", false]], "pdfservicesjobparams (class in adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params.PDFServicesJobParams", false]], "pdfservicesjobstatus (class in adobe.pdfservices.operation.pdf_services_job_status)": [[2, "adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus", false]], "pdfservicesjobstatusresponse (class in adobe.pdfservices.operation.pdf_services_job_status_response)": [[2, "adobe.pdfservices.operation.pdf_services_job_status_response.PDFServicesJobStatusResponse", false]], "pdfservicesmediatype (class in adobe.pdfservices.operation.pdf_services_media_type)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType", false]], "pdfservicesresponse (class in adobe.pdfservices.operation.pdf_services_response)": [[2, "adobe.pdfservices.operation.pdf_services_response.PDFServicesResponse", false]], "pdfwatermarkparams (class in adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params.PDFWatermarkParams", false]], "permission (class in adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission", false]], "permissions (class in adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.Permissions", false]], "pkcs7 (adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.signatureformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.SignatureFormat.PKCS7", false]], "pl_pl (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.PL_PL", false]], "pl_pl (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.PL_PL", false]], "pl_pl (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.PL_PL", false]], "pl_pl (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.PL_PL", false]], "pl_pl (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.PL_PL", false]], "png (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.PNG", false]], "png (adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.exportpdftoimagestargetformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.ExportPDFToImagesTargetFormat.PNG", false]], "ppt (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.PPT", false]], "pptx (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.PPTX", false]], "pptx (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.exportpdftargetformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat.PPTX", false]], "print_high_quality (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.permission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission.PRINT_HIGH_QUALITY", false]], "print_low_quality (adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.permission attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission.PRINT_LOW_QUALITY", false]], "protectpdfparams (class in adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params.ProtectPDFParams", false]], "psd (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.PSD", false]], "pt_br (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.PT_BR", false]], "pt_br (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.PT_BR", false]], "pt_br (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.PT_BR", false]], "pt_br (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.PT_BR", false]], "pt_br (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.PT_BR", false]], "pt_pt (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.PT_PT", false]], "refresh_download_uri() (adobe.pdfservices.operation.internal.pdf_services_helper.pdfserviceshelper class method)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper.refresh_download_uri", false]], "refresh_download_uri() (adobe.pdfservices.operation.pdf_services.pdfservices method)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices.refresh_download_uri", false]], "region (class in adobe.pdfservices.operation.region)": [[2, "adobe.pdfservices.operation.region.Region", false]], "removeprotectionparams (class in adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params.RemoveProtectionParams", false]], "reorderpagesparams (class in adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params.ReorderPagesParams", false]], "replacepagesparams (class in adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.ReplacePagesParams", false]], "rfc3161tsaoptions (class in adobe.pdfservices.operation.pdfjobs.params.eseal.rfc3161_tsa_options)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options.RFC3161TSAOptions", false]], "ro_ro (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.RO_RO", false]], "ro_ro (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.RO_RO", false]], "ro_ro (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.RO_RO", false]], "ro_ro (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.RO_RO", false]], "ro_ro (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.RO_RO", false]], "rotatepagesparams (class in adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams", false]], "rtf (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.RTF", false]], "rtf (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.exportpdftargetformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat.RTF", false]], "ru_ru (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.RU_RU", false]], "ru_ru (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.RU_RU", false]], "ru_ru (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.RU_RU", false]], "ru_ru (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.RU_RU", false]], "ru_ru (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.RU_RU", false]], "seal_image (adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.appearanceitem attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem.SEAL_IMAGE", false]], "searchable_image (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.ocrsupportedtype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.OCRSupportedType.SEARCHABLE_IMAGE", false]], "searchable_image_exact (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.ocrsupportedtype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.OCRSupportedType.SEARCHABLE_IMAGE_EXACT", false]], "signatureformat (class in adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.SignatureFormat", false]], "sk_sk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.SK_SK", false]], "sk_sk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.SK_SK", false]], "sk_sk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.SK_SK", false]], "sk_sk (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.SK_SK", false]], "sk_sk (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.SK_SK", false]], "sl_si (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.SL_SI", false]], "sl_si (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.SL_SI", false]], "sl_si (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.SL_SI", false]], "sl_si (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.SL_SI", false]], "sl_si (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.SL_SI", false]], "splitpdfparams (class in adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params)": [[78, "adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.SplitPDFParams", false]], "sr_sr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.SR_SR", false]], "sr_sr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.SR_SR", false]], "sr_sr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.SR_SR", false]], "sr_sr (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.SR_SR", false]], "sr_sr (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.SR_SR", false]], "submit() (adobe.pdfservices.operation.pdf_services.pdfservices method)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices.submit", false]], "submit_job() (adobe.pdfservices.operation.internal.pdf_services_helper.pdfserviceshelper class method)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper.submit_job", false]], "sv_se (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.SV_SE", false]], "sv_se (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.SV_SE", false]], "sv_se (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.SV_SE", false]], "sv_se (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.SV_SE", false]], "sv_se (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.SV_SE", false]], "svg (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.SVG", false]], "tables (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type.extractelementtype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type.ExtractElementType.TABLES", false]], "tables (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type.extractrenditionselementtype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type.ExtractRenditionsElementType.TABLES", false]], "tablestructuretype (class in adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type.TableStructureType", false]], "text (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type.extractelementtype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type.ExtractElementType.TEXT", false]], "tif (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.TIF", false]], "tiff (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.TIFF", false]], "tr_tr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.TR_TR", false]], "tr_tr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.TR_TR", false]], "tr_tr (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.TR_TR", false]], "tr_tr (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.TR_TR", false]], "tr_tr (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.TR_TR", false]], "tsabasicauthcredentials (class in adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.TSABasicAuthCredentials", false]], "tsaoptions (class in adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options)": [[78, "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options.TSAOptions", false]], "txt (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.TXT", false]], "uk_ua (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.UK_UA", false]], "uk_ua (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.UK_UA", false]], "uk_ua (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.UK_UA", false]], "uk_ua (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.UK_UA", false]], "uk_ua (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.UK_UA", false]], "upload() (adobe.pdfservices.operation.internal.pdf_services_helper.pdfserviceshelper class method)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper.upload", false]], "upload() (adobe.pdfservices.operation.pdf_services.pdfservices method)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices.upload", false]], "upload_assets() (adobe.pdfservices.operation.internal.pdf_services_helper.pdfserviceshelper class method)": [[8, "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper.upload_assets", false]], "upload_assets() (adobe.pdfservices.operation.pdf_services.pdfservices method)": [[2, "adobe.pdfservices.operation.pdf_services.PDFServices.upload_assets", false]], "us (adobe.pdfservices.operation.region.region attribute)": [[2, "adobe.pdfservices.operation.region.Region.US", false]], "validate() (adobe.pdfservices.operation.internal.execution_context.executioncontext method)": [[8, "adobe.pdfservices.operation.internal.execution_context.ExecutionContext.validate", false]], "watermarkappearance (class in adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.WatermarkAppearance", false]], "xls (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.XLS", false]], "xlsx (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.XLSX", false]], "xlsx (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.exportpdftargetformat attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat.XLSX", false]], "xlsx (adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type.tablestructuretype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type.TableStructureType.XLSX", false]], "zh_cn (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.ZH_CN", false]], "zh_cn (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.ZH_CN", false]], "zh_cn (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.ZH_CN", false]], "zh_cn (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.ZH_CN", false]], "zh_cn (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.ZH_CN", false]], "zh_hant (adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.exportocrlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale.ZH_HANT", false]], "zh_hk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage.ZH_HK", false]], "zh_hk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage.ZH_HK", false]], "zh_hk (adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.documentlanguage attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage.ZH_HK", false]], "zh_hk (adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.ocrsupportedlocale attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale.ZH_HK", false]], "zip (adobe.pdfservices.operation.pdf_services_media_type.pdfservicesmediatype attribute)": [[2, "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType.ZIP", false]], "zip_of_page_images (adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.exportpdftoimagesoutputtype attribute)": [[78, "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.ExportPDFToImagesOutputType.ZIP_OF_PAGE_IMAGES", false]]}, "objects": {"": [[0, 0, 0, "-", "adobe"]], "adobe": [[1, 0, 0, "-", "pdfservices"]], "adobe.pdfservices": [[2, 0, 0, "-", "operation"]], "adobe.pdfservices.operation": [[3, 0, 0, "-", "auth"], [4, 0, 0, "-", "config"], [7, 0, 0, "-", "exception"], [8, 0, 0, "-", "internal"], [37, 0, 0, "-", "io"], [2, 0, 0, "-", "pdf_services"], [2, 0, 0, "-", "pdf_services_job"], [2, 0, 0, "-", "pdf_services_job_status"], [2, 0, 0, "-", "pdf_services_job_status_response"], [2, 0, 0, "-", "pdf_services_media_type"], [2, 0, 0, "-", "pdf_services_response"], [38, 0, 0, "-", "pdfjobs"], [2, 0, 0, "-", "region"]], "adobe.pdfservices.operation.auth": [[3, 0, 0, "-", "credentials"], [3, 0, 0, "-", "service_principal_credentials"]], "adobe.pdfservices.operation.auth.credentials": [[69, 1, 1, "", "Credentials"]], "adobe.pdfservices.operation.auth.service_principal_credentials": [[69, 1, 1, "", "ServicePrincipalCredentials"]], "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials": [[69, 2, 1, "", "get_client_id"], [69, 2, 1, "", "get_client_secret"]], "adobe.pdfservices.operation.config": [[4, 0, 0, "-", "client_config"], [5, 0, 0, "-", "notifier"], [6, 0, 0, "-", "proxy"]], "adobe.pdfservices.operation.config.client_config": [[70, 1, 1, "", "ClientConfig"]], "adobe.pdfservices.operation.config.client_config.ClientConfig": [[70, 2, 1, "", "from_file"], [70, 2, 1, "", "get_connect_timeout"], [4, 2, 1, "", "get_pdf_services_uri"], [70, 2, 1, "", "get_proxy_server_config"], [70, 2, 1, "", "get_read_timeout"], [4, 2, 1, "", "validate"]], "adobe.pdfservices.operation.config.notifier": [[5, 0, 0, "-", "callback_notifier_data"], [5, 0, 0, "-", "notifier_config"], [5, 0, 0, "-", "notifier_data"], [5, 0, 0, "-", "notifier_type"]], "adobe.pdfservices.operation.config.notifier.callback_notifier_data": [[71, 1, 1, "", "CallbackNotifierData"]], "adobe.pdfservices.operation.config.notifier.callback_notifier_data.CallbackNotifierData": [[5, 3, 1, "", "json_hint"], [5, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.config.notifier.notifier_config": [[71, 1, 1, "", "NotifierConfig"]], "adobe.pdfservices.operation.config.notifier.notifier_config.NotifierConfig": [[5, 3, 1, "", "json_hint"], [5, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.config.notifier.notifier_data": [[71, 1, 1, "", "NotifierData"]], "adobe.pdfservices.operation.config.notifier.notifier_type": [[71, 1, 1, "", "NotifierType"]], "adobe.pdfservices.operation.config.notifier.notifier_type.NotifierType": [[71, 3, 1, "", "CALLBACK"]], "adobe.pdfservices.operation.config.proxy": [[6, 0, 0, "-", "proxy_authentication_credentials"], [6, 0, 0, "-", "proxy_scheme"], [6, 0, 0, "-", "proxy_server_config"], [6, 0, 0, "-", "username_password_credentials"]], "adobe.pdfservices.operation.config.proxy.proxy_authentication_credentials": [[72, 1, 1, "", "ProxyAuthenticationCredentials"]], "adobe.pdfservices.operation.config.proxy.proxy_scheme": [[72, 1, 1, "", "ProxyScheme"]], "adobe.pdfservices.operation.config.proxy.proxy_scheme.ProxyScheme": [[72, 3, 1, "", "HTTP"], [72, 3, 1, "", "HTTPS"], [72, 2, 1, "", "get"]], "adobe.pdfservices.operation.config.proxy.proxy_server_config": [[72, 1, 1, "", "ProxyServerConfig"]], "adobe.pdfservices.operation.config.proxy.proxy_server_config.ProxyServerConfig": [[72, 3, 1, "", "HTTPS_PORT"], [72, 3, 1, "", "HTTP_PORT"], [72, 2, 1, "", "from_json"], [72, 2, 1, "", "get_credentials"], [72, 2, 1, "", "get_host"], [72, 2, 1, "", "get_port"], [6, 2, 1, "", "get_port_based_on_scheme"], [72, 2, 1, "", "get_proxy_scheme"], [6, 2, 1, "", "proxy_config_map"]], "adobe.pdfservices.operation.config.proxy.username_password_credentials": [[72, 1, 1, "", "UsernamePasswordCredentials"]], "adobe.pdfservices.operation.config.proxy.username_password_credentials.UsernamePasswordCredentials": [[72, 2, 1, "", "from_json"], [72, 2, 1, "", "get_password"], [72, 2, 1, "", "get_username"]], "adobe.pdfservices.operation.exception": [[7, 0, 0, "-", "exceptions"]], "adobe.pdfservices.operation.exception.exceptions": [[73, 0, 0, "-", "SdkException"], [73, 0, 0, "-", "ServiceApiException"], [73, 0, 0, "-", "ServiceUsageException"]], "adobe.pdfservices.operation.exception.exceptions.SdkException": [[7, 4, 1, "", "request_tracking_id"], [73, 5, 1, "", "with_traceback"]], "adobe.pdfservices.operation.exception.exceptions.ServiceApiException": [[7, 3, 1, "", "DEFAULT_ERROR_CODE"], [7, 3, 1, "", "DEFAULT_STATUS_CODE"], [7, 4, 1, "", "error_code"], [7, 4, 1, "", "request_tracking_id"], [7, 4, 1, "", "status_code"], [73, 5, 1, "", "with_traceback"]], "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException": [[7, 3, 1, "", "DEFAULT_ERROR_CODE"], [7, 3, 1, "", "DEFAULT_STATUS_CODE"], [7, 4, 1, "", "error_code"], [7, 4, 1, "", "request_tracking_id"], [7, 4, 1, "", "status_code"], [73, 5, 1, "", "with_traceback"]], "adobe.pdfservices.operation.internal": [[9, 0, 0, "-", "api"], [32, 0, 0, "-", "auth"], [33, 0, 0, "-", "constants"], [8, 0, 0, "-", "exceptions"], [8, 0, 0, "-", "execution_context"], [34, 0, 0, "-", "http"], [35, 0, 0, "-", "params"], [8, 0, 0, "-", "pdf_services_helper"], [36, 0, 0, "-", "util"]], "adobe.pdfservices.operation.internal.api": [[10, 0, 0, "-", "dto"], [9, 0, 0, "-", "pdf_services_api"], [9, 0, 0, "-", "storage_api"]], "adobe.pdfservices.operation.internal.api.dto": [[11, 0, 0, "-", "request"], [30, 0, 0, "-", "response"]], "adobe.pdfservices.operation.internal.api.dto.request": [[11, 0, 0, "-", "asset_upload_uri_request"], [12, 0, 0, "-", "autotagpdf"], [13, 0, 0, "-", "combinepdf"], [14, 0, 0, "-", "compresspdf"], [15, 0, 0, "-", "createpdf"], [16, 0, 0, "-", "document_generation"], [17, 0, 0, "-", "esealpdf"], [18, 0, 0, "-", "exportpdf"], [19, 0, 0, "-", "extract_pdf"], [20, 0, 0, "-", "htmltopdf"], [21, 0, 0, "-", "linearizepdf"], [22, 0, 0, "-", "ocrpdf"], [23, 0, 0, "-", "pagemanipulation"], [24, 0, 0, "-", "pdf_properties"], [25, 0, 0, "-", "pdf_services_api"], [26, 0, 0, "-", "pdftoimage"], [27, 0, 0, "-", "protect_pdf"], [28, 0, 0, "-", "remove_protection"], [29, 0, 0, "-", "splitpdf"]], "adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request": [[11, 1, 1, "", "AssetUploadURIRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.asset_upload_uri_request.AssetUploadURIRequest": [[11, 3, 1, "", "json_hint"], [11, 4, 1, "", "media_type"], [11, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf": [[12, 0, 0, "-", "autotag_pdf_external_asset_request"], [12, 0, 0, "-", "autotag_pdf_internal_asset_request"], [12, 0, 0, "-", "autotag_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request": [[12, 1, 1, "", "AutotagPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_external_asset_request.AutotagPDFExternalAssetRequest": [[12, 3, 1, "", "json_hint"], [12, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request": [[12, 1, 1, "", "AutotagPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_internal_asset_request.AutotagPDFInternalAssetRequest": [[12, 3, 1, "", "json_hint"], [12, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload": [[12, 1, 1, "", "AutotagPDFParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_params_payload.AutotagPDFParamsPayload": [[12, 3, 1, "", "json_hint"], [12, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.combinepdf": [[13, 0, 0, "-", "combine_pdf_external_asset_request"], [13, 0, 0, "-", "combine_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request": [[13, 1, 1, "", "CombinePDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_external_asset_request.CombinePDFExternalAssetRequest": [[13, 3, 1, "", "json_hint"], [13, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request": [[13, 1, 1, "", "CombinePDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.combinepdf.combine_pdf_internal_asset_request.CombinePDFInternalAssetRequest": [[13, 3, 1, "", "json_hint"], [13, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf": [[14, 0, 0, "-", "compress_pdf_external_asset_request"], [14, 0, 0, "-", "compress_pdf_internal_asset_request"], [14, 0, 0, "-", "compress_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request": [[14, 1, 1, "", "CompressPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_external_asset_request.CompressPDFExternalAssetRequest": [[14, 3, 1, "", "json_hint"], [14, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request": [[14, 1, 1, "", "CompressPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_internal_asset_request.CompressPDFInternalAssetRequest": [[14, 3, 1, "", "json_hint"], [14, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload": [[14, 1, 1, "", "CompressPDFParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.compresspdf.compress_pdf_params_payload.CompressPDFParamsPayload": [[14, 3, 1, "", "json_hint"], [14, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf": [[15, 0, 0, "-", "create_pdf_external_asset_request"], [15, 0, 0, "-", "create_pdf_internal_asset_request"], [15, 0, 0, "-", "create_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request": [[15, 1, 1, "", "CreatePDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_external_asset_request.CreatePDFExternalAssetRequest": [[15, 3, 1, "", "json_hint"], [15, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request": [[15, 1, 1, "", "CreatePDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_internal_asset_request.CreatePDFInternalAssetRequest": [[15, 3, 1, "", "json_hint"], [15, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload": [[15, 1, 1, "", "CreatePDFParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.createpdf.create_pdf_params_payload.CreatePDFParamsPayload": [[15, 3, 1, "", "json_hint"], [15, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation": [[16, 0, 0, "-", "document_generation_external_asset_request"], [16, 0, 0, "-", "document_generation_internal_asset_request"], [16, 0, 0, "-", "document_generation_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request": [[16, 1, 1, "", "DocumentMergeExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_external_asset_request.DocumentMergeExternalAssetRequest": [[16, 3, 1, "", "json_hint"], [16, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request": [[16, 1, 1, "", "DocumentMergeInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_internal_asset_request.DocumentMergeInternalAssetRequest": [[16, 3, 1, "", "json_hint"], [16, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload": [[16, 1, 1, "", "DocumentGenerationParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.document_generation.document_generation_params_payload.DocumentGenerationParamsPayload": [[16, 3, 1, "", "json_hint"], [16, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.esealpdf": [[17, 0, 0, "-", "eseal_pdf_external_asset_request"], [17, 0, 0, "-", "eseal_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request": [[17, 1, 1, "", "ESealPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_external_asset_request.ESealPDFExternalAssetRequest": [[17, 3, 1, "", "json_hint"], [17, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request": [[17, 1, 1, "", "ESealPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.esealpdf.eseal_pdf_internal_asset_request.ESealPDFInternalAssetRequest": [[17, 3, 1, "", "json_hint"], [17, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf": [[18, 0, 0, "-", "export_pdf_external_asset_request"], [18, 0, 0, "-", "export_pdf_internal_asset_request"], [18, 0, 0, "-", "export_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request": [[18, 1, 1, "", "ExportPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_external_asset_request.ExportPDFExternalAssetRequest": [[18, 3, 1, "", "json_hint"], [18, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request": [[18, 1, 1, "", "ExportPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_internal_asset_request.ExportPDFInternalAssetRequest": [[18, 3, 1, "", "json_hint"], [18, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload": [[18, 1, 1, "", "ExportPDFParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.exportpdf.export_pdf_params_payload.ExportPDFParamsPayload": [[18, 3, 1, "", "json_hint"], [18, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf": [[19, 0, 0, "-", "extract_pdf_external_asset_request"], [19, 0, 0, "-", "extract_pdf_internal_asset_request"], [19, 0, 0, "-", "extract_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request": [[19, 1, 1, "", "ExtractPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_external_asset_request.ExtractPDFExternalAssetRequest": [[19, 3, 1, "", "json_hint"], [19, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request": [[19, 1, 1, "", "ExtractPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_internal_asset_request.ExtractPDFInternalAssetRequest": [[19, 3, 1, "", "json_hint"], [19, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload": [[19, 1, 1, "", "ExtractPDFParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf.extract_pdf_params_payload.ExtractPDFParamsPayload": [[19, 3, 1, "", "json_hint"], [19, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf": [[20, 0, 0, "-", "html_to_pdf_external_asset_request"], [20, 0, 0, "-", "html_to_pdf_internal_asset_request"], [20, 0, 0, "-", "html_to_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request": [[20, 1, 1, "", "HTMLtoPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_external_asset_request.HTMLtoPDFExternalAssetRequest": [[20, 3, 1, "", "json_hint"], [20, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request": [[20, 1, 1, "", "HTMLtoPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_internal_asset_request.HTMLtoPDFInternalAssetRequest": [[20, 3, 1, "", "json_hint"], [20, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload": [[20, 1, 1, "", "HTMLtoPDFParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf.html_to_pdf_params_payload.HTMLtoPDFParamsPayload": [[20, 3, 1, "", "json_hint"], [20, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf": [[21, 0, 0, "-", "linearize_pdf_external_asset_request"], [21, 0, 0, "-", "linearize_pdf_internal_asset_request"]], "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request": [[21, 1, 1, "", "LinearizePDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_external_asset_request.LinearizePDFExternalAssetRequest": [[21, 3, 1, "", "json_hint"], [21, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request": [[21, 1, 1, "", "LinearizePDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf.linearize_pdf_internal_asset_request.LinearizePDFInternalAssetRequest": [[21, 3, 1, "", "json_hint"], [21, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf": [[22, 0, 0, "-", "ocr_pdf_external_asset_request"], [22, 0, 0, "-", "ocr_pdf_internal_asset_request"], [22, 0, 0, "-", "ocr_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request": [[22, 1, 1, "", "OCRPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_external_asset_request.OCRPDFExternalAssetRequest": [[22, 3, 1, "", "json_hint"], [22, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request": [[22, 1, 1, "", "OCRPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_internal_asset_request.OCRPDFInternalAssetRequest": [[22, 3, 1, "", "json_hint"], [22, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload": [[22, 1, 1, "", "OCRParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf.ocr_pdf_params_payload.OCRParamsPayload": [[22, 3, 1, "", "json_hint"], [22, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation": [[23, 0, 0, "-", "delete_page_action"], [23, 0, 0, "-", "page_action"], [23, 0, 0, "-", "page_action_command"], [23, 0, 0, "-", "page_action_commands"], [23, 0, 0, "-", "page_actions"], [23, 0, 0, "-", "page_manipulation_external_asset_request"], [23, 0, 0, "-", "page_manipulation_internal_asset_request"], [23, 0, 0, "-", "page_manipulation_params_payload"], [23, 0, 0, "-", "rotate_page_action"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action": [[23, 1, 1, "", "DeletePageAction"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.delete_page_action.DeletePageAction": [[23, 2, 1, "", "get_type"], [23, 3, 1, "", "json_hint"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action": [[23, 1, 1, "", "PageAction"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action.PageAction": [[23, 2, 1, "", "get_page_ranges"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command": [[23, 1, 1, "", "PageActionCommand"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_command.PageActionCommand": [[23, 2, 1, "", "create_from"], [23, 3, 1, "", "json_hint"], [23, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands": [[23, 1, 1, "", "PageActionCommands"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_action_commands.PageActionCommands": [[23, 2, 1, "", "add_command"], [23, 2, 1, "", "get_commands"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions": [[23, 1, 1, "", "PageActions"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_actions.PageActions": [[23, 2, 1, "", "add_action"], [23, 2, 1, "", "get_actions"], [23, 2, 1, "", "get_length"], [23, 2, 1, "", "is_empty"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request": [[23, 1, 1, "", "PageManipulationExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_external_asset_request.PageManipulationExternalAssetRequest": [[23, 3, 1, "", "json_hint"], [23, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request": [[23, 1, 1, "", "PageManipulationInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_internal_asset_request.PageManipulationInternalAssetRequest": [[23, 3, 1, "", "json_hint"], [23, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload": [[23, 1, 1, "", "PageManipulationParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.page_manipulation_params_payload.PageManipulationParamsPayload": [[23, 3, 1, "", "json_hint"], [23, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action": [[23, 1, 1, "", "RotatePageAction"]], "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation.rotate_page_action.RotatePageAction": [[23, 2, 1, "", "get_rotation_angle"], [23, 3, 1, "", "json_hint"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties": [[24, 0, 0, "-", "pdf_properties_external_asset_request"], [24, 0, 0, "-", "pdf_properties_internal_asset_request"], [24, 0, 0, "-", "pdf_properties_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request": [[24, 1, 1, "", "PDFPropertiesExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_external_asset_request.PDFPropertiesExternalAssetRequest": [[24, 3, 1, "", "json_hint"], [24, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request": [[24, 1, 1, "", "PDFPropertiesInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_internal_asset_request.PDFPropertiesInternalAssetRequest": [[24, 3, 1, "", "json_hint"], [24, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload": [[24, 1, 1, "", "PDFPropertiesParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties.pdf_properties_params_payload.PDFPropertiesParamsPayload": [[24, 3, 1, "", "json_hint"], [24, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api": [[25, 0, 0, "-", "pdf_services_api_request"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request": [[25, 1, 1, "", "PDFServicesAPIRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request.PDFServicesAPIRequest": [[25, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage": [[26, 0, 0, "-", "pdf_to_image_external_asset_request"], [26, 0, 0, "-", "pdf_to_image_internal_asset_request"], [26, 0, 0, "-", "pdf_to_image_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request": [[26, 1, 1, "", "PDFtoImagesExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_external_asset_request.PDFtoImagesExternalAssetRequest": [[26, 3, 1, "", "json_hint"], [26, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request": [[26, 1, 1, "", "PDFToImagesInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_internal_asset_request.PDFToImagesInternalAssetRequest": [[26, 3, 1, "", "json_hint"], [26, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload": [[26, 1, 1, "", "PDFtoImageParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage.pdf_to_image_params_payload.PDFtoImageParamsPayload": [[26, 3, 1, "", "json_hint"], [26, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf": [[27, 0, 0, "-", "protect_pdf_external_asset_request"], [27, 0, 0, "-", "protect_pdf_internal_asset_request"], [27, 0, 0, "-", "protect_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request": [[27, 1, 1, "", "ProtectPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_external_asset_request.ProtectPDFExternalAssetRequest": [[27, 3, 1, "", "json_hint"], [27, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request": [[27, 1, 1, "", "ProtectPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_internal_asset_request.ProtectPDFInternalAssetRequest": [[27, 3, 1, "", "json_hint"], [27, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload": [[27, 1, 1, "", "ProtectPDFParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf.protect_pdf_params_payload.ProtectPDFParamsPayload": [[27, 3, 1, "", "json_hint"], [27, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection": [[28, 0, 0, "-", "remove_protection_extenal_asset_request"], [28, 0, 0, "-", "remove_protection_internal_asset_request"], [28, 0, 0, "-", "remove_protection_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request": [[28, 1, 1, "", "RemoveProtectionExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_extenal_asset_request.RemoveProtectionExternalAssetRequest": [[28, 3, 1, "", "json_hint"], [28, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request": [[28, 1, 1, "", "RemoveProtectionInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_internal_asset_request.RemoveProtectionInternalAssetRequest": [[28, 3, 1, "", "json_hint"], [28, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload": [[28, 1, 1, "", "RemoveProtectionParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.remove_protection.remove_protection_params_payload.RemoveProtectionParamsPayload": [[28, 3, 1, "", "json_hint"], [28, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf": [[29, 0, 0, "-", "split_pdf_external_asset_request"], [29, 0, 0, "-", "split_pdf_internal_asset_request"], [29, 0, 0, "-", "split_pdf_params_payload"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request": [[29, 1, 1, "", "SplitPDFExternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_external_asset_request.SplitPDFExternalAssetRequest": [[29, 3, 1, "", "json_hint"], [29, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request": [[29, 1, 1, "", "SplitPDFInternalAssetRequest"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_internal_asset_request.SplitPDFInternalAssetRequest": [[29, 3, 1, "", "json_hint"], [29, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload": [[29, 1, 1, "", "SplitPDFParamsPayload"]], "adobe.pdfservices.operation.internal.api.dto.request.splitpdf.split_pdf_params_payload.SplitPDFParamsPayload": [[29, 3, 1, "", "json_hint"], [29, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.dto.response": [[30, 0, 0, "-", "job_status"], [31, 0, 0, "-", "pdf_services_api"]], "adobe.pdfservices.operation.internal.api.dto.response.job_status": [[30, 1, 1, "", "JobStatus"]], "adobe.pdfservices.operation.internal.api.dto.response.job_status.JobStatus": [[30, 3, 1, "", "DONE"], [30, 3, 1, "", "FAILED"], [30, 3, 1, "", "IN_PROGRESS"]], "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api": [[31, 0, 0, "-", "job_error_response"], [31, 0, 0, "-", "pdf_services_api_response"]], "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response": [[31, 1, 1, "", "JobErrorResponse"]], "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.job_error_response.JobErrorResponse": [[31, 2, 1, "", "get_code"], [31, 2, 1, "", "get_message"], [31, 2, 1, "", "get_status"]], "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response": [[31, 1, 1, "", "PDFServicesAPIResponse"]], "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api.pdf_services_api_response.PDFServicesAPIResponse": [[31, 2, 1, "", "from_json"], [31, 2, 1, "", "get_error_response"], [31, 2, 1, "", "get_status"], [31, 3, 1, "", "json_hint"], [31, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.api.pdf_services_api": [[9, 1, 1, "", "PDFServicesAPI"]], "adobe.pdfservices.operation.internal.api.pdf_services_api.PDFServicesAPI": [[9, 3, 1, "", "POLLING_TIMEOUT_STATUS_CODE"], [9, 3, 1, "", "assets"], [9, 2, 1, "", "delete_asset"], [9, 2, 1, "", "get_response"], [9, 2, 1, "", "handle_error_response"], [9, 3, 1, "", "operation"], [9, 2, 1, "", "status_poll"], [9, 2, 1, "", "submit_job"]], "adobe.pdfservices.operation.internal.api.storage_api": [[9, 1, 1, "", "StorageApi"]], "adobe.pdfservices.operation.internal.api.storage_api.StorageApi": [[9, 3, 1, "", "assets"], [9, 2, 1, "", "get_download_uri"], [9, 2, 1, "", "get_upload_uri"], [9, 2, 1, "", "handle_error_response"], [9, 2, 1, "", "upload_to_cloud"]], "adobe.pdfservices.operation.internal.auth": [[32, 0, 0, "-", "auth_factory"], [32, 0, 0, "-", "authenticator"], [32, 0, 0, "-", "service_principal_authenticator"], [32, 0, 0, "-", "service_token_authenticator"], [32, 0, 0, "-", "service_token_credentials"], [32, 0, 0, "-", "session_token"]], "adobe.pdfservices.operation.internal.auth.auth_factory": [[32, 1, 1, "", "AuthenticatorFactory"]], "adobe.pdfservices.operation.internal.auth.auth_factory.AuthenticatorFactory": [[32, 2, 1, "", "get_authenticator"]], "adobe.pdfservices.operation.internal.auth.authenticator": [[32, 1, 1, "", "Authenticator"]], "adobe.pdfservices.operation.internal.auth.authenticator.Authenticator": [[32, 2, 1, "", "get_api_key"], [32, 2, 1, "", "refresh_token"], [32, 2, 1, "", "session_token"]], "adobe.pdfservices.operation.internal.auth.service_principal_authenticator": [[32, 1, 1, "", "ServicePrincipalAuthenticator"]], "adobe.pdfservices.operation.internal.auth.service_principal_authenticator.ServicePrincipalAuthenticator": [[32, 2, 1, "", "get_api_key"], [32, 2, 1, "", "handle_ims_failure"], [32, 2, 1, "", "refresh_token"], [32, 3, 1, "", "service_principal_configuration"], [32, 2, 1, "", "session_token"], [32, 2, 1, "", "time_to_expire"], [32, 3, 1, "", "token"], [32, 3, 1, "", "token_endpoint"]], "adobe.pdfservices.operation.internal.auth.service_token_authenticator": [[32, 1, 1, "", "ServiceTokenAuthenticator"]], "adobe.pdfservices.operation.internal.auth.service_token_authenticator.ServiceTokenAuthenticator": [[32, 2, 1, "", "get_api_key"], [32, 2, 1, "", "refresh_token"], [32, 2, 1, "", "session_token"]], "adobe.pdfservices.operation.internal.auth.service_token_credentials": [[32, 1, 1, "", "ServiceTokenCredentials"]], "adobe.pdfservices.operation.internal.auth.service_token_credentials.ServiceTokenCredentials": [[32, 2, 1, "", "get_client_id"], [32, 2, 1, "", "get_token"], [32, 2, 1, "", "set_client_id"], [32, 2, 1, "", "set_token"]], "adobe.pdfservices.operation.internal.auth.session_token": [[32, 1, 1, "", "SessionToken"]], "adobe.pdfservices.operation.internal.auth.session_token.SessionToken": [[32, 3, 1, "", "expired_at"]], "adobe.pdfservices.operation.internal.constants": [[33, 0, 0, "-", "custom_error_messages"], [33, 0, 0, "-", "operation_header_info_endpoint_map"], [33, 0, 0, "-", "pdf_services_uri"], [33, 0, 0, "-", "request_key"], [33, 0, 0, "-", "service_constants"]], "adobe.pdfservices.operation.internal.constants.custom_error_messages": [[33, 1, 1, "", "CustomErrorMessages"]], "adobe.pdfservices.operation.internal.constants.custom_error_messages.CustomErrorMessages": [[33, 3, 1, "", "GENERIC_CAN_NOT_BE_NONE"], [33, 3, 1, "", "GENERIC_CAN_NOT_BE_NONE_OR_EMPTY"], [33, 3, 1, "", "INVALID_INPUT_ASSET"], [33, 3, 1, "", "INVALID_OUTPUT_ASSET"], [33, 3, 1, "", "SET_OUTPUT_VALIDATE"]], "adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map": [[33, 1, 1, "", "OperationHeaderInfoEndpointMap"]], "adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map.OperationHeaderInfoEndpointMap": [[33, 3, 1, "", "AUTO_TAG"], [33, 3, 1, "", "COMBINE_PDF"], [33, 3, 1, "", "COMPRESS_PDF"], [33, 3, 1, "", "CREATE_PDF"], [33, 3, 1, "", "DELETE_PAGES"], [33, 3, 1, "", "EXPORT_PDF"], [33, 3, 1, "", "EXPORT_PDF_FORM_DATA"], [33, 3, 1, "", "EXPORT_PDF_TO_IMAGES"], [33, 3, 1, "", "EXTRACT_PDF"], [33, 3, 1, "", "E_SEAL"], [33, 3, 1, "", "HTML_TO_PDF"], [33, 3, 1, "", "IMPORT_PDF_FORM_DATA"], [33, 3, 1, "", "INSERT_PAGES"], [33, 3, 1, "", "LINEARIZE_PDF"], [33, 3, 1, "", "MERGE_DOCUMENT"], [33, 3, 1, "", "OCR"], [33, 3, 1, "", "PDF_ACCESSIBILITY_CHECKER"], [33, 3, 1, "", "PDF_PROPERTIES"], [33, 3, 1, "", "PDF_WATERMARK"], [33, 3, 1, "", "PROTECT_PDF"], [33, 3, 1, "", "REMOVE_PROTECTION"], [33, 3, 1, "", "REORDER_PAGES"], [33, 3, 1, "", "REPLACE_PAGES"], [33, 3, 1, "", "ROTATE_PAGES"], [33, 3, 1, "", "SPLIT_PDF"], [33, 2, 1, "", "get_endpoint"], [33, 2, 1, "", "get_header_info"]], "adobe.pdfservices.operation.internal.constants.pdf_services_uri": [[33, 1, 1, "", "PDFServicesURI"]], "adobe.pdfservices.operation.internal.constants.pdf_services_uri.PDFServicesURI": [[33, 3, 1, "", "EU_URI"], [33, 3, 1, "", "REGION_URI_MAP"], [33, 3, 1, "", "URI"], [33, 3, 1, "", "US_URI"], [33, 2, 1, "", "get_default_uri"], [33, 2, 1, "", "get_uri_for_region"]], "adobe.pdfservices.operation.internal.constants.request_key": [[33, 1, 1, "", "RequestKey"]], "adobe.pdfservices.operation.internal.constants.request_key.RequestKey": [[33, 3, 1, "", "AUTHN"], [33, 3, 1, "", "DOWNLOAD"], [33, 3, 1, "", "PLATFORM"], [33, 3, 1, "", "STATUS"], [33, 3, 1, "", "UPLOAD"]], "adobe.pdfservices.operation.internal.constants.service_constants": [[33, 1, 1, "", "ServiceConstants"]], "adobe.pdfservices.operation.internal.constants.service_constants.ServiceConstants": [[33, 3, 1, "", "AUTOTAG_OPERATION_NAME"], [33, 3, 1, "", "COMBINE_PDF_NAME"], [33, 3, 1, "", "COMPRESS_PDF_OPERATION_NAME"], [33, 3, 1, "", "CREATE_OPERATION_NAME"], [33, 3, 1, "", "DELETE_PAGES_OPERATION_NAME"], [33, 3, 1, "", "DOCUMENT_MERGE_OPERATION_NAME"], [33, 3, 1, "", "ESEAL_PDF_NAME"], [33, 3, 1, "", "EXPORT_PDF_FORM_DATA_OPERATION_NAME"], [33, 3, 1, "", "EXPORT_PDF_OPERATION_NAME"], [33, 3, 1, "", "EXTRACT_OPERATION_NAME"], [33, 3, 1, "", "HTML_TO_PDF_OPERATION_NAME"], [33, 3, 1, "", "HTTP_CONNECT_TIMEOUT"], [33, 3, 1, "", "HTTP_READ_TIMEOUT"], [33, 3, 1, "", "IMPORT_PDF_FORM_DATA_OPERATION_NAME"], [33, 3, 1, "", "INSERT_PAGES_OPERATION_NAME"], [33, 3, 1, "", "LINEARIZE_PDF_OPERATION_NAME"], [33, 3, 1, "", "OCR_PDF_OPERATION_NAME"], [33, 3, 1, "", "OPERATION_RESULT_TEMP_DIRECTORY"], [33, 3, 1, "", "PDF_ACCESSIBILITY_CHECKER_OPERATION_NAME"], [33, 3, 1, "", "PDF_PROPERTIES_OPERATION_NAME"], [33, 3, 1, "", "PDF_TO_IMAGES_OPERATION_NAME"], [33, 3, 1, "", "PDF_WATERMARK_OPERATION_NAME"], [33, 3, 1, "", "PROTECT_PDF_NAME"], [33, 3, 1, "", "REMOVE_PROTECTION_OPERATION_NAME"], [33, 3, 1, "", "REORDER_PAGES_OPERATION_NAME"], [33, 3, 1, "", "REPLACE_PAGES_OPERATION_NAME"], [33, 3, 1, "", "ROTATE_PAGES_OPERATION_NAME"], [33, 3, 1, "", "SPLIT_PDF_OPERATION_NAME"]], "adobe.pdfservices.operation.internal.exceptions": [[8, 6, 1, "", "OperationException"]], "adobe.pdfservices.operation.internal.exceptions.OperationException": [[8, 4, 1, "", "error_code"]], "adobe.pdfservices.operation.internal.execution_context": [[8, 1, 1, "", "ExecutionContext"]], "adobe.pdfservices.operation.internal.execution_context.ExecutionContext": [[8, 4, 1, "", "authenticator"], [8, 4, 1, "", "client_config"], [8, 4, 1, "", "credentials"], [8, 2, 1, "", "validate"]], "adobe.pdfservices.operation.internal.http": [[34, 0, 0, "-", "http_client"], [34, 0, 0, "-", "http_method"], [34, 0, 0, "-", "http_request"], [34, 0, 0, "-", "request_header_const"], [34, 0, 0, "-", "response_util"]], "adobe.pdfservices.operation.internal.http.http_client": [[34, 5, 1, "", "process_request"]], "adobe.pdfservices.operation.internal.http.http_method": [[34, 1, 1, "", "HttpMethod"]], "adobe.pdfservices.operation.internal.http.http_method.HttpMethod": [[34, 3, 1, "", "DELETE"], [34, 3, 1, "", "GET"], [34, 3, 1, "", "POST"], [34, 3, 1, "", "PUT"]], "adobe.pdfservices.operation.internal.http.http_request": [[34, 1, 1, "", "HttpRequest"]], "adobe.pdfservices.operation.internal.http.request_header_const": [[34, 1, 1, "", "DefaultHeaders"]], "adobe.pdfservices.operation.internal.http.request_header_const.DefaultHeaders": [[34, 3, 1, "", "ACCEPT_HEADER_NAME"], [34, 3, 1, "", "AUTHORIZATION_HEADER_NAME"], [34, 3, 1, "", "CONTENT_TYPE_HEADER_NAME"], [34, 3, 1, "", "DC_APP_INFO_HEADER_KEY"], [34, 3, 1, "", "DC_REQUEST_ID_HEADER_KEY"], [34, 3, 1, "", "JSON_TXT_CONTENT_TYPE"], [34, 3, 1, "", "LOCATION_HEADER_NAME"], [34, 3, 1, "", "SESSION_TOKEN_REQUEST_ID_HEADER_KEY"], [34, 3, 1, "", "X_API_KEY_HEADER_NAME"], [34, 3, 1, "", "X_DCSDK_OPS_INFO_HEADER_NAME"]], "adobe.pdfservices.operation.internal.http.response_util": [[34, 1, 1, "", "ResponseUtil"]], "adobe.pdfservices.operation.internal.http.response_util.ResponseUtil": [[34, 3, 1, "", "CUSTOM_ERROR_MESSAGES_STATUS_CODE_MAPPING"], [34, 3, 1, "", "INTEGRATION_SERVICE_USAGE_LIMIT_REACHED_ERROR_MESSAGE"], [34, 3, 1, "", "QUOTA_ERROR_MESSAGE"], [34, 3, 1, "", "SERVICE_USAGE_EXCEPTION_STATUS_CODE_429001_STRING"], [34, 3, 1, "", "SERVICE_USAGE_EXCEPTION_STATUS_CODE_429002_STRING"], [34, 3, 1, "", "SERVICE_USAGE_LIMIT_REACHED_ERROR_MESSAGE"], [34, 2, 1, "", "get_request_tracking_id_from_response"], [34, 2, 1, "", "handle_api_failures"], [34, 2, 1, "", "handle_service_api_error_response"], [34, 2, 1, "", "handle_service_usage_failure"], [34, 2, 1, "", "handle_upload_asset_failure"]], "adobe.pdfservices.operation.internal.params": [[35, 0, 0, "-", "combine_pdf_job_input"], [35, 0, 0, "-", "page_range"]], "adobe.pdfservices.operation.internal.params.combine_pdf_job_input": [[35, 1, 1, "", "CombinePDFJobInput"]], "adobe.pdfservices.operation.internal.params.combine_pdf_job_input.CombinePDFJobInput": [[35, 2, 1, "", "get_asset"], [35, 2, 1, "", "get_page_ranges"], [35, 3, 1, "", "json_hint"], [35, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.internal.params.page_range": [[35, 1, 1, "", "PageRange"]], "adobe.pdfservices.operation.internal.params.page_range.PageRange": [[35, 2, 1, "", "get_end"], [35, 2, 1, "", "get_start"], [35, 3, 1, "", "json_hint"], [35, 2, 1, "", "to_json"], [35, 2, 1, "", "validate"]], "adobe.pdfservices.operation.internal.pdf_services_helper": [[8, 1, 1, "", "PDFServicesHelper"]], "adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper": [[8, 2, 1, "", "delete_asset"], [8, 2, 1, "", "get_content"], [8, 2, 1, "", "get_job_result"], [8, 2, 1, "", "get_job_status"], [8, 2, 1, "", "refresh_download_uri"], [8, 2, 1, "", "submit_job"], [8, 2, 1, "", "upload"], [8, 2, 1, "", "upload_assets"]], "adobe.pdfservices.operation.internal.util": [[36, 0, 0, "-", "asset_upload_util"], [36, 0, 0, "-", "enforce_types"], [36, 0, 0, "-", "file_utils"], [36, 0, 0, "-", "json_hint_encoder"], [36, 0, 0, "-", "object_util"], [36, 0, 0, "-", "path_util"], [36, 0, 0, "-", "string_util"], [36, 0, 0, "-", "validation_util"]], "adobe.pdfservices.operation.internal.util.asset_upload_util": [[36, 1, 1, "", "AssetUploadUtil"]], "adobe.pdfservices.operation.internal.util.enforce_types": [[36, 5, 1, "", "enforce_types"]], "adobe.pdfservices.operation.internal.util.file_utils": [[36, 5, 1, "", "read_conf_file_content"]], "adobe.pdfservices.operation.internal.util.json_hint_encoder": [[36, 1, 1, "", "JSONHintDecoder"], [36, 1, 1, "", "JSONHintEncoder"]], "adobe.pdfservices.operation.internal.util.json_hint_encoder.JSONHintDecoder": [[36, 2, 1, "", "as_class"], [36, 2, 1, "", "rev"]], "adobe.pdfservices.operation.internal.util.json_hint_encoder.JSONHintEncoder": [[36, 2, 1, "", "default"]], "adobe.pdfservices.operation.internal.util.object_util": [[36, 1, 1, "", "ObjectUtil"]], "adobe.pdfservices.operation.internal.util.object_util.ObjectUtil": [[36, 2, 1, "", "require_not_null"]], "adobe.pdfservices.operation.internal.util.path_util": [[36, 5, 1, "", "get_file_path"]], "adobe.pdfservices.operation.internal.util.string_util": [[36, 1, 1, "", "StringUtil"]], "adobe.pdfservices.operation.internal.util.string_util.StringUtil": [[36, 2, 1, "", "is_blank"]], "adobe.pdfservices.operation.internal.util.validation_util": [[36, 1, 1, "", "ValidationUtil"]], "adobe.pdfservices.operation.internal.util.validation_util.ValidationUtil": [[36, 2, 1, "", "validate_asset_with_page_options"], [36, 2, 1, "", "validate_csc_credential"], [36, 2, 1, "", "validate_document_merge_params"], [36, 2, 1, "", "validate_execution_context"], [36, 2, 1, "", "validate_field_location"], [36, 2, 1, "", "validate_field_options"], [36, 2, 1, "", "validate_insert_asset_inputs"], [36, 2, 1, "", "validate_page_options"], [36, 2, 1, "", "validate_page_ranges"], [36, 2, 1, "", "validate_page_ranges_overlap"], [36, 2, 1, "", "validate_password"], [36, 2, 1, "", "validate_password_to_remove_protection"], [36, 2, 1, "", "validate_pdf_electronic_seal_params"], [36, 2, 1, "", "validate_protect_pdf_params"], [36, 2, 1, "", "validate_replace_files_inputs"], [36, 2, 1, "", "validate_rotate_page_actions"], [36, 2, 1, "", "validate_split_pdf_operation_params"]], "adobe.pdfservices.operation.io": [[37, 0, 0, "-", "asset"], [37, 0, 0, "-", "cloud_asset"], [37, 0, 0, "-", "external_asset"], [37, 0, 0, "-", "external_storage_type"], [37, 0, 0, "-", "stream_asset"]], "adobe.pdfservices.operation.io.asset": [[75, 1, 1, "", "Asset"]], "adobe.pdfservices.operation.io.cloud_asset": [[75, 1, 1, "", "CloudAsset"]], "adobe.pdfservices.operation.io.cloud_asset.CloudAsset": [[75, 2, 1, "", "get_asset_id"], [75, 2, 1, "", "get_download_uri"]], "adobe.pdfservices.operation.io.external_asset": [[75, 1, 1, "", "ExternalAsset"]], "adobe.pdfservices.operation.io.external_asset.ExternalAsset": [[75, 2, 1, "", "get_external_storage_type"], [75, 2, 1, "", "get_uri"], [37, 3, 1, "", "json_hint"], [37, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.io.external_storage_type": [[75, 1, 1, "", "ExternalStorageType"]], "adobe.pdfservices.operation.io.external_storage_type.ExternalStorageType": [[75, 3, 1, "", "BLOB"], [75, 3, 1, "", "DROPBOX"], [75, 3, 1, "", "S3"], [75, 3, 1, "", "SHAREPOINT"], [75, 2, 1, "", "get"]], "adobe.pdfservices.operation.io.stream_asset": [[75, 1, 1, "", "StreamAsset"]], "adobe.pdfservices.operation.io.stream_asset.StreamAsset": [[75, 2, 1, "", "get_input_stream"], [75, 2, 1, "", "get_mime_type"]], "adobe.pdfservices.operation.pdf_services": [[74, 1, 1, "", "PDFServices"]], "adobe.pdfservices.operation.pdf_services.PDFServices": [[74, 2, 1, "", "delete_asset"], [74, 2, 1, "", "get_content"], [74, 2, 1, "", "get_job_result"], [74, 2, 1, "", "get_job_status"], [74, 2, 1, "", "refresh_download_uri"], [74, 2, 1, "", "submit"], [74, 2, 1, "", "upload"], [74, 2, 1, "", "upload_assets"]], "adobe.pdfservices.operation.pdf_services_job": [[74, 1, 1, "", "PDFServicesJob"]], "adobe.pdfservices.operation.pdf_services_job_status": [[74, 1, 1, "", "PDFServicesJobStatus"]], "adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus": [[74, 3, 1, "", "DONE"], [74, 3, 1, "", "FAILED"], [74, 3, 1, "", "IN_PROGRESS"], [74, 2, 1, "", "get_value"]], "adobe.pdfservices.operation.pdf_services_job_status_response": [[74, 1, 1, "", "PDFServicesJobStatusResponse"]], "adobe.pdfservices.operation.pdf_services_job_status_response.PDFServicesJobStatusResponse": [[74, 2, 1, "", "get_retry_interval"], [74, 2, 1, "", "get_status"]], "adobe.pdfservices.operation.pdf_services_media_type": [[74, 1, 1, "", "PDFServicesMediaType"]], "adobe.pdfservices.operation.pdf_services_media_type.PDFServicesMediaType": [[74, 3, 1, "", "AI"], [74, 3, 1, "", "BMP"], [74, 3, 1, "", "CSV"], [74, 3, 1, "", "DOC"], [74, 3, 1, "", "DOCX"], [74, 3, 1, "", "GIF"], [74, 3, 1, "", "HTML"], [74, 3, 1, "", "INDD"], [74, 3, 1, "", "JPEG"], [74, 3, 1, "", "JPG"], [74, 3, 1, "", "JSON"], [74, 3, 1, "", "PDF"], [74, 3, 1, "", "PNG"], [74, 3, 1, "", "PPT"], [74, 3, 1, "", "PPTX"], [74, 3, 1, "", "PSD"], [74, 3, 1, "", "RTF"], [74, 3, 1, "", "SVG"], [74, 3, 1, "", "TIF"], [74, 3, 1, "", "TIFF"], [74, 3, 1, "", "TXT"], [74, 3, 1, "", "XLS"], [74, 3, 1, "", "XLSX"], [74, 3, 1, "", "ZIP"], [74, 4, 1, "", "extension"], [74, 2, 1, "", "get_from_extension"], [74, 4, 1, "", "mime_type"]], "adobe.pdfservices.operation.pdf_services_response": [[74, 1, 1, "", "PDFServicesResponse"]], "adobe.pdfservices.operation.pdf_services_response.PDFServicesResponse": [[74, 2, 1, "", "get_result"]], "adobe.pdfservices.operation.pdfjobs": [[39, 0, 0, "-", "jobs"], [41, 0, 0, "-", "params"], [66, 0, 0, "-", "result"]], "adobe.pdfservices.operation.pdfjobs.jobs": [[39, 0, 0, "-", "autotag_pdf_job"], [39, 0, 0, "-", "combine_pdf_job"], [39, 0, 0, "-", "compress_pdf_job"], [39, 0, 0, "-", "create_pdf_job"], [39, 0, 0, "-", "delete_pages_job"], [39, 0, 0, "-", "document_merge_job"], [39, 0, 0, "-", "eseal_job"], [40, 0, 0, "-", "export_pdf_form_data_job"], [39, 0, 0, "-", "export_pdf_job"], [39, 0, 0, "-", "export_pdf_to_images_job"], [39, 0, 0, "-", "extract_pdf_job"], [39, 0, 0, "-", "html_to_pdf_job"], [39, 0, 0, "-", "insert_pages_job"], [39, 0, 0, "-", "linearize_pdf_job"], [39, 0, 0, "-", "ocr_pdf_job"], [39, 0, 0, "-", "pdf_properties_job"], [39, 0, 0, "-", "protect_pdf_job"], [39, 0, 0, "-", "remove_protection_job"], [39, 0, 0, "-", "reorder_pages_job"], [39, 0, 0, "-", "replace_pages_job"], [39, 0, 0, "-", "rotate_pages_job"], [39, 0, 0, "-", "split_pdf_job"]], "adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job": [[77, 1, 1, "", "AutotagPDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.combine_pdf_job": [[77, 1, 1, "", "CombinePDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.compress_pdf_job": [[77, 1, 1, "", "CompressPDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.create_pdf_job": [[77, 1, 1, "", "CreatePDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.delete_pages_job": [[77, 1, 1, "", "DeletePagesJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job": [[77, 1, 1, "", "DocumentMergeJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.eseal_job": [[77, 1, 1, "", "PDFElectronicSealJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job": [[40, 1, 1, "", "ExportPDFFormDataJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_job": [[77, 1, 1, "", "ExportPDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_to_images_job": [[77, 1, 1, "", "ExportPDFtoImagesJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.extract_pdf_job": [[77, 1, 1, "", "ExtractPDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.html_to_pdf_job": [[77, 1, 1, "", "HTMLtoPDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.import_pdf_form_data_job": [[77, 1, 1, "", "ImportPDFFormDataJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.import_pdf_form_data_job.ImportPDFFormDataJob": [[77, 2, 1, "", "set_output"], [77, 2, 1, "", "set_params"]], "adobe.pdfservices.operation.pdfjobs.jobs.insert_pages_job": [[77, 1, 1, "", "InsertPagesJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.linearize_pdf_job": [[77, 1, 1, "", "LinearizePDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job": [[77, 1, 1, "", "OCRPDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.pdf_accessibility_checker_job": [[77, 1, 1, "", "PDFAccessibilityCheckerJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.pdf_properties_job": [[77, 1, 1, "", "PDFPropertiesJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.pdf_watermark_job": [[77, 1, 1, "", "PDFWatermarkJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.protect_pdf_job": [[77, 1, 1, "", "ProtectPDFJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.remove_protection_job": [[77, 1, 1, "", "RemoveProtectionJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.reorder_pages_job": [[77, 1, 1, "", "ReorderPagesJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.replace_pages_job": [[77, 1, 1, "", "ReplacePagesJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.rotate_pages_job": [[77, 1, 1, "", "RotatePagesJob"]], "adobe.pdfservices.operation.pdfjobs.jobs.split_pdf_job": [[77, 1, 1, "", "SplitPDFJob"]], "adobe.pdfservices.operation.pdfjobs.params": [[42, 0, 0, "-", "autotag_pdf"], [43, 0, 0, "-", "combine_pdf"], [44, 0, 0, "-", "compress_pdf"], [45, 0, 0, "-", "create_pdf"], [49, 0, 0, "-", "delete_pages"], [50, 0, 0, "-", "documentmerge"], [51, 0, 0, "-", "eseal"], [52, 0, 0, "-", "export_pdf"], [53, 0, 0, "-", "extract_pdf"], [54, 0, 0, "-", "html_to_pdf"], [55, 0, 0, "-", "import_pdf_form_data"], [56, 0, 0, "-", "insert_pages"], [57, 0, 0, "-", "ocr_pdf"], [41, 0, 0, "-", "page_ranges"], [58, 0, 0, "-", "pdf_properties"], [41, 0, 0, "-", "pdf_services_job_params"], [59, 0, 0, "-", "pdf_to_image"], [60, 0, 0, "-", "protect_pdf"], [61, 0, 0, "-", "remove_protection"], [62, 0, 0, "-", "reorder_pages"], [63, 0, 0, "-", "replace_pages"], [64, 0, 0, "-", "rotate_pages"], [65, 0, 0, "-", "split_pdf"]], "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf": [[78, 0, 0, "-", "autotag_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params": [[78, 1, 1, "", "AutotagPDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf.autotag_pdf_params.AutotagPDFParams": [[78, 2, 1, "", "get_generate_report"], [78, 2, 1, "", "get_shift_headings"]], "adobe.pdfservices.operation.pdfjobs.params.combine_pdf": [[78, 0, 0, "-", "combine_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params": [[78, 1, 1, "", "CombinePDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.combine_pdf.combine_pdf_params.CombinePDFParams": [[78, 2, 1, "", "add_asset"], [78, 2, 1, "", "get_assets_to_combine"]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf": [[78, 0, 0, "-", "compress_pdf_params"], [78, 0, 0, "-", "compression_level"]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params": [[78, 1, 1, "", "CompressPDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compress_pdf_params.CompressPDFParams": [[78, 2, 1, "", "get_compression_level"]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level": [[78, 1, 1, "", "CompressionLevel"]], "adobe.pdfservices.operation.pdfjobs.params.compress_pdf.compression_level.CompressionLevel": [[78, 3, 1, "", "HIGH"], [78, 3, 1, "", "LOW"], [78, 3, 1, "", "MEDIUM"], [78, 2, 1, "", "get_compression_level"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf": [[78, 0, 0, "-", "CreatePDFParams"], [46, 0, 0, "-", "excel"], [47, 0, 0, "-", "ppt"], [48, 0, 0, "-", "word"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams": [[78, 1, 1, "", "CreatePDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams.CreatePDFParams": [[45, 2, 1, "", "get_create_tagged_pdf"], [45, 2, 1, "", "get_document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel": [[78, 0, 0, "-", "create_pdf_from_excel_params"], [78, 0, 0, "-", "document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params": [[78, 1, 1, "", "CreatePDFFromExcelParams"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.create_pdf_from_excel_params.CreatePDFFromExcelParams": [[46, 2, 1, "", "get_create_tagged_pdf"], [78, 2, 1, "", "get_document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language": [[78, 1, 1, "", "DocumentLanguage"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel.document_language.DocumentLanguage": [[78, 3, 1, "", "BG_BG"], [78, 3, 1, "", "CA_CA"], [78, 3, 1, "", "CS_CZ"], [78, 3, 1, "", "DA_DK"], [78, 3, 1, "", "DE_CH"], [78, 3, 1, "", "DE_DE"], [78, 3, 1, "", "EL_GR"], [78, 3, 1, "", "EN_GB"], [78, 3, 1, "", "EN_US"], [78, 3, 1, "", "ES_ES"], [78, 3, 1, "", "ET_EE"], [78, 3, 1, "", "FI_FI"], [78, 3, 1, "", "FR_FR"], [78, 3, 1, "", "HR_HR"], [78, 3, 1, "", "HU_HU"], [78, 3, 1, "", "IT_IT"], [78, 3, 1, "", "IW_IL"], [78, 3, 1, "", "JA_JP"], [78, 3, 1, "", "KO_KR"], [78, 3, 1, "", "LT_LT"], [78, 3, 1, "", "LV_LV"], [78, 3, 1, "", "MK_MK"], [78, 3, 1, "", "MT_MT"], [78, 3, 1, "", "NB_NO"], [78, 3, 1, "", "NL_NL"], [78, 3, 1, "", "NO_NO"], [78, 3, 1, "", "PL_PL"], [78, 3, 1, "", "PT_BR"], [78, 3, 1, "", "RO_RO"], [78, 3, 1, "", "RU_RU"], [78, 3, 1, "", "SK_SK"], [78, 3, 1, "", "SL_SI"], [78, 3, 1, "", "SR_SR"], [78, 3, 1, "", "SV_SE"], [78, 3, 1, "", "TR_TR"], [78, 3, 1, "", "UK_UA"], [78, 3, 1, "", "ZH_CN"], [78, 3, 1, "", "ZH_HK"], [78, 2, 1, "", "get_document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt": [[78, 0, 0, "-", "create_pdf_from_ppt_params"], [78, 0, 0, "-", "document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params": [[78, 1, 1, "", "CreatePDFFromPPTParams"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.create_pdf_from_ppt_params.CreatePDFFromPPTParams": [[47, 2, 1, "", "get_create_tagged_pdf"], [78, 2, 1, "", "get_document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language": [[78, 1, 1, "", "DocumentLanguage"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt.document_language.DocumentLanguage": [[78, 3, 1, "", "BG_BG"], [78, 3, 1, "", "CA_CA"], [78, 3, 1, "", "CS_CZ"], [78, 3, 1, "", "DA_DK"], [78, 3, 1, "", "DE_CH"], [78, 3, 1, "", "DE_DE"], [78, 3, 1, "", "EL_GR"], [78, 3, 1, "", "EN_GB"], [78, 3, 1, "", "EN_US"], [78, 3, 1, "", "ES_ES"], [78, 3, 1, "", "ET_EE"], [78, 3, 1, "", "FI_FI"], [78, 3, 1, "", "FR_FR"], [78, 3, 1, "", "HR_HR"], [78, 3, 1, "", "HU_HU"], [78, 3, 1, "", "IT_IT"], [78, 3, 1, "", "IW_IL"], [78, 3, 1, "", "JA_JP"], [78, 3, 1, "", "KO_KR"], [78, 3, 1, "", "LT_LT"], [78, 3, 1, "", "LV_LV"], [78, 3, 1, "", "MK_MK"], [78, 3, 1, "", "MT_MT"], [78, 3, 1, "", "NB_NO"], [78, 3, 1, "", "NL_NL"], [78, 3, 1, "", "NO_NO"], [78, 3, 1, "", "PL_PL"], [78, 3, 1, "", "PT_BR"], [78, 3, 1, "", "RO_RO"], [78, 3, 1, "", "RU_RU"], [78, 3, 1, "", "SK_SK"], [78, 3, 1, "", "SL_SI"], [78, 3, 1, "", "SR_SR"], [78, 3, 1, "", "SV_SE"], [78, 3, 1, "", "TR_TR"], [78, 3, 1, "", "UK_UA"], [78, 3, 1, "", "ZH_CN"], [78, 3, 1, "", "ZH_HK"], [78, 2, 1, "", "get_document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word": [[78, 0, 0, "-", "create_pdf_from_word_params"], [78, 0, 0, "-", "document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params": [[78, 1, 1, "", "CreatePDFFromWordParams"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.create_pdf_from_word_params.CreatePDFFromWordParams": [[48, 2, 1, "", "get_create_tagged_pdf"], [78, 2, 1, "", "get_document_language"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language": [[78, 1, 1, "", "DocumentLanguage"]], "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word.document_language.DocumentLanguage": [[78, 3, 1, "", "BG_BG"], [78, 3, 1, "", "CA_CA"], [78, 3, 1, "", "CS_CZ"], [78, 3, 1, "", "DA_DK"], [78, 3, 1, "", "DE_CH"], [78, 3, 1, "", "DE_DE"], [78, 3, 1, "", "EL_GR"], [78, 3, 1, "", "EN_GB"], [78, 3, 1, "", "EN_US"], [78, 3, 1, "", "ES_ES"], [78, 3, 1, "", "ET_EE"], [78, 3, 1, "", "FI_FI"], [78, 3, 1, "", "FR_FR"], [78, 3, 1, "", "HR_HR"], [78, 3, 1, "", "HU_HU"], [78, 3, 1, "", "IT_IT"], [78, 3, 1, "", "IW_IL"], [78, 3, 1, "", "JA_JP"], [78, 3, 1, "", "KO_KR"], [78, 3, 1, "", "LT_LT"], [78, 3, 1, "", "LV_LV"], [78, 3, 1, "", "MK_MK"], [78, 3, 1, "", "MT_MT"], [78, 3, 1, "", "NB_NO"], [78, 3, 1, "", "NL_NL"], [78, 3, 1, "", "NO_NO"], [78, 3, 1, "", "PL_PL"], [78, 3, 1, "", "PT_BR"], [78, 3, 1, "", "RO_RO"], [78, 3, 1, "", "RU_RU"], [78, 3, 1, "", "SK_SK"], [78, 3, 1, "", "SL_SI"], [78, 3, 1, "", "SR_SR"], [78, 3, 1, "", "SV_SE"], [78, 3, 1, "", "TR_TR"], [78, 3, 1, "", "UK_UA"], [78, 3, 1, "", "ZH_CN"], [78, 3, 1, "", "ZH_HK"], [78, 2, 1, "", "get_document_language"]], "adobe.pdfservices.operation.pdfjobs.params.delete_pages": [[78, 0, 0, "-", "delete_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params": [[78, 1, 1, "", "DeletePagesParams"]], "adobe.pdfservices.operation.pdfjobs.params.delete_pages.delete_pages_params.DeletePagesParams": [[78, 2, 1, "", "get_page_ranges"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge": [[78, 0, 0, "-", "document_merge_params"], [78, 0, 0, "-", "fragments"], [78, 0, 0, "-", "output_format"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params": [[78, 1, 1, "", "DocumentMergeParams"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.DocumentMergeParams": [[78, 2, 1, "", "get_fragments"], [78, 2, 1, "", "get_json_data_for_merge"], [78, 2, 1, "", "get_output_format"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments": [[78, 1, 1, "", "Fragments"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments": [[78, 2, 1, "", "add_fragment"], [78, 2, 1, "", "add_fragments"], [78, 2, 1, "", "get_fragments_list"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format": [[78, 1, 1, "", "OutputFormat"]], "adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.OutputFormat": [[78, 3, 1, "", "DOCX"], [78, 3, 1, "", "PDF"], [78, 2, 1, "", "get_format"]], "adobe.pdfservices.operation.pdfjobs.params.eseal": [[78, 0, 0, "-", "RFC3161_tsa_options"], [78, 0, 0, "-", "appearance_item"], [78, 0, 0, "-", "appearance_options"], [78, 0, 0, "-", "csc_auth_context"], [78, 0, 0, "-", "csc_credentials"], [78, 0, 0, "-", "document_level_permission"], [78, 0, 0, "-", "electronic_seal_params"], [78, 0, 0, "-", "field_location"], [78, 0, 0, "-", "field_options"], [78, 0, 0, "-", "signature_format"], [78, 0, 0, "-", "tsa_basic_auth_credentials"], [78, 0, 0, "-", "tsa_options"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options": [[78, 1, 1, "", "RFC3161TSAOptions"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options.RFC3161TSAOptions": [[78, 2, 1, "", "get_tsa_basic_auth_credentials"], [78, 2, 1, "", "get_url"], [51, 2, 1, "", "to_dict"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item": [[78, 1, 1, "", "AppearanceItem"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem": [[78, 3, 1, "", "DATE"], [78, 3, 1, "", "DISTINGUISHED_NAME"], [78, 3, 1, "", "LABELS"], [78, 3, 1, "", "NAME"], [78, 3, 1, "", "SEAL_IMAGE"], [51, 2, 1, "", "get_appearance_item"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options": [[78, 1, 1, "", "AppearanceOptions"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.AppearanceOptions": [[78, 2, 1, "", "add_item"], [78, 2, 1, "", "get_appearance_options"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context": [[78, 1, 1, "", "CSCAuthContext"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.CSCAuthContext": [[78, 2, 1, "", "get_access_token"], [78, 2, 1, "", "get_token_type"], [51, 2, 1, "", "to_dict"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials": [[78, 1, 1, "", "CSCCredentials"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials": [[78, 2, 1, "", "get_credential_id"], [78, 2, 1, "", "get_csc_auth_context"], [78, 2, 1, "", "get_pin"], [78, 2, 1, "", "get_provider_name"], [51, 2, 1, "", "to_dict"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission": [[78, 1, 1, "", "DocumentLevelPermission"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.DocumentLevelPermission": [[78, 3, 1, "", "FORM_FILLING"], [78, 3, 1, "", "FORM_FILLING_AND_ANNOTATIONS"], [78, 3, 1, "", "NO_CHANGES_ALLOWED"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params": [[78, 1, 1, "", "PDFElectronicSealParams"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams": [[78, 2, 1, "", "get_seal_appearance_options"], [78, 2, 1, "", "get_seal_certificate_credentials"], [78, 2, 1, "", "get_seal_field_options"], [78, 2, 1, "", "get_signature_format"], [51, 2, 1, "", "to_dict"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location": [[78, 1, 1, "", "FieldLocation"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation": [[78, 2, 1, "", "get_bottom"], [78, 2, 1, "", "get_left"], [78, 2, 1, "", "get_right"], [78, 2, 1, "", "get_top"], [51, 2, 1, "", "to_dict"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options": [[78, 1, 1, "", "FieldOptions"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions": [[78, 2, 1, "", "get_field_location"], [78, 2, 1, "", "get_field_name"], [78, 2, 1, "", "get_page_number"], [78, 2, 1, "", "get_visible"], [51, 2, 1, "", "to_dict"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format": [[78, 1, 1, "", "SignatureFormat"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.SignatureFormat": [[78, 3, 1, "", "PADES"], [78, 3, 1, "", "PKCS7"], [78, 2, 1, "", "get_signature_format"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials": [[78, 1, 1, "", "TSABasicAuthCredentials"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.TSABasicAuthCredentials": [[78, 2, 1, "", "get_password"], [78, 2, 1, "", "get_username"], [51, 2, 1, "", "to_dict"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options": [[78, 1, 1, "", "TSAOptions"]], "adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options.TSAOptions": [[51, 2, 1, "", "to_dict"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf": [[78, 0, 0, "-", "export_ocr_locale"], [78, 0, 0, "-", "export_pdf_params"], [78, 0, 0, "-", "export_pdf_target_format"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale": [[78, 1, 1, "", "ExportOCRLocale"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_ocr_locale.ExportOCRLocale": [[78, 3, 1, "", "BG_BG"], [78, 3, 1, "", "CA_CA"], [78, 3, 1, "", "CS_CZ"], [78, 3, 1, "", "DA_DK"], [78, 3, 1, "", "DE_CH"], [78, 3, 1, "", "DE_DE"], [78, 3, 1, "", "EL_GR"], [78, 3, 1, "", "EN_GB"], [78, 3, 1, "", "EN_US"], [78, 3, 1, "", "ES_ES"], [78, 3, 1, "", "ET_EE"], [78, 3, 1, "", "EU_ES"], [78, 3, 1, "", "FI_FI"], [78, 3, 1, "", "FR_FR"], [78, 3, 1, "", "GL_ES"], [78, 3, 1, "", "HR_HR"], [78, 3, 1, "", "HU_HU"], [78, 3, 1, "", "IT_IT"], [78, 3, 1, "", "IW_IL"], [78, 3, 1, "", "JA_JP"], [78, 3, 1, "", "KO_KR"], [78, 3, 1, "", "LT_LT"], [78, 3, 1, "", "LV_LV"], [78, 3, 1, "", "MK_MK"], [78, 3, 1, "", "MT_MT"], [78, 3, 1, "", "NB_NO"], [78, 3, 1, "", "NL_NL"], [78, 3, 1, "", "NN_NO"], [78, 3, 1, "", "PL_PL"], [78, 3, 1, "", "PT_BR"], [78, 3, 1, "", "PT_PT"], [78, 3, 1, "", "RO_RO"], [78, 3, 1, "", "RU_RU"], [78, 3, 1, "", "SK_SK"], [78, 3, 1, "", "SL_SI"], [78, 3, 1, "", "SR_SR"], [78, 3, 1, "", "SV_SE"], [78, 3, 1, "", "TR_TR"], [78, 3, 1, "", "UK_UA"], [78, 3, 1, "", "ZH_CN"], [78, 3, 1, "", "ZH_HANT"], [78, 2, 1, "", "get_export_ocr_locale"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params": [[78, 1, 1, "", "ExportPDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_params.ExportPDFParams": [[78, 2, 1, "", "get_ocr_lang"], [78, 2, 1, "", "get_target_format"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format": [[78, 1, 1, "", "ExportPDFTargetFormat"]], "adobe.pdfservices.operation.pdfjobs.params.export_pdf.export_pdf_target_format.ExportPDFTargetFormat": [[78, 3, 1, "", "DOC"], [78, 3, 1, "", "DOCX"], [78, 3, 1, "", "PPTX"], [78, 3, 1, "", "RTF"], [78, 3, 1, "", "XLSX"], [78, 2, 1, "", "get_file_ext"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf": [[78, 0, 0, "-", "extract_element_type"], [78, 0, 0, "-", "extract_pdf_params"], [78, 0, 0, "-", "extract_renditions_element_type"], [78, 0, 0, "-", "table_structure_type"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type": [[78, 1, 1, "", "ExtractElementType"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_element_type.ExtractElementType": [[78, 3, 1, "", "TABLES"], [78, 3, 1, "", "TEXT"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params": [[78, 1, 1, "", "ExtractPDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_pdf_params.ExtractPDFParams": [[78, 2, 1, "", "get_add_char_info"], [78, 2, 1, "", "get_elements_to_extract"], [78, 2, 1, "", "get_elements_to_extract_renditions"], [78, 2, 1, "", "get_styling_info"], [78, 2, 1, "", "get_table_structure_type"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type": [[78, 1, 1, "", "ExtractRenditionsElementType"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.extract_renditions_element_type.ExtractRenditionsElementType": [[78, 3, 1, "", "FIGURES"], [78, 3, 1, "", "TABLES"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type": [[78, 1, 1, "", "TableStructureType"]], "adobe.pdfservices.operation.pdfjobs.params.extract_pdf.table_structure_type.TableStructureType": [[78, 3, 1, "", "CSV"], [78, 3, 1, "", "XLSX"]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf": [[78, 0, 0, "-", "html_to_pdf_params"], [78, 0, 0, "-", "page_layout"]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params": [[78, 1, 1, "", "HTMLtoPDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.html_to_pdf_params.HTMLtoPDFParams": [[78, 2, 1, "", "get_include_header_footer"], [78, 2, 1, "", "get_json"], [78, 2, 1, "", "get_page_layout"]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout": [[78, 1, 1, "", "PageLayout"]], "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf.page_layout.PageLayout": [[78, 3, 1, "", "DEFAULT_PAGE_HEIGHT"], [78, 3, 1, "", "DEFAULT_PAGE_WIDTH"], [54, 3, 1, "", "json_hint"], [54, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data": [[78, 0, 0, "-", "import_pdf_form_data_params"]], "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params": [[78, 1, 1, "", "ImportPDFFormDataParams"]], "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params.ImportPDFFormDataParams": [[78, 2, 1, "", "get_json_form_fields_data"], [78, 2, 1, "", "get_json_form_fields_data_string"]], "adobe.pdfservices.operation.pdfjobs.params.insert_pages": [[78, 0, 0, "-", "insert_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params": [[78, 1, 1, "", "InsertPagesParams"]], "adobe.pdfservices.operation.pdfjobs.params.insert_pages.insert_pages_params.InsertPagesParams": [[78, 2, 1, "", "add_pages_to_insert"], [78, 2, 1, "", "get_assets_to_insert"], [78, 2, 1, "", "get_base_asset"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf": [[78, 0, 0, "-", "ocr_params"], [78, 0, 0, "-", "ocr_supported_locale"], [78, 0, 0, "-", "ocr_supported_type"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params": [[78, 1, 1, "", "OCRParams"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.OCRParams": [[78, 2, 1, "", "get_ocr_locale"], [78, 2, 1, "", "get_ocr_type"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale": [[78, 1, 1, "", "OCRSupportedLocale"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale": [[78, 3, 1, "", "BG_BG"], [78, 3, 1, "", "CA_CA"], [78, 3, 1, "", "CS_CZ"], [78, 3, 1, "", "DA_DK"], [78, 3, 1, "", "DE_CH"], [78, 3, 1, "", "DE_DE"], [78, 3, 1, "", "EL_GR"], [78, 3, 1, "", "EN_GB"], [78, 3, 1, "", "EN_US"], [78, 3, 1, "", "ES_ES"], [78, 3, 1, "", "ET_EE"], [78, 3, 1, "", "FI_FI"], [78, 3, 1, "", "FR_FR"], [78, 3, 1, "", "HR_HR"], [78, 3, 1, "", "HU_HU"], [78, 3, 1, "", "IT_IT"], [78, 3, 1, "", "IW_IL"], [78, 3, 1, "", "JA_JP"], [78, 3, 1, "", "KO_KR"], [78, 3, 1, "", "LT_LT"], [78, 3, 1, "", "LV_LV"], [78, 3, 1, "", "MK_MK"], [78, 3, 1, "", "MT_MT"], [78, 3, 1, "", "NB_NO"], [78, 3, 1, "", "NL_NL"], [78, 3, 1, "", "NO_NO"], [78, 3, 1, "", "PL_PL"], [78, 3, 1, "", "PT_BR"], [78, 3, 1, "", "RO_RO"], [78, 3, 1, "", "RU_RU"], [78, 3, 1, "", "SK_SK"], [78, 3, 1, "", "SL_SI"], [78, 3, 1, "", "SR_SR"], [78, 3, 1, "", "SV_SE"], [78, 3, 1, "", "TR_TR"], [78, 3, 1, "", "UK_UA"], [78, 3, 1, "", "ZH_CN"], [78, 3, 1, "", "ZH_HK"], [78, 2, 1, "", "get_locale"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type": [[78, 1, 1, "", "OCRSupportedType"]], "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.OCRSupportedType": [[78, 3, 1, "", "SEARCHABLE_IMAGE"], [78, 3, 1, "", "SEARCHABLE_IMAGE_EXACT"], [78, 2, 1, "", "get_type"]], "adobe.pdfservices.operation.pdfjobs.params.page_ranges": [[78, 1, 1, "", "PageRanges"]], "adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges": [[78, 2, 1, "", "add_all"], [78, 2, 1, "", "add_all_from"], [78, 2, 1, "", "add_range"], [78, 2, 1, "", "add_single_page"], [78, 2, 1, "", "get_ranges"], [78, 2, 1, "", "is_empty"], [41, 3, 1, "", "json_hint"], [41, 2, 1, "", "to_json"], [41, 2, 1, "", "validate"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker": [[78, 0, 0, "-", "pdf_accessibility_checker_params"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params": [[78, 1, 1, "", "PDFAccessibilityCheckerParams"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params.PDFAccessibilityCheckerParams": [[78, 2, 1, "", "get_page_end"], [78, 2, 1, "", "get_page_start"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_properties": [[78, 0, 0, "-", "pdf_properties_params"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params": [[78, 1, 1, "", "PDFPropertiesParams"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_properties.pdf_properties_params.PDFPropertiesParams": [[78, 2, 1, "", "get_include_page_level_properties"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_services_job_params": [[78, 1, 1, "", "PDFServicesJobParams"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image": [[78, 0, 0, "-", "export_pdf_to_images_output_type"], [78, 0, 0, "-", "export_pdf_to_images_params"], [78, 0, 0, "-", "export_pdf_to_images_target_format"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type": [[78, 1, 1, "", "ExportPDFToImagesOutputType"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_output_type.ExportPDFToImagesOutputType": [[78, 3, 1, "", "LIST_OF_PAGE_IMAGES"], [78, 3, 1, "", "ZIP_OF_PAGE_IMAGES"], [78, 2, 1, "", "get_output_type"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params": [[78, 1, 1, "", "ExportPDFtoImagesParams"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_params.ExportPDFtoImagesParams": [[78, 2, 1, "", "get_export_pdf_to_images_output_type"], [78, 2, 1, "", "get_export_pdf_to_images_target_format"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format": [[78, 1, 1, "", "ExportPDFToImagesTargetFormat"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image.export_pdf_to_images_target_format.ExportPDFToImagesTargetFormat": [[78, 3, 1, "", "JPEG"], [78, 3, 1, "", "PNG"], [78, 2, 1, "", "get_file_ext"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params": [[78, 1, 1, "", "PDFWatermarkParams"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.pdf_watermark_params.PDFWatermarkParams": [[78, 2, 1, "", "get_page_ranges"], [78, 2, 1, "", "get_watermark_appearance"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance": [[78, 1, 1, "", "WatermarkAppearance"]], "adobe.pdfservices.operation.pdfjobs.params.pdf_watermark.watermark_appearance.WatermarkAppearance": [[78, 2, 1, "", "get_appear_on_foreground"], [78, 2, 1, "", "get_opacity"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf": [[78, 0, 0, "-", "content_encryption"], [78, 0, 0, "-", "encryption_algorithm"], [78, 0, 0, "-", "password_protect_params"], [78, 0, 0, "-", "permission"], [78, 0, 0, "-", "permissions"], [78, 0, 0, "-", "protect_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption": [[78, 1, 1, "", "ContentEncryption"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.content_encryption.ContentEncryption": [[78, 3, 1, "", "ALL_CONTENT"], [78, 3, 1, "", "ALL_CONTENT_EXCEPT_METADATA"], [78, 3, 1, "", "ONLY_EMBEDDED_FILES"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm": [[78, 1, 1, "", "EncryptionAlgorithm"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.encryption_algorithm.EncryptionAlgorithm": [[78, 3, 1, "", "AES_128"], [78, 3, 1, "", "AES_256"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params": [[78, 1, 1, "", "PasswordProtectParams"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.password_protect_params.PasswordProtectParams": [[78, 2, 1, "", "get_content_encryption"], [78, 2, 1, "", "get_encryption_algorithm"], [78, 2, 1, "", "get_owner_password"], [78, 2, 1, "", "get_permissions"], [78, 2, 1, "", "get_user_password"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission": [[78, 1, 1, "", "Permission"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permission.Permission": [[78, 3, 1, "", "COPY_CONTENT"], [78, 3, 1, "", "EDIT_ANNOTATIONS"], [78, 3, 1, "", "EDIT_CONTENT"], [78, 3, 1, "", "EDIT_DOCUMENT_ASSEMBLY"], [78, 3, 1, "", "EDIT_FILL_AND_SIGN_FORM_FIELDS"], [78, 3, 1, "", "PRINT_HIGH_QUALITY"], [78, 3, 1, "", "PRINT_LOW_QUALITY"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions": [[78, 1, 1, "", "Permissions"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.permissions.Permissions": [[78, 2, 1, "", "add_permission"], [78, 2, 1, "", "get_values"]], "adobe.pdfservices.operation.pdfjobs.params.protect_pdf.protect_pdf_params": [[78, 1, 1, "", "ProtectPDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.remove_protection": [[78, 0, 0, "-", "remove_protection_params"]], "adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params": [[78, 1, 1, "", "RemoveProtectionParams"]], "adobe.pdfservices.operation.pdfjobs.params.remove_protection.remove_protection_params.RemoveProtectionParams": [[78, 2, 1, "", "get_password"]], "adobe.pdfservices.operation.pdfjobs.params.reorder_pages": [[78, 0, 0, "-", "reorder_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params": [[78, 1, 1, "", "ReorderPagesParams"]], "adobe.pdfservices.operation.pdfjobs.params.reorder_pages.reorder_pages_params.ReorderPagesParams": [[78, 2, 1, "", "get_asset"], [78, 2, 1, "", "get_page_ranges"]], "adobe.pdfservices.operation.pdfjobs.params.replace_pages": [[78, 0, 0, "-", "replace_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params": [[78, 1, 1, "", "ReplacePagesParams"]], "adobe.pdfservices.operation.pdfjobs.params.replace_pages.replace_pages_params.ReplacePagesParams": [[78, 2, 1, "", "add_pages_to_replace"], [78, 2, 1, "", "get_assets_to_replace"], [78, 2, 1, "", "get_base_asset"]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages": [[78, 0, 0, "-", "angle"], [78, 0, 0, "-", "rotate_pages_params"]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle": [[78, 1, 1, "", "Angle"]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.angle.Angle": [[78, 3, 1, "", "ANGLE_180"], [78, 3, 1, "", "ANGLE_270"], [78, 3, 1, "", "ANGLE_90"]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params": [[78, 1, 1, "", "RotatePagesParams"]], "adobe.pdfservices.operation.pdfjobs.params.rotate_pages.rotate_pages_params.RotatePagesParams": [[78, 2, 1, "", "add_angle_to_rotate"], [78, 2, 1, "", "add_angle_to_rotate_for_page_ranges"], [78, 2, 1, "", "get_page_actions"]], "adobe.pdfservices.operation.pdfjobs.params.split_pdf": [[78, 0, 0, "-", "split_pdf_params"]], "adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params": [[78, 1, 1, "", "SplitPDFParams"]], "adobe.pdfservices.operation.pdfjobs.params.split_pdf.split_pdf_params.SplitPDFParams": [[78, 2, 1, "", "get_file_count"], [78, 2, 1, "", "get_page_count"], [78, 2, 1, "", "get_page_ranges"], [65, 3, 1, "", "json_hint"], [65, 2, 1, "", "to_json"]], "adobe.pdfservices.operation.pdfjobs.result": [[66, 0, 0, "-", "autotag_pdf_result"], [66, 0, 0, "-", "combine_pdf_result"], [66, 0, 0, "-", "compress_pdf_result"], [66, 0, 0, "-", "create_pdf_result"], [66, 0, 0, "-", "delete_pages_result"], [66, 0, 0, "-", "document_merge_result"], [66, 0, 0, "-", "eseal_pdf_result"], [66, 0, 0, "-", "export_pdf_result"], [66, 0, 0, "-", "export_pdf_to_images_result"], [66, 0, 0, "-", "extract_pdf_result"], [66, 0, 0, "-", "html_to_pdf_result"], [66, 0, 0, "-", "insert_pages_result"], [66, 0, 0, "-", "linearize_pdf_result"], [66, 0, 0, "-", "ocr_pdf_result"], [66, 0, 0, "-", "pdf_properties_result"], [66, 0, 0, "-", "pdf_services_job_result"], [66, 0, 0, "-", "protect_pdf_result"], [66, 0, 0, "-", "remove_protection_result"], [66, 0, 0, "-", "reorder_pages_result"], [66, 0, 0, "-", "replace_page_result"], [66, 0, 0, "-", "rotate_pages_result"], [66, 0, 0, "-", "split_pdf_result"]], "adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result": [[79, 1, 1, "", "AutotagPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result.AutotagPDFResult": [[79, 2, 1, "", "get_report"], [79, 2, 1, "", "get_resource"], [79, 2, 1, "", "get_tagged_pdf"]], "adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result": [[79, 1, 1, "", "CombinePDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.combine_pdf_result.CombinePDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result": [[79, 1, 1, "", "CompressPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result.CompressPDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.create_pdf_result": [[79, 1, 1, "", "CreatePDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.create_pdf_result.CreatePDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.delete_pages_result": [[79, 1, 1, "", "DeletePagesResult"]], "adobe.pdfservices.operation.pdfjobs.result.delete_pages_result.DeletePagesResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.document_merge_result": [[79, 1, 1, "", "DocumentMergePDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.document_merge_result.DocumentMergePDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result": [[79, 1, 1, "", "ESealPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result.ESealPDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.export_pdf_form_data_result": [[79, 1, 1, "", "ExportPDFFormDataResult"]], "adobe.pdfservices.operation.pdfjobs.result.export_pdf_form_data_result.ExportPDFFormDataResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.export_pdf_result": [[79, 1, 1, "", "ExportPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.export_pdf_result.ExportPDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result": [[79, 1, 1, "", "ExportPDFtoImagesResult"]], "adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result.ExportPDFtoImagesResult": [[79, 2, 1, "", "get_assets"]], "adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result": [[79, 1, 1, "", "ExtractPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.extract_pdf_result.ExtractPDFResult": [[79, 2, 1, "", "get_content"], [79, 2, 1, "", "get_content_json"], [79, 2, 1, "", "get_resource"]], "adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result": [[79, 1, 1, "", "HTMLtoPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.html_to_pdf_result.HTMLtoPDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.import_pdf_form_data_result": [[79, 1, 1, "", "ImportPDFFormDataResult"]], "adobe.pdfservices.operation.pdfjobs.result.import_pdf_form_data_result.ImportPDFFormDataResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.insert_pages_result": [[79, 1, 1, "", "InsertPagesResult"]], "adobe.pdfservices.operation.pdfjobs.result.insert_pages_result.InsertPagesResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result": [[79, 1, 1, "", "LinearizePDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result.LinearizePDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result": [[79, 1, 1, "", "OCRPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.ocr_pdf_result.OCRPDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_accessibility_checker_result": [[79, 1, 1, "", "PDFAccessibilityCheckerResult"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_accessibility_checker_result.PDFAccessibilityCheckerResult": [[79, 2, 1, "", "get_asset"], [79, 2, 1, "", "get_report"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result": [[79, 1, 1, "", "PDFPropertiesResult"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_properties_result.PDFPropertiesResult": [[79, 2, 1, "", "get_pdf_properties_dict"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_services_job_result": [[79, 1, 1, "", "PDFServicesJobResult"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_watermark_result": [[79, 1, 1, "", "PDFWatermarkResult"]], "adobe.pdfservices.operation.pdfjobs.result.pdf_watermark_result.PDFWatermarkResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result": [[79, 1, 1, "", "ProtectPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result.ProtectPDFResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.remove_protection_result": [[79, 1, 1, "", "RemoveProtectionResult"]], "adobe.pdfservices.operation.pdfjobs.result.remove_protection_result.RemoveProtectionResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result": [[79, 1, 1, "", "ReorderPagesResult"]], "adobe.pdfservices.operation.pdfjobs.result.reorder_pages_result.ReorderPagesResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.replace_page_result": [[79, 1, 1, "", "ReplacePagesResult"]], "adobe.pdfservices.operation.pdfjobs.result.replace_page_result.ReplacePagesResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result": [[79, 1, 1, "", "RotatePagesResult"]], "adobe.pdfservices.operation.pdfjobs.result.rotate_pages_result.RotatePagesResult": [[79, 2, 1, "", "get_asset"]], "adobe.pdfservices.operation.pdfjobs.result.split_pdf_result": [[79, 1, 1, "", "SplitPDFResult"]], "adobe.pdfservices.operation.pdfjobs.result.split_pdf_result.SplitPDFResult": [[79, 2, 1, "", "get_asset"], [79, 2, 1, "", "get_assets"]], "adobe.pdfservices.operation.region": [[74, 1, 1, "", "Region"]], "adobe.pdfservices.operation.region.Region": [[74, 3, 1, "", "EU"], [74, 3, 1, "", "US"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"], "6": ["py", "exception", "Python exception"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:property", "5": "py:function", "6": "py:exception"}, "terms": {"": [6, 39, 51, 56, 63, 72, 77, 78], "0": [4, 6, 7, 9, 36, 39, 54, 70, 72, 77, 78], "1": [4, 6, 39, 41, 51, 70, 72, 77, 78], "100": [39, 44, 77, 78], "10000": [4, 33, 70], "11": [39, 54, 77, 78], "127": [4, 6, 70, 72], "128": [39, 60, 77, 78], "144": [44, 78], "15": [39, 77], "150": [39, 77], "180": [64, 78], "2": [39, 77], "200": [39, 44, 77, 78], "20000": [4, 70], "25": 77, "250": [39, 44, 77, 78], "256": [39, 60, 77, 78], "270": [64, 78], "3": [39, 77], "350": [39, 77], "4": [39, 77], "4000": [4, 33, 70], "413": 34, "429": 7, "429001": 34, "429002": 34, "443": [6, 72], "5": [39, 54, 77, 78], "502": 34, "503": 34, "504": 34, "72": [44, 78], "8": [39, 54, 77, 78], "80": [6, 72], "8080": [4, 6, 70, 72], "90": [64, 78], "A": [6, 39, 40, 42, 43, 51, 56, 60, 61, 62, 63, 65, 72, 77, 78], "And": [54, 78], "At": [39, 77], "For": [3, 5, 36, 37, 39, 51, 60, 69, 77, 78], "IT": [46, 47, 48, 52, 57, 78], "If": [2, 36, 42, 51, 54, 58, 74, 78], "In": [39, 51, 77, 78], "It": [2, 6, 36, 66, 72, 74, 77, 79], "NO": [46, 47, 48, 52, 57, 78], "No": [51, 78], "Such": [39, 77], "The": [4, 7, 34, 36, 39, 40, 45, 46, 47, 48, 51, 53, 54, 62, 63, 65, 66, 70, 77, 78, 79], "These": [2, 74], "To": [36, 39, 50, 53, 54, 77, 78], "_0": [39, 77], "_14": [39, 77], "__class__": [2, 74], "__traceback__": 73, "abc": [2, 3, 5, 6, 12, 13, 23, 25, 32, 37, 41, 45, 51, 60, 66, 69, 71, 72, 74, 75, 78, 79], "abcmeta": [2, 74], "about": [5, 39, 42, 50, 71, 77, 78], "abov": [44, 78], "abstract": [2, 3, 5, 6, 32, 45, 51, 66, 69, 71, 72, 74, 78, 79], "accept": 34, "accept_header_nam": [8, 34], "access": [32, 33, 39, 51, 60, 77, 78], "access_token": [32, 39, 51, 77, 78], "accessibilitycheck": 33, "accord": [39, 77], "acrobat": [77, 79], "action": 23, "ad": [41, 50, 51, 77, 78], "add": [4, 41, 43, 50, 53, 56, 60, 70, 77, 78], "add_act": [11, 23], "add_al": [38, 41, 78], "add_all_from": [38, 41, 78], "add_angle_to_rot": [39, 41, 64, 77, 78], "add_angle_to_rotate_for_page_rang": [41, 64, 78], "add_asset": [39, 41, 43, 77, 78], "add_char_info": [53, 78], "add_command": [11, 23], "add_frag": [41, 50, 78], "add_item": [41, 51, 78], "add_pages_to_insert": [39, 41, 56, 77, 78], "add_pages_to_replac": [39, 41, 63, 77, 78], "add_permiss": [41, 60, 78], "add_rang": [38, 39, 41, 77, 78], "add_single_pag": [38, 39, 41, 77, 78], "addit": [4, 42, 51, 60, 70, 77, 78], "addwatermark": 33, "adequ": 7, "adob": [68, 69, 70, 71, 72, 73, 74, 75, 77, 78, 79], "ae": [39, 60, 77, 78], "aes_128": [41, 60, 78], "aes_256": [39, 41, 60, 77, 78], "after": [4, 34, 51, 70, 78], "ag": 77, "again": [34, 77], "agreement": [39, 77], "ai": [1, 2, 74], "ajax": [54, 78], "algorithm": [39, 60, 77, 78], "all": [2, 4, 36, 41, 56, 60, 70, 74, 78], "all_cont": [39, 41, 60, 77, 78], "all_content_except_metadata": [41, 60, 78], "allow": [3, 39, 51, 60, 69, 77, 78], "allow_nan": 36, "along": [51, 56, 63, 78], "alreadi": [51, 78], "also": [39, 51, 54, 60, 77, 78], "altern": [39, 77], "an": [2, 3, 4, 5, 6, 7, 33, 34, 36, 37, 39, 40, 42, 43, 44, 49, 51, 66, 69, 70, 71, 72, 73, 74, 75, 77, 78, 79], "angl": [23, 38, 39, 41, 74, 76, 77], "angle_180": [41, 64, 78], "angle_270": [41, 64, 78], "angle_90": [39, 41, 64, 77, 78], "ani": [2, 4, 50, 55, 70, 74, 78], "annot": [51, 78], "api": [2, 3, 4, 7, 8, 32, 34, 51, 67, 69, 70, 73, 77, 78], "app": 34, "appear": [51, 78], "appear_on_foreground": [77, 78], "appearance_item": [38, 41, 78], "appearance_opt": [38, 41, 78], "appearanceitem": [41, 51, 74, 76], "appearanceopt": [41, 51, 74, 76], "appli": [39, 51, 77, 78], "applic": [2, 3, 34, 39, 50, 52, 69, 74, 77, 78], "approv": [51, 78], "ar": [4, 6, 34, 36, 39, 51, 56, 70, 72, 77, 78], "arbitrari": 36, "archiv": [39, 77], "arrai": 36, "as_class": [8, 36], "ascii": 36, "asset": [1, 2, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 33, 35, 36, 39, 40, 43, 56, 62, 63, 66, 74, 77, 78, 79], "asset_1": [39, 77], "asset_2": [39, 77], "asset_id": [9, 12, 14, 15, 16, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 35, 37, 75], "asset_to_insert": [39, 77], "asset_upload_uri_request": [9, 10], "asset_upload_util": [2, 8], "assetid": [12, 14, 15, 16, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 35, 37, 75], "assets_to_insert": 36, "assets_to_replac": 36, "assetuploadurirequest": [10, 11], "assetuploadutil": [8, 36], "assist": [39, 77, 79], "associ": [39, 51, 66, 77, 78, 79], "attach": [51, 78], "attempt": 36, "auth": [1, 2, 8, 69, 77], "auth_factori": [2, 8], "authent": [2, 6, 8, 34, 67, 72, 74], "authenticatorfactori": [8, 32], "authn": [8, 33], "author": [34, 51, 78], "authorization_header_nam": [8, 34], "auto_tag": [8, 33], "autotag": 33, "autotag_operation_nam": [8, 33], "autotag_pdf": [33, 38, 41, 78], "autotag_pdf_external_asset_request": [10, 11], "autotag_pdf_internal_asset_request": [10, 11], "autotag_pdf_job": [2, 38, 77], "autotag_pdf_param": [12, 38, 39, 41, 77, 78], "autotag_pdf_params_payload": [10, 11], "autotag_pdf_result": [2, 38, 79], "autotagpdf": [10, 11], "autotagpdfexternalassetrequest": [11, 12], "autotagpdfinternalassetrequest": [11, 12], "autotagpdfjob": [38, 39, 42, 66, 74, 76, 78, 79], "autotagpdfparam": [12, 39, 41, 42, 74, 76, 77], "autotagpdfparamspayload": [11, 12], "autotagpdfresult": [38, 39, 66, 74, 76, 77], "avail": 34, "background": [51, 78], "bad": 34, "badgatewai": 34, "base": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "base_asset": [36, 39, 56, 63, 77, 78], "base_fil": [39, 77], "base_input_stream": [39, 77], "base_pag": [39, 56, 63, 77, 78], "basi": 36, "basic": [2, 3, 5, 6, 37, 41, 51, 69, 71, 72, 74, 75, 78], "basqu": [52, 78], "bearer": [39, 51, 77, 78], "been": [2, 7, 34, 73, 74], "befor": [54, 78], "behavior": 36, "bg": [46, 47, 48, 52, 57, 78], "bg_bg": [41, 45, 46, 47, 48, 52, 57, 78], "blob": [2, 37, 75], "bmp": [1, 2, 74], "bool": [34, 36, 42, 46, 47, 48, 51, 53, 54, 58, 78], "boolean": [42, 53, 78], "bottom": [51, 78], "bound": [53, 78], "box": [53, 78], "br": [46, 47, 48, 52, 57, 78], "brand": [39, 77], "brazil": [46, 47, 48, 52, 57, 78], "builder": [4, 70], "bulgaria": [46, 47, 48, 52, 57, 78], "bulgarian": [46, 47, 48, 52, 57, 78], "byte": [60, 78], "c": [46, 47, 48, 52, 57, 78], "ca": [46, 47, 48, 52, 57, 78], "ca_ca": [41, 45, 46, 47, 48, 52, 57, 78], "call": [3, 4, 7, 32, 36, 41, 46, 47, 48, 69, 70, 73, 78], "callabl": [34, 36], "callback": [4, 5, 71], "callback_notifier_data": [2, 4, 71], "callbacknotifierdata": [4, 5, 70, 74], "can": [2, 3, 5, 33, 36, 37, 39, 40, 45, 46, 47, 48, 49, 50, 51, 52, 54, 56, 59, 60, 62, 63, 64, 69, 71, 74, 75, 77, 78], "canada": [46, 47, 48, 52, 57, 78], "cannot": [6, 51, 72, 77, 78], "case": [39, 50, 60, 77, 78], "catalan": [46, 47, 48, 52, 57, 78], "caus": 36, "certain": [39, 77], "certif": [51, 78], "certificate_credenti": [39, 77], "certificatecredenti": [51, 78], "ch": [46, 47, 48, 52, 57, 78], "chain": 77, "chang": [51, 78], "charact": [36, 39, 53, 60, 77, 78], "check": [36, 77], "check_circular": 36, "checker": [33, 77, 78], "china": [46, 47, 48, 52, 57, 78], "chines": [46, 47, 48, 52, 57, 78], "circular": 36, "class": [2, 3, 4, 5, 6, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "classmethod": [6, 8, 36, 37, 72, 75], "click": [3, 39, 50, 69, 77, 78], "client": [2, 3, 4, 7, 39, 41, 46, 47, 48, 69, 70, 73, 74, 77, 78], "client_config": [1, 2, 8, 32, 70, 74], "client_config_file_path": [4, 70], "client_id": [3, 32, 39, 40, 69, 77], "client_secret": [3, 39, 40, 69, 77], "clientconfig": [2, 4, 8, 32, 74], "clockwis": [64, 78], "close": [2, 39, 40, 74, 77], "cloud_asset": [1, 2, 75], "cloudasset": [2, 8, 37, 39, 40, 74, 77], "cn": [46, 47, 48, 52, 57, 78], "code": [7, 37, 52, 57, 75, 78], "colour": [44, 78], "com": 34, "combin": [33, 39, 43, 77, 78], "combine_pdf": [8, 33, 38, 41, 78], "combine_pdf_external_asset_request": [10, 11], "combine_pdf_internal_asset_request": [10, 11], "combine_pdf_job": [2, 38, 77], "combine_pdf_job_input": [2, 8, 36], "combine_pdf_nam": [8, 33], "combine_pdf_param": [13, 38, 39, 41, 77, 78], "combine_pdf_result": [2, 38, 79], "combinepdf": [10, 11, 33], "combinepdfexternalassetrequest": [11, 13], "combinepdfinternalassetrequest": [11, 13], "combinepdfjob": [38, 39, 43, 66, 74, 76, 78, 79], "combinepdfjobinput": [8, 35, 36, 43, 78], "combinepdfparam": [13, 39, 41, 43, 74, 76, 77], "combinepdfresult": [38, 39, 66, 74, 76, 77], "command": 23, "comment": [60, 78], "commun": [51, 78], "compact": 36, "compar": 36, "complet": [2, 5, 71, 74], "complex": [39, 77], "compli": [39, 77], "compliant": [36, 39, 51, 77, 78], "compress": [33, 39, 44, 77, 78], "compress_pdf": [8, 33, 38, 41, 78], "compress_pdf_external_asset_request": [10, 11], "compress_pdf_internal_asset_request": [10, 11], "compress_pdf_job": [2, 38, 77], "compress_pdf_operation_nam": [8, 33], "compress_pdf_param": [14, 38, 39, 41, 77, 78], "compress_pdf_params_payload": [10, 11], "compress_pdf_result": [2, 38, 79], "compression_level": [14, 38, 41, 78], "compressionlevel": [14, 39, 41, 44, 74, 76, 77], "compresspdf": [10, 11, 33], "compresspdfexternalassetrequest": [11, 14], "compresspdfinternalassetrequest": [11, 14], "compresspdfjob": [38, 39, 44, 66, 74, 76, 78, 79], "compresspdfparam": [14, 39, 41, 44, 74, 76, 77], "compresspdfparamspayload": [11, 14], "compresspdfresult": [38, 39, 66, 74, 76, 77], "config": [1, 2, 67, 74], "configur": [2, 4, 5, 6, 70, 71, 72, 74, 77], "connect": [4, 70], "connect_timeout": [4, 34, 70], "connecttimeout": [4, 70], "consist": [36, 54, 78], "constant": [2, 8], "construct": [2, 3, 4, 5, 6, 37, 39, 40, 41, 42, 43, 44, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 65, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "constructor": [36, 52, 54, 78], "contain": [2, 6, 36, 39, 40, 42, 44, 55, 66, 72, 74, 77, 78, 79], "content": [68, 77, 78, 79], "content_encrypt": [38, 39, 41, 77, 78], "content_json": [66, 79], "content_to_encrypt": 27, "content_type_header_nam": [8, 34], "contentencrypt": [39, 41, 60, 74, 76, 77], "contenttoencrypt": 27, "context": [8, 9, 36, 51, 78], "contract": [2, 3, 5, 6, 37, 39, 41, 51, 69, 71, 72, 74, 75, 77, 78], "control": [60, 78], "convei": 77, "convers": [39, 46, 47, 48, 77, 78], "convert": [39, 54, 57, 77, 78], "coordin": [51, 78], "copi": [39, 60, 77, 78], "copy_cont": [41, 60, 78], "correct": 77, "correspond": [39, 45, 77, 78], "could": [36, 39, 77], "couldn": 34, "count": [65, 78], "creat": [2, 4, 6, 33, 39, 42, 44, 45, 46, 47, 48, 49, 51, 72, 74, 77, 78], "create_from": [11, 23], "create_operation_nam": [8, 33], "create_pdf": [8, 33, 38, 41, 78], "create_pdf_external_asset_request": [10, 11], "create_pdf_from_excel_param": [41, 45, 78], "create_pdf_from_ppt_param": [41, 45, 78], "create_pdf_from_word_param": [41, 45, 78], "create_pdf_internal_asset_request": [10, 11], "create_pdf_job": [2, 38, 77], "create_pdf_param": [15, 39, 77], "create_pdf_params_payload": [10, 11], "create_pdf_result": [2, 38, 79], "create_tagged_pdf": [15, 46, 47, 48, 78], "createpdf": [10, 11, 33], "createpdfexternalassetrequest": [11, 15], "createpdffromexcelparam": [45, 46, 74, 76], "createpdffrompptparam": [45, 47, 74, 76], "createpdffromwordparam": [45, 48, 74, 76], "createpdfinternalassetrequest": [11, 15], "createpdfjob": [38, 39, 45, 66, 74, 76, 78, 79], "createpdfparam": [15, 38, 39, 41, 46, 47, 48, 74, 76, 77], "createpdfparamspayload": [11, 15], "createpdfresult": [38, 39, 66, 74, 76, 77], "createtaggedpdf": 15, "creation": [51, 60, 78], "credenti": [1, 2, 6, 7, 8, 32, 34, 39, 40, 51, 72, 73, 74, 77, 78], "credential_id": [39, 51, 77, 78], "croatia": [46, 47, 48, 52, 57, 78], "croatian": [46, 47, 48, 52, 57, 78], "cs_cz": [41, 45, 46, 47, 48, 52, 57, 78], "csc": [51, 78], "csc_auth_context": [38, 39, 41, 77, 78], "csc_credenti": [36, 38, 41, 78], "cscauthcontext": [39, 41, 51, 74, 76, 77], "csccredenti": [36, 39, 41, 51, 74, 76, 77], "css": [39, 77], "csv": [1, 2, 41, 53, 74, 78], "custom": 36, "custom_error_messag": [2, 8], "custom_error_messages_status_code_map": [8, 34], "customernam": [39, 77], "customerrormessag": [8, 33], "customervisit": [39, 77], "cz": [46, 47, 48, 52, 57, 78], "czech": [46, 47, 48, 52, 57, 78], "da": [46, 47, 48, 52, 57, 78], "da_dk": [41, 45, 46, 47, 48, 52, 57, 78], "dai": 36, "danish": [46, 47, 48, 52, 57, 78], "data": [5, 6, 33, 34, 39, 40, 50, 51, 53, 54, 55, 71, 72, 77, 78, 79], "date": [41, 51, 54, 78], "datetim": 32, "dc_app_info_header_kei": [8, 34], "dc_request_id_header_kei": [8, 34], "dcsdk": 34, "dct": 36, "de": [46, 47, 48, 52, 57, 78], "de_ch": [41, 45, 46, 47, 48, 52, 57, 78], "de_d": [41, 45, 46, 47, 48, 52, 57, 78], "debug": 34, "decod": 36, "def": 36, "default": [4, 6, 7, 8, 36, 46, 47, 48, 51, 54, 70, 72, 78], "default_error_cod": [2, 7], "default_page_height": [41, 54, 78], "default_page_width": [41, 54, 78], "default_status_cod": [2, 7], "defaulthead": [8, 34], "defin": [4, 70], "degre": [64, 78], "delet": [2, 8, 23, 33, 34, 39, 49, 51, 60, 74, 77, 78], "delete_act": 23, "delete_asset": [1, 2, 8, 9, 74], "delete_pag": [8, 33, 38, 41, 78], "delete_page_act": [10, 11], "delete_pages_job": [2, 38, 77], "delete_pages_operation_nam": [8, 33], "delete_pages_param": [38, 39, 41, 77, 78], "delete_pages_result": [2, 38, 79], "deletepageact": [11, 23], "deletepagesjob": [38, 39, 49, 66, 74, 76, 78, 79], "deletepagesparam": [39, 41, 49, 74, 76, 77], "deletepagesresult": [38, 66, 74, 76], "demonstr": [40, 77], "denmark": [46, 47, 48, 52, 57, 78], "detail": [2, 7, 74], "determin": [4, 70], "dict": [2, 5, 6, 34, 36, 39, 51, 55, 56, 66, 71, 72, 74, 77, 78, 79], "dictionari": [6, 36, 50, 51, 55, 66, 72, 78, 79], "differ": [52, 56, 78], "digit": [51, 60, 78], "dimens": [54, 78], "distinguish": [51, 78], "distinguished_nam": [41, 51, 78], "dk": [46, 47, 48, 52, 57, 78], "doc": [1, 2, 41, 52, 74, 78], "document": [2, 33, 39, 42, 44, 46, 47, 48, 50, 51, 52, 54, 60, 74, 77, 78, 79], "document_gener": [10, 11], "document_generation_external_asset_request": [10, 11], "document_generation_internal_asset_request": [10, 11], "document_generation_params_payload": [10, 11], "document_languag": [15, 41, 45, 78], "document_level_permiss": [38, 39, 41, 77, 78], "document_merg": 33, "document_merge_job": [2, 38, 50, 77, 78], "document_merge_operation_nam": [8, 33], "document_merge_param": [16, 36, 38, 39, 41, 77, 78], "document_merge_result": [2, 38, 79], "documentgener": 33, "documentgenerationparamspayload": [11, 16], "documentlanguag": [15, 45, 46, 47, 48, 74, 76], "documentlevelpermiss": [39, 41, 51, 74, 76, 77], "documentmerg": [38, 41, 78], "documentmergeexternalassetrequest": [11, 16], "documentmergeinternalassetrequest": [11, 16], "documentmergejob": [38, 39, 50, 66, 74, 76, 78, 79], "documentmergeparam": [16, 36, 39, 41, 50, 74, 76, 77], "documentmergepdfresult": [38, 39, 66, 76, 77, 79], "documentmergeresult": [74, 76], "docx": [1, 2, 39, 41, 50, 52, 74, 77, 78], "doe": [51, 78], "doesn": 7, "dom": [54, 78], "done": [1, 2, 10, 30, 74], "dot": [44, 78], "download": [2, 8, 33, 74], "download_uri": [37, 75], "downloaduri": [37, 75], "downstream": [39, 77], "dpi": [44, 78], "dropbox": [2, 37, 75], "dto": [8, 9], "due": 34, "dure": [32, 36], "dutch": [46, 47, 48, 52, 57, 78], "dynam": [39, 77], "e": [46, 47, 48, 51, 52, 57, 78], "e_seal": [8, 33], "edit": [39, 46, 47, 48, 60, 77, 78], "edit_annot": [41, 60, 78], "edit_cont": [41, 60, 78], "edit_document_assembli": [41, 60, 78], "edit_fill_and_sign_form_field": [41, 60, 78], "ee": [46, 47, 48, 52, 57, 78], "either": [7, 34, 39, 73, 77, 78], "el": [46, 47, 48, 52, 57, 78], "el_gr": [41, 45, 46, 47, 48, 52, 57, 78], "electron": [33, 39, 51, 77, 78], "electronic_seal_job": [39, 77], "electronic_seal_param": [17, 38, 39, 41, 77, 78], "electronics": 33, "electronicsealparam": 51, "element": [36, 39, 51, 53, 54, 77, 78], "elements_to_extract": [19, 39, 53, 77, 78], "elements_to_extract_rendit": [53, 78], "elementstoextract": 19, "elimin": 36, "els": [36, 51, 78], "embed": [60, 78], "empti": [3, 6, 33, 69, 72], "en": [46, 47, 48, 52, 57, 78], "en_gb": [41, 45, 46, 47, 48, 52, 57, 78], "en_u": [41, 45, 46, 47, 48, 52, 57, 78], "enabl": [39, 60, 77, 78], "encapsul": [2, 4, 5, 6, 37, 66, 70, 71, 72, 74, 75, 79], "enclos": [66, 79], "encod": 36, "encount": [2, 74], "encrypt": [39, 60, 77, 78], "encryption_algorithm": [27, 36, 38, 39, 41, 77, 78], "encryptionalgorithm": [27, 36, 39, 41, 60, 74, 76, 77], "end": [35, 39, 41, 77, 78], "enforce_typ": [2, 8], "english": [46, 47, 48, 52, 57, 78], "enhanc": [39, 77], "ensur": [36, 77], "ensure_ascii": 36, "entiti": 34, "entri": [2, 74], "enum": [2, 5, 6, 30, 33, 34, 37, 39, 44, 46, 47, 48, 50, 51, 52, 53, 57, 59, 60, 64, 71, 72, 74, 75, 77, 78], "enumer": [2, 33, 34, 74], "environ": [39, 77], "err_msg": 36, "error": [2, 7, 31, 51, 73, 74, 78], "error_cod": [2, 7, 8, 34], "error_messag": 8, "error_respons": 31, "error_response_handl": 34, "es_": [41, 45, 46, 47, 48, 52, 57, 78], "escap": 36, "eseal": [38, 41, 78], "eseal_job": [2, 38, 77], "eseal_pdf": 33, "eseal_pdf_external_asset_request": [10, 11], "eseal_pdf_internal_asset_request": [10, 11], "eseal_pdf_nam": [8, 33], "eseal_pdf_result": [2, 38, 79], "esealpdf": [10, 11], "esealpdfexternalassetrequest": [11, 17], "esealpdfinternalassetrequest": [11, 17], "esealpdfresult": [38, 39, 66, 74, 76, 77], "establish": [4, 70], "estonia": [46, 47, 48, 52, 57, 78], "estonian": [46, 47, 48, 52, 57, 78], "et": [46, 47, 48, 52, 57, 78], "et_e": [41, 45, 46, 47, 48, 52, 57, 78], "eu": [1, 2, 4, 33, 52, 70, 74, 78], "eu_": [41, 52, 78], "eu_uri": [8, 33], "europ": [2, 74], "european": [52, 78], "ew1": 33, "exampl": [36, 39, 77], "excel": [2, 41, 45, 74, 78], "except": [1, 2, 36, 60, 67, 74, 78], "execut": [2, 74], "execution_context": [1, 2], "executioncontext": [2, 8, 9, 36], "exhaust": [2, 7, 34, 73, 74], "exist": [39, 51, 77, 78], "expired_at": [8, 32], "expired_in_m": 32, "expiri": 32, "export": [33, 39, 52, 53, 59, 77, 78], "export_ocr_local": [38, 41, 78], "export_pdf": [8, 33, 38, 41, 78], "export_pdf_external_asset_request": [10, 11], "export_pdf_form_data": [8, 33], "export_pdf_form_data_job": [40, 77], "export_pdf_form_data_operation_nam": [8, 33], "export_pdf_form_data_result": 79, "export_pdf_internal_asset_request": [10, 11], "export_pdf_job": [2, 38, 77], "export_pdf_operation_nam": [8, 33], "export_pdf_param": [18, 38, 39, 41, 77, 78], "export_pdf_params_payload": [10, 11], "export_pdf_result": [2, 38, 79], "export_pdf_target_format": [38, 41, 78], "export_pdf_to_imag": [8, 33], "export_pdf_to_images_job": [2, 38, 77], "export_pdf_to_images_output_typ": [38, 39, 41, 77, 78], "export_pdf_to_images_param": [26, 38, 39, 41, 77, 78], "export_pdf_to_images_result": [2, 38, 79], "export_pdf_to_images_target_format": [38, 39, 41, 77, 78], "exportocrlocal": [41, 52, 74, 76], "exportpdf": [10, 11, 33], "exportpdfexternalassetrequest": [11, 18], "exportpdfformdatajob": [40, 74, 76, 79], "exportpdfformdataparam": [74, 76], "exportpdfformdataresult": [40, 74, 76, 77], "exportpdfinternalassetrequest": [11, 18], "exportpdfjob": [38, 39, 52, 66, 74, 76, 78, 79], "exportpdfparam": [18, 39, 41, 52, 74, 76, 77], "exportpdfparamspayload": [11, 18], "exportpdfresult": [38, 39, 66, 74, 76, 77], "exportpdftargetformat": [39, 41, 52, 74, 76, 77], "exportpdftoimagesjob": [38, 39, 59, 66, 74, 76, 78, 79], "exportpdftoimagesoutputtyp": [39, 41, 59, 74, 76, 77], "exportpdftoimagesparam": [26, 39, 41, 59, 74, 76, 77], "exportpdftoimagesresult": [38, 39, 66, 74, 76, 77], "exportpdftoimagestargetformat": [39, 41, 59, 74, 76, 77], "extens": [1, 2, 52, 59, 74, 78], "extern": [33, 37, 39, 40, 66, 75, 77, 79], "external_asset": [1, 2, 35, 75], "external_storage_typ": [1, 2, 75], "externalasset": [2, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 37, 39, 74, 77], "externalstoragetyp": [2, 37, 74], "extract": [33, 39, 40, 53, 60, 66, 77, 78, 79], "extract_element_typ": [38, 41, 78], "extract_operation_nam": [8, 33], "extract_pdf": [8, 10, 11, 33, 38, 41, 78], "extract_pdf_external_asset_request": [10, 11], "extract_pdf_internal_asset_request": [10, 11], "extract_pdf_job": [2, 38, 77], "extract_pdf_param": [19, 38, 39, 41, 77, 78], "extract_pdf_params_payload": [10, 11], "extract_pdf_result": [2, 38, 79], "extract_renditions_element_typ": [38, 41, 78], "extracted_form_data": [40, 77], "extractelementtyp": [39, 41, 53, 74, 76, 77], "extractpdf": 33, "extractpdfexternalassetrequest": [11, 19], "extractpdfinternalassetrequest": [11, 19], "extractpdfjob": [38, 39, 53, 66, 74, 76, 78, 79], "extractpdfparam": [19, 39, 41, 53, 74, 76, 77], "extractpdfparamspayload": [11, 19], "extractpdfresult": [38, 39, 66, 74, 76, 77], "extractrenditionselementtyp": [41, 53, 74, 76], "factori": [45, 78], "fail": [1, 2, 10, 30, 74], "failur": [7, 32, 34], "fals": [34, 36, 42, 46, 47, 48, 53, 54, 58, 78], "favorite_movi": 77, "featur": [39, 77], "fetch": [39, 77], "fi": [46, 47, 48, 52, 57, 78], "fi_fi": [41, 45, 46, 47, 48, 52, 57, 78], "fidel": [39, 77], "field": [51, 55, 77, 78], "field_loc": [36, 38, 39, 41, 77, 78], "field_nam": [39, 51, 77, 78], "field_opt": [36, 38, 39, 41, 77, 78], "fieldloc": [36, 39, 41, 51, 74, 76, 77], "fieldopt": [36, 39, 41, 51, 74, 76, 77], "figur": [41, 53, 78], "file": [4, 6, 33, 34, 39, 40, 41, 44, 52, 54, 56, 58, 59, 60, 63, 65, 66, 70, 72, 77, 78, 79], "file_1": [39, 77], "file_2": [39, 77], "file_count": [36, 65, 78], "file_ext": [52, 78], "file_input_stream": [39, 77], "file_path": 36, "file_to_insert": [39, 77], "file_util": [2, 8], "filecount": 65, "fill": [51, 55, 60, 78], "find": 77, "finland": [46, 47, 48, 52, 57, 78], "finnish": [46, 47, 48, 52, 57, 78], "first": [39, 77], "fix": [77, 79], "flag": [51, 78], "float": [36, 54, 78], "folder": [39, 77], "follow": [39, 77], "footer": [54, 78], "foreground": 78, "form": [6, 33, 39, 40, 51, 55, 60, 72, 77, 78, 79], "form_data": 77, "form_fil": [39, 41, 51, 77, 78], "form_filling_and_annot": [41, 51, 78], "format": [6, 39, 40, 50, 51, 52, 53, 59, 72, 77, 78, 79], "fr": [46, 47, 48, 52, 57, 78], "fr_fr": [41, 45, 46, 47, 48, 52, 57, 78], "fragment": [16, 38, 41, 74, 76], "franc": [46, 47, 48, 52, 57, 78], "free": 34, "french": [46, 47, 48, 52, 57, 78], "from": [2, 6, 39, 40, 41, 44, 49, 51, 52, 53, 57, 60, 61, 66, 72, 74, 77, 78, 79], "from_fil": [2, 4, 70], "from_json": [4, 6, 30, 31, 72], "func": 36, "function": [2, 36, 74], "further": [39, 77], "galician": [52, 78], "gatewai": 34, "gb": [46, 47, 48, 52, 57, 78], "gener": [39, 42, 50, 66, 77, 78, 79], "generate_report": [12, 42, 78], "generatereport": 12, "generic_can_not_be_non": [8, 33], "generic_can_not_be_none_or_empti": [8, 33], "german": [46, 47, 48, 52, 57, 78], "germani": [46, 47, 48, 52, 57, 78], "get": [2, 3, 4, 6, 8, 34, 36, 37, 39, 54, 58, 69, 72, 74, 75, 77, 78], "get_access_token": [41, 51, 78], "get_act": [11, 23], "get_add_char_info": [41, 53, 78], "get_api_kei": [8, 32], "get_appear_on_foreground": 78, "get_appearance_item": [41, 51], "get_appearance_opt": [41, 51, 78], "get_asset": [8, 35, 38, 39, 40, 41, 62, 66, 77, 78, 79], "get_asset_id": [2, 37, 75], "get_assets_to_combin": [41, 43, 78], "get_assets_to_insert": [41, 56, 78], "get_assets_to_replac": [41, 63, 78], "get_authent": [8, 32], "get_base_asset": [41, 56, 63, 78], "get_bottom": [41, 51, 78], "get_char_bound": 19, "get_client_id": [2, 3, 8, 32, 69], "get_client_secret": [2, 3, 69], "get_cod": [30, 31], "get_command": [11, 23], "get_compression_level": [41, 44, 78], "get_connect_timeout": [2, 4, 70], "get_cont": [1, 2, 8, 38, 39, 40, 66, 74, 77, 79], "get_content_encrypt": [41, 60, 78], "get_content_json": [38, 66, 79], "get_create_tagged_pdf": [41, 45, 46, 47, 48], "get_credenti": [4, 6, 72], "get_credential_id": [41, 51, 78], "get_csc_auth_context": [41, 51, 78], "get_default_uri": [8, 33], "get_document_languag": [41, 45, 46, 47, 48, 78], "get_download_uri": [2, 8, 9, 37, 75], "get_elements_to_extract": [41, 53, 78], "get_elements_to_extract_rendit": [41, 53, 78], "get_encryption_algorithm": [41, 60, 78], "get_end": [8, 35], "get_endpoint": [8, 33], "get_error_respons": [30, 31], "get_export_ocr_local": [41, 52, 78], "get_export_pdf_to_images_output_typ": [41, 59, 78], "get_export_pdf_to_images_target_format": [41, 59, 78], "get_external_storage_typ": [2, 37, 75], "get_field_loc": [41, 51, 78], "get_field_nam": [41, 51, 78], "get_file_count": [41, 65, 78], "get_file_ext": [41, 52, 59, 78], "get_file_path": [8, 36], "get_format": [41, 50, 78], "get_frag": [41, 50, 78], "get_fragments_list": [41, 50, 78], "get_from_extens": [1, 2, 74], "get_generate_report": [41, 42, 78], "get_header_info": [8, 33], "get_host": [4, 6, 72], "get_include_header_foot": [41, 54, 78], "get_include_page_level_properti": [41, 58, 78], "get_input_stream": [2, 37, 40, 75, 77], "get_job_result": [1, 2, 8, 39, 40, 74, 77], "get_job_statu": [1, 2, 8, 74], "get_json": [41, 54, 78], "get_json_data_for_merg": [41, 50, 78], "get_json_form_fields_data": [41, 55, 78], "get_json_form_fields_data_str": [41, 55, 78], "get_left": [41, 51, 78], "get_length": [11, 23], "get_local": [41, 57, 78], "get_messag": [30, 31], "get_mime_typ": [2, 37, 75], "get_ocr_lang": [41, 52, 78], "get_ocr_local": [41, 57, 78], "get_ocr_typ": [41, 57, 78], "get_opac": 78, "get_output_format": [41, 50, 78], "get_output_typ": [41, 59, 78], "get_owner_password": [41, 60, 78], "get_page_act": [41, 64, 78], "get_page_count": [41, 65, 78], "get_page_end": 78, "get_page_layout": [41, 54, 78], "get_page_numb": [41, 51, 78], "get_page_rang": [8, 11, 23, 35, 41, 49, 62, 65, 78], "get_page_start": 78, "get_password": [4, 6, 41, 51, 61, 72, 78], "get_pdf_properties_dict": [38, 66, 79], "get_pdf_services_uri": [2, 4], "get_permiss": [41, 60, 78], "get_pin": [41, 51, 78], "get_port": [4, 6, 72], "get_port_based_on_schem": [4, 6], "get_provider_nam": [41, 51, 78], "get_proxy_schem": [4, 6, 72], "get_proxy_server_config": [2, 4, 70], "get_rang": [38, 41, 78], "get_read_timeout": [2, 4, 70], "get_report": [38, 66, 77, 79], "get_request_tracking_id_from_respons": [8, 34], "get_resourc": [38, 39, 66, 77, 79], "get_respons": [8, 9], "get_result": [1, 2, 39, 40, 74, 77], "get_retry_interv": [1, 2, 74], "get_right": [41, 51, 78], "get_rotation_angl": [11, 23], "get_seal_appearance_opt": [41, 51, 78], "get_seal_certificate_credenti": [41, 51, 78], "get_seal_field_opt": [41, 51, 78], "get_shift_head": [41, 42, 78], "get_signature_format": [41, 51, 78], "get_start": [8, 35], "get_statu": [1, 2, 30, 31, 74], "get_styling_info": [41, 53, 78], "get_table_structure_typ": [41, 53, 78], "get_tagged_pdf": [38, 39, 66, 77, 79], "get_target_format": [41, 52, 78], "get_token": [8, 32], "get_token_typ": [41, 51, 78], "get_top": [41, 51, 78], "get_tsa_basic_auth_credenti": [41, 51, 78], "get_typ": [11, 23, 41, 57, 78], "get_upload_uri": [8, 9], "get_uri": [2, 37, 75], "get_uri_for_region": [8, 33], "get_url": [41, 51, 78], "get_user_password": [41, 60, 78], "get_usernam": [4, 6, 41, 51, 72, 78], "get_valu": [1, 2, 41, 60, 74, 78], "get_vis": [41, 51, 78], "get_watermark_appear": 78, "getcharbound": 19, "getenv": [39, 40, 77], "getformdata": 33, "gif": [1, 2, 74], "given": [2, 49, 74, 78], "gl": [52, 78], "gl_e": [41, 52, 78], "go": 34, "gr": [46, 47, 48, 52, 57, 78], "grayscal": [44, 78], "greater": [6, 72], "greec": [46, 47, 48, 52, 57, 78], "greek": [46, 47, 48, 52, 57, 78], "guarante": [36, 39, 77], "ha": [2, 7, 34, 73, 74, 78], "handl": 32, "handle_api_failur": [8, 34], "handle_error_respons": [8, 9], "handle_ims_failur": [8, 32], "handle_service_api_error_respons": [8, 34], "handle_service_usage_failur": [8, 34], "handle_upload_asset_failur": [8, 34], "hant": [52, 78], "have": [2, 39, 74, 77], "head": [42, 78], "header": [2, 5, 34, 54, 71, 74, 78], "hebrew": [46, 47, 48, 52, 57, 78], "height": [54, 78], "here": [3, 39, 50, 69, 77, 78], "hidden": [44, 78], "high": [39, 41, 44, 60, 77, 78], "hk": [46, 47, 48, 57, 78], "hong": [46, 47, 48, 57, 78], "host": [4, 6, 51, 70, 72, 78], "how": [40, 77], "howev": [39, 77], "hr": [46, 47, 48, 52, 57, 78], "hr_hr": [41, 45, 46, 47, 48, 52, 57, 78], "html": [1, 2, 33, 39, 54, 74, 77, 78], "html_to_pdf": [8, 33, 38, 41, 78], "html_to_pdf_external_asset_request": [10, 11], "html_to_pdf_internal_asset_request": [10, 11], "html_to_pdf_job": [2, 38, 77], "html_to_pdf_operation_nam": [8, 33], "html_to_pdf_param": [20, 38, 39, 41, 77, 78], "html_to_pdf_params_payload": [10, 11], "html_to_pdf_result": [2, 38, 79], "htmltopdf": [10, 11, 33], "htmltopdfexternalassetrequest": [11, 20], "htmltopdfinternalassetrequest": [11, 20], "htmltopdfjob": [38, 39, 54, 66, 74, 76, 78, 79], "htmltopdfparam": [20, 39, 41, 54, 74, 76, 77], "htmltopdfparamspayload": [11, 20], "htmltopdfresult": [38, 39, 66, 74, 76, 77], "http": [2, 4, 6, 7, 8, 33, 70, 72], "http_client": [2, 8], "http_connect_timeout": [8, 33], "http_method": [2, 8], "http_port": [4, 6, 72], "http_read_timeout": [8, 33], "http_request": [2, 8], "httpmethod": [8, 34], "httprequest": [8, 34], "https_port": [4, 6, 72], "hu": [46, 47, 48, 52, 57, 78], "hu_hu": [41, 45, 46, 47, 48, 52, 57, 78], "human": 77, "hungari": [46, 47, 48, 52, 57, 78], "hungarian": [46, 47, 48, 52, 57, 78], "i": [2, 4, 6, 7, 33, 34, 36, 39, 40, 46, 47, 48, 51, 54, 56, 60, 66, 70, 72, 73, 74, 77, 78, 79], "id": [3, 7, 34, 51, 69, 78], "ignor": [51, 78], "il": [46, 47, 48, 52, 57, 78], "illustr": [2, 74], "im": [32, 33], "imag": [2, 33, 39, 44, 51, 53, 59, 74, 77, 78], "image_source_path": [39, 77], "implement": [2, 6, 36, 72, 74], "import": [33, 55, 77, 78, 79], "import_job": 77, "import_param": 77, "import_pdf_form_data": [8, 33, 38, 41, 77, 78], "import_pdf_form_data_job": 77, "import_pdf_form_data_operation_nam": [8, 33], "import_pdf_form_data_param": [38, 41, 77, 78], "import_pdf_form_data_result": [77, 79], "importpdfformdatajob": [55, 74, 76, 78, 79], "importpdfformdataparam": [41, 55, 74, 76, 77], "importpdfformdataresult": [74, 76, 77], "impos": [2, 74], "in_progress": [1, 2, 10, 30, 74], "inch": [44, 54, 78], "includ": [54, 58, 60, 78], "include_header_foot": [20, 39, 54, 77, 78], "include_page_level_properti": [24, 39, 58, 77, 78], "include_styl": 19, "includeheaderfoot": [20, 54, 78], "includestyl": 19, "inclus": [41, 78], "incom": 36, "increment": [39, 77], "indd": [1, 2, 74], "indent": 36, "indesign": [2, 74], "index": [39, 41, 67, 77, 78], "individu": [2, 74], "infin": 36, "infinit": 36, "info": 34, "inform": [39, 42, 51, 53, 77, 78], "initi": [54, 77, 78], "inlin": [39, 77], "input": [2, 6, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 33, 35, 37, 39, 40, 46, 47, 48, 53, 56, 57, 58, 63, 66, 72, 74, 75, 77, 78, 79], "input_asset": [12, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 39, 40, 56, 63, 77, 78], "input_asset_id": [14, 18, 19, 20, 21, 22, 23, 26, 28], "input_document_asset_id": 17, "input_form": 77, "input_stream": [2, 8, 9, 37, 39, 40, 74, 75, 77], "input_stream_1": [39, 77], "input_stream_2": [39, 77], "input_stream_to_insert": [39, 77], "input_url": [20, 39, 77], "inputdocumentassetid": 17, "inputurl": 20, "insert": [33, 36, 39, 56, 60, 63, 77, 78], "insert_pag": [8, 33, 38, 41, 78], "insert_pages_job": [2, 38, 77], "insert_pages_operation_nam": [8, 33], "insert_pages_param": [38, 39, 41, 77, 78], "insert_pages_result": [2, 38, 79], "insertpagesjob": [38, 39, 56, 66, 74, 76, 78, 79], "insertpagesparam": [39, 41, 56, 74, 76, 77], "insertpagespdfjob": [39, 77], "insertpagesresult": [38, 39, 66, 74, 76, 77], "instanc": [2, 3, 4, 5, 6, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 54, 55, 56, 57, 59, 60, 61, 62, 63, 65, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "instanti": [51, 78], "int": [2, 4, 6, 31, 35, 36, 41, 51, 56, 63, 65, 70, 72, 74, 78], "integ": [36, 78], "integr": 34, "integration_service_usage_limit_reached_error_messag": [8, 34], "intend": [41, 46, 47, 48, 51, 54, 60, 78], "intern": [1, 2, 5, 6, 37, 41, 46, 47, 48, 51, 54, 66, 75, 78, 79], "internal_client_config": [1, 2], "interv": [2, 74], "invalid": 33, "invalid_input_asset": [8, 33], "invalid_output_asset": [8, 33], "invoic": [39, 77], "invok": [53, 56, 78], "involv": [40, 77], "io": [1, 2, 33, 36, 43, 56, 63, 67, 74, 78], "is_blank": [8, 36], "is_empti": [11, 23, 38, 41, 78], "is_ims_api_cal": 34, "is_ims_cal": 34, "is_user_password": 36, "israel": [46, 47, 48, 52, 57, 78], "it_it": [41, 45, 46, 47, 48, 52, 57, 78], "itali": [46, 47, 48, 52, 57, 78], "italian": [46, 47, 48, 52, 57, 78], "item": [36, 51, 78], "item_separ": 36, "iter": 36, "its": [2, 37, 44, 50, 57, 74, 75, 78], "iw": [46, 47, 48, 52, 57, 78], "iw_il": [41, 45, 46, 47, 48, 52, 57, 78], "j": [54, 78], "ja": [46, 47, 48, 52, 57, 78], "ja_jp": [41, 45, 46, 47, 48, 52, 57, 78], "japan": [46, 47, 48, 52, 57, 78], "japanes": [46, 47, 48, 52, 57, 78], "javascript": [36, 44, 54, 78], "job": [2, 38, 50, 53, 57, 64, 66, 67, 74, 78, 79], "job_error_respons": [10, 30], "job_statu": [9, 10], "joberrorrespons": [30, 31], "jobstatu": [10, 30], "jp": [46, 47, 48, 52, 57, 78], "jp2k": [44, 78], "jpeg": [1, 2, 39, 41, 44, 59, 74, 77, 78], "jpg": [1, 2, 74], "json": [1, 2, 4, 5, 6, 20, 34, 36, 37, 39, 40, 50, 53, 54, 55, 58, 66, 70, 72, 74, 77, 78, 79], "json_data": [6, 72], "json_data_for_merg": [16, 39, 50, 77, 78], "json_form_fields_data": [55, 77, 78], "json_hint": [2, 4, 5, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 30, 31, 35, 37, 38, 41, 54, 65], "json_hint_encod": [2, 8], "json_str": 31, "json_txt_content_typ": [8, 34], "jsondataformerg": 16, "jsonencod": 36, "jsonhintdecod": [8, 36], "jsonhintencod": [8, 36], "kane": [39, 77], "kei": [2, 4, 5, 6, 32, 34, 36, 37, 39, 40, 42, 43, 44, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 60, 65, 70, 71, 72, 74, 75, 77, 78], "key_separ": 36, "kingdom": [46, 47, 48, 52, 57, 78], "know": [39, 50, 77, 78], "known": [39, 77], "ko": [46, 47, 48, 52, 57, 78], "ko_kr": [41, 45, 46, 47, 48, 52, 57, 78], "kong": [46, 47, 48, 57, 78], "korea": [46, 47, 48, 52, 57, 78], "korean": [46, 47, 48, 52, 57, 78], "kr": [46, 47, 48, 52, 57, 78], "label": [41, 51, 78], "languag": [46, 47, 48, 52, 57, 78], "larg": 34, "last": [39, 41, 77, 78], "later": 34, "latin": [39, 60, 77, 78], "latvia": [46, 47, 48, 52, 57, 78], "latvian": [46, 47, 48, 52, 57, 78], "layer": [44, 78], "layout": [54, 78], "least": [39, 77], "leav": [2, 74], "left": [51, 78], "length": [60, 78], "let": 36, "level": [36, 39, 44, 51, 52, 53, 58, 77, 78], "li": [2, 74], "like": [36, 39, 77], "limit": [2, 7, 34, 73, 74], "linear": [33, 39, 77], "linearize_pdf": [8, 33], "linearize_pdf_external_asset_request": [10, 11], "linearize_pdf_internal_asset_request": [10, 11], "linearize_pdf_job": [2, 38, 77], "linearize_pdf_operation_nam": [8, 33], "linearize_pdf_result": [2, 38, 79], "linearizepdf": [10, 11, 33], "linearizepdfexternalassetrequest": [11, 21], "linearizepdfinternalassetrequest": [11, 21], "linearizepdfjob": [38, 39, 66, 74, 76, 79], "linearizepdfresult": [38, 39, 66, 74, 76, 77], "link": [77, 79], "list": [2, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 34, 36, 39, 43, 50, 51, 53, 59, 60, 66, 74, 77, 78, 79], "list_of_page_imag": [39, 41, 59, 77, 78], "listofpageimag": [59, 78], "lithuania": [46, 47, 48, 52, 57, 78], "lithuanian": [46, 47, 48, 52, 57, 78], "local": [39, 46, 47, 48, 52, 57, 77, 78], "locat": [8, 9, 34, 39, 40, 51, 77, 78], "location_header_nam": [8, 34], "low": [41, 44, 60, 78], "lt": [46, 47, 48, 52, 57, 78], "lt_lt": [41, 45, 46, 47, 48, 52, 57, 78], "lv": [46, 47, 48, 52, 57, 78], "lv_lv": [41, 45, 46, 47, 48, 52, 57, 78], "m": [2, 74], "macedonia": [46, 47, 48, 52, 57, 78], "macedonian": [46, 47, 48, 52, 57, 78], "machin": 77, "mai": [39, 77], "main": [39, 77], "make": [39, 54, 77, 78], "malta": [46, 47, 48, 52, 57, 78], "maltes": [46, 47, 48, 52, 57, 78], "mandatori": [39, 77], "manipul": [54, 78], "manual": [77, 79], "map": [5, 51, 56, 63, 71, 78], "mark": 77, "marker": [45, 60, 78], "market": [39, 77], "match": [55, 78], "maximum": [60, 78], "mean": 77, "mechan": [54, 78], "media": [2, 37, 39, 45, 50, 52, 59, 74, 75, 77, 78], "media_typ": [8, 9, 10, 11], "mediatyp": [11, 39, 40, 77], "medium": [41, 44, 78], "meet": [39, 77], "member": 36, "merg": [33, 39, 50, 77, 78], "merge_docu": [8, 33], "messag": [7, 8, 34], "metadata": [44, 60, 78], "method": [2, 36, 45, 56, 74, 77, 78], "might": [54, 78], "miller": [39, 77], "millisecond": [4, 70], "mime": [2, 37, 74, 75], "mime_typ": [1, 2, 37, 39, 40, 74, 75, 77], "minut": 32, "mk": [46, 47, 48, 52, 57, 78], "mk_mk": [41, 45, 46, 47, 48, 52, 57, 78], "modif": [51, 78], "modul": [67, 68], "more": [39, 50, 77, 78], "most": 36, "msword": [2, 52, 74, 78], "mt": [46, 47, 48, 52, 57, 78], "mt_mt": [41, 45, 46, 47, 48, 52, 57, 78], "multipl": [39, 56, 77, 78], "must": [39, 54, 77, 78], "name": [6, 39, 41, 51, 54, 55, 72, 77, 78], "nan": 36, "nb": [46, 47, 48, 52, 57, 78], "nb_no": [41, 45, 46, 47, 48, 52, 57, 78], "need": [39, 42, 77, 78], "neg": 36, "netherland": [46, 47, 48, 52, 57, 78], "network": [2, 7, 39, 73, 74, 77], "new": [2, 39, 40, 41, 42, 43, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 65, 66, 74, 77, 78, 79], "newlin": 36, "nl": [46, 47, 48, 52, 57, 78], "nl_nl": [41, 45, 46, 47, 48, 52, 57, 78], "nn": [52, 78], "nn_no": [41, 52, 78], "no_changes_allow": [41, 51, 78], "no_no": [41, 45, 46, 47, 48, 57, 78], "non": [36, 39, 77], "none": [2, 3, 4, 5, 6, 7, 8, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 32, 33, 34, 35, 36, 37, 39, 40, 46, 47, 48, 49, 50, 51, 52, 53, 54, 56, 59, 60, 62, 63, 64, 65, 69, 70, 71, 72, 74, 75, 77, 78], "norwai": [46, 47, 48, 52, 57, 78], "norwegian": [46, 47, 48, 52, 57, 78], "note": [46, 47, 48, 77, 78], "notif": [2, 74], "notifi": [2, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 70, 74], "notifier_config": [2, 4, 27, 71], "notifier_data": [2, 4, 71], "notifier_typ": [2, 4, 71], "notifierconfig": [2, 4, 5, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 70, 74], "notifierdata": [4, 5, 70, 74], "notifiertyp": [4, 5, 70, 74], "notify_config_list": [2, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 74], "number": [4, 6, 39, 51, 54, 56, 63, 70, 72, 77, 78], "nynorsk": [52, 78], "o": [36, 39, 40, 77], "oauth": 32, "obj": 36, "object": [2, 4, 5, 6, 8, 9, 11, 12, 14, 15, 16, 18, 19, 20, 22, 23, 24, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 43, 50, 51, 54, 56, 58, 60, 63, 66, 70, 71, 72, 74, 75, 77, 78, 79], "object_util": [2, 8], "objectutil": [8, 36], "ocr": [8, 33, 39, 52, 57, 77, 78], "ocr_lang": [18, 22, 52, 78], "ocr_local": [57, 78], "ocr_param": [22, 38, 41, 78], "ocr_pdf": [33, 38, 41, 78], "ocr_pdf_external_asset_request": [10, 11], "ocr_pdf_internal_asset_request": [10, 11], "ocr_pdf_job": [2, 38, 57, 66, 77, 78, 79], "ocr_pdf_operation_nam": [8, 33], "ocr_pdf_param": [22, 39, 77], "ocr_pdf_params_payload": [10, 11], "ocr_pdf_result": [2, 38, 79], "ocr_supported_local": [38, 41, 78], "ocr_supported_typ": [38, 41, 78], "ocr_typ": [22, 57, 78], "ocrjob": [57, 78], "ocrlang": [18, 22], "ocrparam": [22, 39, 41, 57, 74, 76, 77], "ocrparamspayload": [11, 22], "ocrpdf": [10, 11], "ocrpdfexternalassetrequest": [11, 22], "ocrpdfinternalassetrequest": [11, 22], "ocrpdfjob": [38, 39, 57, 66, 74, 76, 78, 79], "ocrpdfresult": [38, 39, 66, 74, 76, 77], "ocrsupportedlocal": [39, 41, 57, 74, 76, 77], "ocrsupportedtyp": [41, 57, 74, 76], "ocrtyp": 22, "off": 77, "offic": [46, 47, 48, 78], "officedocu": [2, 50, 52, 74, 78], "one": [39, 77], "onli": [33, 36, 39, 40, 46, 47, 48, 51, 60, 77, 78], "only_embedded_fil": [41, 60, 78], "onto": [39, 77], "op": 34, "opac": [77, 78], "open": [39, 40, 60, 77, 78], "openxmlformat": [2, 50, 52, 74, 78], "oper": [0, 1, 69, 70, 71, 72, 73, 74, 75, 77, 78, 79], "operation_endpoint": [8, 9], "operation_header_info": [8, 9], "operation_header_info_endpoint_map": [2, 8], "operation_result_temp_directori": [8, 33], "operationexcept": [2, 8], "operationheaderinfoendpointmap": [8, 33], "optim": [39, 77], "option": [2, 4, 5, 6, 37, 39, 40, 42, 43, 44, 46, 47, 48, 50, 51, 52, 53, 54, 56, 57, 58, 60, 65, 70, 71, 72, 74, 75, 77, 78], "option_on": 77, "option_thre": 77, "option_two": 77, "order": [39, 77], "otherwis": [36, 54, 78], "our": 34, "output": [12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 33, 36, 39, 40, 42, 44, 50, 51, 53, 59, 66, 77, 78, 79], "output_asset": [12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 39, 40, 77], "output_fil": [40, 77], "output_file_path": [40, 77], "output_filled_form": 77, "output_format": [16, 38, 39, 41, 77, 78], "output_typ": 26, "outputformat": [16, 39, 41, 50, 74, 76, 77], "outputtyp": [26, 59, 78], "overload": 34, "owner": [51, 60, 78], "owner_password": [60, 78], "packag": 68, "pade": [41, 51, 78], "page": [33, 39, 41, 49, 51, 54, 56, 58, 60, 62, 63, 64, 65, 67, 77, 78], "page_act": [10, 11, 36], "page_action_command": [10, 11], "page_count": [36, 39, 65, 77, 78], "page_end": 78, "page_height": [39, 54, 77, 78], "page_layout": [20, 38, 39, 41, 77, 78], "page_level": 24, "page_manipulation_external_asset_request": [10, 11], "page_manipulation_internal_asset_request": [10, 11], "page_manipulation_params_payload": [10, 11], "page_numb": [39, 51, 77, 78], "page_rang": [2, 8, 23, 36, 38, 39, 43, 49, 56, 62, 63, 64, 65, 77, 78], "page_ranges_for_delet": [39, 77], "page_start": 78, "page_width": [39, 54, 77, 78], "pageact": [11, 23, 36, 64, 78], "pageactioncommand": [11, 23], "pagecount": 65, "pageheight": 54, "pagelayout": [20, 39, 41, 54, 74, 76, 77], "pagelevel": 24, "pagemanipul": [10, 11, 33], "pagemanipulationexternalassetrequest": [11, 23], "pagemanipulationinternalassetrequest": [11, 23], "pagemanipulationparamspayload": [11, 23], "pagerang": [8, 23, 35, 36, 38, 39, 41, 43, 49, 56, 62, 63, 64, 65, 74, 76, 77], "pages_to_reord": [39, 77], "pagewidth": 54, "paid": 34, "param": [2, 8, 12, 14, 15, 16, 17, 18, 19, 20, 22, 23, 24, 26, 27, 28, 29, 36, 38, 74, 76, 77], "paramet": [2, 3, 4, 5, 6, 37, 39, 40, 42, 43, 44, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "particular": [2, 74], "pass": 36, "password": [4, 6, 28, 36, 39, 51, 60, 61, 70, 72, 77, 78], "password_protect": 27, "password_protect_param": [38, 41, 78], "passwordprotect": 27, "passwordprotectparam": [27, 39, 41, 60, 74, 76, 77], "path": [4, 70, 77], "path_util": [2, 8], "pathlib": 77, "pdf": [1, 2, 3, 4, 32, 33, 39, 40, 41, 42, 43, 44, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 69, 74, 77, 78, 79], "pdf_accessibility_check": [8, 33, 78], "pdf_accessibility_checker_job": 77, "pdf_accessibility_checker_operation_nam": [8, 33], "pdf_accessibility_checker_param": [77, 78], "pdf_accessibility_checker_result": 79, "pdf_electronic_seal_param": 36, "pdf_file": [39, 77], "pdf_properti": [8, 10, 11, 33, 38, 41, 78], "pdf_properties_dict": [66, 79], "pdf_properties_external_asset_request": [10, 11], "pdf_properties_internal_asset_request": [10, 11], "pdf_properties_job": [2, 38, 77], "pdf_properties_operation_nam": [8, 33], "pdf_properties_param": [24, 38, 39, 41, 77, 78], "pdf_properties_params_payload": [10, 11], "pdf_properties_result": [2, 38, 39, 77, 79], "pdf_servic": [0, 1, 39, 40, 74, 77], "pdf_services_api": [2, 8, 10, 11, 30, 33], "pdf_services_api_request": [10, 11], "pdf_services_api_respons": [10, 30], "pdf_services_client_id": [39, 40, 77], "pdf_services_client_secret": [39, 40, 77], "pdf_services_help": [1, 2], "pdf_services_job": [0, 1, 74], "pdf_services_job_param": [2, 38, 78], "pdf_services_job_result": [2, 38, 79], "pdf_services_job_statu": [0, 1, 74], "pdf_services_job_status_respons": [0, 1, 74], "pdf_services_media_typ": [0, 1, 74, 77], "pdf_services_respons": [0, 1, 39, 40, 74, 77], "pdf_services_uri": [2, 8], "pdf_to_imag": [33, 38, 41, 78], "pdf_to_image_external_asset_request": [10, 11], "pdf_to_image_internal_asset_request": [10, 11], "pdf_to_image_params_payload": [10, 11], "pdf_to_images_operation_nam": [8, 33], "pdf_watermark": [8, 33, 78, 79], "pdf_watermark_job": 77, "pdf_watermark_operation_nam": [8, 33], "pdf_watermark_param": [77, 78], "pdf_watermark_result": [77, 79], "pdfaccessibilitycheckerjob": [74, 76, 78, 79], "pdfaccessibilitycheckerparam": [74, 76, 77], "pdfaccessibilitycheckerresult": [74, 76, 77], "pdfelectronicsealjob": [38, 39, 51, 66, 74, 76, 78, 79], "pdfelectronicsealparam": [17, 36, 39, 41, 51, 74, 76, 77], "pdfjob": [1, 2, 77, 78, 79], "pdfproperti": 33, "pdfpropertiesexternalassetrequest": [11, 24], "pdfpropertiesinternalassetrequest": [11, 24], "pdfpropertiesjob": [38, 39, 58, 66, 74, 76, 78, 79], "pdfpropertiesparam": [24, 39, 41, 58, 74, 76, 77], "pdfpropertiesparamspayload": [11, 24], "pdfpropertiesresult": [38, 39, 66, 74, 76, 77], "pdfservic": [0, 68, 69, 70, 71, 72, 73, 75, 77, 78, 79], "pdfservicesapi": [8, 9], "pdfservicesapirequest": [8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "pdfservicesapirespons": [30, 31], "pdfserviceshelp": [2, 8], "pdfservicesjob": [1, 2, 5, 37, 39, 40, 41, 66, 67, 71, 75, 77, 78, 79], "pdfservicesjobparam": [38, 41, 42, 43, 44, 45, 49, 50, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 74, 76], "pdfservicesjobresult": [2, 38, 66, 74, 76], "pdfservicesjobstatu": [1, 2, 67], "pdfservicesjobstatusrespons": [1, 2, 67], "pdfservicesmediatyp": [1, 2, 39, 67, 77], "pdfservicesrespons": [1, 2, 8, 67], "pdfservicesuri": [8, 33], "pdftoimag": [10, 11, 33], "pdftoimageparamspayload": [11, 26], "pdftoimagesexternalassetrequest": [11, 26], "pdftoimagesinternalassetrequest": [11, 26], "pdftoolsapi_err_quota": 34, "pdftoolsapi_hom": 34, "pdfwatermarkjob": [74, 76, 78, 79], "pdfwatermarkparam": [74, 76, 77], "pdfwatermarkresult": [74, 76, 77], "per": [39, 44, 77, 78], "percentag": 78, "perform": [2, 39, 51, 74, 77, 78], "permiss": [27, 38, 41, 51, 74, 76], "permit": [51, 78], "photoshop": [2, 74], "pin": [39, 51, 77, 78], "pkcs7": [41, 51, 78], "pl": [46, 47, 48, 52, 57, 78], "pl_pl": [41, 45, 46, 47, 48, 52, 57, 78], "place": 36, "placement": 78, "plain": [2, 34, 74], "platform": [8, 33], "platform_api_request": [8, 9], "pleas": [34, 46, 47, 48, 78], "png": [1, 2, 39, 41, 59, 74, 77, 78], "point": [2, 74], "poland": [46, 47, 48, 52, 57, 78], "polish": [46, 47, 48, 52, 57, 78], "poll": [2, 74], "polling_timeout_status_cod": [8, 9], "polling_url": [2, 74], "port": [4, 6, 70, 72], "portugues": [46, 47, 48, 52, 57, 78], "possibl": [6, 72], "post": [8, 34], "powerpoint": [2, 74], "ppt": [1, 2, 41, 45, 74, 78], "pptx": [1, 2, 41, 52, 74, 78], "pre": [54, 78], "prefer": [46, 47, 48, 78], "present": [2, 51, 52, 74, 78], "presentationml": [2, 52, 74, 78], "pretti": 36, "prevent": 36, "princip": [3, 32, 69], "principl": 32, "print": [36, 39, 44, 60, 77, 78], "print_high_qu": [41, 60, 78], "print_low_qu": [41, 60, 78], "pro": [77, 79], "problem": [77, 79], "process": [2, 40, 50, 74, 77, 78], "process_request": [8, 34], "produc": [39, 77], "progress": [2, 74], "properli": 77, "properti": [2, 7, 8, 11, 33, 39, 44, 58, 66, 74, 77, 78, 79], "propos": [39, 77], "protect": [33, 39, 61, 77, 78], "protect_pdf": [8, 10, 11, 33, 38, 41, 78], "protect_pdf_external_asset_request": [10, 11], "protect_pdf_internal_asset_request": [10, 11], "protect_pdf_job": [2, 38, 77], "protect_pdf_nam": [8, 33], "protect_pdf_param": [27, 36, 38, 39, 41, 77, 78], "protect_pdf_params_payload": [10, 11], "protect_pdf_result": [2, 38, 79], "protectpdf": 33, "protectpdfexternalassetrequest": [11, 27], "protectpdfinternalassetrequest": [11, 27], "protectpdfjob": [38, 39, 60, 66, 74, 76, 78, 79], "protectpdfparam": [36, 39, 41, 60, 74, 76, 77], "protectpdfparamspayload": [11, 27], "protectpdfresult": [38, 39, 66, 74, 76, 77], "provid": [6, 33, 39, 50, 51, 72, 77, 78], "provider_nam": [39, 51, 77, 78], "proxi": [2, 4, 34, 70, 74], "proxy_authentication_credenti": [2, 4, 72], "proxy_config_map": [4, 6], "proxy_schem": [2, 4, 72], "proxy_server_config": [2, 4, 70, 72], "proxyauthenticationcredenti": [4, 6, 70, 74], "proxyschem": [4, 6, 70, 74], "proxyserverconfig": [4, 6, 34, 70, 74], "psd": [1, 2, 74], "pt": [46, 47, 48, 52, 57, 78], "pt_br": [41, 45, 46, 47, 48, 52, 57, 78], "pt_pt": [41, 52, 78], "put": [8, 34], "py": [50, 78], "python": 77, "qualiti": [44, 60, 78], "quota": [2, 7, 34, 73, 74], "quota_error_messag": [8, 34], "rais": [2, 36, 74], "rang": [39, 41, 56, 62, 63, 77, 78], "rb": [39, 40, 77], "reach": [2, 7, 34, 73, 74], "read": [4, 39, 40, 70, 77], "read_conf_file_cont": [8, 36], "read_timeout": [4, 34, 70], "readabl": [39, 77], "reader": [39, 77], "readtimeout": [4, 70], "rearrang": [39, 77], "recurs": 36, "recursionerror": 36, "reduc": [39, 44, 77, 78], "refer": [36, 39, 54, 67, 77, 78], "refresh": [2, 32, 74], "refresh_download_uri": [1, 2, 8, 74], "refresh_token": [8, 32], "region": [0, 1, 4, 33, 46, 47, 48, 67, 70, 78], "region_uri_map": [8, 33], "regress": 36, "relat": [51, 78], "remain": 32, "remedi": [39, 77], "remov": [33, 39, 61, 77, 78], "remove_protect": [8, 10, 11, 33, 38, 41, 78], "remove_protection_extenal_asset_request": [10, 11], "remove_protection_internal_asset_request": [10, 11], "remove_protection_job": [2, 38, 77], "remove_protection_operation_nam": [8, 33], "remove_protection_param": [28, 38, 39, 41, 77, 78], "remove_protection_params_payload": [10, 11], "remove_protection_result": [2, 38, 79], "removeprotect": 33, "removeprotectionexternalassetrequest": [11, 28], "removeprotectioninternalassetrequest": [11, 28], "removeprotectionjob": [38, 39, 61, 66, 74, 76, 78, 79], "removeprotectionparam": [28, 39, 41, 61, 74, 76, 77], "removeprotectionparamspayload": [11, 28], "removeprotectionresult": [38, 39, 66, 74, 76, 77], "rendit": [53, 78], "renditions_to_extract": 19, "renditionstoextract": 19, "reorder": [33, 62, 78], "reorder_pag": [8, 33, 38, 41, 78], "reorder_pages_job": [2, 38, 77], "reorder_pages_operation_nam": [8, 33], "reorder_pages_param": [38, 39, 41, 77, 78], "reorder_pages_result": [2, 38, 79], "reorderpagesjob": [38, 39, 62, 66, 74, 76, 78, 79], "reorderpagesparam": [39, 41, 62, 74, 76, 77], "reorderpagesresult": [38, 39, 66, 74, 76, 77], "replac": [33, 39, 63, 77, 78], "replace_pag": [8, 33, 38, 41, 78], "replace_page_result": [2, 38, 79], "replace_pages_job": [2, 38, 77], "replace_pages_operation_nam": [8, 33], "replace_pages_param": [38, 39, 41, 77, 78], "replacepagesjob": [38, 39, 63, 66, 74, 76, 78, 79], "replacepagesparam": [39, 41, 63, 74, 76, 77], "replacepagesresult": [38, 39, 66, 74, 76, 77], "report": [39, 42, 66, 77, 78, 79], "report_asset": 77, "report_error_cod": 8, "repres": [2, 3, 5, 6, 7, 37, 39, 40, 41, 46, 47, 48, 50, 51, 52, 54, 57, 59, 60, 64, 66, 69, 71, 72, 74, 75, 77, 78, 79], "represent": [2, 5, 36, 37, 44, 50, 51, 54, 57, 74, 75, 78], "republ": [46, 47, 48, 52, 57, 78], "request": [4, 7, 9, 10, 33, 34, 54, 70, 78], "request_header_const": [2, 8], "request_kei": [2, 8, 34], "request_tracking_id": [2, 7, 8], "requestentitytoolarg": 34, "requestkei": [8, 33], "requir": [39, 51, 54, 60, 77, 78], "require_not_nul": [8, 36], "resolut": [44, 78], "resourc": [66, 79], "respons": [2, 4, 9, 10, 32, 34, 70, 74], "response_util": [2, 8], "responseutil": [8, 34], "restrict": [2, 39, 74, 77], "result": [2, 7, 38, 39, 50, 53, 54, 58, 60, 73, 74, 76, 77, 78], "result_asset": [39, 40, 77], "result_typ": [2, 8, 74], "retri": [2, 34, 74], "retriev": [40, 54, 77, 78], "retryabl": 34, "return": [2, 3, 4, 5, 6, 7, 36, 37, 39, 40, 42, 43, 44, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 69, 70, 72, 73, 74, 75, 77, 78, 79], "rev": [8, 36], "rfc3161": [51, 78], "rfc3161_tsa_opt": [38, 41, 78], "rfc3161tsaoption": [41, 51, 74, 76], "right": [51, 78], "ro": [46, 47, 48, 52, 57, 78], "ro_ro": [41, 45, 46, 47, 48, 52, 57, 78], "romania": [46, 47, 48, 52, 57, 78], "romanian": [46, 47, 48, 52, 57, 78], "rotat": [23, 39, 60, 64, 77, 78], "rotate_act": 23, "rotate_pag": [8, 33, 38, 41, 78], "rotate_page_act": [10, 11], "rotate_pages_job": [2, 38, 64, 77, 78], "rotate_pages_operation_nam": [8, 33], "rotate_pages_param": [38, 39, 41, 77, 78], "rotate_pages_result": [2, 38, 79], "rotatepageact": [11, 23], "rotatepagesjob": [38, 39, 64, 66, 74, 76, 78, 79], "rotatepagesparam": [39, 41, 64, 74, 76, 77], "rotatepagesresult": [38, 39, 66, 74, 76, 77], "rotation_angl": 23, "rtf": [1, 2, 41, 52, 74, 78], "ru": [46, 47, 48, 52, 57, 78], "ru_ru": [41, 45, 46, 47, 48, 52, 57, 78], "russia": [46, 47, 48, 52, 57, 78], "russian": [46, 47, 48, 52, 57, 78], "s3": [2, 37, 75], "same": [51, 56, 78], "sampl": [39, 40, 77], "save": [40, 77], "scheme": [4, 6, 70, 72], "screen": [39, 77], "script": [54, 78], "sdk": [2, 5, 6, 37, 40, 41, 46, 47, 48, 51, 54, 74, 77, 78], "sdk_result": 33, "sdkexcept": [2, 7, 74], "se": [46, 47, 48, 52, 57, 78], "seal": [33, 39, 51, 77, 78], "seal_appearance_opt": [51, 78], "seal_certificate_credenti": [39, 51, 77, 78], "seal_field_nam": [39, 77], "seal_field_opt": [39, 51, 77, 78], "seal_imag": [41, 51, 78], "seal_image_asset": [17, 39, 77], "seal_image_asset_id": 17, "seal_image_fil": [39, 77], "seal_image_input_stream": [39, 77], "seal_opt": 17, "seal_page_numb": [39, 77], "seal_signature_format": [51, 78], "seal_vis": [39, 77], "sealimageassetid": 17, "sealopt": 17, "search": 67, "searchabl": [39, 57, 77, 78], "searchable_imag": [41, 57, 78], "searchable_image_exact": [41, 57, 78], "second": [2, 74], "secret": [3, 69], "secur": [39, 60, 77, 78], "see": [43, 44, 65, 77, 78], "self": [36, 73], "send": [4, 70], "sensibl": 36, "sent": 32, "separ": 36, "serbia": [46, 47, 48, 52, 57, 78], "serbian": [46, 47, 48, 52, 57, 78], "serial": 36, "serializ": 36, "server": [4, 6, 32, 34, 70, 72], "servic": [2, 3, 4, 7, 32, 33, 34, 40, 51, 69, 73, 74, 77, 78], "service_const": [2, 8], "service_principal_authent": [2, 8], "service_principal_configur": [8, 32], "service_principal_credenti": [1, 2, 69, 77], "service_token_authent": [2, 8], "service_token_credenti": [2, 8], "service_usage_exception_status_code_429001_str": [8, 34], "service_usage_exception_status_code_429002_str": [8, 34], "service_usage_limit_reached_error_messag": [8, 34], "serviceapiexcept": [2, 7, 74], "serviceconst": [8, 33], "serviceprincipalauthent": [8, 32], "serviceprincipalcredenti": [2, 3, 32, 39, 40, 74, 77], "servicetokenauthent": [8, 32], "servicetokencredenti": [8, 32], "serviceunavaibal": 34, "serviceusageerror": [7, 73], "serviceusageexcept": [2, 7, 74], "session_token": [2, 8, 33], "session_token_request_id_header_kei": [8, 34], "sessiontoken": [8, 32], "set": [2, 4, 33, 39, 40, 44, 46, 47, 48, 51, 52, 54, 60, 64, 70, 73, 74, 77, 78], "set_client_id": [8, 32], "set_output": 77, "set_output_valid": [8, 33], "set_param": 77, "set_token": [8, 32], "setformdata": 33, "sharepoint": [2, 37, 75], "sheet": [2, 52, 74, 78], "shift": [42, 78], "shift_head": [12, 42, 78], "shifthead": 12, "should": [6, 36, 51, 55, 72, 78], "si": [46, 47, 48, 52, 57, 78], "side": [2, 7, 73, 74], "signatur": [51, 60, 78], "signature1": [39, 77], "signature_format": [38, 41, 78], "signatureformat": [41, 51, 74, 76], "simpl": [6, 72], "simpli": [36, 39, 77], "singl": [39, 41, 77, 78], "size": [39, 44, 77, 78], "sk": [46, 47, 48, 52, 57, 78], "sk_sk": [41, 45, 46, 47, 48, 52, 57, 78], "skip": 36, "skipkei": 36, "sl": [46, 47, 48, 52, 57, 78], "sl_si": [41, 45, 46, 47, 48, 52, 57, 78], "slovak": [46, 47, 48, 52, 57, 78], "slovakia": [46, 47, 48, 52, 57, 78], "slovenia": [46, 47, 48, 52, 57, 78], "slovenian": [46, 47, 48, 52, 57, 78], "smaller": [39, 77], "some": [34, 39, 77], "sometim": 34, "sort": 36, "sort_kei": 36, "sourc": [39, 40, 45, 52, 54, 59, 77, 78], "source_path": [39, 40, 77], "source_path_1": [39, 77], "source_path_2": [39, 77], "spain": [46, 47, 48, 52, 57, 78], "spanish": [46, 47, 48, 52, 57, 78], "specif": [2, 36, 39, 74, 77], "specifi": [5, 6, 36, 39, 42, 44, 51, 53, 56, 64, 71, 72, 77, 78], "split": [33, 39, 65, 77, 78], "split_pdf": [8, 33, 38, 41, 78], "split_pdf_external_asset_request": [10, 11], "split_pdf_internal_asset_request": [10, 11], "split_pdf_job": [2, 38, 77], "split_pdf_operation_nam": [8, 33], "split_pdf_param": [29, 38, 39, 41, 77, 78], "split_pdf_params_payload": [10, 11], "split_pdf_result": [2, 38, 79], "splitopt": 29, "splitpdf": [10, 11, 33], "splitpdfexternalassetrequest": [11, 29], "splitpdfinternalassetrequest": [11, 29], "splitpdfjob": [38, 39, 65, 66, 74, 76, 78, 79], "splitpdfparam": [29, 39, 41, 65, 74, 76, 77], "splitpdfparamspayload": [11, 29], "splitpdfresult": [38, 39, 66, 74, 76, 77], "spreadsheetml": [2, 52, 74, 78], "sr": [46, 47, 48, 52, 57, 78], "sr_sr": [41, 45, 46, 47, 48, 52, 57, 78], "src": [54, 78], "stack": 34, "stamp": [51, 78], "standard": [39, 77], "star": 77, "start": [34, 35, 41, 78], "state": [46, 47, 48, 52, 57, 78], "static": [2, 9, 23, 31, 32, 33, 34, 36, 39, 74, 77], "statu": [2, 7, 8, 30, 31, 33, 74], "status_cod": [2, 7, 8], "status_pol": [8, 9], "storag": [2, 37, 74, 75], "storage_api": [2, 8], "storage_typ": [37, 75], "storageapi": [8, 9], "store": [37, 51, 75, 78], "str": [2, 3, 4, 5, 6, 8, 9, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28, 29, 30, 32, 33, 34, 36, 37, 39, 51, 54, 55, 60, 61, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "stream": [2, 37, 74, 75], "stream_asset": [1, 2, 36, 39, 40, 75, 77], "stream_asset_list": 8, "stream_report": 77, "streamasset": [2, 8, 36, 37, 39, 40, 74, 77], "string": [2, 5, 6, 36, 37, 39, 44, 50, 51, 55, 57, 60, 66, 72, 74, 75, 77, 78, 79], "string_util": [2, 8], "stringutil": [8, 36], "structur": [4, 39, 44, 53, 70, 77, 78], "style": [53, 78], "styling_info": [53, 78], "subclass": 36, "submit": [1, 2, 39, 40, 74, 77], "submit_job": [2, 8, 9], "submodul": [0, 1, 10, 38], "subpackag": 68, "subtyp": [51, 78], "success_status_cod": 34, "sufia": 77, "summar": 77, "suppli": [54, 78], "support": [2, 6, 36, 39, 44, 46, 47, 48, 50, 51, 52, 53, 57, 59, 60, 72, 74, 77, 78], "sv": [46, 47, 48, 52, 57, 78], "sv_se": [41, 45, 46, 47, 48, 52, 57, 78], "svg": [1, 2, 74], "sweden": [46, 47, 48, 52, 57, 78], "swedish": [46, 47, 48, 52, 57, 78], "switzerland": [46, 47, 48, 52, 57, 78], "t": [7, 34, 36], "tabl": [39, 41, 53, 77, 78], "table_output_format": 19, "table_structure_typ": [38, 41, 78], "tableoutputformat": 19, "tablestructuretyp": [41, 53, 74, 76], "tabular": [53, 78], "tag": [39, 42, 46, 47, 48, 66, 77, 78, 79], "tagged_pdf": [66, 79], "take": 36, "target": [52, 55, 59, 78], "target_format": [18, 26, 39, 52, 77, 78], "targetformat": [18, 26], "tb": 73, "technologi": [39, 77], "templat": [39, 50, 51, 60, 77, 78], "test": 36, "text": [2, 34, 39, 41, 52, 53, 54, 74, 77, 78], "textual": [53, 78], "than": [6, 72], "thei": 77, "thi": [2, 3, 4, 5, 6, 7, 34, 36, 37, 39, 40, 41, 44, 45, 46, 47, 48, 50, 51, 52, 54, 56, 57, 59, 60, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "those": [39, 77], "thrown": [2, 7, 51, 73, 74, 78], "tif": [1, 2, 74], "tiff": [1, 2, 74], "till": 32, "time": [32, 51, 56, 78], "time_to_expir": [8, 32], "timeout": [4, 34, 70], "timestamp": [51, 78], "titl": [54, 78], "to_dict": [41, 51], "to_json": [2, 4, 5, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 35, 37, 38, 41, 54, 65], "token": [8, 32, 51, 78], "token_endpoint": [8, 32], "token_typ": [39, 51, 77, 78], "too": 34, "top": [39, 51, 77, 78], "tr": [46, 47, 48, 52, 57, 78], "tr_tr": [41, 45, 46, 47, 48, 52, 57, 78], "track": 7, "tradit": [52, 78], "trial": 34, "true": [36, 39, 42, 51, 54, 58, 77, 78], "trust": [51, 78], "try": [34, 36], "tsa": [51, 78], "tsa_basic_auth_credenti": [38, 41, 78], "tsa_opt": [38, 41, 78], "tsabasicauthcredenti": [41, 51, 74, 76], "tsaoption": [41, 51, 74, 76], "tsp": [51, 78], "tupl": 36, "turkei": [46, 47, 48, 52, 57, 78], "turkish": [46, 47, 48, 52, 57, 78], "txt": [1, 2, 74], "type": [2, 3, 4, 5, 6, 34, 36, 37, 39, 40, 41, 42, 43, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "typeerror": 36, "typic": [7, 73], "u": [1, 2, 4, 33, 46, 47, 48, 52, 57, 70, 74, 78], "ua": [39, 46, 47, 48, 52, 57, 77, 78], "ue1": 33, "uk": [46, 47, 48, 52, 57, 78], "uk_ua": [41, 45, 46, 47, 48, 52, 57, 78], "ukrain": [46, 47, 48, 52, 57, 78], "ukrainian": [46, 47, 48, 52, 57, 78], "underli": [7, 73], "unicod": [39, 60, 77, 78], "unit": [46, 47, 48, 52, 57, 78], "unknown": 7, "until": [4, 70], "up": [2, 34, 74], "upgrad": 34, "upload": [1, 2, 8, 33, 39, 40, 74, 77], "upload_asset": [1, 2, 8, 39, 74, 77], "upload_asset_list": [2, 74], "upload_to_cloud": [8, 9], "uri": [2, 4, 8, 9, 33, 37, 74, 75], "url": [2, 5, 34, 39, 51, 71, 74, 77, 78], "us": [2, 3, 4, 5, 6, 34, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 69, 70, 71, 72, 74, 75, 77, 78, 79], "us_uri": [8, 33], "usag": [2, 7, 34, 39, 40, 73, 74, 77], "user": [5, 44, 60, 71, 78], "user_password": [39, 60, 77, 78], "usernam": [4, 6, 51, 70, 72, 78], "username_password_credenti": [2, 4, 72], "usernamepasswordcredenti": [4, 6, 70, 74], "util": [2, 8, 74], "valid": [2, 4, 8, 35, 38, 41, 74], "validate_asset_with_page_opt": [8, 36], "validate_csc_credenti": [8, 36], "validate_document_merge_param": [8, 36], "validate_execution_context": [8, 36], "validate_field_loc": [8, 36], "validate_field_opt": [8, 36], "validate_insert_asset_input": [8, 36], "validate_page_opt": [8, 36], "validate_page_rang": [8, 36], "validate_page_ranges_overlap": [8, 36], "validate_password": [8, 36], "validate_password_to_remove_protect": [8, 36], "validate_pdf_electronic_seal_param": [8, 36], "validate_protect_pdf_param": [8, 36], "validate_replace_files_input": [8, 36], "validate_rotate_page_act": [8, 36], "validate_split_pdf_operation_param": [8, 36], "validation_util": [2, 8], "validationutil": [8, 36], "valu": [2, 4, 5, 6, 7, 30, 33, 34, 37, 39, 40, 42, 43, 44, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 64, 65, 70, 71, 72, 74, 75, 77, 78], "valueerror": 36, "variou": [2, 39, 74, 77], "verifi": 77, "version": 36, "via": [39, 77], "view": [60, 78], "visibl": [39, 51, 77, 78], "visit": 34, "vnd": [2, 50, 52, 74, 78], "wa": [53, 66, 78, 79], "wait": [4, 70], "war": 77, "water": 77, "watermark": [33, 77, 78, 79], "watermark_appear": [77, 78], "watermark_asset": 77, "watermarkappear": [74, 76, 77], "wb": [40, 77], "wcag": [39, 77], "web": [39, 77], "well": [33, 39, 40, 77], "when": [7, 33, 39, 40, 73, 77], "where": [41, 54, 78], "whether": [42, 46, 47, 48, 53, 78], "which": [36, 39, 42, 51, 52, 56, 59, 63, 77, 78], "while": [2, 39, 74, 77], "whitespac": 36, "width": [54, 78], "with_traceback": [73, 74], "within": [34, 45, 78], "word": [39, 41, 45, 77, 78], "wordprocessingml": [2, 50, 52, 74, 78], "would": 36, "write": [40, 77], "www": 34, "x": [2, 34, 74], "x_api_key_header_nam": [8, 34], "x_dcsdk_ops_info_header_nam": [8, 34], "x_request_id": [8, 9], "xl": [1, 2, 74], "xlsx": [1, 2, 41, 52, 53, 74, 78], "xml": [2, 74], "ye": 77, "you": 36, "your": [3, 69], "zh": [46, 47, 48, 52, 57, 78], "zh_cn": [41, 45, 46, 47, 48, 52, 57, 78], "zh_hant": [41, 52, 78], "zh_hk": [41, 45, 46, 47, 48, 57, 78], "zip": [1, 2, 39, 59, 66, 74, 77, 78, 79], "zip_of_page_imag": [41, 59, 78], "zipofpageimag": [59, 78]}, "titles": ["adobe package", "adobe.pdfservices package", "adobe.pdfservices.operation package", "adobe.pdfservices.operation.auth package", "adobe.pdfservices.operation.config package", "adobe.pdfservices.operation.config.notifier package", "adobe.pdfservices.operation.config.proxy package", "adobe.pdfservices.operation.exception package", "adobe.pdfservices.operation.internal package", "adobe.pdfservices.operation.internal.api package", "adobe.pdfservices.operation.internal.api.dto package", "adobe.pdfservices.operation.internal.api.dto.request package", "adobe.pdfservices.operation.internal.api.dto.request.autotagpdf package", "adobe.pdfservices.operation.internal.api.dto.request.combinepdf package", "adobe.pdfservices.operation.internal.api.dto.request.compresspdf package", "adobe.pdfservices.operation.internal.api.dto.request.createpdf package", "adobe.pdfservices.operation.internal.api.dto.request.document_generation package", "adobe.pdfservices.operation.internal.api.dto.request.esealpdf package", "adobe.pdfservices.operation.internal.api.dto.request.exportpdf package", "adobe.pdfservices.operation.internal.api.dto.request.extract_pdf package", "adobe.pdfservices.operation.internal.api.dto.request.htmltopdf package", "adobe.pdfservices.operation.internal.api.dto.request.linearizepdf package", "adobe.pdfservices.operation.internal.api.dto.request.ocrpdf package", "adobe.pdfservices.operation.internal.api.dto.request.pagemanipulation package", "adobe.pdfservices.operation.internal.api.dto.request.pdf_properties package", "adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api package", "adobe.pdfservices.operation.internal.api.dto.request.pdftoimage package", "adobe.pdfservices.operation.internal.api.dto.request.protect_pdf package", "adobe.pdfservices.operation.internal.api.dto.request.remove_protection package", "adobe.pdfservices.operation.internal.api.dto.request.splitpdf package", "adobe.pdfservices.operation.internal.api.dto.response package", "adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api package", "adobe.pdfservices.operation.internal.auth package", "adobe.pdfservices.operation.internal.constants package", "adobe.pdfservices.operation.internal.http package", "adobe.pdfservices.operation.internal.params package", "adobe.pdfservices.operation.internal.util package", "adobe.pdfservices.operation.io package", "adobe.pdfservices.operation.pdfjobs package", "adobe.pdfservices.operation.pdfjobs.jobs package", "adobe.pdfservices.operation.pdfjobs.jobs.export\\_pdf\\_form\\_data package", "adobe.pdfservices.operation.pdfjobs.params package", "adobe.pdfservices.operation.pdfjobs.params.autotag_pdf package", "adobe.pdfservices.operation.pdfjobs.params.combine_pdf package", "adobe.pdfservices.operation.pdfjobs.params.compress_pdf package", "adobe.pdfservices.operation.pdfjobs.params.create_pdf package", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.excel package", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.ppt package", "adobe.pdfservices.operation.pdfjobs.params.create_pdf.word package", "adobe.pdfservices.operation.pdfjobs.params.delete_pages package", "adobe.pdfservices.operation.pdfjobs.params.documentmerge package", "adobe.pdfservices.operation.pdfjobs.params.eseal package", "adobe.pdfservices.operation.pdfjobs.params.export_pdf package", "adobe.pdfservices.operation.pdfjobs.params.extract_pdf package", "adobe.pdfservices.operation.pdfjobs.params.html_to_pdf package", "adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data package", "adobe.pdfservices.operation.pdfjobs.params.insert_pages package", "adobe.pdfservices.operation.pdfjobs.params.ocr_pdf package", "adobe.pdfservices.operation.pdfjobs.params.pdf_properties package", "adobe.pdfservices.operation.pdfjobs.params.pdf_to_image package", "adobe.pdfservices.operation.pdfjobs.params.protect_pdf package", "adobe.pdfservices.operation.pdfjobs.params.remove_protection package", "adobe.pdfservices.operation.pdfjobs.params.reorder_pages package", "adobe.pdfservices.operation.pdfjobs.params.replace_pages package", "adobe.pdfservices.operation.pdfjobs.params.rotate_pages package", "adobe.pdfservices.operation.pdfjobs.params.split_pdf package", "adobe.pdfservices.operation.pdfjobs.result package", "Welcome to pdfservices-sdk\u2019s documentation!", "src", "Authentication", "Config", "Notifier Config", "Proxy Config", "Exceptions", "API Reference", "IO", "PDF Jobs", "Jobs", "Params", "Result"], "titleterms": {"": 67, "_data": 40, "_form": 40, "_job": 40, "_pdf": 40, "adob": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66], "angl": [64, 78], "api": [9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 74], "appearance_item": 51, "appearance_opt": 51, "appearanceitem": 78, "appearanceopt": 78, "asset": [37, 75], "asset_upload_uri_request": 11, "asset_upload_util": 36, "auth": [3, 32], "auth_factori": 32, "authent": [32, 69], "autotag_pdf": 42, "autotag_pdf_external_asset_request": 12, "autotag_pdf_internal_asset_request": 12, "autotag_pdf_job": 39, "autotag_pdf_param": 42, "autotag_pdf_params_payload": 12, "autotag_pdf_result": 66, "autotagpdf": 12, "autotagpdfjob": 77, "autotagpdfparam": 78, "autotagpdfresult": 79, "callback_notifier_data": 5, "callbacknotifierdata": 71, "client_config": 4, "clientconfig": 70, "cloud_asset": 37, "cloudasset": 75, "combine_pdf": 43, "combine_pdf_external_asset_request": 13, "combine_pdf_internal_asset_request": 13, "combine_pdf_job": 39, "combine_pdf_job_input": 35, "combine_pdf_param": 43, "combine_pdf_result": 66, "combinepdf": 13, "combinepdfjob": 77, "combinepdfparam": 78, "combinepdfresult": 79, "compress_pdf": 44, "compress_pdf_external_asset_request": 14, "compress_pdf_internal_asset_request": 14, "compress_pdf_job": 39, "compress_pdf_param": 44, "compress_pdf_params_payload": 14, "compress_pdf_result": 66, "compression_level": 44, "compressionlevel": 78, "compresspdf": 14, "compresspdfjob": 77, "compresspdfparam": 78, "compresspdfresult": 79, "config": [4, 5, 6, 70, 71, 72], "constant": 33, "content": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 74], "content_encrypt": 60, "contentencrypt": 78, "create_pdf": [45, 46, 47, 48], "create_pdf_external_asset_request": 15, "create_pdf_from_excel_param": 46, "create_pdf_from_ppt_param": 47, "create_pdf_from_word_param": 48, "create_pdf_internal_asset_request": 15, "create_pdf_job": 39, "create_pdf_params_payload": 15, "create_pdf_result": 66, "createpdf": 15, "createpdffromexcelparam": 78, "createpdffrompptparam": 78, "createpdffromwordparam": 78, "createpdfjob": 77, "createpdfparam": [45, 78], "createpdfresult": 79, "credenti": [3, 69], "csc_auth_context": 51, "csc_credenti": 51, "cscauthcontext": 78, "csccredenti": 78, "custom_error_messag": 33, "delete_pag": 49, "delete_page_act": 23, "delete_pages_job": 39, "delete_pages_param": 49, "delete_pages_result": 66, "deletepagesjob": 77, "deletepagesparam": 78, "deletepagesresult": 79, "document": 67, "document_gener": 16, "document_generation_external_asset_request": 16, "document_generation_internal_asset_request": 16, "document_generation_params_payload": 16, "document_languag": [46, 47, 48], "document_level_permiss": 51, "document_merge_job": 39, "document_merge_param": 50, "document_merge_result": 66, "documentlanguag": 78, "documentlevelpermiss": 78, "documentmerg": 50, "documentmergejob": 77, "documentmergeparam": 78, "documentmergeresult": 79, "dto": [10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31], "electronic_seal_param": 51, "encryption_algorithm": 60, "encryptionalgorithm": 78, "enforce_typ": 36, "eseal": 51, "eseal_job": 39, "eseal_pdf_external_asset_request": 17, "eseal_pdf_internal_asset_request": 17, "eseal_pdf_result": 66, "esealpdf": 17, "esealpdfresult": 79, "excel": 46, "except": [7, 8, 73], "execution_context": 8, "export": 40, "export_ocr_local": 52, "export_pdf": 52, "export_pdf_external_asset_request": 18, "export_pdf_internal_asset_request": 18, "export_pdf_job": 39, "export_pdf_param": 52, "export_pdf_params_payload": 18, "export_pdf_result": 66, "export_pdf_target_format": 52, "export_pdf_to_images_job": 39, "export_pdf_to_images_output_typ": 59, "export_pdf_to_images_param": 59, "export_pdf_to_images_result": 66, "export_pdf_to_images_target_format": 59, "exportocrlocal": 78, "exportpdf": 18, "exportpdfformdatajob": 77, "exportpdfformdataparam": 78, "exportpdfformdataresult": 79, "exportpdfjob": 77, "exportpdfparam": 78, "exportpdfresult": 79, "exportpdftargetformat": 78, "exportpdftoimagesjob": 77, "exportpdftoimagesoutputtyp": 78, "exportpdftoimagesparam": 78, "exportpdftoimagesresult": 79, "exportpdftoimagestargetformat": 78, "external_asset": 37, "external_storage_typ": 37, "externalasset": 75, "externalstoragetyp": 75, "extract_element_typ": 53, "extract_pdf": [19, 53], "extract_pdf_external_asset_request": 19, "extract_pdf_internal_asset_request": 19, "extract_pdf_job": 39, "extract_pdf_param": 53, "extract_pdf_params_payload": 19, "extract_pdf_result": 66, "extract_renditions_element_typ": 53, "extractelementtyp": 78, "extractpdfjob": 77, "extractpdfparam": 78, "extractpdfresult": 79, "extractrenditionselementtyp": 78, "field_loc": 51, "field_opt": 51, "fieldloc": 78, "fieldopt": 78, "file_util": 36, "fragment": [50, 78], "html_to_pdf": 54, "html_to_pdf_external_asset_request": 20, "html_to_pdf_internal_asset_request": 20, "html_to_pdf_job": 39, "html_to_pdf_param": 54, "html_to_pdf_params_payload": 20, "html_to_pdf_result": 66, "htmltopdf": 20, "htmltopdfjob": 77, "htmltopdfparam": 78, "htmltopdfresult": 79, "http": 34, "http_client": 34, "http_method": 34, "http_request": 34, "import_pdf_form_data": 55, "import_pdf_form_data_param": 55, "importpdfformdatajob": 77, "importpdfformdataparam": 78, "importpdfformdataresult": 79, "indic": 67, "insert_pag": 56, "insert_pages_job": 39, "insert_pages_param": 56, "insert_pages_result": 66, "insertpagesjob": 77, "insertpagesparam": 78, "insertpagesresult": 79, "intern": [8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36], "internal_client_config": 8, "io": [37, 75], "job": [39, 40, 76, 77], "job_error_respons": 31, "job_statu": 30, "json_hint_encod": 36, "linearize_pdf_external_asset_request": 21, "linearize_pdf_internal_asset_request": 21, "linearize_pdf_job": 39, "linearize_pdf_result": 66, "linearizepdf": 21, "linearizepdfjob": 77, "linearizepdfresult": 79, "modul": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66], "notifi": [5, 71], "notifier_config": 5, "notifier_data": 5, "notifier_typ": 5, "notifierconfig": 71, "notifierdata": 71, "notifiertyp": 71, "object_util": 36, "ocr_param": 57, "ocr_pdf": 57, "ocr_pdf_external_asset_request": 22, "ocr_pdf_internal_asset_request": 22, "ocr_pdf_job": 39, "ocr_pdf_params_payload": 22, "ocr_pdf_result": 66, "ocr_supported_local": 57, "ocr_supported_typ": 57, "ocrparam": 78, "ocrpdf": 22, "ocrpdfjob": 77, "ocrpdfresult": 79, "ocrsupportedlocal": 78, "ocrsupportedtyp": 78, "oper": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66], "operation_header_info_endpoint_map": 33, "output_format": 50, "outputformat": 78, "packag": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66], "page_act": 23, "page_action_command": 23, "page_layout": 54, "page_manipulation_external_asset_request": 23, "page_manipulation_internal_asset_request": 23, "page_manipulation_params_payload": 23, "page_rang": [35, 41], "pagelayout": 78, "pagemanipul": 23, "pagerang": 78, "param": [35, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 78], "password_protect_param": 60, "passwordprotectparam": 78, "path_util": 36, "pdf": 76, "pdf_properti": [24, 58], "pdf_properties_external_asset_request": 24, "pdf_properties_internal_asset_request": 24, "pdf_properties_job": 39, "pdf_properties_param": 58, "pdf_properties_params_payload": 24, "pdf_properties_result": 66, "pdf_servic": 2, "pdf_services_api": [9, 25, 31], "pdf_services_api_request": 25, "pdf_services_api_respons": 31, "pdf_services_help": 8, "pdf_services_job": 2, "pdf_services_job_param": 41, "pdf_services_job_result": 66, "pdf_services_job_statu": 2, "pdf_services_job_status_respons": 2, "pdf_services_media_typ": 2, "pdf_services_respons": 2, "pdf_services_uri": 33, "pdf_to_imag": 59, "pdf_to_image_external_asset_request": 26, "pdf_to_image_internal_asset_request": 26, "pdf_to_image_params_payload": 26, "pdfaccessibilitycheckerjob": 77, "pdfaccessibilitycheckerparam": 78, "pdfaccessibilitycheckerresult": 79, "pdfelectronicsealjob": 77, "pdfelectronicsealparam": 78, "pdfjob": [38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66], "pdfpropertiesjob": 77, "pdfpropertiesparam": 78, "pdfpropertiesresult": 79, "pdfservic": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 74], "pdfservicesjob": 74, "pdfservicesjobparam": 78, "pdfservicesjobresult": 79, "pdfservicesjobstatu": 74, "pdfservicesjobstatusrespons": 74, "pdfservicesmediatyp": 74, "pdfservicesrespons": 74, "pdftoimag": 26, "pdfwatermarkjob": 77, "pdfwatermarkparam": 78, "pdfwatermarkresult": 79, "permiss": [60, 78], "ppt": 47, "protect_pdf": [27, 60], "protect_pdf_external_asset_request": 27, "protect_pdf_internal_asset_request": 27, "protect_pdf_job": 39, "protect_pdf_param": 60, "protect_pdf_params_payload": 27, "protect_pdf_result": 66, "protectpdfjob": 77, "protectpdfparam": 78, "protectpdfresult": 79, "proxi": [6, 72], "proxy_authentication_credenti": 6, "proxy_schem": 6, "proxy_server_config": 6, "proxyauthenticationcredenti": 72, "proxyschem": 72, "proxyserverconfig": 72, "refer": 74, "region": [2, 74], "remove_protect": [28, 61], "remove_protection_extenal_asset_request": 28, "remove_protection_internal_asset_request": 28, "remove_protection_job": 39, "remove_protection_param": 61, "remove_protection_params_payload": 28, "remove_protection_result": 66, "removeprotectionjob": 77, "removeprotectionparam": 78, "removeprotectionresult": 79, "reorder_pag": 62, "reorder_pages_job": 39, "reorder_pages_param": 62, "reorder_pages_result": 66, "reorderpagesjob": 77, "reorderpagesparam": 78, "reorderpagesresult": 79, "replace_pag": 63, "replace_page_result": 66, "replace_pages_job": 39, "replace_pages_param": 63, "replacepagesjob": 77, "replacepagesparam": 78, "replacepagesresult": 79, "request": [11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "request_header_const": 34, "request_kei": 33, "respons": [30, 31], "response_util": 34, "result": [66, 79], "rfc3161_tsa_opt": 51, "rfc3161tsaoption": 78, "rotate_pag": 64, "rotate_page_act": 23, "rotate_pages_job": 39, "rotate_pages_param": 64, "rotate_pages_result": 66, "rotatepagesjob": 77, "rotatepagesparam": 78, "rotatepagesresult": 79, "sdk": 67, "sdkexcept": 73, "service_const": 33, "service_principal_authent": 32, "service_principal_credenti": 3, "service_token_authent": 32, "service_token_credenti": 32, "serviceapiexcept": 73, "serviceprincipalcredenti": 69, "serviceusageexcept": 73, "session_token": 32, "signature_format": 51, "signatureformat": 78, "split_pdf": 65, "split_pdf_external_asset_request": 29, "split_pdf_internal_asset_request": 29, "split_pdf_job": 39, "split_pdf_param": 65, "split_pdf_params_payload": 29, "split_pdf_result": 66, "splitpdf": 29, "splitpdfjob": 77, "splitpdfparam": 78, "splitpdfresult": 79, "src": 68, "storage_api": 9, "stream_asset": 37, "streamasset": 75, "string_util": 36, "submodul": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66], "subpackag": [0, 1, 2, 4, 8, 9, 10, 11, 30, 38, 41, 45], "tabl": 67, "table_structure_typ": 53, "tablestructuretyp": 78, "tsa_basic_auth_credenti": 51, "tsa_opt": 51, "tsabasicauthcredenti": 78, "tsaoption": 78, "username_password_credenti": 6, "usernamepasswordcredenti": 72, "util": 36, "validation_util": 36, "watermarkappear": 78, "welcom": 67, "word": 48}}) \ No newline at end of file diff --git a/docs/apidocs/latest b/docs/apidocs/latest index 2582ddd..ef8d756 120000 --- a/docs/apidocs/latest +++ b/docs/apidocs/latest @@ -1 +1 @@ -4.1.1 \ No newline at end of file +4.2.0 \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index a96f0c8..3c2e415 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1 @@ -pdfservices-sdk==4.1.1 \ No newline at end of file +pdfservices-sdk==4.2.0 \ No newline at end of file diff --git a/src/exportpdfformdata/export_pdf_form_data.py b/src/exportpdfformdata/export_pdf_form_data.py new file mode 100644 index 0000000..870f72b --- /dev/null +++ b/src/exportpdfformdata/export_pdf_form_data.py @@ -0,0 +1,75 @@ +#!/usr/bin/env python3 + +""" +Copyright 2024 Adobe +All Rights Reserved. + +NOTICE: Adobe permits you to use, modify, and distribute this file in +accordance with the terms of the Adobe license agreement accompanying it. +""" + +import logging +import os +from datetime import datetime + +from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials +from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException +from adobe.pdfservices.operation.pdf_services import PDFServices +from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType +from adobe.pdfservices.operation.pdfjobs.jobs.export_pdf_form_data_job import ExportPDFFormDataJob +from adobe.pdfservices.operation.pdfjobs.result.export_pdf_form_data_result import ExportPDFFormDataResult + +# Initialize the logger +logging.basicConfig(level=logging.INFO) + + +class ExportPDFFormData: + def __init__(self): + try: + file = open('../resources/exportPdfFormDataInput.pdf', 'rb') + input_stream = file.read() + file.close() + + # Initial setup, create credentials instance + credentials = ServicePrincipalCredentials( + client_id=os.getenv('PDF_SERVICES_CLIENT_ID'), + client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET') + ) + + # Creates a PDF Services instance + pdf_services = PDFServices(credentials=credentials) + + # Creates an asset(s) from source file(s) and upload + input_asset = pdf_services.upload(input_stream=input_stream, + mime_type=PDFServicesMediaType.PDF) + + # Creates a new job instance + export_pdf_form_data_job = ExportPDFFormDataJob(input_asset=input_asset) + + # Submit the job and gets the job result + location = pdf_services.submit(export_pdf_form_data_job) + pdf_services_response = pdf_services.get_job_result(location, ExportPDFFormDataResult) + + # Get content from the resulting asset(s) + result_asset = pdf_services_response.get_result().get_asset() + stream_asset = pdf_services.get_content(result_asset) + + # Creates an output stream and copy stream asset's content to it + output_file_path = self.create_output_file_path() + with open(output_file_path, "wb") as file: + file.write(stream_asset.get_input_stream()) + + except (ServiceApiException, ServiceUsageException, SdkException) as e: + logging.exception(f'Exception encountered while executing operation: {e}') + + # Generates a string containing a directory structure and file name for the output file + @staticmethod + def create_output_file_path() -> str: + now = datetime.now() + time_stamp = now.strftime("%Y-%m-%dT%H-%M-%S") + os.makedirs("../../output/ExportPDFFormData", exist_ok=True) + return f"../../output/ExportPDFFormData/export{time_stamp}.json" + + +if __name__ == "__main__": + ExportPDFFormData() \ No newline at end of file diff --git a/src/importpdfformdata/import_pdf_form_data.py b/src/importpdfformdata/import_pdf_form_data.py new file mode 100644 index 0000000..1d64153 --- /dev/null +++ b/src/importpdfformdata/import_pdf_form_data.py @@ -0,0 +1,94 @@ +#!/usr/bin/env python3 + +""" +Copyright 2024 Adobe +All Rights Reserved. + +NOTICE: Adobe permits you to use, modify, and distribute this file in +accordance with the terms of the Adobe license agreement accompanying it. +""" + +import logging +import os +from datetime import datetime +from pathlib import Path + +from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials +from adobe.pdfservices.operation.config.client_config import ClientConfig +from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException +from adobe.pdfservices.operation.pdf_services import PDFServices +from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType +from adobe.pdfservices.operation.pdfjobs.jobs.import_pdf_form_data_job import ImportPDFFormDataJob +from adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params import ImportPDFFormDataParams +from adobe.pdfservices.operation.pdfjobs.result.import_pdf_form_data_result import ImportPDFFormDataResult + +# Initialize the logger +logging.basicConfig(level=logging.INFO) + + +class ImportPDFFormData: + def __init__(self): + try: + file = open('../resources/importPdfFormDataInput.pdf', 'rb') + input_stream = file.read() + file.close() + + # Initial setup, create credentials instance + credentials = ServicePrincipalCredentials( + client_id=os.getenv('PDF_SERVICES_CLIENT_ID'), + client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET') + ) + + # Creates a PDF Services instance + pdf_services = PDFServices(credentials=credentials) + + # Creates an asset(s) from source file(s) and upload + input_asset = pdf_services.upload(input_stream=input_stream, + mime_type=PDFServicesMediaType.PDF) + + # Form data to be imported + form_data = { + "option_two": "Yes", + "option_one": "Yes", + "name": "garvit", + "option_three": "Off", + "age": "24", + "favorite_movie": "Star Wars Again", + } + + # Create parameters for the job + import_pdf_form_data_params = ImportPDFFormDataParams(json_form_fields_data=form_data) + + # Creates a new job instance + import_pdf_form_data_job = ImportPDFFormDataJob(input_asset=input_asset) + + # Set the parameters for the job + import_pdf_form_data_job.set_params(import_pdf_form_data_params) + + # Submit the job and gets the job result + location = pdf_services.submit(import_pdf_form_data_job) + pdf_services_response = pdf_services.get_job_result(location, ImportPDFFormDataResult) + + # Get content from the resulting asset(s) + result_asset = pdf_services_response.get_result().get_asset() + stream_asset = pdf_services.get_content(result_asset) + + # Creates an output stream and copy stream asset's content to it + output_file_path = self.create_output_file_path() + with open(output_file_path, "wb") as file: + file.write(stream_asset.get_input_stream()) + + except (ServiceApiException, ServiceUsageException, SdkException) as e: + logging.exception(f'Exception encountered while executing operation: {e}') + + # Generates a string containing a directory structure and file name for the output file + @staticmethod + def create_output_file_path() -> str: + now = datetime.now() + time_stamp = now.strftime("%Y-%m-%dT%H-%M-%S") + os.makedirs("../../output/ImportPDFFormData", exist_ok=True) + return f"../../output/ImportPDFFormData/import{time_stamp}.pdf" + + +if __name__ == "__main__": + ImportPDFFormData() \ No newline at end of file diff --git a/src/resources/exportPdfFormDataInput.pdf b/src/resources/exportPdfFormDataInput.pdf new file mode 100644 index 0000000..47b4bce Binary files /dev/null and b/src/resources/exportPdfFormDataInput.pdf differ diff --git a/src/resources/importPdfFormDataInput.pdf b/src/resources/importPdfFormDataInput.pdf new file mode 100644 index 0000000..ffd57d2 Binary files /dev/null and b/src/resources/importPdfFormDataInput.pdf differ