Python SDK Release v4.2.0 (#42)

* Upgrading Python SDK to v4.2.0 | Adding Import & Export Form Data Functionality

* Updating Request Format

---------

Co-authored-by: Garvit Kansal <[email protected]>

Author: helewrer3

setup.py

@@ -12,7 +12,7 @@ def parse_requirements(filename, session=None):
 
 setuptools.setup(
     name="pdfservices-sdk",
-    version="4.1.1",
+    version="4.2.0",
     author='Adobe Acrobat Services',
     author_email='[email protected]',
     license='Apache2',

src/adobe/pdfservices/operation/internal/api/dto/request/exportpdfformdata/__init__.py

@@ -0,0 +1,11 @@
+# Copyright 2024 Adobe
+# All Rights Reserved.
+#
+# NOTICE:  All information contained herein is, and remains
+# the property of Adobe and its suppliers, if any. The intellectual
+# and technical concepts contained herein are proprietary to Adobe
+# and its suppliers and are protected by all applicable intellectual
+# property laws, including trade secret and copyright laws.
+# Dissemination of this information or reproduction of this material
+# is strictly forbidden unless prior written permission is obtained
+# from Adobe. 

src/adobe/pdfservices/operation/internal/api/dto/request/exportpdfformdata/export_pdf_form_data_external_asset_request.py

@@ -0,0 +1,41 @@
+# Copyright 2024 Adobe
+# All Rights Reserved.
+#
+# NOTICE:  All information contained herein is, and remains
+# the property of Adobe and its suppliers, if any. The intellectual
+# and technical concepts contained herein are proprietary to Adobe
+# and its suppliers and are protected by all applicable intellectual
+# property laws, including trade secret and copyright laws.
+# Dissemination of this information or reproduction of this material
+# is strictly forbidden unless prior written permission is obtained
+# from Adobe.
+
+import json
+from typing import List
+
+from adobe.pdfservices.operation.config.notifier.notifier_config import NotifierConfig
+from adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request import \
+    PDFServicesAPIRequest
+from adobe.pdfservices.operation.internal.util.json_hint_encoder import JSONHintEncoder
+from adobe.pdfservices.operation.io.asset import Asset
+from adobe.pdfservices.operation.io.external_asset import ExternalAsset
+
+
+class ExportPDFFormDataExternalAssetRequest(PDFServicesAPIRequest):
+    json_hint = {
+        'input': 'input',
+        'output': 'output',
+        'notify_config_list': 'notifiers'
+    }
+
+    def __init__(self, input_asset: Asset, notify_config_list: List[NotifierConfig] = None, 
+                 output_asset: ExternalAsset = None):
+        super().__init__()
+        input_asset.__class__ = ExternalAsset
+        self.input: ExternalAsset = input_asset
+        if output_asset is not None:
+            self.output = output_asset
+        self.notify_config_list = notify_config_list
+
+    def to_json(self):
+        return json.dumps(self, cls=JSONHintEncoder, indent=1, sort_keys=True) 

src/adobe/pdfservices/operation/internal/api/dto/request/exportpdfformdata/export_pdf_form_data_internal_asset_request.py

@@ -0,0 +1,34 @@
+# Copyright 2024 Adobe
+# All Rights Reserved.
+#
+# NOTICE:  All information contained herein is, and remains
+# the property of Adobe and its suppliers, if any. The intellectual
+# and technical concepts contained herein are proprietary to Adobe
+# and its suppliers and are protected by all applicable intellectual
+# property laws, including trade secret and copyright laws.
+# Dissemination of this information or reproduction of this material
+# is strictly forbidden unless prior written permission is obtained
+# from Adobe.
+
+import json
+from typing import List
+
+from adobe.pdfservices.operation.config.notifier.notifier_config import NotifierConfig
+from adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request import \
+    PDFServicesAPIRequest
+from adobe.pdfservices.operation.internal.util.json_hint_encoder import JSONHintEncoder
+
+
+class ExportPDFFormDataInternalAssetRequest(PDFServicesAPIRequest):
+    json_hint = {
+        'asset_id': 'assetID',
+        'notify_config_list': 'notifiers'
+    }
+
+    def __init__(self, input_asset_id: str, notify_config_list: List[NotifierConfig] = None):
+        super().__init__()
+        self.asset_id = input_asset_id
+        self.notify_config_list = notify_config_list
+
+    def to_json(self):
+        return json.dumps(self, cls=JSONHintEncoder, indent=1, sort_keys=True) 

src/adobe/pdfservices/operation/internal/api/dto/request/importpdfformdata/__init__.py

@@ -0,0 +1,11 @@
+# Copyright 2024 Adobe
+# All Rights Reserved.
+#
+# NOTICE:  All information contained herein is, and remains
+# the property of Adobe and its suppliers, if any. The intellectual
+# and technical concepts contained herein are proprietary to Adobe
+# and its suppliers and are protected by all applicable intellectual
+# property laws, including trade secret and copyright laws.
+# Dissemination of this information or reproduction of this material
+# is strictly forbidden unless prior written permission is obtained
+# from Adobe. 

src/adobe/pdfservices/operation/internal/api/dto/request/importpdfformdata/import_pdf_form_data_external_asset_request.py

@@ -0,0 +1,97 @@
+# Copyright 2024 Adobe
+# All Rights Reserved.
+#
+# NOTICE:  All information contained herein is, and remains
+# the property of Adobe and its suppliers, if any. The intellectual
+# and technical concepts contained herein are proprietary to Adobe
+# and its suppliers and are protected by all applicable intellectual
+# property laws, including trade secret and copyright laws.
+# Dissemination of this information or reproduction of this material
+# is strictly forbidden unless prior written permission is obtained
+# from Adobe.
+
+import json
+from typing import List
+
+from adobe.pdfservices.operation.config.notifier.notifier_config import NotifierConfig
+from adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request import PDFServicesAPIRequest
+from adobe.pdfservices.operation.internal.util.json_hint_encoder import JSONHintEncoder
+from adobe.pdfservices.operation.io.external_asset import ExternalAsset
+from adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params import ImportPDFFormDataParams
+
+
+class ImportPDFFormDataParamsPayload:
+    """
+    Payload class for Import PDF Form Data parameters
+    """
+    json_hint = {
+        'json_form_fields_data': 'jsonFormFieldsData'
+    }
+
+    def __init__(self, import_pdf_form_data_params: ImportPDFFormDataParams = None):
+        """
+        Constructs a new ImportPDFFormDataParamsPayload instance.
+
+        :param import_pdf_form_data_params: Parameters containing form data to import
+        :type import_pdf_form_data_params: ImportPDFFormDataParams
+        """
+        self.json_form_fields_data = None
+        if import_pdf_form_data_params is not None:
+            self.json_form_fields_data = import_pdf_form_data_params.get_json_form_fields_data()
+
+    def to_json(self):
+        """
+        :return: JSON representation of the payload
+        :rtype: str
+        """
+        return json.dumps(self, cls=JSONHintEncoder, indent=1, sort_keys=True)
+
+
+class ImportPDFFormDataExternalAssetRequest(PDFServicesAPIRequest):
+    """
+    Request DTO for Import PDF Form Data operation using external assets
+    """
+    
+    json_hint = {
+        'input_asset': 'input',
+        'params': 'params',
+        'output_asset': 'output',
+        'notify_config_list': 'notifiers'
+    }
+
+    def __init__(self, input_asset: ExternalAsset, import_pdf_form_data_params: ImportPDFFormDataParams,
+                 notifier_config_list: List[NotifierConfig] = None):
+        """
+        Constructs a new ImportPDFFormDataExternalAssetRequest instance.
+
+        :param input_asset: External asset representing the input PDF
+        :type input_asset: ExternalAsset
+        :param import_pdf_form_data_params: Parameters containing form data to import
+        :type import_pdf_form_data_params: ImportPDFFormDataParams
+        :param notifier_config_list: List of notifier configurations (Optional)
+        :type notifier_config_list: List[NotifierConfig]
+        """
+        super().__init__()
+        self.input_asset = input_asset
+        self.params = ImportPDFFormDataParamsPayload(import_pdf_form_data_params)
+        self.notify_config_list = notifier_config_list
+        self.output_asset = None
+
+    def set_output(self, output_asset: ExternalAsset):
+        """
+        Sets the output external asset.
+
+        :param output_asset: External asset for output
+        :type output_asset: ExternalAsset
+        :return: Self for method chaining
+        :rtype: ImportPDFFormDataExternalAssetRequest
+        """
+        self.output_asset = output_asset
+        return self
+
+    def to_json(self):
+        """
+        :return: JSON representation of the request
+        :rtype: str
+        """
+        return json.dumps(self, cls=JSONHintEncoder, indent=1, sort_keys=True) 

src/adobe/pdfservices/operation/internal/api/dto/request/importpdfformdata/import_pdf_form_data_internal_asset_request.py

@@ -0,0 +1,55 @@
+# Copyright 2024 Adobe
+# All Rights Reserved.
+#
+# NOTICE:  All information contained herein is, and remains
+# the property of Adobe and its suppliers, if any. The intellectual
+# and technical concepts contained herein are proprietary to Adobe
+# and its suppliers and are protected by all applicable intellectual
+# property laws, including trade secret and copyright laws.
+# Dissemination of this information or reproduction of this material
+# is strictly forbidden unless prior written permission is obtained
+# from Adobe.
+
+import json
+from typing import List
+
+from adobe.pdfservices.operation.config.notifier.notifier_config import NotifierConfig
+from adobe.pdfservices.operation.internal.api.dto.request.pdf_services_api.pdf_services_api_request import PDFServicesAPIRequest
+from adobe.pdfservices.operation.internal.util.json_hint_encoder import JSONHintEncoder
+from adobe.pdfservices.operation.pdfjobs.params.import_pdf_form_data.import_pdf_form_data_params import ImportPDFFormDataParams
+
+
+class ImportPDFFormDataInternalAssetRequest(PDFServicesAPIRequest):
+    """
+    Request DTO for Import PDF Form Data operation using internal assets
+    """
+    
+    json_hint = {
+        'asset_id': 'assetID',
+        'json_form_fields_data': 'jsonFormFieldsData',
+        'notify_config_list': 'notifiers'
+    }
+
+    def __init__(self, asset_id: str, import_pdf_form_data_params: ImportPDFFormDataParams,
+                 notifier_config_list: List[NotifierConfig] = None):
+        """
+        Constructs a new ImportPDFFormDataInternalAssetRequest instance.
+
+        :param asset_id: Asset ID of the input PDF document
+        :type asset_id: str
+        :param import_pdf_form_data_params: Parameters containing form data to import
+        :type import_pdf_form_data_params: ImportPDFFormDataParams
+        :param notifier_config_list: List of notifier configurations (Optional)
+        :type notifier_config_list: List[NotifierConfig]
+        """
+        super().__init__()
+        self.asset_id = asset_id
+        self.json_form_fields_data = import_pdf_form_data_params.get_json_form_fields_data()
+        self.notify_config_list = notifier_config_list
+
+    def to_json(self):
+        """
+        :return: JSON representation of the request
+        :rtype: str
+        """
+        return json.dumps(self, cls=JSONHintEncoder, indent=1, sort_keys=True) 

src/adobe/pdfservices/operation/internal/constants/operation_header_info_endpoint_map.py

@@ -17,6 +17,8 @@ class OperationHeaderInfoEndpointMap(Enum):
     CREATE_PDF = ("Create PDF Operation", "createpdf")
     COMBINE_PDF = ("Combine Files Operation", "combinepdf")
     EXPORT_PDF = ("Export PDF Operation", "exportpdf")
+    EXPORT_PDF_FORM_DATA = ("Export PDF Form Data Operation", "getformdata")
+    IMPORT_PDF_FORM_DATA = ("Import PDF Form Data Operation", "setformdata")
     EXPORT_PDF_TO_IMAGES = ("Export PDF to Images Operation", "pdftoimages")
     HTML_TO_PDF = ("HTML to PDF Operation", "htmltopdf")
     OCR = ("OCR Operation", "ocr")

src/adobe/pdfservices/operation/internal/constants/service_constants.py

@@ -47,6 +47,8 @@ class ServiceConstants:
     PROTECT_PDF_NAME = "PROTECT_PDF"
     COMBINE_PDF_NAME = "COMBINE_PDF"
     EXPORT_PDF_OPERATION_NAME = "EXPORT_PDF"
+    EXPORT_PDF_FORM_DATA_OPERATION_NAME = "EXPORT_PDF_FORM_DATA"
+    IMPORT_PDF_FORM_DATA_OPERATION_NAME = "IMPORT_PDF_FORM_DATA"
     OCR_PDF_OPERATION_NAME = "OCR_PDF"
     HTML_TO_PDF_OPERATION_NAME = "HTML_TO_PDF"
     COMPRESS_PDF_OPERATION_NAME = "COMPRESS_PDF"

src/adobe/pdfservices/operation/internal/http/http_client.py

@@ -51,7 +51,7 @@ def _append_default_headers(headers: dict):
     # Set SDK Info header
     headers[DefaultHeaders.DC_APP_INFO_HEADER_KEY] = "{lang}-{name}-{version}".format(lang="python",
                                                                                       name='pdfservices-sdk',
-                                                                                      version='4.1.0')
+                                                                                      version='4.2.0')
     headers[DefaultHeaders.ACCEPT_HEADER_NAME] = DefaultHeaders.JSON_TXT_CONTENT_TYPE