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:

asset (Asset) – see Asset
page_ranges (PageRanges) – see PageRanges (Optional, use key-value)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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)

get_include_header_footer()

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:

ocr_locale (OCRSupportedLocale) – Input language to be used for OCR. (Optional, use key-value)
ocr_type (OCRSupportedType) – OCR type. (Optional, use key-value)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

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 = True, opacity: int = 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