diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 768bad7..959036e 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -14,11 +14,9 @@ jobs: strategy: matrix: ruby: - - "3.2" - - "3.1" - - "3.0" - - "2.7" - - "2.6" + - "3.4" + - "3.3" + steps: - uses: actions/checkout@v3 diff --git a/CHANGELOG.md b/CHANGELOG.md index c838c91..e666688 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ ## [Unreleased] +## [0.3.0] - 2026-08-20 +### Added +- Swapped out JWT authorization for Oauth + ## [0.1.0] - 2022-08-25 - Initial release diff --git a/Gemfile.lock b/Gemfile.lock index b9c3477..a6b0d26 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,74 +1,91 @@ PATH remote: . specs: - pdfservices (0.2.2) + pdfservices (0.3.0) http (~> 5.1) json (~> 2.6) - jwt (>= 1.0, < 3.0) multipart-parser (~> 0.1) GEM remote: https://rubygems.org/ specs: - addressable (2.8.1) - public_suffix (>= 2.0.2, < 6.0) - ast (2.4.2) - crack (0.4.5) + addressable (2.9.0) + public_suffix (>= 2.0.2, < 8.0) + ast (2.4.3) + bigdecimal (4.1.2) + crack (1.0.1) + bigdecimal rexml - domain_name (0.5.20190701) - unf (>= 0.0.5, < 1.0.0) - ffi (1.15.5) - ffi-compiler (1.0.1) - ffi (>= 1.0.0) + domain_name (0.6.20240107) + ffi (1.17.4) + ffi (1.17.4-arm64-darwin) + ffi (1.17.4-x86_64-linux-gnu) + ffi-compiler (1.4.2) + ffi (>= 1.15.5) rake - hashdiff (1.0.1) - http (5.1.1) + hashdiff (1.2.1) + http (5.3.1) addressable (~> 2.8) http-cookie (~> 1.0) http-form_data (~> 2.2) - llhttp-ffi (~> 0.4.0) - http-cookie (1.0.5) + llhttp-ffi (~> 0.5.0) + http-cookie (1.1.6) domain_name (~> 0.5) http-form_data (2.3.0) - json (2.6.2) - jwt (2.7.0) - llhttp-ffi (0.4.0) + json (2.21.2) + language_server-protocol (3.17.0.6) + lint_roller (1.1.0) + llhttp-ffi (0.5.1) ffi-compiler (~> 1.0) rake (~> 13.0) - minitest (5.16.3) + minitest (5.27.0) multipart-parser (0.1.1) - parallel (1.22.1) - parser (3.1.2.1) + parallel (2.1.0) + parser (3.3.12.0) ast (~> 2.4.1) - public_suffix (5.0.0) + racc + prism (1.9.0) + public_suffix (7.0.5) + racc (1.8.1) rainbow (3.1.1) - rake (13.0.6) - regexp_parser (2.5.0) - rexml (3.2.5) - rubocop (1.35.1) + rake (13.4.2) + regexp_parser (2.12.0) + rexml (3.4.4) + rubocop (1.88.2) json (~> 2.3) - parallel (~> 1.10) - parser (>= 3.1.2.1) + language_server-protocol (~> 3.17.0.2) + lint_roller (~> 1.1.0) + parallel (>= 1.10) + parser (>= 3.3.0.2) rainbow (>= 2.2.2, < 4.0) - regexp_parser (>= 1.8, < 3.0) - rexml (>= 3.2.5, < 4.0) - rubocop-ast (>= 1.20.1, < 2.0) + regexp_parser (>= 2.9.3, < 3.0) + rubocop-ast (>= 1.49.0, < 2.0) ruby-progressbar (~> 1.7) - unicode-display_width (>= 1.4.0, < 3.0) - rubocop-ast (1.21.0) - parser (>= 3.1.1.0) - rubocop-performance (1.14.3) - rubocop (>= 1.7.0, < 2.0) - rubocop-ast (>= 0.4.0) - ruby-progressbar (1.11.0) - standard (1.16.1) - rubocop (= 1.35.1) - rubocop-performance (= 1.14.3) - unf (0.1.4) - unf_ext - unf_ext (0.0.8.2) - unicode-display_width (2.2.0) - webmock (3.18.1) + unicode-display_width (>= 2.4.0, < 4.0) + rubocop-ast (1.50.0) + parser (>= 3.3.7.2) + prism (~> 1.7) + rubocop-performance (1.26.1) + lint_roller (~> 1.1) + rubocop (>= 1.75.0, < 2.0) + rubocop-ast (>= 1.47.1, < 2.0) + ruby-progressbar (1.13.0) + standard (1.56.0) + language_server-protocol (~> 3.17.0.2) + lint_roller (~> 1.0) + rubocop (~> 1.88.0) + standard-custom (~> 1.0.0) + standard-performance (~> 1.8) + standard-custom (1.0.2) + lint_roller (~> 1.0) + rubocop (~> 1.50) + standard-performance (1.9.0) + lint_roller (~> 1.1) + rubocop-performance (~> 1.26.0) + unicode-display_width (3.2.0) + unicode-emoji (~> 4.1) + unicode-emoji (4.2.0) + webmock (3.26.2) addressable (>= 2.8.0) crack (>= 0.3.2) hashdiff (>= 0.4.0, < 2.0.0) @@ -86,4 +103,4 @@ DEPENDENCIES webmock (~> 3.18) BUNDLED WITH - 2.4.10 + 4.0.19 diff --git a/docs/openapi.json b/docs/openapi.json new file mode 100644 index 0000000..3a6ba4c --- /dev/null +++ b/docs/openapi.json @@ -0,0 +1,15259 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "PDF Services API", + "description": "

", + "version": "" + }, + "servers": [ + { + "url": "https://pdf-services-ue1.adobe.io" + }, + { + "url": "https://pdf-services-ew1.adobe.io" + } + ], + "tags": [ + { + "name": "Generate Token", + "description": "Creates an access token using client id and client secret. Click here to refer underlying IMS authentication APIs." + }, + { + "name": "Assets", + "description": "Upload and download assets to Adobe internal storage.
Uploading and downloading of assets is not required when using a custom external storage solution with signed URLs.
Note: Assets uploaded to Adobe internal storage are transiently stored for 24 hours.
" + }, + { + "name": "Create PDF", + "description": "Create PDF document from Microsoft Office documents (Word, Excel and PowerPoint), Markdown and Image file formats." + }, + { + "name": "Export PDF", + "description": "Convert a PDF File to a non-PDF File" + }, + { + "name": "PDF To Images", + "description": "Convert a PDF File to image files" + }, + { + "name": "Extract PDF", + "description": "Extract content from PDF documents and output it in a structured JSON format, along with tables and figures" + }, + { + "name": "PDF To Markdown", + "description": "Extract content from PDF documents and output it in a well-formatted LLM-friendly Markdown text, along with tables and figures" + }, + { + "name": "Html to PDF", + "description": "Convert HTML Resources to a PDF File" + }, + { + "name": "Combine PDF", + "description": "Combine multiple PDF Files into a single PDF File" + }, + { + "name": "Compress PDF", + "description": "Compress a PDF File" + }, + { + "name": "Linearize PDF", + "description": "Convert a PDF File to a Linearized or Web Optimized PDF File" + }, + { + "name": "OCR", + "description": "Perform OCR on a PDF File" + }, + { + "name": "Page Manipulation", + "description": "Rotate and delete pages of a PDF File" + }, + { + "name": "PDF Properties", + "description": "Extract basic information about a PDF document." + }, + { + "name": "Protect PDF", + "description": "Add encryption and/or restrict permissions on a PDF File" + }, + { + "name": "Remove Protection", + "description": "Remove password protection from a PDF File" + }, + { + "name": "Split PDF", + "description": "Split a PDF File into multiple PDF Files" + }, + { + "name": "Document Generation", + "description": "Merge Word based templates with input JSON data to create Word and PDF documents" + }, + { + "name": "PDF Electronic Seal", + "description": "Create electronic seal on PDF documents like invoices, agreements etc using the digital certificate issued to the user by Trust Service Provider." + }, + { + "name": "PDF Accessibility Auto-Tag", + "description": "Operation to create the tagged pdf and excel report for accessibility auto-tag use case." + }, + { + "name": "PDF Accessibility Checker", + "description": "Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements of PDF/UA and WCAG." + }, + { + "name": "PDF Watermark", + "description": "PDF Watermark API will add a watermark in PDF document." + }, + { + "name": "Export PDF Form Data", + "description": "The Export PDF Form Data API will retrieve the data from a PDF form and return it as a JSON file." + }, + { + "name": "Import PDF Form Data", + "description": "The Import PDF Form Data API will take the form data provided as a JSON, insert it into the PDF form, and generate the resulting PDF." + } + ], + "x-tagGroups": [ + { + "name": "Authentication", + "tags": [ + "Generate Token" + ] + }, + { + "name": "Files", + "tags": [ + "Assets" + ] + }, + { + "name": "PDF Operations", + "tags": [ + "Combine PDF", + "Compress PDF", + "Create PDF", + "Document Generation", + "Export PDF", + "Export PDF Form Data", + "Extract PDF", + "Html to PDF", + "Import PDF Form Data", + "Linearize PDF", + "OCR", + "Page Manipulation", + "PDF Accessibility Auto-Tag", + "PDF Accessibility Checker", + "PDF Electronic Seal", + "PDF Properties", + "PDF To Images", + "PDF To Markdown", + "PDF Watermark", + "Protect PDF", + "Remove Protection", + "Split PDF" + ] + } + ], + "paths": { + "/token": { + "post": { + "tags": [ + "Generate Token" + ], + "summary": "Generate access token to perform PDF Services operations", + "description": "Creates an access token using client id and client Secret.", + "operationId": "authentication.generatetoken", + "requestBody": { + "description": "Params for generating the access token.", + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Token" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "The request was successful.", + "headers": { + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IMS400" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IMS401" + } + } + } + }, + "403": { + "description": "Forbidden.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IMS403" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IMS404" + } + } + } + }, + "409": { + "description": "The request could not be processed because of conflict in the request", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IMS409" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IMS500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/assets": { + "post": { + "tags": [ + "Assets" + ], + "summary": "Get upload pre-signed URI. ", + "description": "Get the pre-signed URI to directly upload the content to the adobe's internal cloud provider. \n\nOutput: Response will have the asset URI of created asset and pre-signed URI for uploading the content.
Note: The pre-signed URI provided for uploading or downloading the content has an expiry of 1 hour.
", + "operationId": "asset.uploadpresignedurl", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for getting upload presigned url Operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetUploadPresignedUrlRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "The request was successful.", + "headers": { + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetUploadPresignedUrlAsset" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Asset429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + } + } + }, + "/assets/{assetId}": { + "get": { + "tags": [ + "Assets" + ], + "summary": "Get download pre-signed URI.", + "description": "Get the pre-signed URI to fetch the content directly from the cloud provider.
Note: The pre-signed URI provided for uploading or downloading the content has an expiry of 1 hour.
", + "operationId": "asset.get", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "headers": { + "Content-Type": { + "description": "The media type of the response body, which is application/json.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique ID to identify each individual request.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPresignedUrl" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Asset429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Assets" + ], + "summary": "Delete the asset from storage.", + "description": "Delete the stored asset from the cloud provider.", + "operationId": "asset.delete", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The request was successful, but no content received.", + "headers": { + "Content-Type": { + "description": "The media type of the response body, which is application/json.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique ID to identify each individual request.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Asset429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + } + } + }, + "/assets/{assetId}/metadata": { + "get": { + "tags": [ + "Assets" + ], + "summary": "Get asset metadata.", + "description": "Get the metadata of the stored temporary asset.", + "operationId": "asset.metadata", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "headers": { + "Content-Type": { + "description": "The media type of the response body, which is application/json.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique ID to identify each individual request.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AssetMetadata" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Asset429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + } + } + }, + "/operation/documentgeneration": { + "post": { + "tags": [ + "Document Generation" + ], + "summary": "Merge Word based templates with input JSON data to create Word and PDF documents", + "description": "Merges the input JSON data with Word based templates to create dynamic documents. To learn more about document generation and document templates, please see the documentation.", + "operationId": "pdfoperations.documentgeneration", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Document Generation Operation. Refer to the External Section below for using external storage with Document Generation API", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/DocumentGenerationInternal" + }, + { + "$ref": "#/components/schemas/DocumentGenerationExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/documentgeneration/{jobID}/status": { + "get": { + "tags": [ + "Document Generation" + ], + "summary": "Poll the document generation job for completion", + "operationId": "pdfoperations.documentgeneration.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentGenerationJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/pdftomarkdown": { + "post": { + "tags": [ + "PDF To Markdown" + ], + "summary": "Extract content from PDF documents and output it in a markdown format, along with tables and figures", + "description": "Extract PDF Content, Tables content and Tables/Figures renditions from a PDF document. Various available options are: \n\n1. Extract figures or images in base64 format", + "operationId": "pdfoperations.pdftomarkdown", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for PDF to Markdown Operation. Refer to the External Section below for using external storage with PDF to Markdown Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/PDFToMarkdownInternal" + }, + { + "$ref": "#/components/schemas/PDFToMarkdownExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/pdftomarkdown/{jobID}/status": { + "get": { + "tags": [ + "PDF To Markdown" + ], + "summary": "Poll the PDF to markdown job for completion", + "operationId": "pdfoperations.pdftomarkdown.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PDFToMarkdownJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/extractpdf": { + "post": { + "tags": [ + "Extract PDF" + ], + "summary": "Extract content from PDF documents and output it in a structured JSON format, along with tables and figures", + "description": "Extract PDF Content, Tables content and Tables/Figures renditions from a PDF document. Various available options are: (mutually exclusive)\n\n1. Extract text with structure (headings, paragraphs, lists and footnotes)\n\n2. Extract tables data as CSV or XLSX\n\n3. Extract tables as images.\n\n4. Extract bounding boxes for characters present in text blocks(paragraphs, list, headings)\n\n5. Extract figures or images as PNG", + "operationId": "pdfoperations.extractpdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Extract PDF Operation. Refer to the External Section below for using external storage with Extract PDF Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ExtractPDFInternal" + }, + { + "$ref": "#/components/schemas/ExtractPDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/extractpdf/{jobID}/status": { + "get": { + "tags": [ + "Extract PDF" + ], + "summary": "Poll the extract pdf job for completion", + "operationId": "pdfoperations.extractpdf.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtractPDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/createpdf": { + "post": { + "tags": [ + "Create PDF" + ], + "summary": "Create PDF document from non PDF document.", + "description": "Create PDF document from Microsoft Office documents (Word, Excel and PowerPoint), Markdown and Image file formats.", + "operationId": "pdfoperations.createpdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Create PDF Operation. Refer to the External Section below for using external storage with Create PDF Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/CreatePDFInternal" + }, + { + "$ref": "#/components/schemas/CreatePDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/createpdf/{jobID}/status": { + "get": { + "tags": [ + "Create PDF" + ], + "summary": "Poll the create PDF job for completion", + "operationId": "pdfoperations.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/htmltopdf": { + "post": { + "tags": [ + "Html to PDF" + ], + "summary": "Convert HTML Resources to a PDF File", + "description": "Creates PDFs from static/dynamic HTML or HTML(with inline CSS) or just a URL. It's a common scenario for enterprise to provide end users with a HTML template with form fields. In case of dynamic HTML this API allows you to capture the users unique data entries and then save it as PDF. Collected data is stored in a JSON file, and the source HTML file must include \\. You can also provide the URL of the HTML page in inputUrl parameter. However, creating PDF from URL is not supported in External Storage flow.
We do not provide support under the following conditions:
1. The URL Scheme is not HTTPS.
2. The hostname resolves to a non-routable IP address. This encompasses scenarios where redirects lead to non-routable IP addresses as well.
", + "operationId": "pdfoperations.htmltopdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for converting HTML to PDF Operation. Refer to the External Section below for using external storage with HTML to PDF Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/HtmlToPdfInternal" + }, + { + "$ref": "#/components/schemas/HtmlToPdfExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/htmltopdf/{jobID}/status": { + "get": { + "tags": [ + "Html to PDF" + ], + "summary": "Poll the Html to PDF job for completion", + "operationId": "pdfoperations.htmltopdf.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HtmlToPdfJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/combinepdf": { + "post": { + "tags": [ + "Combine PDF" + ], + "summary": "Combine multiple PDF Files into a single PDF File", + "description": "Combines multiple PDF files(upto 20 files) into a single PDF file. Allows specifying which pages of the source files to combine. By default all the pages of source files are considered if explicit PageRanges are not specified.", + "operationId": "pdfoperations.combinepdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Combine PDF Operation. Refer to the External Section below for using external storage with Combine PDF operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/CombinePDFInternal" + }, + { + "$ref": "#/components/schemas/CombinePDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/combinepdf/{jobID}/status": { + "get": { + "tags": [ + "Combine PDF" + ], + "summary": "Poll the combine pdf job for completion", + "operationId": "pdfoperations.combinepdf.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CombinePDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/compresspdf": { + "post": { + "tags": [ + "Compress PDF" + ], + "summary": "Compress a PDF File", + "description": "Compress PDFs to reduce the file size prior to performing workflow operations that use bandwidth or memory.", + "operationId": "pdfoperations.compresspdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Compress PDF Operation. Refer to the External Section below for using external storage with Compress PDF operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/CompressPDFInternal" + }, + { + "$ref": "#/components/schemas/CompressPDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/compresspdf/{jobID}/status": { + "get": { + "tags": [ + "Compress PDF" + ], + "summary": "Poll the compress PDF job for completion", + "operationId": "pdfoperations.compresspdf.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompressPDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/exportpdf": { + "post": { + "tags": [ + "Export PDF" + ], + "summary": "Export a PDF file into a number of supported formats.", + "description": "Export a PDF file into a number of supported formats. The supported formats are doc, docx, pptx, xlsx, rtf.", + "operationId": "pdfoperations.exportpdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Parameter to specify output document target format. Refer to the External Section below for using external storage with Export PDF Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ExportPDFInternal" + }, + { + "$ref": "#/components/schemas/ExportPDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/exportpdf/{jobID}/status": { + "get": { + "tags": [ + "Export PDF" + ], + "summary": "Poll the export PDF job for completion", + "operationId": "pdfoperations.exportpdf.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExportPDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/pdftoimages": { + "post": { + "tags": [ + "PDF To Images" + ], + "summary": "Convert a PDF file into supported image formats.", + "description": "Convert a PDF file into supported image formats. Each image file name ends with _(unpadded_page_index_number). For example, a PDF file with 15 pages will generate 15 image files. The first file name ends with _1 and the last file name ends with _15. With External Storage, supported output type is `zipOfPageImages` only.", + "operationId": "pdfoperations.pdftoimages", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Parameter to specify output document target format. Refer to the External Section below for using external storage with PDF to Images Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/PDFToImageInternal" + }, + { + "$ref": "#/components/schemas/PDFToImageExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/pdftoimages/{jobID}/status": { + "get": { + "tags": [ + "PDF To Images" + ], + "summary": "Poll the pdf to image job for completion", + "operationId": "pdfoperations.pdftoimages.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PDFTOImageJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/linearizepdf": { + "post": { + "tags": [ + "Linearize PDF" + ], + "summary": "Convert a PDF File to a Linearized or Web Optimized PDF File", + "description": "Linearize a PDF Document to create a web-optimized PDF Document which supports incremental access in network environments. Refer to the External Section below for using external storage with Linearize PDF Operation.", + "operationId": "pdfoperations.linearizepdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Linearize PDF Operation. Refer to the External Section below for using external storage with Linearize PDF Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/LinearizePDFInternal" + }, + { + "$ref": "#/components/schemas/LinearizePDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/linearizepdf/{jobID}/status": { + "get": { + "tags": [ + "Linearize PDF" + ], + "summary": "Poll the linearize pdf job for completion", + "operationId": "pdfoperations.linearizepdf.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinearizePDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/ocr": { + "post": { + "tags": [ + "OCR" + ], + "summary": "Perform OCR on a PDF File", + "description": "Perform OCR on PDF Document by providing specific language and type.", + "operationId": "pdfoperations.ocr", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for OCR PDF Operation. Refer to the External Section below for using external storage with OCR PDF Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OCRInternal" + }, + { + "$ref": "#/components/schemas/OCRExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/ocr/{jobID}/status": { + "get": { + "tags": [ + "OCR" + ], + "summary": "Poll the ocr job for completion", + "operationId": "pdfoperations.ocr.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OCRJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/pagemanipulation": { + "post": { + "tags": [ + "Page Manipulation" + ], + "summary": "Rotate and delete pages of a PDF File", + "description": "Selectively rotate or delete pages in a PDF document. For example, you can change portrait view to landscape view or remove certain pages from a PDF document.", + "operationId": "pdfoperations.pagemanipulation", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Page Manipulation PDF Operation. Refer to the External Section below for using external storage with Page Manipulation Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/PageManipulationInternal" + }, + { + "$ref": "#/components/schemas/PageManipulationExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/pagemanipulation/{jobID}/status": { + "get": { + "tags": [ + "Page Manipulation" + ], + "summary": "Poll the page manipulation job for completion", + "operationId": "pdfoperations.pagemanipulation.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageManipulationJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/pdfproperties": { + "post": { + "tags": [ + "PDF Properties" + ], + "summary": "Extract basic information about a PDF document.", + "description": "Extract basic information about the document such as page count, pdf version, if the file is encrypted, if the file linearized, if the file contains embedded files etc.", + "operationId": "pdfoperations.pdfproperties", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Pdf Properties Operation. Refer to the External Section below for using external storage with PDF Properties Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/PDFPropertiesInternal" + }, + { + "$ref": "#/components/schemas/PDFPropertiesExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/pdfproperties/{jobID}/status": { + "get": { + "tags": [ + "PDF Properties" + ], + "summary": "Poll the PDF properties job for completion", + "operationId": "pdfoperations.pdfproperties.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PDFPropertiesJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/protectpdf": { + "post": { + "tags": [ + "Protect PDF" + ], + "summary": "Add encryption and/or restrict permissions on a PDF File", + "description": "Secure a PDF Document with user or/and owner password and set the restrictions on certain features like printing, editing and copying in the PDF document. You can specify the type of content to be encrypted with your specified encryption algorithm.
All Adobe products enforce the restrictions set by the permissions password. However, if third-party products don’t support these settings, document recipients can bypass some or all of your restrictions.", + "operationId": "pdfoperations.protectpdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Protect PDF Operation. Refer to the External Section below for using external storage with Protect PDF Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ProtectPDFInternal" + }, + { + "$ref": "#/components/schemas/ProtectPDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/protectpdf/{jobID}/status": { + "get": { + "tags": [ + "Protect PDF" + ], + "summary": "Poll the protect pdf job for completion", + "operationId": "pdfoperations.protectpdf.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProtectPDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/removeprotection": { + "post": { + "tags": [ + "Remove Protection" + ], + "summary": "Remove password protection from a PDF File", + "description": "Remove security from a PDF document. If the PDF is protected by owner password then the owner password is required in the field password to remove security otherwise user password is required.", + "operationId": "pdfoperations.removeprotection", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Remove Protection PDF Operation. Refer to the External Section below for using external storage with Remove Protection Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/RemoveProtectionInternal" + }, + { + "$ref": "#/components/schemas/RemoveProtectionExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/removeprotection/{jobID}/status": { + "get": { + "tags": [ + "Remove Protection" + ], + "summary": "Poll the remove protection job for completion", + "operationId": "pdfoperations.removeprotection.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoveProtectionJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/splitpdf": { + "post": { + "tags": [ + "Split PDF" + ], + "summary": "Split a PDF File into multiple PDF Files", + "description": "Split a PDF document into multiple smaller documents by simply specifying either the number of files, pages per file, or page ranges. Various available options are: (mutually exclusive)\n\n1. Use the page count to specify the maximum number of pages in each of the output file(s).\n\n2. Creating smaller PDFs with a set number of pages, you can split PDFs into multiple smaller documents by specifying page ranges where each page range corresponds to a single output file.\n\n3. Split PDFs by file count. In this case, the operation creates the specified number of files with each containing an identical number of pages (if possible).", + "operationId": "pdfoperations.splitpdf", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Split PDF Operation. Refer to the External Section below for using external storage with Split PDF Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/SplitPDFInternal" + }, + { + "$ref": "#/components/schemas/SplitPDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/splitpdf/{jobID}/status": { + "get": { + "tags": [ + "Split PDF" + ], + "summary": "Poll the split pdf job for completion", + "operationId": "pdfoperations.splitpdf.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SplitPDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/electronicseal": { + "post": { + "tags": [ + "PDF Electronic Seal" + ], + "summary": "PDF Electronic Seal Operation", + "description": "An operation to create an electronic seal on input PDF documents using the digital certificate issued to the user by Trust Service Provider. To know more about PDF Electronic Seal, please see the documentation.", + "operationId": "pdfoperations.electronicseal", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params to specify the options required for applying Electronic Seal. Refer to the External Section below for using external storage with Electronic Seal Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ElectronicSealInternal" + }, + { + "$ref": "#/components/schemas/ElectronicSealExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/electronicseal/{jobID}/status": { + "get": { + "tags": [ + "PDF Electronic Seal" + ], + "summary": "Poll the electronic seal job for completion", + "operationId": "pdfoperations.electronicseal.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ElectronicSealPDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/autotag": { + "post": { + "tags": [ + "PDF Accessibility Auto-Tag" + ], + "summary": "PDF Accessibility Auto-Tag Operation", + "description": "Operation to create the tagged pdf and excel report for accessibility auto-tag use case. Automatic tagging provides significant quality improvements over untagged PDF files including more accurate results for heading levels, reading order, complex lists, links, references, and tables. Screen reader users also benefit significantly from the improvements to heading levels for navigation.", + "operationId": "pdfoperations.autotag", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Input Params for Accessibility Auto-Tag Operation. Refer to the External Section below for using external storage with Accessibility Auto-Tag Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AutoTagPDFInternal" + }, + { + "$ref": "#/components/schemas/AutoTagPDFExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/autotag/{jobID}/status": { + "get": { + "tags": [ + "PDF Accessibility Auto-Tag" + ], + "summary": "Poll the accessibility auto-tag job for completion", + "operationId": "pdfoperations.autotag.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoTagPDFJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/accessibilitychecker": { + "post": { + "tags": [ + "PDF Accessibility Checker" + ], + "summary": "PDF Accessibility Checker Operation", + "description": "Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements of PDF/UA and WCAG. 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.", + "operationId": "pdfoperations.accessibilitychecker", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Input Params for Accessibility Checker Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AccessibilityCheckerInternal" + }, + { + "$ref": "#/components/schemas/AccessibilityCheckerExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/accessibilitychecker/{jobID}/status": { + "get": { + "tags": [ + "PDF Accessibility Checker" + ], + "summary": "Poll the PDF accessibility checker job for completion", + "operationId": "pdfoperations.accessibilitychecker.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AccessibilityCheckerJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/addwatermark": { + "post": { + "tags": [ + "PDF Watermark" + ], + "summary": "Add Watermark in PDF Document", + "description": "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.", + "operationId": "pdfoperations.addwatermark", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Params for Add Watermark Operation. Refer to the External Section below for using external storage with PDF Watermark API", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AddWatermarkInternal" + }, + { + "$ref": "#/components/schemas/AddWatermarkExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/addwatermark/{jobID}/status": { + "get": { + "tags": [ + "PDF Watermark" + ], + "summary": "Poll the add watermark job for completion", + "operationId": "pdfoperations.addwatermark.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddWatermarkJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/getformdata": { + "post": { + "tags": [ + "Export PDF Form Data" + ], + "summary": "Export PDF Form Data Operation", + "description": "The Export PDF Form Data API will retrieve the data from a PDF form and return it as a JSON file where field names of form will be the keys and value will be the data of the form.", + "operationId": "pdfoperations.getformdata", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Input Params for Export PDF Form Data Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/GetFormDataInternal" + }, + { + "$ref": "#/components/schemas/GetFormDataExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/getformdata/{jobID}/status": { + "get": { + "tags": [ + "Export PDF Form Data" + ], + "summary": "Poll the Export PDF Form Data job for completion", + "operationId": "pdfoperations.getformdata.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetFormDataJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + }, + "/operation/setformdata": { + "post": { + "tags": [ + "Import PDF Form Data" + ], + "summary": "Import PDF Form Data Operation", + "description": "The Import PDF Form Data API will take the form data provided as a JSON, insert it into the PDF form, and generate the resulting PDF where field names of form will be the keys and value will be the data of the form in the input JSON.", + "operationId": "pdfoperations.setformdata", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Input Params for Import PDF Form Data Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/SetFormDataInternal" + }, + { + "$ref": "#/components/schemas/SetFormDataExternal" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.", + "headers": { + "location": { + "description": "Job status URI for polling the results", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the error JSON response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/operation/setformdata/{jobID}/status": { + "get": { + "tags": [ + "Import PDF Form Data" + ], + "summary": "Poll the Import PDF Form Data job for completion", + "operationId": "pdfoperations.setformdata.jobstatus", + "parameters": [ + { + "name": "jobID", + "in": "path", + "description": "Job ID of the request", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A response with job information.", + "headers": { + "content-type": { + "description": "The content type of the status call response.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetFormDataJobStatus" + } + } + } + }, + "400": { + "description": "Bad Request. The request was invalid or cannot be otherwise served.", + "headers": { + "content-type": { + "description": "The content type of the status call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status400" + } + } + } + }, + "404": { + "description": "Resource Not Found.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus404" + } + } + } + }, + "401": { + "description": "Unauthorized.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-server": { + "description": "The name and version of the server.", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus401" + } + } + } + }, + "429": { + "description": "Caller doesn't have sufficient quota for this operation.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus429" + } + } + } + }, + "500": { + "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.", + "headers": { + "content-type": { + "description": "The content type of the POST API call response", + "schema": { + "type": "string" + } + }, + "x-request-id": { + "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Satus500" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "PDFToMarkdownInternal": { + "title": "Internal", + "description": "Params for PDF to Markdown Operation", + "type": "object", + "required": [ + "assetID" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "getFigures": { + "description": "Extract figures or images in base64 format", + "type": "boolean", + "default": "false" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "getFigures": false, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "PDFToMarkdownExternal": { + "title": "External", + "description": "Params for PDF to Markdown Operation using external storage.", + "type": "object", + "required": [ + "input" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for PDF to Markdown processing", + "type": "object", + "properties": { + "getFigures": { + "description": "Extract figures or images in base64 format", + "type": "boolean", + "default": "false" + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "getFigures": true + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "Token": { + "description": "Params for generating the Access Token.", + "type": "object", + "properties": { + "client_id": { + "description": "Contains the client id obtained upon client registration.", + "type": "string" + }, + "client_secret": { + "description": "Contains the client secret obtained upon client registration.", + "type": "string" + } + }, + "example": { + "client_id": "", + "client_secret": "" + }, + "required": [ + "client_id", + "client_secret" + ], + "additionalProperties": false + }, + "TokenResponse": { + "description": "Response of generate Access Token Operation.", + "type": "object", + "properties": { + "access_token": { + "description": "The token which can be used in performing the PDF Service Operation.", + "type": "string" + }, + "token_type": { + "description": "The type of the token issued.", + "type": "string" + }, + "expires_in": { + "description": "The lifetime in seconds of the access token.", + "type": "integer" + } + }, + "example": { + "access_token": "*******", + "token_type": "Bearer", + "expires_in": "86399" + } + }, + "documentLanguage": { + "description": "Specifies the default language for the input non-PDF document. In absence of font info within file’s content, an appropriate font is chosen on its basis. \n\n Note : ja-JP Locale is currently not supported in EU region. ", + "type": "string", + "default": "en-US", + "enum": [ + "ca-ES", + "cs-CZ", + "da-DK", + "de-DE", + "en-AE", + "en-GB", + "en-IL", + "en-US", + "es-ES", + "es-MX", + "eu-ES", + "fi-FI", + "fr-CA", + "fr-FR", + "fr-MA", + "hr-HR", + "ht-HU", + "it-IT", + "ja-JP", + "ko-KR", + "nb-NO", + "nl-NL", + "pl-PL", + "pt-BR", + "pt-PT", + "ro-RO", + "ru-RU", + "sk-SK", + "sl-SI", + "sv-SE", + "tr-TR", + "uk-UA", + "zh-CN", + "zh-TW", + "lt-LT", + "el-GR", + "zh-HK", + "hu-HU", + "et-EE", + "lv-LV", + "bg-BG", + "mt-MT", + "sr-SR", + "ca-CA", + "mk-MK", + "de-CH", + "no-NO", + "iw-IL" + ] + }, + "ocrLang": { + "description": "Specifies the input language to be used for OCR.", + "type": "string", + "default": "en-US", + "enum": [ + "da-DK", + "lt-LT", + "sl-SI", + "el-GR", + "ru-RU", + "en-US", + "zh-HK", + "hu-HU", + "et-EE", + "pt-BR", + "uk-UA", + "nb-NO", + "pl-PL", + "lv-LV", + "fi-FI", + "ja-JP", + "es-ES", + "bg-BG", + "en-GB", + "cs-CZ", + "mt-MT", + "de-DE", + "hr-HR", + "sk-SK", + "sr-SR", + "ca-CA", + "mk-MK", + "ko-KR", + "de-CH", + "nl-NL", + "zh-CN", + "sv-SE", + "it-IT", + "no-NO", + "tr-TR", + "fr-FR", + "ro-RO", + "iw-IL" + ] + }, + "exportOCRLang": { + "title": "ocrLang", + "type": "string", + "description": "Language to be used for ocr operation", + "enum": [ + "en-GB", + "en-US", + "nl-NL", + "fr-FR", + "de-DE", + "it-IT", + "es-ES", + "sv-SE", + "da-DK", + "fi-FI", + "nb-NO", + "pt-BR", + "pt-PT", + "ca-CA", + "nn-NO", + "de-CH", + "ja-JP", + "bg-BG", + "hr-HR", + "cs-CZ", + "et-EE", + "el-GR", + "hu-HU", + "lv-LV", + "lt-LT", + "pl-PL", + "ro-RO", + "ru-RU", + "zh-CN", + "sl-SI", + "zh-Hant", + "tr-TR", + "ko-KR", + "sk-SK", + "eu-ES", + "gl-ES", + "mk-MK", + "mt-MT", + "sr-SR", + "uk-UA", + "iw-IL" + ] + }, + "400": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
BAD_REQUESTBad Request.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "BAD_REQUEST", + "message": "Bad Request." + } + } + }, + "404": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
NOT_FOUNDAsset not found.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "NOT_FOUND", + "message": "Asset not found." + } + } + }, + "401": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
UNAUTHORIZEDNot authorised to perform the operation.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "UNAUTHORIZED", + "message": "Not authorised to perform the operation." + } + } + }, + "408": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
REQUEST_TIMEOUTRequest processing took more than %s seconds.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "REQUEST_TIMEOUT", + "message": "Request processing took more than %s seconds." + } + } + }, + "429": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
TOO_MANY_REQUESTSToo Many Requests.
INSUFFICIENT_QUOTAEither 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.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "TOO_MANY_REQUESTS", + "message": "Too Many Requests." + } + } + }, + "500": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
INTERNAL_SERVER_ERRORThere was an error processing your request.
UNKNOWNUnknown error.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "INTERNAL_SERVER_ERROR", + "message": "There was an error processing your request." + } + } + }, + "IMS400": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
invalid_clientmissing client_id parameter
invalid_clientinvalid client_id parameter
invalid_clientmissing client_secret parameter
invalid_clientmissing client_secret parameter
unauthorized_clientclient is not authorized to use this grant type.
invalid_target_scopeNone of the requested scopes is enabled in the SP binding
missing_separatorThe guid xXx is invalid.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "invalid_client", + "message": "missing client_id parameter" + } + } + }, + "IMS401": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
invalid_clientAccording to Section 5.2 of RFC6749 the response includes the \"WWW-Authenticate\" response header field matching the authentication scheme used by the client.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "invalid_client", + "message": "According to Section 5.2 of RFC6749 the response includes the \"WWW-Authenticate\" response header field matching the authentication scheme used by the client." + } + } + }, + "IMS403": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
access_deniedfield matching the authentication scheme used by the client.
access_deniedService principal is no longer part of the organization.
ForbiddenThe client is not allowed to perform the operation.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "access_denied", + "message": "field matching the authentication scheme used by the client." + } + } + }, + "IMS404": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
not_foundOrganization with id xXX cannot be found
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "NOT_FOUND", + "message": "Asset not found." + } + } + }, + "IMS409": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
duplicate_bindingThere are multiple bindings for this client and org.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "duplicate_binding", + "message": "There are multiple bindings for this client and org." + } + } + }, + "IMS500": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
INTERNAL_SERVER_ERRORThere was an error processing your request.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "INTERNAL_SERVER_ERROR", + "message": "There was an error processing your request." + } + } + }, + "Asset429": { + "properties": { + "error_code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. ", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
429001Service usage limit reached
429002Developer key usage limit reached
429050Too many requests
", + "type": "string" + } + }, + "example": { + "error_code": "429050", + "message": "Too many requests" + } + }, + "Status400": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
INVALID_JOB_IDInvalid job id present in path param.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "INVALID_JOB_ID", + "message": "Invalid job id present in path param." + } + } + }, + "Satus404": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
NOT_FOUNDJob not found.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "NOT_FOUND", + "message": "Job not found." + } + } + }, + "Satus401": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
UNAUTHORIZEDNot authorised to perform the operation.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "UNAUTHORIZED", + "message": "Not authorised to perform the operation." + } + } + }, + "Satus408": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
REQUEST_TIMEOUTRequest processing took more than %s seconds.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "REQUEST_TIMEOUT", + "message": "Request processing took more than %s seconds." + } + } + }, + "Satus429": { + "properties": { + "error_code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. ", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
429001Service usage limit reached
429002Developer key usage limit reached
429050Too many requests
", + "type": "string" + } + }, + "example": { + "error_code": "429050", + "message": "Too many requests" + } + }, + "Satus500": { + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
codemessage
INTERNAL_SERVER_ERRORThere was an error processing your request.
UNKNOWNUnknown error.
", + "type": "string" + } + } + } + }, + "example": { + "error": { + "code": "INTERNAL_SERVER_ERROR", + "message": "There was an error processing your request." + } + } + }, + "createTaggedPDF": { + "description": "Enables accessibility and reflow in the converted PDF file with Tagged PDF.", + "type": "boolean" + }, + "CreatePDFInternal": { + "title": "Internal", + "description": "Params for Create PDF Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. Supported file formats are bmp, doc, docx, gif, jpeg, jpg, png, ppt, pptx, rtf, tif, tiff, txt, xls, xlsx and md. For more details click here .", + "type": "string" + }, + "documentLanguage": { + "$ref": "#/components/schemas/documentLanguage" + }, + "isActiveSheetConversion": { + "description": "Specifies whether to convert only the active sheet of the Excel file.", + "type": "boolean", + "default": false + }, + "pageRange": { + "$ref": "#/components/schemas/CreatePDFPageRange" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "default": { + "documentLanguage": "en-US" + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "documentLanguage": "en-US", + "pageRange": { + "start": 1, + "end": 4 + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID" + ], + "additionalProperties": false + }, + "CreatePDFExternal": { + "title": "External", + "description": "Params for Create PDF Operation using external storage", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Create PDF processing", + "type": "object", + "properties": { + "documentLanguage": { + "$ref": "#/components/schemas/documentLanguage" + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "default": { + "documentLanguage": "en-US" + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f378b68a-7427-40a7-9d6f-5ec804bf3a0f?X-Amz-Security-Token=FwoGZXIvYXdzEIL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDEIZGjPptSLXfARH1yLTAfJTaRdY3uk3U6cPXeYmRyehW9X7CHlzsGvTlLmJTmfNjAMgEEup0IDFWMZoem2JY%2BGO5Bdn%2FJU%2FhdKbc6%2FNmOAHAcAcY0%2F5h1kMempmrqwJvwRkfU%2BQi0JEz1Bj6QBaV3%2B9mluSmL7OuNgCmVtzPVJD3ilIncP42hY8P6zd86AMtN9Y7l5hfHvGzJJdQSB5jsF3NdAONhBIj21hJO2yTVjuSZZh%2FPteHH4C2n7GtxPqvWKz5%2FOAj2GgmoMNN%2BTDzyyT1Vq29%2BtLwsWWveMKPdxD0Nwo2eK%2BpQYyLTokOdaY01RJkdMmYzGhPO6%2FLriOy4k0zXz5IBARU3snKFzRQbyo%2Fumb2CaGZg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230713T081101Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47LMDZTLAW%2F20230713%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2f9038878059237c1a149139e4addda4bfdabeb5868da3e4ad29ad4f8395b47a", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/6c87e993-5359-497a-8580-994cc87af336?X-Amz-Security-Token=FwoGZXIvYXdzEIL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDPeFWZ0VRI3WwhzPpyLTAf9IHH25%2BhV1x17SRxzjCIepHKWnI3V9nmM5qu5mru9ud2iyJ3p9JEn%2Bu%2Fa6YWRx9EsoTbKoTJAWGi7WfDqHjn5y3nophcNveAMS7FnWLogK43GBvl4IIMLxbC5dMRcfqlsCw8%2FHcTep2bgGIv0xjvK4BirN6qa9rnyr0aBGB8sdxAxagx6zfaZ1f6bV4YcbEx2qQIXEaQAgfy0Oo%2BY9wUxTThHrO33PVTWpJ6Zhy%2FokJ3eETa551zc9xevZUqtEpvu41vmmMZeWyBidwbYCNG790t0oh%2BK%2BpQYyLTrNKbZU%2B%2Bf7i5NHcj50bZWHbEZrHD03psMAToKLsxSpnbrN8PtJsIZ8zddP9A%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230713T081108Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47LL7P67JE%2F20230713%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=158407c206615682fbf562786011297b258464221de3a715a7ea389db1560846", + "storage": "S3" + }, + "params": { + "documentLanguage": "en-US", + "pageRange": { + "start": 1, + "end": 4 + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input" + ], + "additionalProperties": false + }, + "ExportPDFInternal": { + "title": "Internal", + "description": "Parameter for export pdf operation", + "type": "object", + "required": [ + "assetID", + "targetFormat" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "targetFormat": { + "description": "Target exported File Format", + "type": "string", + "enum": [ + "doc", + "docx", + "pptx", + "xlsx", + "rtf" + ] + }, + "ocrLang": { + "$ref": "#/components/schemas/exportOCRLang" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "targetFormat": "docx", + "ocrLang": "en-US", + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "ExportPDFExternal": { + "title": "External", + "description": "Parameter for export pdf operation using external storage", + "type": "object", + "required": [ + "input", + "params" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Export PDF processing", + "type": "object", + "properties": { + "targetFormat": { + "description": "Target exported File Format", + "type": "string", + "enum": [ + "doc", + "docx", + "pptx", + "xlsx", + "rtf" + ] + }, + "ocrLang": { + "$ref": "#/components/schemas/exportOCRLang" + } + }, + "required": [ + "targetFormat" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/82623a1c-a82f-430d-8a26-571dae502f5a?X-Amz-Security-Token=FwoGZXIvYXdzEKL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDCR9Qac371UlbnQelCLTAYsiejKDwtWVFttx1jtKosej4mVUEiJdOhqPsFLFzffSFF%2BMsiW02c8kvrwogGGRP1rgphK%2FJpuxm6i%2FIqXGBc3as69fZfITgppgTSCPKMYkIYwRE266eGchw%2FArQIBFA%2B3IRDqsNFAxIz79XQKAYkkqYOWj14RhMB149csTVCF55TnpqEFkFgc%2B%2Fs58G4Djo0tdJtPLiHrO6cUASOJRJkb%2F8Xn3BlTe4ivquvuFql5XCdeo3spj25YwNqFgGP0eaJ2q6Gi89NtpYMesLFAFmxRKLioozY%2F%2BpQYyLQUIVjet4ICeOSac%2FvkJOFViLl3nexU8d7dwJkPXsqqk2xkdUOZKxxRlh%2F%2F6Yg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230725T082901Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47HL6NSM4I%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=a44d819e4e5b67adc993c1a9a8a73907327b0b5e4548873f0596418bde4101a2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/be3e5be0-7471-4517-a9c1-9ab0773643b5?X-Amz-Security-Token=FwoGZXIvYXdzEKL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDGnmnu%2BgRva9cjruFCLTAdShzBfaOPHw9WCZeF7%2B6LtT44gvzgcdlMfF1kVP4aafl6hGInW%2BTS1oThzc%2Bi%2BnNzV4txT6I5sgLw44OwQedzdAnvUI4WHFuoFWXTwWxaLKlXFG5DZ8wylCAqm%2FUrZjBUPIqNFPdbuQZHumNHA9C%2B8GYJL46E%2FhViQ3SdBdV9%2FQTUqdnoJnMHYm1oYmPdKOloJtucDrPN7p2IrsEzHDVh7IrLFCFHMMdAFcsZwdW48hDpyYZ6c%2FZqiwDp1r3Do2AmZ3Z8QeQQeEl1PTtOu6NP2m4B0oz4%2F%2BpQYyLUuqP2mFz1NrqSRk9acFo6zciHwwMK6sr2IJdS84QxtnjskvI7NFRmAWDrwRNw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230725T082903Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47B245SKPR%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=bb5f2facb7382d9072fb39d6cf1d281328b71b2aea7496b1dbf96f1d9631f145", + "storage": "S3" + }, + "params": { + "targetFormat": "docx", + "ocrLang": "en-US" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "PDFToImageInternal": { + "title": "Internal", + "description": "Parameter for PDF to Image operation.", + "type": "object", + "required": [ + "assetID", + "targetFormat", + "outputType" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "targetFormat": { + "description": "Target exported image File Format", + "type": "string", + "enum": [ + "jpeg", + "png", + "tiff" + ] + }, + "outputType": { + "description": "If it is set to zipOfPageImages then the response will be provided as a zip response, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat.", + "type": "string", + "enum": [ + "listOfPageImages", + "zipOfPageImages" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "targetFormat": "jpeg", + "outputType": "listOfPageImages", + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "PDFToImageExternal": { + "title": "External", + "description": "Parameter for PDF to Image operation.", + "type": "object", + "required": [ + "input", + "params" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutputZip" + }, + "params": { + "description": "Params for PDF to Images processing", + "type": "object", + "properties": { + "targetFormat": { + "description": "Target exported image File Format", + "type": "string", + "enum": [ + "jpeg", + "png", + "tiff" + ] + } + }, + "required": [ + "targetFormat" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/543833a8-9467-4f62-a382-11d52d3cbced?X-Amz-Security-Token=FwoGZXIvYXdzEKX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDTPgDrLKMcd41%2BpKyLTAV7kfv1UVPt7Sa0SM5r7TIHztxH1mhtfWvEkjVk9QGIDksCsmoQZV9D9vLbmWJiyURuKXlOov8Iu4DCZ3ojidX%2BGhaCK8naQl46ZpH9Qz4B0Ign0yu8HtbK7NqIWH1TLopl%2Fxj3Nq69AYxAjctStT7Kw1tFTyDvKl4S%2Btf7NU4hbG9C43wguHlcJU42Vtks%2FS4xU8Xih%2BSzUPXE029FhxYH7kf0%2FzL9SPcokOKRjzdSomGStcZuRujTSfYqNd9wjNAGcXJnz4tSbwJdfhpV9kG3JDmUo6eb%2BpQYyLf9SC0VpyMwt%2FC9%2F4r2kyso3J%2F115yRDjNVjJnEfdJdQERFQ%2BmfSPXoW%2F1XoIA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230725T113539Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47MC323YPD%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2828a283496de0006207ba121f7ecbb96ffafcdae731f5221dbe76d96a90d7c3", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "targetFormat":"jpeg" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "ExtractPDFInternal": { + "title": "Internal", + "description": "Params for Extract PDF Operation", + "type": "object", + "required": [ + "assetID" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "getCharBounds": { + "description": "Extract bounding boxes for characters present in text blocks(paragraphs, list, headings)", + "type": "boolean", + "default": false + }, + "includeStyling": { + "description": "Boolean specifying whether to add styling information to json output", + "type": "boolean", + "default": false + }, + "elementsToExtract": { + "description": "List of elements that should be extracted as json. Possible values are text and tables.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "text", + "tables" + ] + }, + "default": [ + "text" + ] + }, + "tableOutputFormat": { + "description": "Specifies the format of table contents output. Possible values are csv and xlsx.", + "type": "string", + "default": "xlsx" + }, + "renditionsToExtract": { + "description": "List of elements whose renditions should be generated. Possible values are figures and tables.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "tables", + "figures" + ] + } + }, + "includeHeaderFooter": { + "description": "If true, extract header and footer information as part of json.", + "type": "boolean", + "default": false + }, + "tagEncapsulatedText": { + "description": "List of elements from which to extract encapsulated text content.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Figure" + ] + }, + "default": [ + "Figure" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "getCharBounds": false, + "includeStyling": false, + "elementsToExtract": [ + "text", + "tables" + ], + "tableOutputFormat": "xlsx", + "renditionsToExtract": [ + "tables", + "figures" + ], + "includeHeaderFooter": false, + "tagEncapsulatedText": ["Figure"], + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "ExtractPDFExternal": { + "title": "External", + "description": "Params for Extract PDF Operation using external storage.", + "type": "object", + "required": [ + "input" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutputZip" + }, + "params": { + "description": "Params for Extract PDF processing", + "type": "object", + "properties": { + "getCharBounds": { + "description": "Extract bounding boxes for characters present in text blocks(paragraphs, list, headings)", + "type": "boolean", + "default": false + }, + "includeStyling": { + "description": "Boolean specifying whether to add styling information to json output", + "type": "boolean", + "default": false + }, + "elementsToExtract": { + "description": "List of elements that should be extracted as json. Possible values are text and tables.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "text", + "tables" + ] + }, + "default": [ + "text" + ] + }, + "tableOutputFormat": { + "description": "Specifies the format of table contents output. Possible values are csv and xlsx.", + "type": "string", + "default": "xlsx" + }, + "renditionsToExtract": { + "description": "List of elements whose renditions should be generated. Possible values are figures and tables.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "tables", + "figures" + ] + } + }, + "includeHeaderFooter": { + "description": "If true, extract header and footer information as part of json.", + "type": "boolean", + "default": false + }, + "tagEncapsulatedText": { + "description": "List of elements from which to extract encapsulated text content.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Figure" + ] + }, + "default": [ + "Figure" + ] + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "getCharBounds": false, + "includeStyling": false, + "elementsToExtract": [ + "text", + "tables" + ], + "tableOutputFormat": "xlsx", + "renditionsToExtract": [ + "tables", + "figures" + ], + "includeHeaderFooter" : false, + "tagEncapsulatedText": ["Figure"] + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "HtmlToPdfInternal": { + "title": "Internal", + "description": "Params for converting HTML to PDF Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "inputUrl": { + "description": "Parameter to provide the URL as input. Provide one of the value between assetID and inputUrl ", + "type": "string" + }, + "json": { + "description": "JavaScript variables to be placed in global scope to reference while rendering the HTML. This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests. The actual mechanics of accessing this content varies depending if rendering from a zip file or from a url. When rendering from a zip file, the source collateral must include a script element such as: \\ When rendering from a URL, the content of this json object is injected into the browser VM before the page is rendered.", + "type": "string", + "default": null + }, + "includeHeaderFooter": { + "description": "Determine whether to add default headers and footers to the output pages. The default header includes a short date and the contents of document title. The default footer includes a file name and a page n/m reference.", + "type": "boolean", + "default": false + }, + "pageLayout": { + "description": "Parameters for specifying the layout of the output page.", + "type": "object", + "properties": { + "pageWidth": { + "description": "The width (in inches) of the output paper size.", + "type": "number", + "default": [ + 11 + ] + }, + "pageHeight": { + "description": "The height (in inches) of the output paper size.", + "type": "number", + "default": [ + 8.5 + ] + } + } + }, + "waitTimeToLoad": { + "description": "Specifies the maximum time (in milliseconds) to wait before finalizing the PDF. After this duration, the HTML is captured and converted into a PDF, regardless of whether all elements have finished loading or rendering. If a customer provides a custom value, it overrides the default.", + "type": "number", + "default": 100 + }, + "includeRenderedHtml": { + "description": "When set to `true`, the operation returns a ZIP file containing both the generated PDF and the rendered HTML content. Valid and accepted input type of files are - HTML files and ZIP files (containing HTML + assets)", + "type": "boolean", + "default": false + }, + "createTaggedPDF": { + "description": "Determines whether the output PDF should be tagged. Tagged PDFs improve heading levels, reading order, lists, links, references, and tables, while adding some processing overhead. They also enhance screen reader navigation. If not specified, the API generates a tagged PDF by default.", + "type": "boolean", + "default": true + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "json": "{}", + "includeHeaderFooter": true, + "pageLayout": { + "pageWidth": 11, + "pageHeight": 8.5 + }, + "waitTimeToLoad": 100, + "includeRenderedHtml": true, + "createTaggedPDF": true, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "HtmlToPdfExternal": { + "title": "External", + "description": "Params for converting HTML to PDF Operation using external storage.", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for HTML to PDF processing", + "type": "object", + "properties": { + "json": { + "description": "JavaScript variables to be placed in global scope to reference while rendering the HTML. This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests. The actual mechanics of accessing this content varies depending if rendering from a zip file or from a url. When rendering from a zip file, the source collateral must include a script element such as:\\When rendering from a URL, the content of this json object is injected into the browser VM before the page is rendered.", + "type": "string", + "default": null + }, + "includeHeaderFooter": { + "description": "Determine whether to add default headers and footers to the output pages. The default header includes a short date and the contents of document title. The default footer includes a file name and a page n/m reference.", + "type": "boolean", + "default": false + }, + "pageLayout": { + "description": "Parameters for specifying the layout of the output page.", + "type": "object", + "properties": { + "pageWidth": { + "description": "The width (in inches) of the output paper size.", + "type": "number", + "default": [ + 11 + ] + }, + "pageHeight": { + "description": "The height (in inches) of the output paper size.", + "type": "number", + "default": [ + 8.5 + ] + } + } + }, + "waitTimeToLoad": { + "description": "Specifies the maximum time (in milliseconds) to wait before finalizing the PDF. After this duration, the HTML is captured and converted into a PDF, regardless of whether all elements have finished loading or rendering. If a customer provides a custom value, it overrides the default.", + "type": "number", + "default": 100 + }, + "includeRenderedHtml": { + "description": "When set to `true`, the operation returns a ZIP file containing both the generated PDF and the rendered HTML content.Valid and accepted input type of files are - HTML files and ZIP files (containing HTML + assets)", + "type": "boolean", + "default": false + }, + "createTaggedPDF": { + "description": "Determines whether the output PDF should be tagged. Tagged PDFs improve heading levels, reading order, lists, links, references, and tables, while adding some processing overhead. They also enhance screen reader navigation. If not specified, the API generates a tagged PDF by default.", + "type": "boolean", + "default": true + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "json": "{\"k1\":\"v1\",\"k2\": \"v2\"}", + "includeHeaderFooter": true, + "pageLayout": { + "pageWidth": 8.5, + "pageHeight": 11 + }, + "waitTimeToLoad": 100, + "includeRenderedHtml": true, + "createTaggedPDF": true + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input" + ], + "additionalProperties": false + }, + "CombinePDFInternal": { + "title": "Internal", + "description": "Params for Combine PDF Operation", + "type": "object", + "properties": { + "assets": { + "description": "The array of assets with the required PageRanges to include in the output PDF document.", + "type": "array", + "items": { + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "pageRanges": { + "$ref": "#/components/schemas/CombinePageRanges" + } + }, + "required": ["assetID"] + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assets": [ + { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "pageRanges": [ + { + "start": 1, + "end": 2 + } + ] + }, + { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87d3-087832fca718", + "pageRanges": [ + { + "start": 1, + "end": 2 + } + ] + } + ], + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assets" + ], + "additionalProperties": false + }, + "CombinePDFExternal": { + "title": "External", + "description": "Params for Combine PDF Operation", + "type": "object", + "properties": { + "inputs": { + "description": "The array of inputs with the required PageRanges to include in the output PDF document.", + "type": "array", + "items": { + "properties": { + "input": { + "description": "Params representing input object for combine pdf operation", + "type": "object", + "properties": { + "uri": { + "description": "Input file Download Signed URI.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT" + ] + } + }, + "required": [ + "uri" + ] + }, + "pageRanges": { + "$ref": "#/components/schemas/CombinePageRanges" + } + }, + "required": [ + "inputs" + ] + } + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "inputs": [ + { + "input": { + "uri": "https://dcalpine2.sharepoint.com/sites/Docgen/_layouts/15/download.aspx?UniqueId=353087f7-b1ea-4d84-91d7-0821b23e04ea&Translate=false&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvZGNhbHBpbmUyLnNoYXJlcG9pbnQuY29tQGIxYzY2OGZhLTU3YzQtNDBjYy1iZTgyLTg4OWJiYzkxNmM1NiIsImlzcyI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMCIsIm5iZiI6IjE2ODA2MDI5MDkiLCJleHAiOiIxNjgwNjA2NTA5IiwiZW5kcG9pbnR1cmwiOiIwU1NJNDAxdjZhUll6YUIyV2lod005VnIxOVJHNStvSUxFN280dk0yUlMwPSIsImVuZHBvaW50dXJsTGVuZ3RoIjoiMTMzIiwiaXNsb29wYmFjayI6IlRydWUiLCJjaWQiOiJPVEUxTlRZMFkyRXROREZpT1MwME1HSTBMVGczWVdRdFlqaGpaREprWkdNeVlXVTUiLCJ2ZXIiOiJoYXNoZWRwcm9vZnRva2VuIiwic2l0ZWlkIjoiWmpjM1l6QmtNekF0TVRka1lpMDBZalJoTFdFNU5qZ3RZVFJtWkRsaU5qQTRabVJqIiwiYXBwX2Rpc3BsYXluYW1lIjoiU2hhcmVwb2ludC1QT0MiLCJuYW1laWQiOiIyYmVmMjRkNy04OTRlLTQ4MzQtYWQxOC00OGZkNDRiNzk0ZTNAYjFjNjY4ZmEtNTdjNC00MGNjLWJlODItODg5YmJjOTE2YzU2Iiwicm9sZXMiOiJhbGxzaXRlcy5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbGZpbGVzLnJlYWQiLCJ0dCI6IjEiLCJ1c2VQZXJzaXN0ZW50Q29va2llIjpudWxsLCJpcGFkZHIiOiIyMC4xOTAuMTQ1LjE2OSJ9.aStWTExNZ045T3h3OGV4MHdyYURmLzZqOW9McGRhSmtZWStHOE1wM0ZaYz0&ApiVersion=2.0", + "storage": "SHAREPOINT" + }, + "pageRanges": [ + { + "start": 1, + "end": 2 + } + ] + }, + { + "input": { + "uri": "https://dcalpine2.sharepoint.com/sites/Docgen/_layouts/15/download.aspx?UniqueId=353087f7-b1ea-4d84-91d7-0821b23e04ea&Translate=false&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvZGNhbHBpbmUyLnNoYXJlcG9pbnQuY29tQGIxYzY2OGZhLTU3YzQtNDBjYy1iZTgyLTg4OWJiYzkxNmM1NiIsImlzcyI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMCIsIm5iZiI6IjE2ODA2MDI5MDkiLCJleHAiOiIxNjgwNjA2NTA5IiwiZW5kcG9pbnR1cmwiOiIwU1NJNDAxdjZhUll6YUIyV2lod005VnIxOVJHNStvSUxFN280dk0yUlMwPSIsImVuZHBvaW50dXJsTGVuZ3RoIjoiMTMzIiwiaXNsb29wYmFjayI6IlRydWUiLCJjaWQiOiJPVEUxTlRZMFkyRXROREZpT1MwME1HSTBMVGczWVdRdFlqaGpaREprWkdNeVlXVTUiLCJ2ZXIiOiJoYXNoZWRwcm9vZnRva2VuIiwic2l0ZWlkIjoiWmpjM1l6QmtNekF0TVRka1lpMDBZalJoTFdFNU5qZ3RZVFJtWkRsaU5qQTRabVJqIiwiYXBwX2Rpc3BsYXluYW1lIjoiU2hhcmVwb2ludC1QT0MiLCJuYW1laWQiOiIyYmVmMjRkNy04OTRlLTQ4MzQtYWQxOC00OGZkNDRiNzk0ZTNAYjFjNjY4ZmEtNTdjNC00MGNjLWJlODItODg5YmJjOTE2YzU2Iiwicm9sZXMiOiJhbGxzaXRlcy5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbGZpbGVzLnJlYWQiLCJ0dCI6IjEiLCJ1c2VQZXJzaXN0ZW50Q29va2llIjpudWxsLCJpcGFkZHIiOiIyMC4xOTAuMTQ1LjE2OSJ9.aStWTExNZ045T3h3OGV4MHdyYURmLzZqOW9McGRhSmtZWStHOE1wM0ZaYz0&ApiVersion=2.0", + "storage": "SHAREPOINT" + }, + "pageRanges": [ + { + "start": 1, + "end": 2 + } + ] + } + ], + "output": { + "uri": "https://dcalpine2.sharepoint.com/sites/Docgen/_api/v2.0/drives/b!MA1899sXSkupaKT9m2CP3JIqXDMQyoBCth9h9Rn6bQRjzBEBFxsbQpN23hY-rzQT/items/01TAIM7P3ZQQ4DP4NZHFDI6FBJPIGFRCY3/uploadSession?guid='2c79b9aa-f9dc-42c8-8919-da5a9b554b81'&overwrite=True&rename=False&dc=0&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvZGNhbHBpbmUyLnNoYXJlcG9pbnQuY29tQGIxYzY2OGZhLTU3YzQtNDBjYy1iZTgyLTg4OWJiYzkxNmM1NiIsImlzcyI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMCIsIm5iZiI6IjE2ODA2MDAyOTMiLCJleHAiOiIxNjgwNjg2NjkzIiwiZW5kcG9pbnR1cmwiOiJXVWNNVHhndVdyMHR4YzhlYWxlRzMrYUV1aXg5anoxanZuRmRpMENjNHFRPSIsImVuZHBvaW50dXJsTGVuZ3RoIjoiMjYxIiwiaXNsb29wYmFjayI6IlRydWUiLCJjaWQiOiJaREZsTURjek5tRXRaREJtWkMwMFlXUXlMV0V5WTJNdE1HRTRPV1prTTJJNU5XTmwiLCJ2ZXIiOiJoYXNoZWRwcm9vZnRva2VuIiwic2l0ZWlkIjoiWmpjM1l6QmtNekF0TVRka1lpMDBZalJoTFdFNU5qZ3RZVFJtWkRsaU5qQTRabVJqIiwiYXBwX2Rpc3BsYXluYW1lIjoiU2hhcmVwb2ludC1QT0MiLCJuYW1laWQiOiIyYmVmMjRkNy04OTRlLTQ4MzQtYWQxOC00OGZkNDRiNzk0ZTNAYjFjNjY4ZmEtNTdjNC00MGNjLWJlODItODg5YmJjOTE2YzU2Iiwicm9sZXMiOiJhbGxzaXRlcy5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbGZpbGVzLnJlYWQiLCJ0dCI6IjEiLCJ1c2VQZXJzaXN0ZW50Q29va2llIjpudWxsLCJpcGFkZHIiOiIyMC4xOTAuMTQ1LjE3MCJ9.a1hxR1J1emlFSE9jSTU0SnFTcFN6TGlsRHNhWTFRaDNkT2hwT3ZPYm8waz0", + "storage": "SHAREPOINT" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "inputs" + ], + "additionalProperties": false + }, + "CompressPDFInternal": { + "title": "Internal", + "description": "Params for Compress PDF Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "compressionLevel": { + "description": "Specify the level of compression to reduce the file size of the pdf. Supported levels of compression which reduces the file size of pdf:\n\n1. Low : Reduces resolution of the coloured and grayscale images above 250 dpi to 200 dpi. This option uses JP2K high quality compression.\n\n2. Medium : Reduces resolution of the coloured and grayscale images above 200 dpi to 144 dpi. This option uses JP2K medium quality compression.\n\n3. High : Reduces resolution of the coloured and grayscale images above 100 dpi to 72 dpi. This option uses JPEG medium quality compression. Output pdf will not contain hidden layers, document structure, metadata, javascript, user properties and print settings.", + "type": "string", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "compressionLevel": "LOW", + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID" + ], + "additionalProperties": false + }, + "CompressPDFExternal": { + "title": "External", + "description": "Params for Compress PDF Operation using external storage.", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Compress PDF processing", + "type": "object", + "properties": { + "compressionLevel": { + "description": "Specify the level of compression to reduce the file size of the pdf. Supported levels of compression which reduces the file size of pdf:\n\n1. Low : Reduces resolution of the coloured and grayscale images above 250 dpi to 200 dpi. This option uses JP2K high quality compression.\n\n2. Medium : Reduces resolution of the coloured and grayscale images above 200 dpi to 144 dpi. This option uses JP2K medium quality compression.\n\n3. High : Reduces resolution of the coloured and grayscale images above 100 dpi to 72 dpi. This option uses JPEG medium quality compression. Output pdf will not contain hidden layers, document structure, metadata, javascript, user properties and print settings.", + "type": "string", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ] + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/5830469d-d0f3-4bbe-9edb-fc01d152cbe6?X-Amz-Security-Token=FwoGZXIvYXdzEOH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDGhKYF78oYlJR%2Bxi7yLTAasegZMdcGZqUXgZv42QSYhTKhYD9TBiGcB8LZ7noJQeM79TV%2BbqL12x5FAsMBW74CzOhauXM%2F92xDZI%2BY6YiOsNrvY%2BXy3fdRQ208CU8hY4hNpUHW6VXoac2TjpYNJ6wVt3WeZUtSk0wm30mYfXgwkL2C3%2BqiJevWkEoWNAp9JRj46WFSWdO1JDzH76MmWT04pYaZ98Rnnbfsa32RfuU3%2BQQfd9kYg8CPY3kxVTU6PwXDHJ9NBSM1KBVubCmbcs6wZ%2FP6wVuxf23YtLvE%2FsKokm4p8o38%2FTpQYyLQ%2BQZUQVD1IDPfdCpJ1YVmIJFJL60mQcCwm7G23s0djHcNaUa%2BuqhDftYDo1Cg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230717T071454Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47JUJAAI63%2F20230717%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=23b3ae0f1fb7158af54dffb51002cf4095b8e7c584716ecf917f6c07044a4c2a", + "storage": "s3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/aa7a9c47-3469-4755-b354-f81693c55da6?X-Amz-Security-Token=FwoGZXIvYXdzEOD%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNgbniYOC8yEK4ApsCLRAUeto7ALcO4WHJw4dry6GtcbKpy5dv7V1ch%2FVw%2BqLgv2%2B948QSINdtGcTjpWHZIXgXxedFA2dT%2BjZrlQcIKSyS5RmhcgBpIsUKU%2FEEh%2FyB1V9CJiwu%2F006yCzGJdDbRiyra7%2BU%2BUknTeasMBtOsEp10SZgT6dX2%2Fm0jA4nI5bdvDGGIAyyTpbzl2iGFsZQKYMs7KHiO0Jt5BhEFCDK%2FUrgNu4FUeSYi0iTrCv5VloOm0ZVKQbyTHyMy6LvmXzll7XorEIDk7N6u4pxcIloXElOxnKPHN06UGMi2%2FXC6XJnH32BrBTWXNMLm2%2Fkg2Fpm0rGgz8P7iN3QiAJmQWo%2Bvz49Fp8fAcDc%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230717T071456Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47OQSL7LZ4%2F20230717%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=7c4528c0f6ad2e6fc144d5871916991a03b10ed73811b3cd55ab19a52a267fc0", + "storage": "s3" + }, + "params": { + "compressionLevel": "LOW" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input" + ], + "additionalProperties": false + }, + "LinearizePDFInternal": { + "title": "Internal", + "description": "Params for Linearize PDF Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID" + ], + "additionalProperties": false + }, + "LinearizePDFExternal": { + "title": "External", + "description": "Params for Linearize PDF Operation", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/8a7057f2-41c8-4a46-a76c-4d1c5ba30362?X-Amz-Security-Token=FwoGZXIvYXdzEKj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDJwEwK%2Fs1OibdEc%2FUSLTASPfoknMZYg8Nqkncsp24v5%2BZWDucKxQGeKZ0cmUHgXlYW%2FPnxz9K4HBGQP3IlBp%2FVZn55FfHmB0MBWcJ6HcJJ6UFEAAUdsRXc%2BtTXw1Kp02O4ZepcOqf%2BJ3%2Fz5SkoZ%2F8bm6Y6xMKg0LapQ5DEz1Xa4zWbm7HbssuUtt7fDWdR2ntOtFHBC9V26DE9DBK3rdabFkDUavdPoO9BEXXaswsmQgejfQlAOWz62GeE5z%2BwokyEu%2B8Qu8G5OWnLK49bdA2OvN6BSxPvYMyHNbBvT4TV6ip%2FMoofuOpQYyLagjRZjzkPNsS%2BHnkO0PvkYXqpNCpkrZmpTWus5FucvE7AOC7KIcVVuIztaG7Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230704T064433Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47HCTNSCMP%2F20230704%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=03dac900f4b7194ca503153c73b5f634d880d581c14a1d0b8d26c83e8bad74aa", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/c436259c-9b5a-4cb6-90ee-896977a8cf79?X-Amz-Security-Token=FwoGZXIvYXdzEKj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNPDTAjFnx2YzhSfIiLTAb0JPLRZf87ktkyvbfqLFQmyqQCJmKY53nwWJ3WsR%2BdaU5Xthi1sE00GVatWYOZ%2FFAwtSnPH3rASwRP1oM%2Fav%2FXtTuIi344QCbTFi1lAfzU1%2BxZjcpk2z8e%2B7tww8ArkaXRkbXfL%2Bn0eZIY0dwSgb89wJgsY4mfA7v8Yj%2FEkLcZuYEGkQnvqfyLTvZw6OqiDcRnyfzEFbx7ZZ41hSZrHA7wM%2BVYZDnijFUlTl4BJI1fV3NvLUTesfMML%2BmsZZzw3Jn1BuEwlAWVbTw4RlFiqAVdHVUAouP6OpQYyLdQSDw%2F0CFdJsNjUQG2Jt%2F%2Bii7Z3DLwdFd7cboI%2F5Op8GJuvDjBkOH1Q3oPy%2FQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230704T064436Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47D54AZ57L%2F20230704%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=0f86cf401c565d141aa8c24c0a4e4855431f71f9f1bad736b8590a455077da10", + "storage": "S3" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input" + ], + "additionalProperties": false + }, + "OCRInternal": { + "title": "Internal", + "description": "Params for OCR PDF Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "ocrLang": { + "$ref": "#/components/schemas/ocrLang" + }, + "ocrType": { + "description": "Specifies OCR Type. \n\nThere are two types which produce a different result:\n\n1. One type ensures that text is searchable and selectable, but modifies the original image during the cleanup process (for example, deskews it) before placing an invisible text layer over it. This type removes unwanted artifacts and may result in a more readable document in some scenarios.\n\n2. The second (EXACT) type, also overlays a searchable text layer over the original image, but in this case, the original image is unchanged. This type produces maximum fidelity to the original image.", + "type": "string", + "default": "searchable_image", + "enum": [ + "searchable_image", + "searchable_image_exact" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "ocrLang": "en-US", + "ocrType": "searchable_image", + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID" + ], + "additionalProperties": false + }, + "OCRExternal": { + "title": "External", + "description": "Params for OCR PDF Operation using external storage.", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for OCR PDF processing", + "type": "object", + "properties": { + "ocrLang": { + "$ref": "#/components/schemas/ocrLang" + }, + "ocrType": { + "description": "Specifies OCR Type. \n\nThere are two types which produce a different result:\n\n1. One type ensures that text is searchable and selectable, but modifies the original image during the cleanup process (for example, deskews it) before placing an invisible text layer over it. This type removes unwanted artifacts and may result in a more readable document in some scenarios.\n\n2. The second (EXACT) type, also overlays a searchable text layer over the original image, but in this case, the original image is unchanged. This type produces maximum fidelity to the original image.", + "type": "string", + "default": "searchable_image", + "enum": [ + "searchable_image", + "searchable_image_exact" + ] + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/fccd2ad0-e30f-41d6-b044-8f03736ecb93?X-Amz-Security-Token=FwoGZXIvYXdzEPD%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDFggMug%2BIF84HXdvKiLTAWv5unqWcoL8YlscLVMJixSnbTs9HlENjm%2Fqsw5NsGC5OrKkxfO0JSnM4pthVU%2BWYdwyyWv5IPIrlA5WpRWqrmXXjmAc6DxUBIdGM8229jLHb%2FbRjUyCJNUkEhY%2FWbr3R%2BrZDyQpNXUmwRCJqvijXy2KuMLWSniNCVsDamP3Y9zHRuq42oHCqSEXiSUNBNfoenIHry2CMC3yX7oQ%2BpKLK7ndF2JMg8Ww7WC9XdTE%2BJL8Shg7RCuLNYR6%2B0yDqdyf7CaSr7rixwJ1r57v0nFp01JRChYohNaepQYyLYwnH4AN7bDUjo7rVzcTPEPlI1UK17lHSRfYWNzNoJWhR7vPlPCo3Wej330SSg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230707T061814Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AUMPLT2M%2F20230707%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c0055069e692fcf2a601e1c97ea05ef488d3681a883e40a651fda1dc2a1138dc", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/cc5eabc5-a285-40bb-8464-b5a2d74d48ab?X-Amz-Security-Token=FwoGZXIvYXdzEPD%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDHVK300DsROZjGwTKCLTAUl6n%2FB3191j%2FRyM7F0%2F00q33%2BYlLAWkMVjQLFMZ14y5LMGn%2BWawJ3XZBBUzBkK58oTnLF%2BE8addaTuVlA83sKbiD4YRR4nDSvq0agql5gSjK7Kxw1CVyzehG9UT72ICFTBVK7t8SlP%2F%2FLlhXblGN05zAthbjwi6aXCGXp7rBQHW716msTf6pOwwVUsfbjU6%2Fuo4NykRo5IfJMBiI3LwFBy31RScBmaaXYK7zu4k63QH2h6FE3%2BNHinYxTsEdKYREetrlsfpaQb4NaBv8vtgvTr%2Bbwco0NeepQYyLVb1jldYVJvSrboAU3cZOSx6hWm3bER45o%2Bui64crYtWTMdQEXJd%2FY2pQ%2B%2BQuw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230707T061816Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47AGCWKDNL%2F20230707%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b87c1a5b170441423bbc6a121103c00c22048aa77c07ad617de333b260ef8d95", + "storage": "S3" + }, + "params": { + "ocrLang": "en-US", + "ocrType": "searchable_image" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input" + ], + "additionalProperties": false + }, + "PageManipulationInternal": { + "title": "Internal", + "description": "Params for Page Manipulation PDF Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "pageActions": { + "description": "A list of page actions to be performed on an input PDF document in a given order.", + "type": "array", + "items": [ + { + "oneOf": [ + { + "$ref": "#/components/schemas/delete" + }, + { + "$ref": "#/components/schemas/rotate" + } + ] + } + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "pageActions": [ + { + "rotate": { + "angle": 270, + "pageRanges": [ + { + "start": 1, + "end": 2 + } + ] + } + }, + { + "delete": { + "pageRanges": [ + { + "start": 1, + "end": 2 + } + ] + } + } + ], + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID", + "pageActions" + ], + "additionalProperties": false + }, + "PageManipulationExternal": { + "title": "External", + "description": "Params for Page Manipulation PDF Operation", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Page Manipulation processing", + "type": "object", + "properties": { + "pageActions": { + "description": "A list of page actions to be performed on an input PDF document in a given order.", + "type": "array", + "items": [ + { + "oneOf": [ + { + "$ref": "#/components/schemas/delete" + }, + { + "$ref": "#/components/schemas/rotate" + } + ] + } + ] + } + }, + "required": [ + "pageActions" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/01832818-8174-4330-8e02-1216354cc8bb?X-Amz-Security-Token=FwoGZXIvYXdzEJb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDLM7R8jIjxWAOEAOmiLTARSYWTEyGQfSoeJ8oeqnEwoKMgPu2rONJCRrTEtavzV9xYy6pAdq9QXJMJgrh6eXFk7kDpPP4Da9tPNXQ5Q5o8ueT0DOHFQhz7mOqtpuV0ss5CJ8kcDLwzpGYipQHbJf6vve75tZkFKKSS%2Ft6iTYz1CF%2BlxxnCYyZo1EWiQcqqfyV5F3mcHEYyIasRKDM9oEG5pMwK2g3XQDTlwDx7C8%2Bg9dezafxuy1sKcW6b6m2WOnd8qdkgFdVPPb8E4N3o8C7971QLZxg%2BRd5rpL5MKyxXGR9YIooPOKpQYyLY7z2XupNdWIjvlD6YyATQUKTaQBRHKcY8vbo09ZqNo6saEPtozmpG%2FK2JM0gg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230703T121829Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47AM4EPWWD%2F20230703%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ec9483c3fc8a709aaf1b4f2d79afc18884888952fd785f707b015bfdf70eb746", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/3b9f664f-ac35-4438-abbb-22ec8baf035c?X-Amz-Security-Token=FwoGZXIvYXdzEJb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDLM7R8jIjxWAOEAOmiLTARSYWTEyGQfSoeJ8oeqnEwoKMgPu2rONJCRrTEtavzV9xYy6pAdq9QXJMJgrh6eXFk7kDpPP4Da9tPNXQ5Q5o8ueT0DOHFQhz7mOqtpuV0ss5CJ8kcDLwzpGYipQHbJf6vve75tZkFKKSS%2Ft6iTYz1CF%2BlxxnCYyZo1EWiQcqqfyV5F3mcHEYyIasRKDM9oEG5pMwK2g3XQDTlwDx7C8%2Bg9dezafxuy1sKcW6b6m2WOnd8qdkgFdVPPb8E4N3o8C7971QLZxg%2BRd5rpL5MKyxXGR9YIooPOKpQYyLY7z2XupNdWIjvlD6YyATQUKTaQBRHKcY8vbo09ZqNo6saEPtozmpG%2FK2JM0gg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230703T121831Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47AM4EPWWD%2F20230703%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=a14dac81168c166c777fb76c9c5b64187febdc1ce23413b659a15cd728a4dbca", + "storage": "S3" + }, + "params": { + "pageActions": [ + { + "rotate": { + "angle": 270, + "pageRanges": [ + { + "start": 1, + "end": 2 + } + ] + } + }, + { + "delete": { + "pageRanges": [ + { + "start": 3, + "end": 4 + } + ] + } + } + ] + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input", + "params" + ], + "additionalProperties": false + }, + "PDFPropertiesInternal": { + "title": "Internal", + "description": "Params for PDF Properties Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "pageLevel": { + "description": "To get page level properties of the PDF.", + "type": "boolean", + "default": false + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "pageLevel": false, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID" + ], + "additionalProperties": false + }, + "PDFPropertiesExternal": { + "title": "External", + "description": "Params for PDF Properties Operation", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "params": { + "description": "Params for PDF Properties processing", + "type": "object", + "properties": { + "pageLevel": { + "description": "To get page level properties of the PDF.", + "type": "boolean", + "default": false + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/d7dc8346-f984-4c05-a276-4a1831a19146?X-Amz-Security-Token=FwoGZXIvYXdzEML%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNgsF%2FxAk7585OhJpSLSAQc%2FNC8n50ag2ut24XYriaC72ihx1vpAniZeiex4DWR6GfqWad%2BLefSSVRdoy3j5ltJnw1eaCuVZ85sKHZru6DTAaXX408Ke%2FRPnf%2BVt7x0ZmZT%2FFLq6R8DKMe82v8%2FeaBkfxsquo5m7CXIg1%2BwBwrQ1dwsBv6FZhxqSDBbtpDRh%2B9Qvjzbw4xybzPWwa8pC8AN3bdd66J6Pa2NQKGtpPfEz6D1kOSqbNwE0m0ysyrLmK%2B2N8O46U2VZMpC6De8zpAHFLw7BirSQtilS0NY%2BNCJ4tSjOioWmBjItbRVda0hvUrHl0C6Sle7nRjw44nXT1mWsBalV9nIKICeKQ5k8h%2Bfuhg21I9lR&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230726T160950Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47JJ34CQOQ%2F20230726%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=f70693e5e6cf429f2f5b99fbdb48aacc7dc0152bec0f26f4e7f9622b159e181a", + "storage": "S3" + }, + "params": { + "pageLevel": false + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input" + ], + "additionalProperties": false + }, + "ProtectPDFInternal": { + "title": "Internal", + "description": "Params for Protect PDF Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "passwordProtection": { + "description": "Enables the use of passwords to encrypt the input PDF document. At least one of userPassword and ownerPassword must be specified and non-empty. Each password can be up to 128 characters in length.", + "anyOf": [ + { + "$ref": "#/components/schemas/userPassword" + }, + { + "$ref": "#/components/schemas/ownerPassword" + } + ] + }, + "encryptionAlgorithm": { + "description": "Sets the encryption algorithm. For AES-128 encryption, the password supports LATIN-I characters only. For AES-256 encryption, the password supports Unicode character set.", + "type": "string", + "enum": [ + "AES_128", + "AES_256" + ] + }, + "contentToEncrypt": { + "description": "Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.", + "type": "string", + "enum": [ + "ALL_CONTENT", + "ALL_CONTENT_EXCEPT_METADATA", + "ONLY_EMBEDDED_FILES" + ], + "default": "ALL_CONTENT" + }, + "permissions": { + "description": "Permissions to allow printing, editing and content copying in the PDF document. By default, none of the specified actions are permitted. PRINT_HIGH_QUALITY permission includes PRINT_LOW_QUALITY permission. EDIT_CONTENT permission includes EDIT_DOCUMENT_ASSEMBLY and EDIT_FILL_AND_SIGN_FORM_FIELDS permissions. Permissions settings will only be used in case the ownerPassword is set.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "PRINT_LOW_QUALITY", + "PRINT_HIGH_QUALITY", + "EDIT_CONTENT", + "EDIT_FILL_AND_SIGN_FORM_FIELDS", + "EDIT_ANNOTATIONS", + "EDIT_DOCUMENT_ASSEMBLY", + "COPY_CONTENT" + ] + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "passwordProtection": { + "ownerPassword": "XXXXXX" + }, + "encryptionAlgorithm": "AES_256", + "contentToEncrypt": "ALL_CONTENT", + "permissions": [ + "PRINT_HIGH_QUALITY", + "EDIT_CONTENT" + ], + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID", + "passwordProtection", + "encryptionAlgorithm" + ], + "additionalProperties": false + }, + "ProtectPDFExternal": { + "title": "External", + "description": "Params for Protect PDF Operation", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Protect PDF processing", + "type": "object", + "properties": { + "passwordProtection": { + "description": "Enables the use of passwords to encrypt the input PDF document. At least one of userPassword and ownerPassword must be specified and non-empty. Each password can be up to 128 characters in length.", + "anyOf": [ + { + "$ref": "#/components/schemas/userPassword" + }, + { + "$ref": "#/components/schemas/ownerPassword" + } + ] + }, + "encryptionAlgorithm": { + "description": "Sets the encryption algorithm. For AES-128 encryption, the password supports LATIN-I characters only. For AES-256 encryption, the password supports Unicode character set.", + "type": "string", + "enum": [ + "AES_128", + "AES_256" + ] + }, + "contentToEncrypt": { + "description": "Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.", + "type": "string", + "enum": [ + "ALL_CONTENT", + "ALL_CONTENT_EXCEPT_METADATA", + "ONLY_EMBEDDED_FILES" + ], + "default": "ALL_CONTENT" + }, + "permissions": { + "description": "Permissions to allow printing, editing and content copying in the PDF document. By default, none of the specified actions are permitted. PRINT_HIGH_QUALITY permission includes PRINT_LOW_QUALITY permission. EDIT_CONTENT permission includes EDIT_DOCUMENT_ASSEMBLY and EDIT_FILL_AND_SIGN_FORM_FIELDS permissions. Permissions settings will only be used in case the ownerPassword is set.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "PRINT_LOW_QUALITY", + "PRINT_HIGH_QUALITY", + "EDIT_CONTENT", + "EDIT_FILL_AND_SIGN_FORM_FIELDS", + "EDIT_ANNOTATIONS", + "EDIT_DOCUMENT_ASSEMBLY", + "COPY_CONTENT" + ] + } + } + }, + "required": [ + "passwordProtection", + "encryptionAlgorithm" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/5744605e-3937-48d8-88c5-96dd84e6b2ac?X-Amz-Security-Token=FwoGZXIvYXdzEPf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDFO%2Fye5bzll%2B8gzn4SLTAXEbkG1qef0EhWfnj%2FrBwcek9ConiBxFQ5Xya89H2u9g4h7Y%2F%2FgbvkwvdwCp0Bh%2BPRiGgapO%2BvhPJmpD2knaa%2FmOFle9l11ya41PjORZca%2FkOCESIbEmrRJ%2FJUIkCwLYfaJ0hQl6JghQW08EsxW0%2BYfKcG%2Bf9f0Dan3p9TgeD2eoJoZXqFfuw5JxaKVU4%2BCHtDxFbUplXOhcskMhjf%2FlY4tXJ%2F3o8a%2BEgkOQLC8U%2BPmjmdiWLWOxI13EbWa3NENaiOfw1WzK%2B%2FNgiBIhM78xPQpkNqwoz6WgpQYyLUc%2FqLVbWpz%2FoQVmuvbSaaRu9vAdowKmLvv%2BjE3nrpyQ7UbqL%2Ftw67ZZgp5R0Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230707T133352Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47F7OL2ZQZ%2F20230707%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b72a7c6e6b875cf8d6f43a6e8b12284476dec9552ba3edb34e83df45dd825a54", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/764630da-70b8-49b1-b35e-7e100063a6b6?X-Amz-Security-Token=FwoGZXIvYXdzEPf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDFO%2Fye5bzll%2B8gzn4SLTAXEbkG1qef0EhWfnj%2FrBwcek9ConiBxFQ5Xya89H2u9g4h7Y%2F%2FgbvkwvdwCp0Bh%2BPRiGgapO%2BvhPJmpD2knaa%2FmOFle9l11ya41PjORZca%2FkOCESIbEmrRJ%2FJUIkCwLYfaJ0hQl6JghQW08EsxW0%2BYfKcG%2Bf9f0Dan3p9TgeD2eoJoZXqFfuw5JxaKVU4%2BCHtDxFbUplXOhcskMhjf%2FlY4tXJ%2F3o8a%2BEgkOQLC8U%2BPmjmdiWLWOxI13EbWa3NENaiOfw1WzK%2B%2FNgiBIhM78xPQpkNqwoz6WgpQYyLUc%2FqLVbWpz%2FoQVmuvbSaaRu9vAdowKmLvv%2BjE3nrpyQ7UbqL%2Ftw67ZZgp5R0Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230707T133354Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47F7OL2ZQZ%2F20230707%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=41cb00193e49b216bd76a49bce1afb55598f72e84ef6d26907e8c76a31f155cc", + "storage": "S3" + }, + "params": { + "passwordProtection":{ + "userPassword": "XXXX", + "ownerPassword": "YYYY" + }, + "encryptionAlgorithm": "AES_256", + "contentToEncrypt": "ALL_CONTENT", + "permissions": ["PRINT_LOW_QUALITY", "PRINT_HIGH_QUALITY", "EDIT_CONTENT", "EDIT_FILL_AND_SIGN_FORM_FIELDS", "EDIT_ANNOTATIONS", "EDIT_DOCUMENT_ASSEMBLY", "COPY_CONTENT"] + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input", + "params", + "passwordProtection", + "encryptionAlgorithm" + ], + "additionalProperties": false + }, + "RemoveProtectionInternal": { + "title": "Internal", + "description": "Params for Remove Protection PDF Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "password": { + "description": "Password required for removing security/permissions from the PDF document.", + "type": "string" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "password": "XXXXX", + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID", + "password" + ], + "additionalProperties": false + }, + "RemoveProtectionExternal": { + "title": "External", + "description": "Params for Remove Protection PDF Operation", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Remove Protection processing.", + "type": "object", + "properties": { + "password": { + "description": "Password required for removing security/permissions from the PDF document.", + "type": "string" + } + }, + "required": [ + "password" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/834084d9-e902-46a0-bfdb-11c9d81cb82d?X-Amz-Security-Token=FwoGZXIvYXdzEPf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDBXjqT4C%2F7joNmRVSCLTAQazARqHHw1uYicsoXFeqvQ8jnZhcxcJkDY3DDIVi1f5%2Bgi5a0Lz%2FRV7yZGkhQ5cK03D7QwWZikWu%2FPlmVWuOMzqCpQk9cF8oRDUfSoKGmkNIbcYchZUfSD3v%2Bk7F82cgRybsBpehOQsZxY67rcoaR4fSHej9UIJLrUaeVERkDcHBVa2Pl0d%2FwF2Wn3zKGP%2BNrDnn2uK51i9Mtq0clCgTfTBCc4Mt6oZYyYXWRQWHqss9bZmW0cOEno2d4e2YwFINolenhOYjVNV6pYOAbidQqkTYcwogKWgpQYyLWivFRFSt91vrkc%2Ba24l55sim59RhLYxeN1c5vKiPuJzzz8Lq4whh6crixrwDg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230707T133502Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47LYI26DU3%2F20230707%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=aac63e7f2a7baef8a07a821fb5b5d7820e1c8287bd75f3ed8604dcb57386e8be", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/e0983a2df4d647a8818e2c5e06f85169_097819C664A2BBC20A49421A%40techacct.adobe.com/cd8ba077-98aa-4f88-b63c-78ef5a18e1b8?X-Amz-Security-Token=FwoGZXIvYXdzEPf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDFO%2Fye5bzll%2B8gzn4SLTAXEbkG1qef0EhWfnj%2FrBwcek9ConiBxFQ5Xya89H2u9g4h7Y%2F%2FgbvkwvdwCp0Bh%2BPRiGgapO%2BvhPJmpD2knaa%2FmOFle9l11ya41PjORZca%2FkOCESIbEmrRJ%2FJUIkCwLYfaJ0hQl6JghQW08EsxW0%2BYfKcG%2Bf9f0Dan3p9TgeD2eoJoZXqFfuw5JxaKVU4%2BCHtDxFbUplXOhcskMhjf%2FlY4tXJ%2F3o8a%2BEgkOQLC8U%2BPmjmdiWLWOxI13EbWa3NENaiOfw1WzK%2B%2FNgiBIhM78xPQpkNqwoz6WgpQYyLUc%2FqLVbWpz%2FoQVmuvbSaaRu9vAdowKmLvv%2BjE3nrpyQ7UbqL%2Ftw67ZZgp5R0Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230707T133505Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47F7OL2ZQZ%2F20230707%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=0ecf516a833436083067fc4b5f8ac3f154e214a74e94c893d106f952401e577a", + "storage": "S3" + }, + "params": { + "password": "XXXX" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input", + "params" + ], + "additionalProperties": false + }, + "SplitPDFInternal": { + "title": "Internal", + "description": "Params for Split PDF Operation.", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "splitoption": { + "description": "Provide option to split the PDF document. Different options for splitting PDF document are mutually exclusive.", + "oneOf": [ + { + "title": "fileCount", + "description": "The number of documents to split the input PDF file into.", + "type": "number" + }, + { + "title": "pageCount", + "description": "The maximum number of pages each of the output files can have.", + "type": "number" + }, + { + "$ref": "#/components/schemas/pageRanges" + } + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "splitoption": { + "pageRanges": [ + { + "start": 1, + "end": 10 + } + ] + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID", + "splitoption" + ], + "additionalProperties": false + }, + "SplitPDFExternal": { + "title": "External", + "description": "Params for Split PDF Operation using external storage.", + "type": "object", + "required": [ + "input", + "params" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutputZip" + }, + "params": { + "description": "Params for Split PDF processing", + "type": "object", + "required": ["splitoption"], + "properties": { + "splitoption": { + "description": "Provide option to split the PDF document. Different options for splitting PDF document are mutually exclusive.", + "oneOf": [ + { + "title": "fileCount", + "description": "The number of documents to split the input PDF file into.", + "type": "number" + }, + { + "title": "pageCount", + "description": "The maximum number of pages each of the output files can have.", + "type": "number" + }, + { + "$ref": "#/components/schemas/pageRanges" + } + ] + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "splitoption": { + "pageRanges": [ + { + "start": 1, + "end": 10 + } + ] + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "DocumentGenerationInternal": { + "title": "Internal", + "description": "Params for Document Generation Operation", + "type": "object", + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "outputFormat": { + "description": "Specifies the target format of the generated output document. Possible values are pdf and docx.", + "type": "string", + "enum": [ + "docx", + "pdf" + ], + "default": "pdf" + }, + "jsonDataForMerge": { + "description": "Specifies the JSON data to merge into the document template.", + "type": "object" + }, + "fragments": { + "description": "Specifies the Fragments JSON object or a JSON array to resolve fragments in the document template. To know more about fragments use-case in document generation and document templates, please see the documentation.", + "type": "object" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "outputFormat": "pdf", + "jsonDataForMerge": { + "customerName": "Kane Miller", + "customerVisits": 100, + "itemsBought": [ + { + "name": "Sprays", + "quantity": 50, + "amount": 100 + }, + { + "name": "Chemicals", + "quantity": 100, + "amount": 200 + } + ], + "totalAmount": 300, + "previousBalance": 50, + "lastThreeBillings": [ + 100, + 200, + 300 + ], + "photograph": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP88h8AAu0B9XNPCQQAAAAASUVORK5CYII=" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "assetID", + "jsonDataForMerge" + ], + "additionalProperties": false + }, + "DocumentGenerationExternal": { + "title": "External", + "description": "Params for Document Generation Operation using external storage", + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Document Generation processing", + "type": "object", + "properties": { + "outputFormat": { + "description": "Specifies the target format of the generated output document. Possible values are pdf and docx.", + "type": "string", + "enum": [ + "docx", + "pdf" + ], + "default": "pdf" + }, + "jsonDataForMerge": { + "description": "Specifies the JSON data to merge into the document template.", + "type": "object" + }, + "fragments": { + "description": "Specifies the Fragments JSON object or a JSON array to resolve fragments in the document template. To know more about fragments use-case in document generation and document templates, please see the documentation.", + "type": "object" + } + }, + "required": [ + "jsonDataForMerge" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcalpine2.sharepoint.com/sites/Docgen/_layouts/15/download.aspx?UniqueId=353087f7-b1ea-4d84-91d7-0821b23e04ea&Translate=false&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvZGNhbHBpbmUyLnNoYXJlcG9pbnQuY29tQGIxYzY2OGZhLTU3YzQtNDBjYy1iZTgyLTg4OWJiYzkxNmM1NiIsImlzcyI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMCIsIm5iZiI6IjE2ODA2MDI5MDkiLCJleHAiOiIxNjgwNjA2NTA5IiwiZW5kcG9pbnR1cmwiOiIwU1NJNDAxdjZhUll6YUIyV2lod005VnIxOVJHNStvSUxFN280dk0yUlMwPSIsImVuZHBvaW50dXJsTGVuZ3RoIjoiMTMzIiwiaXNsb29wYmFjayI6IlRydWUiLCJjaWQiOiJPVEUxTlRZMFkyRXROREZpT1MwME1HSTBMVGczWVdRdFlqaGpaREprWkdNeVlXVTUiLCJ2ZXIiOiJoYXNoZWRwcm9vZnRva2VuIiwic2l0ZWlkIjoiWmpjM1l6QmtNekF0TVRka1lpMDBZalJoTFdFNU5qZ3RZVFJtWkRsaU5qQTRabVJqIiwiYXBwX2Rpc3BsYXluYW1lIjoiU2hhcmVwb2ludC1QT0MiLCJuYW1laWQiOiIyYmVmMjRkNy04OTRlLTQ4MzQtYWQxOC00OGZkNDRiNzk0ZTNAYjFjNjY4ZmEtNTdjNC00MGNjLWJlODItODg5YmJjOTE2YzU2Iiwicm9sZXMiOiJhbGxzaXRlcy5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbGZpbGVzLnJlYWQiLCJ0dCI6IjEiLCJ1c2VQZXJzaXN0ZW50Q29va2llIjpudWxsLCJpcGFkZHIiOiIyMC4xOTAuMTQ1LjE2OSJ9.aStWTExNZ045T3h3OGV4MHdyYURmLzZqOW9McGRhSmtZWStHOE1wM0ZaYz0&ApiVersion=2.0", + "storage": "SHAREPOINT" + }, + "output": { + "uri": "https://dcalpine2.sharepoint.com/sites/Docgen/_api/v2.0/drives/b!MA1899sXSkupaKT9m2CP3JIqXDMQyoBCth9h9Rn6bQRjzBEBFxsbQpN23hY-rzQT/items/01TAIM7P3ZQQ4DP4NZHFDI6FBJPIGFRCY3/uploadSession?guid='2c79b9aa-f9dc-42c8-8919-da5a9b554b81'&overwrite=True&rename=False&dc=0&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvZGNhbHBpbmUyLnNoYXJlcG9pbnQuY29tQGIxYzY2OGZhLTU3YzQtNDBjYy1iZTgyLTg4OWJiYzkxNmM1NiIsImlzcyI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMCIsIm5iZiI6IjE2ODA2MDAyOTMiLCJleHAiOiIxNjgwNjg2NjkzIiwiZW5kcG9pbnR1cmwiOiJXVWNNVHhndVdyMHR4YzhlYWxlRzMrYUV1aXg5anoxanZuRmRpMENjNHFRPSIsImVuZHBvaW50dXJsTGVuZ3RoIjoiMjYxIiwiaXNsb29wYmFjayI6IlRydWUiLCJjaWQiOiJaREZsTURjek5tRXRaREJtWkMwMFlXUXlMV0V5WTJNdE1HRTRPV1prTTJJNU5XTmwiLCJ2ZXIiOiJoYXNoZWRwcm9vZnRva2VuIiwic2l0ZWlkIjoiWmpjM1l6QmtNekF0TVRka1lpMDBZalJoTFdFNU5qZ3RZVFJtWkRsaU5qQTRabVJqIiwiYXBwX2Rpc3BsYXluYW1lIjoiU2hhcmVwb2ludC1QT0MiLCJuYW1laWQiOiIyYmVmMjRkNy04OTRlLTQ4MzQtYWQxOC00OGZkNDRiNzk0ZTNAYjFjNjY4ZmEtNTdjNC00MGNjLWJlODItODg5YmJjOTE2YzU2Iiwicm9sZXMiOiJhbGxzaXRlcy5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbGZpbGVzLnJlYWQiLCJ0dCI6IjEiLCJ1c2VQZXJzaXN0ZW50Q29va2llIjpudWxsLCJpcGFkZHIiOiIyMC4xOTAuMTQ1LjE3MCJ9.a1hxR1J1emlFSE9jSTU0SnFTcFN6TGlsRHNhWTFRaDNkT2hwT3ZPYm8waz0", + "storage": "SHAREPOINT" + }, + "params": { + "outputFormat": "pdf", + "jsonDataForMerge": { + "customerName": "Kane Miller", + "customerVisits": 100, + "itemsBought": [ + { + "name": "Sprays", + "quantity": 50, + "amount": 100 + }, + { + "name": "Chemicals", + "quantity": 100, + "amount": 200 + } + ], + "totalAmount": 300, + "previousBalance": 50, + "lastThreeBillings": [ + 100, + 200, + 300 + ], + "photograph": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP88h8AAu0B9XNPCQQAAAAASUVORK5CYII=" + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "input", + "params" + ], + "additionalProperties": false + }, + "ExternalStorageInput": { + "title": "Input", + "description": "Params representing input object.", + "type": "object", + "properties": { + "uri": { + "description": "Input file Download Signed URI.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DROPBOX", + "BLOB" + ] + } + }, + "required": [ + "uri" + ] + }, + "ExternalStorageOutput": { + "title": "Output", + "description": "Params representing output object", + "type": "object", + "properties": { + "uri": { + "description": "Output file Upload Signed URI.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DROPBOX", + "BLOB" + ] + } + } + }, + "ExternalStorageOutputZip": { + "title": "Output", + "description": "Params representing output object", + "type": "object", + "properties": { + "uri": { + "description": "Output file Upload Signed URI. It should be of format zip only in case of external storage.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DROPBOX", + "BLOB" + ] + } + } + }, + "start": { + "description": "Start page index of this page range.", + "type": "integer" + }, + "end": { + "description": "End page index of this page range.", + "type": "integer" + }, + "delete": { + "type": "object", + "properties": { + "pageRanges": { + "$ref": "#/components/schemas/PageManipulationPageRanges" + } + }, + "required": [ + "pageRanges" + ] + }, + "rotate": { + "type": "object", + "properties": { + "angle": { + "description": "Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees. The valid rotation angles are: 90, 180, 270.", + "type": "number", + "enum": [ + 90, + 180, + 270 + ] + }, + "pageRanges": { + "$ref": "#/components/schemas/PageManipulationPageRanges" + } + }, + "required": [ + "angle", + "pageRanges" + ] + }, + "userPassword": { + "description": "Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.", + "type": "string" + }, + "ownerPassword": { + "description": "Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.", + "type": "string" + }, + "pageRanges": { + "description": "Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.", + "type": "array", + "items": { + "properties": { + "start": { + "description": "Start page of this page range. Page numbers are indexed from 1 to N.", + "type": "number" + }, + "end": { + "description": "End page of this page range. Page numbers are indexed from 1 to N.", + "type": "number" + } + } + } + }, + "CombinePageRanges": { + "title": "pageRanges", + "description": "Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default. An array of ranges to allow specifying which pages to include from the source PDF document.", + "type": "array", + "items": { + "anyOf": [ + { + "title": "start", + "description": "Start page index of this page range.", + "type": "number" + }, + { + "title": "end", + "description": "End page index of this page range.", + "type": "number" + } + ] + } + }, + "CreatePDFPageRange": { + "title": "pageRange", + "description": "Parameters to allow specifying which pages to be included for the PDF document. If pageRange is not provided, all pages are considered by default.", + "type": "object", + "properties": { + "start": { + "description": "Start page of this page range. Page numbers are indexed from 1 to N.", + "type": "number" + }, + "end": { + "description": "End page of this page range. Page numbers are indexed from 1 to N.", + "type": "number" + } + } + }, + "PageAction": { + "title": "pageAction", + "description": "An action to perform on pdf pages", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/delete" + }, + { + "$ref": "#/components/schemas/rotate" + } + ] + }, + "PageManipulationPageRanges": { + "title": "pageRanges", + "description": "Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document.", + "type": "array", + "items": { + "anyOf": [ + { + "title": "start", + "description": "Start page index of this page range.", + "type": "number" + }, + { + "title": "end", + "description": "End page index of this page range.", + "type": "number" + } + ] + } + }, + "ElectronicSealInternal": { + "title": "Internal", + "description": "Params to specify the options required for applying digital seal.", + "type": "object", + "required": [ + "inputDocumentAssetID", + "sealOptions" + ], + "properties": { + "inputDocumentAssetID": { + "description": "A file assetID of a PDF document to which a seal has to be applied. For more details click here .", + "type": "string" + }, + "sealImageAssetID": { + "description": " A file assetID of the logo/watermark/background image to be used as part of the appearance of the seal field. For more details click here . The asset format should be one of the below format \n 1. application/pdf \n2. image/jpeg \n3. image/png.", + "type": "string" + }, + "sealOptions": { + "$ref": "#/components/schemas/sealOptions" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "inputDocumentAssetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "sealImageAssetID": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718", + "sealOptions": { + "signatureFormat": "PKCS7", + "documentLevelPermission": "FORM_FILLING_AND_ANNOTATIONS", + "cscCredentialOptions": { + "credentialId": "[ADOBE]_xxxx_xx:35", + "providerName": "intxxxxxst", + "authorizationContext": { + "accessToken": "b7338a1f-xxxx-xxxx-xxxx-1eec91c47c12" + }, + "credentialAuthParameters": { + "pin": "12xxxx65" + } + }, + "tsaOptions": { + "url": "https://time-xxxxxx-abc.com/tsa", + "credentialAuthParameters": { + "username": "abcxxxxxx123", + "Password": "32@xxxx67" + } + }, + "sealFieldOptions": { + "location": { + "top": 300, + "left": 50, + "right": 250, + "bottom": 100 + }, + "fieldName": "Signature1", + "pageNumber": 1 + }, + "sealAppearanceOptions": { + "displayOptions": [ + "NAME", + "DATE", + "DISTINGUISHED_NAME", + "LABELS", + "SEAL_IMAGE" + ] + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "ElectronicSealExternal": { + "title": "External", + "description": "Params to specify the options required for applying digital seal for external storage.", + "type": "object", + "required": [ + "inputs", + "params" + ], + "properties": { + "inputs": { + "title": "inputs", + "description": "Electronic seal operation object containing input doc and seal image uris respectively.", + "type": "object", + "properties": { + "document": { + "title": "document", + "description": "Params representing input document object.", + "type": "object", + "properties": { + "uri": { + "description": "Input file Download Signed URI.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DROPBOX", + "BLOB" + ] + } + }, + "required": [ + "uri" + ] + }, + "sealImage": { + "title": "sealImage", + "description": "Params representing input seal image object.", + "type": "object", + "properties": { + "uri": { + "description": "Input file Download Signed URI.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DROPBOX", + "BLOB" + ] + } + }, + "required": [ + "uri" + ] + } + }, + "required": [ + "document" + ] + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Electronic Seal processing", + "type": "object", + "properties": { + "sealOptions": { + "$ref": "#/components/schemas/sealOptions" + } + }, + "required": [ + "sealOptions" + ] + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "inputs": { + "document": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "sealImage": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + } + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "sealOptions": { + "signatureFormat": "PKCS7", + "documentLevelPermission": "FORM_FILLING_AND_ANNOTATIONS", + "cscCredentialOptions": { + "credentialId": "[ADOBE]_xxxx_xx:35", + "providerName": "intxxxxxst", + "authorizationContext": { + "accessToken": "b7338a1f-xxxx-xxxx-xxxx-1eec91c47c12" + }, + "credentialAuthParameters": { + "pin": "12xxxx65" + } + }, + "tsaOptions": { + "url": "https://time-xxxxxx-abc.com/tsa", + "credentialAuthParameters": { + "username": "abcxxxxxx123", + "Password": "32@xxxx67" + } + }, + "sealFieldOptions": { + "location": { + "top": 300, + "left": 50, + "right": 250, + "bottom": 100 + }, + "fieldName": "Signature1", + "pageNumber": 1 + }, + "sealAppearanceOptions": { + "displayOptions": [ + "NAME", + "DATE", + "DISTINGUISHED_NAME", + "LABELS", + "SEAL_IMAGE" + ] + } + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "sealInputs" : { + "title": "inputs", + "description": "Array of input object for electronic seal operation containing input doc and seal image uris respectively.", + "type": "object", + "properties": { + "uri": { + "description": "Input file Download Signed URI.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DROPBOX", + "BLOB" + ] + } + } + }, + "sealOptions": { + "title": "sealOptions", + "description": "Specifies all the sealing parameters.", + "type": "object", + "required": [ + "cscCredentialOptions", + "sealFieldOptions" + ], + "properties": { + "signatureFormat": { + "type": "string", + "default": "PKCS7", + "description": "Specifies a supported digital signature format. For supported signature formats, please refer documentation.", + "enum": [ + "PADES", + "PKCS7" + ] + }, + "documentLevelPermission": { + "type": "string", + "default": "FORM_FILLING", + "description": "Specifies the document level permissions for changes allowed after sealing. For more details, please refer documentation.", + "enum": [ + "NO_CHANGES_ALLOWED", + "FORM_FILLING", + "FORM_FILLING_AND_ANNOTATIONS" + ] + }, + "cscCredentialOptions": { + "type": "object", + "description": "Specifies the parameters that encapsulates the signer's certificate credential. For more information, please see the documentation.", + "required": [ + "providerName", + "credentialId", + "authorizationContext", + "credentialAuthParameters" + ], + "properties": { + "providerName": { + "type": "string", + "description": "Specifies the name of the Trust Service Provider. For the list of supported TSPs, please refer documentation." + }, + "credentialId": { + "type": "string", + "description": "Specifies the credential ID stored with the TSP." + }, + "authorizationContext": { + "type": "object", + "description": "Specifies the service authorization data required to communicate with the TSP.", + "required": [ + "accessToken" + ], + "properties": { + "tokenType": { + "type": "string", + "description": "Specifies the type of service access token used to authorize access to the CSC provider hosted APIs.", + "default": "Bearer" + }, + "accessToken": { + "type": "string", + "description": "Specifies the service access token used to authorize access to the CSC provider hosted APIs." + } + } + }, + "credentialAuthParameters": { + "type": "object", + "description": "Specifies the credentials authorization information required to authorize the access to their certificate.", + "required": [ + "pin" + ], + "properties": { + "pin": { + "type": "string", + "description": "Specifies the PIN associated with credential ID." + } + } + } + } + }, + "tsaOptions":{ + "type": "object", + "description": "Specifies the TSA details to be used for timestamping as per RFC3161 standards.", + "properties": { + "url": { + "type": "string", + "description": "Specifies the TSA URL to get timestamp token." + }, + "credentialAuthParameters": { + "type": "object", + "required": [ + "username", + "password" + ], + "properties": { + "username": { + "type": "string", + "description": "Specifies the username required to get the timestamp token." + }, + "password": { + "type": "string", + "description": "Specifies the password required to get the timestamp token." + } + }, + "description": "Specifies the credentials information required to get timestamp token using TSA URL." + } + }, + "required": [ "url" ] + }, + "sealFieldOptions": { + "type": "object", + "description": "Specifies the parameters required to create a new signature field or use an existing field. For more details, please refer documentation.", + "required": [ + "fieldName" + ], + "properties": { + "visible": { + "type": "boolean", + "description": "Specified whether the seal field is visible or not.", + "default": true + }, + "location": { + "type": "object", + "description": "Specifies the coordinates of the signature appearance's bounding box in default PDF user space units. 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.", + "required": [ + "top", + "left", + "right", + "bottom" + ], + "properties": { + "top": { + "type": "integer", + "description": "Specifies the top-most y-coordinate of the seal appearance's bounding box in default PDF user space units." + }, + "left": { + "type": "integer", + "description": "Specifies the left-most x-coordinate of the seal appearance's bounding box in default PDF user space units." + }, + "right": { + "type": "integer", + "description": "Specifies the right-most x-coordinate of the seal appearance's bounding box in default PDF user space units." + }, + "bottom": { + "type": "integer", + "description": "Specifies the bottom-most y-coordinate of the seal appearance's bounding box in default PDF user space units." + } + } + }, + "fieldName": { + "type": "string", + "description": "The signature field's name. This must be a non-empty string. 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." + }, + "pageNumber": { + "type": "integer", + "description": "Specifies 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." + } + } + }, + "sealAppearanceOptions": { + "type": "object", + "description": "Specifies signature field appearance parameters. For more details, please refer documentation.", + "default": { + "displayOptions": [ + "NAME", + "LABELS" + ] + }, + "properties": { + "displayOptions": { + "type": "array", + "description": "Specifies the information to display in the signature. These are an enum set of display items: NAME, DATE, DISTINGUISHED_NAME, LABELS and SEAL_IMAGE.", + "items": { + "type": "string" + }, + "default": ["NAME","LABELS"] + } + } + } + } + }, + "notifiers": { + "description": "Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.", + "type": "array", + "items": { + "properties": { + "type": { + "description": "Specifies the notifier type. Currently supported value is \"CALLBACK\" only.", + "type": "string" + }, + "data": { + "description": "Specifies the data needed to invoke the notifier.", + "type": "object" + } + }, + "required": ["type", "data"] + } + }, + "AutoTagPDFInternal": { + "title": "Internal", + "description": "Parameter for Accessibility Auto-Tag operation.", + "type": "object", + "required": [ + "assetID" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "shiftHeadings": { + "description": "Boolean specifying whether to shift headings.", + "type": "boolean", + "default": false + }, + "generateReport": { + "description": "Boolean specifying whether to generate excel report.", + "type": "boolean", + "default": false + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "shiftHeadings": false, + "generateReport": false, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "AutoTagPDFExternal": { + "title": "External", + "description": "Params for Auto Tag PDF Operation using external storage.", + "type": "object", + "required": [ + "input" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutputZip" + }, + "params": { + "description": "Params for Auto Tag PDF processing", + "type": "object", + "properties": { + "shiftHeadings": { + "description": "Boolean specifying whether to shift headings.", + "type": "boolean", + "default": false + }, + "generateReport": { + "description": "Boolean specifying whether to generate excel report.", + "type": "boolean", + "default": false + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "shiftHeadings": false, + "generateReport": false + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "AccessibilityCheckerInternal": { + "title": "Internal", + "description": "Parameter for PDF Accessibility Checker API operation.", + "type": "object", + "required": [ + "assetID" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "pageStart": { + "description": "The parameter allows for the specification of the starting page for the accessibility check. If \"pageStart\" is not provided, the first page is considered the default startPage. It should be greater than equal to 1.", + "type": "number" + }, + "pageEnd": { + "description": "The parameter allows for the specification of the ending page for the accessibility check. If \"pageEnd\" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1.", + "type": "number" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "pageStart": 1, + "pageEnd": 5, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "AccessibilityCheckerExternal": { + "title": "External", + "description": "Parameter for PDF Accessibility Checker API operation.", + "type": "object", + "required": [ + "input" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutputZip" + }, + "params": { + "description": "Params for Accessibility Checker processing", + "type": "object", + "properties": { + "pageStart": { + "description": "The parameter allows for the specification of the starting page for the accessibility check. If \"pageStart\" is not provided, the first page is considered the default startPage. It should be greater than equal to 1.", + "type": "number" + }, + "pageEnd": { + "description": "The parameter allows for the specification of the ending page for the accessibility check. If \"pageEnd\" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1.", + "type": "number" + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "pageStart": 1, + "pageEnd": 5 + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "AddWatermarkInternal": { + "title": "Internal", + "description": "Params for Watermark Operation", + "type": "object", + "required": [ + "inputDocumentAssetID", + "watermarkDocumentAssetID" + ], + "properties": { + "inputDocumentAssetID": { + "description": "A file assetID of a PDF document on which watermark has to be applied. For more details click here .", + "type": "string" + }, + "watermarkDocumentAssetID": { + "description": "A file assetID of a PDF document whose first page will be used as watermark. The output generated will retain the content and watermark of the first page. For more details click here .", + "type": "string" + }, + "pageRanges": { + "$ref": "#/components/schemas/pageRangesWatermark" + }, + "appearance": { + "$ref": "#/components/schemas/watermarkappearance" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "inputDocumentAssetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "watermarkDocumentAssetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "pageRanges": [ + { + "start": 3, + "end": 7 + }, + { + "start": 9, + "end": 15 + } + ], + "appearance": { + "appearOnForeground": true, + "opacity": 50 + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "AddWatermarkExternal": { + "title": "External", + "description": "Params for Add Watermark Operation using external storage", + "type": "object", + "properties": { + "inputs": { + "title": "inputs", + "description": "Add Watermark operation object containing input document and watermark document uris respectively.", + "type": "object", + "properties": { + "document": { + "title": "document", + "description": "Params representing input document object.", + "type": "object", + "properties": { + "uri": { + "description": "Input file Download Signed URI.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DROPBOX", + "BLOB" + ] + } + }, + "required": [ + "uri" + ] + }, + "watermarkDocument": { + "title": "watermarkDocument", + "description": "Params representing input watermark document object.", + "type": "object", + "properties": { + "uri": { + "description": "Input file Download Signed URI.", + "type": "string" + }, + "storage": { + "description": "Specifies the type of the external storage", + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DROPBOX", + "BLOB" + ] + } + }, + "required": [ + "uri" + ] + } + }, + "required": [ + "document", + "watermarkDocument" + ] + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Watermark processing", + "type": "object", + "properties": { + "pageRanges": { + "$ref": "#/components/schemas/pageRangesWatermark" + }, + "appearance": { + "$ref": "#/components/schemas/watermarkappearance" + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "inputs": { + "document": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "watermarkDocument": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + } + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "pageRanges": [ + { + "start": 3, + "end": 7 + }, + { + "start": 9, + "end": 15 + } + ], + "appearance": { + "appearOnForeground": true, + "opacity": 50 + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "required": [ + "inputs" + ], + "additionalProperties": false + }, + "pageRangesWatermark": { + "title": "pageRanges", + "description": "Specifies the page ranges on which watermark has to be applied in the input PDF file.", + "type": "array", + "items": { + "properties": { + "start": { + "description": "Start page of this page range. Page numbers are indexed from 1 to N.", + "type": "number" + }, + "end": { + "description": "End page of this page range. Page numbers are indexed from 1 to N.", + "type": "number" + } + } + } + }, + "watermarkappearance": { + "title": "appearance", + "type": "object", + "description": "Specifies the appearance parameters for watermark.", + "properties": { + "appearOnForeground": { + "description": "Placement of watermark on the page. Watermark will be either foreground or background on the page. Default is foreground.", + "type": "boolean", + "default": true + }, + "opacity": { + "description": "Percentage value specifying watermark opacity. Specified as an Integer value from 0 to 100.", + "type": "number", + "default": 100 + } + } + }, + "GetFormDataInternal": { + "title": "Internal", + "description": "Parameter for Export PDF Form Data operation.", + "type": "object", + "required": [ + "assetID" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "GetFormDataExternal": { + "title": "External", + "description": "Params for Export PDF Form Data Operation using external storage.", + "type": "object", + "required": [ + "input" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "SetFormDataInternal": { + "title": "Internal", + "description": "Parameter for Import PDF Form Data operation.", + "type": "object", + "required": [ + "assetID", + "jsonFormFieldsData" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "jsonFormFieldsData": { + "description": "A JSON object containing the form data for the PDF. Each key in this object should correspond to a field name in the PDF form (including nested or hierarchical field names), and the associated value should be the data to insert into that field. For example:\n\n```json\n{\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Doe\"\n },\n \"dob\": \"01/14/2025\",\n \"address\": {\n \"city\": \"Springfield\",\n \"state\": \"IL\"\n }\n}\n```\n\nThis JSON corresponds to the following PDF field names:\n\n- name.first\n- name.last\n- dob\n- address.city\n- address.state\n\nThe API will use these key-value pairs to populate the respective fields in the PDF form.", + "type": "object" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "jsonFormFieldsData": { + "dob": "10/10/1989", + "billTo": { + "zip": "12401", + "address": { + "line": { + "1": "132", + "2": "My Street" + } + }, + "city": "Kingston", + "state": "New York" + }, + "name": { + "middle": "", + "last": "Smith", + "first": "John" + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "SetFormDataExternal": { + "title": "External", + "description": "Params for Import PDF Form Data Operation using external storage.", + "type": "object", + "required": [ + "input", + "params" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Import PDF Form Data Operation processing", + "type": "object", + "required": ["jsonFormFieldsData"], + "properties": { + "jsonFormFieldsData": { + "description": "A JSON object containing the form data for the PDF. Each key in this object should correspond to a field name in the PDF form (including nested or hierarchical field names), and the associated value should be the data to insert into that field. For example:\n\n```json\n{\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Doe\"\n },\n \"dob\": \"01/14/2025\",\n \"address\": {\n \"city\": \"Springfield\",\n \"state\": \"IL\"\n }\n}\n```\n\nThis JSON corresponds to the following PDF field names:\n\n- name.first\n- name.last\n- dob\n- address.city\n- address.state\n\nThe API will use these key-value pairs to populate the respective fields in the PDF form.", + "type": "object" + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "jsonFormFieldsData": { + "dob": "10/10/1989", + "billTo": { + "zip": "12401", + "address": { + "line": { + "1": "132", + "2": "My Street" + } + }, + "city": "Kingston", + "state": "New York" + }, + "name": { + "middle": "", + "last": "Smith", + "first": "John" + } + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "GetUploadPresignedUrlAsset": { + "type": "object", + "properties": { + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "uploadUri": { + "description": "The URL used to upload the Resource directly to the cloud provider.", + "type": "string" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "uploadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/aa8d8790-321a-4487-92da-0e90ba931239?X-Amz-Security-Token=FwoGZXIvYXdzEP7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDvZayrA6JI2vhkxPiLTAVI%2Fy0F2v7Us5rBDlEd53dHuO2KAe5Bkbs2AmUHtscOPbsH%2Bzh1aFDnv%2BW2nHAiENSNbV2Auq6b5%2FatImE8hUs2wTwV%2BCSB%2FJb896AF905k%2B9ljhZDty2caFGQSHY2lC2OQ4Rr9%2FdS%2FNKwWgnHr4Ld5AtweavSyfhFMfz%2Fw7zLXvHupnLhOISBqqEOTMQim4YDLGzxIt9%2F4C1MKBUSSdGYBX14rfjTSiB%2FivjjjEdNrRRnkGoIg%2Fxe5b1dFDdgukwXWEBsKtZ2qpmZl2uW1boMTHonQoxMTCmAYyLS2FEiNOvaV7rvm8oy6MtGvv2JVY%2FPz%2FFPab%2BhjsCG60vS3kHih4Zy8rUUKv%2Fw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220901T121500Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IU63S5WX%2F20220901%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5424c781b8671fb1d7e068267af26e9de4d9a606f343c0bb8602d2a70ab52fcd" + } + }, + "GetUploadPresignedUrlRequest": { + "type": "object", + "properties": { + "mediaType": { + "description": "The content type of the file to be stored. For e.g: application/pdf.", + "type": "string" + } + }, + "example": { + "mediaType": "application/pdf" + } + }, + "GetPresignedUrl": { + "type": "object", + "properties": { + "downloadUri": { + "description": "The URL used to download the Resource directly from the storage provider.", + "type": "string" + }, + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string" + } + }, + "example": { + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/a059e98b-43bf-4e76-886b-e61a1a19c7bd?X-Amz-Security-Token=FwoGZXIvYXdzEOz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDJoRurLDIx1KmzjT9yLTAZwtCBavc2xtc6InMLLl2rS480ulHYpVTyWSAtCDj34blxS9sghuPqX%2FwTsvUOJZCvgL8kMqHm0khmO3Pnh1%2FOYU1MksBbAlZ47JExBGdzwIsnh8gMIEXBaty0nVmQjIVLUogOKTIyoBuJsnGDvjytpABIpIzbYH50aTS4yECx42ejL6Po%2F4LOroTO3bv98MuUh05hdiFeoCrTfu29%2FXL5%2FuHXo0R1TfgiNPeR6Riq4PL3v%2BSNzPflWlToGIPtWYMWKuEtIEtK0J2Ut3Bddpxevd%2BxsozM2%2BmAYyLblFR%2BVAADnVcQZDc0fW7A8g9iM9BpKQIgmBY9rJrKjj53%2BFHvDko8%2FbkUlGcA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220831T182204Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47P7L6NLGA%2F20220831%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=298a811048105d8093539c6fab4e8649f96af0fcbad17ee5a716e6175e6e166b", + "size": 13130, + "type": "application/pdf" + } + }, + "AssetMetadata": { + "type": "object", + "properties": { + "entity": { + "description": "Technical Account ID or User ID with access to blob.", + "type": "string" + }, + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The content type of the file. For e.g: application/pdf.", + "type": "string" + } + }, + "example": { + "entity": "49505D56624424F00A49423A@techacct.adobe.com", + "size": 13552, + "type": "application/pdf" + } + }, + "DocumentGenerationJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "CreatePDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "ExportPDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "PDFTOImageJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/PDFToImageDone" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "ExtractPDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/ExtractPDFDone" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "PDFToMarkdownJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "HtmlToPdfJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "CombinePDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "CompressPDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "LinearizePDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "OCRJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "PageManipulationJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "PDFPropertiesJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/PDFPropertiesDone" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "ProtectPDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "RemoveProtectionJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "SplitPDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/splitpdfdone" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "ElectronicSealPDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/ElectronicSealPDFDone" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "AutoTagPDFJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/AutoTagPDFDone" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "AccessibilityCheckerJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/AccessibilityCheckerDone" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "inprogress": { + "description": "Response in case of 'in progress' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "in progress" + ] + } + }, + "example": { + "status": "in progress" + } + }, + "JobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/doneOld" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + + "doneOld": { + "description": "Response in case of 'done' status", + "title": "done", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "$ref": "#/components/schemas/responseAsset" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "done": { + "title": "done", + "oneOf": [ + { + "$ref": "#/components/schemas/internal" + }, + { + "$ref": "#/components/schemas/externalstatus" + } + ] + }, + "internal": { + "title": "Internal", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "$ref": "#/components/schemas/responseAsset" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "externalstatus": { + "title": "External", + "oneOf": [ + { + "$ref": "#/components/schemas/externaldonewithoutoutput" + }, + { + "$ref": "#/components/schemas/external" + } + ] + }, + "externaldonewithoutoutput": { + "title": "External without an output URI in the request", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "$ref": "#/components/schemas/responseAsset" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "external": { + "title": "External with an output URI in the request", + "description": "Response in case of 'done' status using signed urls", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + } + }, + "example": { + "status": "done" + } + }, + "responseAsset": { + "title": "asset", + "description": "Details of output asset document. For more details click here .", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string" + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string", + "required": false + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "responseAssetZip": { + "title": "asset", + "description": "Details of output asset document in zip format. For more details click here .", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string" + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string", + "required": false + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "doneWithMultipleAsset": { + "title": "done", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "assetList": { + "description": "List of assets. For more details click here .", + "type": "array", + "items": [ + { + "$ref": "#/components/schemas/responseAsset" + } + ] + } + }, + "example": { + "status": "done", + "assetList": [ + { + "metadata": { + "type": "image/jpeg", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-43s6-87f2-087832fca718" + }, + { + "metadata": { + "type": "image/jpeg", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + ] + } + }, + "splitpdfdone": { + "title": "done", + "oneOf": [ + { + "$ref": "#/components/schemas/splitpdfdoneInternal" + }, + { + "$ref": "#/components/schemas/splitpdfdoneExternal" + } + ] + }, + "splitpdfdoneInternal": { + "title": "Internal", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "assetList": { + "description": "List of assets. For more details click here .", + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string" + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + } + } + }, + "example": { + "status": "done", + "assetList": [ + { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + }, + { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-96a6-87f2-087832fca718" + } + ] + } + }, + "splitpdfdoneExternal": { + "title": "External", + "oneOf": [ + { + "$ref": "#/components/schemas/splitpdfdoneWithoutOutput" + }, + { + "$ref": "#/components/schemas/external" + } + ] + }, + "splitpdfdoneWithoutOutput" : { + "title": "External without an output URI in the request", + "description": "Response in case of 'done' status when ouput uri is not passed in the rquest", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "$ref": "#/components/schemas/responseAssetZip" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "PDFToImageDone": { + "title": "done", + "oneOf": [ + { + "$ref": "#/components/schemas/PDFTOImageDoneInternal" + }, + { + "$ref": "#/components/schemas/PDFTOImageDoneExternal" + } + ] + }, + "PDFTOImageDoneInternal": { + "title": "Internal", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "assetList": { + "description": "List of assets. Details of output asset document. For more details click here .", + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string" + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + } + } + }, + "example": { + "status": "done", + "assetList": [ + { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + }, + { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-97d3-87f2-087832fca718" + } + ] + } + }, + "PDFTOImageDoneExternal": { + "title": "External", + "oneOf": [ + { + "$ref": "#/components/schemas/PDFTOImageDoneExternalWithoutOutput" + }, + { + "$ref": "#/components/schemas/external" + } + ] + }, + "PDFTOImageDoneExternalWithoutOutput" : { + "title": "External without an output URI in the request", + "description": "Response in case of 'done' status when ouput uri is not passed in the rquest", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "assetList": { + "$ref": "#/components/schemas/responseAssetZip" + } + }, + "example": { + "status": "done", + "assetList": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "PDFPropertiesDone": { + "title": "done", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "metadata": { + "description": "Json containing metadata information about pdf document such as the title, the fonts used, and security settings. ", + "type": "object", + "properties": { + "document": { + "type": "object", + "description": "Details like page count, pdf version, number of times PDF is edited, if it is a XFA, has form fields etc.", + "properties": { + "is_XFA": { + "description": "Document is based on the XFA (Extensible Forms Architecture) format or not", + "type": "boolean" + }, + "has_acroform": { + "description": "If the file contains any form fields.", + "type": "boolean" + }, + "file_size": { + "description": "Size of input PDF file.", + "type": "string" + }, + "has_embedded_files": { + "description": "Document contains embedded files or not.", + "type": "boolean" + }, + "incremental_save_count": { + "description": "Number of times the file is edited and saved.", + "type": "number" + }, + "is_certified": { + "description": "Document has been digitally signed with a certifying signature or not.", + "type": "boolean" + }, + "is_signed": { + "description": "If the PDF file is digitally signed.", + "type": "boolean" + }, + "is_encrypted": { + "description": "If the file is encrypted.", + "type": "boolean" + }, + "is_linearized": { + "description": "If it is a linearized PDF file that makes viewing faster over the Internet.", + "type": "boolean" + }, + "is_portfolio": { + "description": "If it is a portfolio PDF - multiple documents are packaged together into one PDF File.", + "type": "boolean" + }, + "is_tagged": { + "description": "If it is a tagged PDF.", + "type": "boolean" + }, + "is_FTPDF": { + "description": "If it is a Fully Tagged PDF file. ", + "type": "boolean" + }, + "page_count": { + "description": "Number of pages in file.", + "type": "number" + }, + "pdf_version": { + "description": "PDF version of the document.", + "type": "string" + }, + "pdfa_compliance_level": { + "description": "Returns the pdfa compliance level for the input file", + "type": "string" + }, + "pdfe_compliance_level": { + "description": "Returns the pdfe compliance level for the input file", + "type": "string" + }, + "pdfua_compliance_level": { + "description": "Returns the pdfua compliance level for the input file", + "type": "string" + }, + "pdfvt_compliance_level": { + "description": "Returns the pdfvt compliance level for the input file", + "type": "string" + }, + "pdfx_compliance_level": { + "description": "Returns the pdfx compliance level for the input file", + "type": "string" + }, + "fonts": { + "type": "array", + "description": "Tag describing list of fonts in input pdf", + "items": { + "type": "object", + "properties": { + "font_type": { + "description": "Font technology (type) - eg. Type 1, TrueType, OpenType", + "type": "string" + }, + "family_name": { + "description": "Font's family name. Example - For font \"Times Bold Italic\", family name is \"Times\"", + "type": "string" + }, + "name": { + "description": "The PostScript name of the font", + "type": "string" + } + }, + "additionalProperties": false + } + }, + "XMP": { + "description": "Tag describing properties.", + "type": "string" + }, + "info_dict": { + "type": "object", + "description": "Information related to file", + "properties": { + "CreationDate": { + "description": "Date of file creation.", + "type": "string" + }, + "Creator": { + "description": "The one by which the PDF is created. Eg. Adobe Acrobat 21.5.", + "type": "string" + }, + "ModDate": { + "description": "Date when the file is last modified.", + "type": "string" + }, + "Producer": { + "description": "By which we get PDF for example Adobe Acrobat 21.5 Image Conversion Plug-in.", + "type": "string" + }, + "Author": { + "description": "The one who created the PDF.", + "type": "string" + }, + "Title": { + "description": "Title of PDF if there.", + "type": "string" + } + } + } + } + }, + "security_info": { + "type": "object", + "description": "Details related to encryption if it is an encrypted PDF like encrypted for metadata, file attachments, permissions for copying, editing, printing etc.", + "properties": { + "encryption": { + "type": "object", + "description": "Password, encryption algorithm related information.", + "properties": { + "algorithm": { + "description": "Encryption algorithm used like AES", + "type": "string" + }, + "bit_length": { + "description": "The number of bits in a key used by a cryptographic algorithm.", + "type": "number" + }, + "encrypt_attachments_only": { + "description": "If the PDF is encrypted only for file attachments.", + "type": "boolean" + }, + "encrypt_metadata": { + "description": "If the PDF is encrypted for metadata.", + "type": "boolean" + }, + "has_owner_password": { + "description": "If the file has a password for any permissions ( like to edit, copy etc)", + "type": "boolean" + }, + "has_user_password": { + "description": "If the file has a password to open it.", + "type": "boolean" + } + }, + "additionalProperties": false + }, + "permissions": { + "type": "object", + "description": "Permission settings include restricting printing, content copying, editing, page extracting, commenting, etc in the PDF", + "properties": { + "assistive_technology": { + "description": "Whether or not the file will be exposed to a screen reader.", + "type": "boolean" + }, + "form_filling": { + "description": "Permission for filling in form fields.", + "type": "boolean" + }, + "copying": { + "description": "Permission for copying the content of file.", + "type": "boolean" + }, + "page_extraction": { + "description": "Permission for extracting pages.", + "type": "boolean" + }, + "document_assembly": { + "description": "Permission for adding or inserting pages.", + "type": "boolean" + }, + "commenting": { + "description": "Permission to add comments to file.", + "type": "boolean" + }, + "printing": { + "description": "Permission for printing the file.", + "type": "string" + }, + "editing": { + "description": "Permission for editing the content in file.", + "type": "boolean" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + }, + "pages": { + "type": "array", + "description": "Json array consisting page level properties", + "items": { + "type": "object", + "properties": { + "page_number": { + "description": "Page number starting from 0.", + "type": "number" + }, + "is_scanned": { + "description": "If the page is scanned or not.", + "type": "boolean" + }, + "has_structure": { + "description": "If the page has structure/tagging.", + "type": "boolean" + }, + "height": { + "description": "Dimension of the page.", + "type": "number" + }, + "width": { + "description": "Dimension of the page.", + "type": "number" + }, + "content": { + "type": "object", + "properties": { + "is_empty": { + "description": "If it is an empty/blank page.", + "type": "boolean" + }, + "has_images": { + "description": "If the page has any images.", + "type": "boolean" + }, + "number_of_images": { + "description": "Number of images in that page.", + "type": "number" + }, + "only_images": { + "description": "If the page consists only images.", + "type": "boolean" + }, + "has_text": { + "description": "If the pages has any text.", + "type": "boolean" + } + } + } + }, + "additionalProperties": false + } + } + } + } + }, + "example": { + "status": "done", + "metadata": { + "pages": [ + { + "page_number": 0, + "is_scanned": false, + "width": 595.0, + "has_structure": false, + "content": { + "number_of_images": 0, + "only_images": false, + "has_text": true, + "has_images": false, + "is_empty": false + }, + "height": 842.0 + } + ], + "document": { + "is_linearized": false, + "pdfe_compliance_level": "", + "is_tagged": false, + "is_portfolio": false, + "is_certified": false, + "is_encrypted": false, + "info_dict": { + "CreationDate": null, + "Producer": null, + "Creator": null, + "ModDate": null + }, + "is_FTPDF": false, + "pdf_version": "1.6", + "has_acroform": false, + "file_size": "4550.09 KB", + "is_signed": false, + "incremental_save_count": 0, + "has_embedded_files": false, + "is_XFA": false, + "fonts": [ + { + "name": "BAAAAA+LiberationSans-Bold", + "font_type": "TrueType", + "family_name": "Liberation Sans" + } + ], + "pdfa_compliance_level": "", + "pdfvt_compliance_level": "", + "pdfx_compliance_level": "", + "pdfua_compliance_level": "", + "XMP": null, + "page_count": 101, + "signature_details": [ + { + "signee_name": "Signed by Simon Haringa", + "signing_date_time": "Jul 18, 2023 11:31:33 +0000", + "signature_type": "UNKNOWN", + "cert_info": { + "valid_from": "Apr 26, 2019 18:00:25 +0000", + "valid_upto": "Apr 24, 2024 18:00:25 +0000", + "cert_status": "UNKNOWN", + "trust_sources": [ + "UNKNOWN" + ] + } + }, + { + "signee_name": "Signed by Simon Alex Haringa", + "signing_date_time": "Jul 18, 2023 11:32:38 +0000", + "signature_type": "QES", + "cert_info": { + "valid_from": "Nov 15, 2022 11:50:02 +0000", + "valid_upto": "Nov 15, 2023 11:50:02 +0000", + "cert_status": "VALID", + "trust_sources": [ + "AATL", + "EUTL" + ] + } + }, + { + "signee_name": "Certified by Adobe Acrobat Sign", + "signing_date_time": "Jul 21, 2023 08:14:50 +0000", + "signature_type": "UNKNOWN", + "cert_info": { + "valid_from": "Dec 20, 2022 00:00:00 +0000", + "valid_upto": "Dec 19, 2025 23:59:59 +0000", + "cert_status": "UNKNOWN", + "trust_sources": [ + "UNKNOWN" + ] + } + }, + { + "signee_name": "Signed by Adobe Acrobat Sign", + "signing_date_time": "Jul 21, 2023 08:14:51 +0000", + "signature_type": "UNKNOWN", + "cert_info": { + "valid_from": "Dec 20, 2022 00:00:00 +0000", + "valid_upto": "Dec 19, 2025 23:59:59 +0000", + "cert_status": "UNKNOWN", + "trust_sources": [ + "UNKNOWN" + ] + } + } + ] + }, + "permissions": null + } + } + }, + "ExtractPDFDone": { + "title": "done", + "oneOf": [ + { + "$ref": "#/components/schemas/ExtractPDFDoneInternal" + }, + { + "$ref": "#/components/schemas/ExtractPDFDoneExternal" + } + ] + }, + "PDFToMarkdownDone": { + "title": "done", + "oneOf": [ + { + "$ref": "#/components/schemas/PDFToMarkdownDoneInternal" + }, + { + "$ref": "#/components/schemas/PDFToMarkdownDoneExternal" + } + ] + }, + "ExtractPDFDoneInternal": { + "title": "Internal", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "content": { + "type": "object", + "description": "Asset of json file containig extracted content of pdf file. For more details click here .", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string", + "enum": [ + "application/json" + ] + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + }, + "resource": { + "type": "object", + "description": "Asset of zip file containg generated resources from extract operation. For more details click here .", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string", + "enum": [ + "application/json" + ] + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + } + }, + "example": { + "status": "done", + "content": { + "metadata": { + "type": "application/json", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + }, + "resource": { + "metadata": { + "type": "application/zip", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-32s3-46d6-87f2-087832fca718" + } + } + }, + "PDFToMarkdownDoneInternal": { + "title": "Internal", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "type": "object", + "description": "Asset of markdown file containing converted content of pdf file. For more details click here .", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string", + "enum": [ + "text/markdown" + ] + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "text/markdown", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "PDFToMarkdownDoneExternal": { + "title": "External", + "oneOf": [ + { + "$ref": "#/components/schemas/PDFToMarkdownDoneExternalWithoutOutput" + }, + { + "$ref": "#/components/schemas/external" + } + ] + }, + "PDFToMarkdownDoneExternalWithoutOutput": { + "title": "External without an output URI in the request", + "description": "Response in case of 'done' status when ouput uri is not passed in the rquest", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "$ref": "#/components/schemas/responseAsset" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "text/markdown", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "ExtractPDFDoneExternalWithoutOutput" : { + "title": "External without an output URI in the request", + "description": "Response in case of 'done' status when ouput uri is not passed in the rquest", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "resource": { + "$ref": "#/components/schemas/responseAssetZip" + } + }, + "example": { + "status": "done", + "resource": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "AutoTagPDFDone": { + "title": "done", + "oneOf": [ + { + "$ref": "#/components/schemas/AutoTagPDFDoneInternal" + }, + { + "$ref": "#/components/schemas/AutoTagPDFDoneExternal" + } + ] + }, + "AutoTagPDFDoneInternal": { + "title": "Internal", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "tagged-pdf": { + "type": "object", + "description": "Asset of tagged pdf file. Details of output asset document. For more details click here .", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string", + "enum": [ + "application/pdf" + ] + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + }, + "report": { + "type": "object", + "description": "Asset of accessibility auto-tag report. Details of output asset document. For more details click here .", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string", + "enum": [ + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" + ] + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + } + }, + "example": { + "status": "done", + "tagged-pdf": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + }, + "report": { + "metadata": { + "type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c6d-46d6-87f2-087832fca718" + } + } + }, + "AutoTagPDFDoneExternal": { + "title": "External", + "oneOf": [ + { + "$ref": "#/components/schemas/AutoTagPDFDoneExternalWithoutOutput" + }, + { + "$ref": "#/components/schemas/external" + } + ] + }, + "AutoTagPDFDoneExternalWithoutOutput" : { + "title": "External without an output URI in the request", + "description": "Response in case of 'done' status when ouput uri is not passed in the request", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "resource": { + "$ref": "#/components/schemas/responseAssetZip" + } + }, + "example": { + "status": "done", + "resource": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "AccessibilityCheckerDoneInternal": { + "title": "Internal", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "type": "object", + "description": "Input PDF file with an attached HTML report detailing the results of the accessibility check. For more details click here .", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string", + "enum": [ + "application/pdf" + ] + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + }, + "report": { + "type": "object", + "description": "JSON file containing detailed information and findings from the accessibility evaluation. For more details click here .", + "properties": { + "metadata": { + "type": "object", + "description": "metadata details of output asset.", + "properties": { + "size": { + "description": "The size of the Resource in bytes. This value helps in making range requests.", + "type": "integer" + }, + "type": { + "description": "The media type of the Resource.", + "type": "string", + "enum": [ + "application/json" + ] + } + } + }, + "assetID": { + "description": "An asset ID identifying an asset that is globally unique and never reused.", + "type": "string" + }, + "downloadUri": { + "description": "The URL used to download the Resource directly to the cloud provider.", + "type": "string" + } + } + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + }, + "report": { + "metadata": { + "type": "application/json", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c6d-46d6-87f2-087832fca718" + } + } + }, + "AccessibilityCheckerDone": { + "title": "done", + "oneOf": [ + { + "$ref": "#/components/schemas/AccessibilityCheckerDoneInternal" + }, + { + "$ref": "#/components/schemas/externalstatus" + } + ] + }, + "AddWatermarkJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "GetFormDataJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "SetFormDataJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "ElectronicSealPDFDone": { + "title": "done", + "oneOf": [ + { + "$ref": "#/components/schemas/ElectronicSealPDFDoneInternal" + }, + { + "$ref": "#/components/schemas/ElectronicSealPDFDoneExternal" + } + ] + }, + "ElectronicSealPDFDoneInternal" : { + "title": "Internal", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "$ref": "#/components/schemas/responseAsset" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "ElectronicSealPDFDoneExternal": { + "title": "External", + "oneOf": [ + { + "$ref": "#/components/schemas/ElectronicSealPDFDoneExternalWithoutOutput" + }, + { + "$ref": "#/components/schemas/external" + } + ] + }, + "ElectronicSealPDFDoneExternalWithoutOutput" : { + "title": "External without an output URI in the request", + "description": "Response in case of 'done' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "done" + ] + }, + "asset": { + "$ref": "#/components/schemas/responseAsset" + } + }, + "example": { + "status": "done", + "asset": { + "metadata": { + "type": "application/pdf", + "size": 200791 + }, + "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56", + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718" + } + } + }, + "failed": { + "description": "Response in case of 'failed' status", + "type": "object", + "properties": { + "status": { + "description": "Job Status", + "type": "string", + "enum": [ + "failed" + ] + }, + "error": { + "type": "object", + "properties": { + "status": { + "description": "Http status code returned by the service", + "type": "integer" + }, + "code": { + "description": "The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.", + "type": "string" + }, + "message": { + "description": "An English language string that contains more information about the error. \n\n
statuscodemessage
400CORRUPT_DOCUMENTFor $(format) mime-type The input file appears to be corrupted and cannot be processed.
400PASSWORD_PROTECTEDSource file is protected and cannot be processed.
500INTERNAL_SERVER_ERRORThere was an error processing your request.
", + "type": "string" + } + } + } + }, + "example": { + "status": "failed", + "error": { + "status": 500, + "code": "INTERNAL_SERVER_ERROR", + "message": "There was an error processing your request" + } + } + } + } + } +} diff --git a/lib/pdfservices.rb b/lib/pdfservices.rb index 27bd0c9..303a0aa 100644 --- a/lib/pdfservices.rb +++ b/lib/pdfservices.rb @@ -2,7 +2,6 @@ require "http" require "json" -require "jwt" require "multipart_parser/reader" require "yaml" require "pdfservices/version" @@ -10,7 +9,7 @@ module PdfServices autoload :CredentialsBuilder, "pdfservices/credentials_builder" autoload :Credentials, "pdfservices/credentials" - autoload :JwtProvider, "pdfservices/jwt_provider" + autoload :OauthProvider, "pdfservices/oauth_provider" module DocumentMerge autoload :Operation, "pdfservices/document_merge/operation" diff --git a/lib/pdfservices/credentials.rb b/lib/pdfservices/credentials.rb index 5883608..4e7c03d 100644 --- a/lib/pdfservices/credentials.rb +++ b/lib/pdfservices/credentials.rb @@ -4,14 +4,11 @@ module PdfServices class Credentials - attr_accessor :client_id, :client_secret, :organization_id, :account_id, :private_key + attr_accessor :client_id, :client_secret - def initialize(client_id: nil, client_secret: nil, organization_id: nil, account_id: nil, private_key: nil) + def initialize(client_id: nil, client_secret: nil) @client_id = client_id @client_secret = client_secret - @organization_id = organization_id - @account_id = account_id - @private_key = private_key end end end diff --git a/lib/pdfservices/credentials_builder.rb b/lib/pdfservices/credentials_builder.rb index 76307df..520b87f 100644 --- a/lib/pdfservices/credentials_builder.rb +++ b/lib/pdfservices/credentials_builder.rb @@ -8,9 +8,6 @@ class CredentialsBuilder def initialize @client_id = nil @client_secret = nil - @organization_id = nil - @account_id = nil - @private_key = nil end def with_client_id(client_id) @@ -23,39 +20,17 @@ def with_client_secret(client_secret) self end - def with_organization_id(organization_id) - @organization_id = organization_id - self - end - - def with_account_id(account_id) - @account_id = account_id - self - end - - def with_private_key(private_key) - @private_key = private_key - self - end - def from_file(file_path) credentials = JSON.parse(File.read(file_path)) - private_key = File.read(credentials["service_account_credentials"]["private_key_file"]) - with_client_id(credentials["client_credentials"]["client_id"]) - with_client_secret(credentials["client_credentials"]["client_secret"]) - with_organization_id(credentials["service_account_credentials"]["organization_id"]) - with_account_id(credentials["service_account_credentials"]["account_id"]) - with_private_key(private_key) + with_client_id(credentials["client_id"]) + with_client_secret(credentials["client_secret"]) self end def build ::PdfServices::Credentials.new( client_id: @client_id, - client_secret: @client_secret, - organization_id: @organization_id, - account_id: @account_id, - private_key: @private_key + client_secret: @client_secret ) end end diff --git a/lib/pdfservices/document_merge/operation.rb b/lib/pdfservices/document_merge/operation.rb index da05628..9962381 100644 --- a/lib/pdfservices/document_merge/operation.rb +++ b/lib/pdfservices/document_merge/operation.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true require "http" -require "pdfservices/jwt_provider" +require "pdfservices/oauth_provider" require "pdfservices/document_merge/result" require "yaml" @@ -64,7 +64,7 @@ def execute def api_headers { - Authorization: "Bearer #{JwtProvider.get_jwt(@credentials)}", + Authorization: "Bearer #{OauthProvider.get_token(@credentials)}", "x-api-key": @credentials.client_id, "Content-Type": "application/json" } diff --git a/lib/pdfservices/html_to_pdf/operation.rb b/lib/pdfservices/html_to_pdf/operation.rb index b97f144..60ee5be 100644 --- a/lib/pdfservices/html_to_pdf/operation.rb +++ b/lib/pdfservices/html_to_pdf/operation.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true require "http" -require "pdfservices/jwt_provider" +require "pdfservices/oauth_provider" require "pdfservices/html_to_pdf/result" require "yaml" @@ -64,7 +64,7 @@ def execute def api_headers { - Authorization: "Bearer #{JwtProvider.get_jwt(@credentials)}", + Authorization: "Bearer #{OauthProvider.get_token(@credentials)}", "x-api-key": @credentials.client_id, "Content-Type": "application/json" } diff --git a/lib/pdfservices/jwt_provider.rb b/lib/pdfservices/jwt_provider.rb deleted file mode 100644 index 4c6b3a5..0000000 --- a/lib/pdfservices/jwt_provider.rb +++ /dev/null @@ -1,40 +0,0 @@ -# frozen_string_literal: true - -require "http" -require "json" -require "jwt" -require "yaml" - -module PdfServices - class JwtProvider - ROOT = "https://ims-na1.adobelogin.com/" - ENDPOINT = "#{ROOT}ims/exchange/jwt/" - SCOPE = "#{ROOT}s/ent_documentcloud_sdk" - - def self.get_jwt(credentials) - payload = { - :exp => Time.now.to_i + 3600, - :iss => credentials.organization_id, - :sub => credentials.account_id, - :aud => "#{ROOT}c/#{credentials.client_id}", - SCOPE => true - } - key = OpenSSL::PKey::RSA.new(credentials.private_key) - jwt = JWT.encode(payload, key, "RS256") - url = ENDPOINT - form = { - client_id: credentials.client_id, - client_secret: credentials.client_secret, - jwt_token: jwt - } - response = HTTP.post(url, form: form) - if response.status == 200 - response_json = JSON.parse(response.body.to_s) - response_json["access_token"] - else - error_description = JSON.parse(response.body.to_s).fetch("error_description", "unknown error") - raise error_description - end - end - end -end diff --git a/lib/pdfservices/oauth_provider.rb b/lib/pdfservices/oauth_provider.rb new file mode 100644 index 0000000..801c1b6 --- /dev/null +++ b/lib/pdfservices/oauth_provider.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require "http" +require "json" + +module PdfServices + class OauthProvider + IMS_ROOT = "https://ims-na1.adobelogin.com/" + TOKEN_ENDPOINT = "#{IMS_ROOT}ims/token/v3" + SCOPE = "openid,AdobeID,DCAPI,additional_info.projectedProductContext" + + def self.get_token(credentials) + response = HTTP.post(TOKEN_ENDPOINT, form: { + grant_type: "client_credentials", + client_id: credentials.client_id, + client_secret: credentials.client_secret, + scope: SCOPE + }) + if response.status == 200 + JSON.parse(response.body.to_s)["access_token"] + else + error_description = JSON.parse(response.body.to_s).fetch("error_description", "unknown error") + raise error_description + end + end + end +end diff --git a/lib/pdfservices/ocr/operation.rb b/lib/pdfservices/ocr/operation.rb index 83e20f2..831ce83 100644 --- a/lib/pdfservices/ocr/operation.rb +++ b/lib/pdfservices/ocr/operation.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true require "http" -require "pdfservices/jwt_provider" +require "pdfservices/oauth_provider" require "pdfservices/ocr/result" require "yaml" @@ -57,7 +57,7 @@ def execute(source_pdf) def api_headers { - Authorization: "Bearer #{JwtProvider.get_jwt(@credentials)}", + Authorization: "Bearer #{OauthProvider.get_token(@credentials)}", "x-api-key": @credentials.client_id, "Content-Type": "application/json" } diff --git a/lib/pdfservices/version.rb b/lib/pdfservices/version.rb index 70ab4ad..fc40d0e 100644 --- a/lib/pdfservices/version.rb +++ b/lib/pdfservices/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module PdfServices - VERSION = "0.2.2" + VERSION = "0.3.0" end diff --git a/pdfservices-ruby-sdk.gemspec b/pdfservices-ruby-sdk.gemspec index 51aa9d3..1bfef99 100644 --- a/pdfservices-ruby-sdk.gemspec +++ b/pdfservices-ruby-sdk.gemspec @@ -12,9 +12,7 @@ Gem::Specification.new do |spec| spec.description = "An Adobe PDF Services Ruby SDK provides APIs for creating, combining, exporting and manipulating PDFs." spec.homepage = "https://github.com/ARPC/PdfServices-ruby-sdk/blob/main/README.md" spec.license = "MIT" - spec.required_ruby_version = ">= 2.6.0" - - spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'" + spec.required_ruby_version = ">= 3.3.4" spec.metadata["homepage_uri"] = spec.homepage spec.metadata["source_code_uri"] = "https://github.com/ARPC/PdfServices-ruby-sdk" @@ -32,7 +30,6 @@ Gem::Specification.new do |spec| # Uncomment to register a new dependency of your gem # spec.add_dependency "example-gem", "~> 1.0" spec.add_dependency "json", "~> 2.6" - spec.add_dependency "jwt", [">= 1.0", "< 3.0"] spec.add_dependency "http", "~> 5.1" spec.add_dependency "multipart-parser", "~> 0.1" diff --git a/test/fixtures/files/pdfservices-api-credentials.json b/test/fixtures/files/pdfservices-api-credentials.json index 5cbc153..e64dc97 100644 --- a/test/fixtures/files/pdfservices-api-credentials.json +++ b/test/fixtures/files/pdfservices-api-credentials.json @@ -1,11 +1,4 @@ { - "client_credentials": { - "client_id": "123someclientid", - "client_secret": "123-somesecret!" - }, - "service_account_credentials": { - "organization_id": "123@AdobeOrg", - "account_id": "456@techacct.adobe.com", - "private_key_file": "test/fixtures/files/private.key" - } + "client_id": "123someclientid", + "client_secret": "123-somesecret!" } diff --git a/test/fixtures/invalid_oauth_response.json b/test/fixtures/invalid_oauth_response.json new file mode 100644 index 0000000..090623b --- /dev/null +++ b/test/fixtures/invalid_oauth_response.json @@ -0,0 +1,4 @@ +{ + "error_description": "The client credentials are invalid", + "error": "invalid_client" +} diff --git a/test/fixtures/valid_oauth_response.json b/test/fixtures/valid_oauth_response.json new file mode 100644 index 0000000..42d370d --- /dev/null +++ b/test/fixtures/valid_oauth_response.json @@ -0,0 +1,5 @@ +{ + "token_type": "bearer", + "access_token": "fake1.fake2.fake3", + "expires_in": 86399998 +} diff --git a/test/pdf_services_sdk/test_credentials.rb b/test/pdf_services_sdk/test_credentials.rb index c6b0758..0bfe50e 100644 --- a/test/pdf_services_sdk/test_credentials.rb +++ b/test/pdf_services_sdk/test_credentials.rb @@ -6,16 +6,10 @@ class CredentialsTest < Minitest::Test def test_it_has_the_fields credentials = ::PdfServices::Credentials.new( client_id: "client_id", - client_secret: "client_secret", - organization_id: "organization_id", - account_id: "account_id", - private_key: "private_key" + client_secret: "client_secret" ) assert credentials.client_id == "client_id" assert credentials.client_secret == "client_secret" - assert credentials.organization_id == "organization_id" - assert credentials.account_id == "account_id" - assert credentials.private_key == "private_key" end end diff --git a/test/pdf_services_sdk/test_credentials_builder.rb b/test/pdf_services_sdk/test_credentials_builder.rb index 55a847f..e928341 100644 --- a/test/pdf_services_sdk/test_credentials_builder.rb +++ b/test/pdf_services_sdk/test_credentials_builder.rb @@ -8,9 +8,6 @@ def test_it_is_empty_when_initialized assert builder.instance_variable_get(:@client_id).nil? assert builder.instance_variable_get(:@client_secret).nil? - assert builder.instance_variable_get(:@organization_id).nil? - assert builder.instance_variable_get(:@account_id).nil? - assert builder.instance_variable_get(:@private_key).nil? end def test_with_client_id_sets_client_id @@ -25,46 +22,19 @@ def test_with_client_secret_sets_client_secret assert builder.instance_variable_get(:@client_secret) == "123someclientsecret" end - def test_with_organization_id_sets_organization_id - builder = ::PdfServices::CredentialsBuilder.new.with_organization_id("123someorganizationid") - - assert builder.instance_variable_get(:@organization_id) == "123someorganizationid" - end - - def test_with_account_id_sets_account_id - builder = ::PdfServices::CredentialsBuilder.new.with_account_id("123someaccountid") - - assert builder.instance_variable_get(:@account_id) == "123someaccountid" - end - - def test_with_private_key_sets_private_key - builder = ::PdfServices::CredentialsBuilder.new.with_private_key("123someprivatekey") - - assert builder.instance_variable_get(:@private_key) == "123someprivatekey" - end - def test_from_file_sets_all_fields builder = ::PdfServices::CredentialsBuilder.new.from_file("test/fixtures/files/pdfservices-api-credentials.json") assert builder.instance_variable_get(:@client_id) == "123someclientid" assert builder.instance_variable_get(:@client_secret) == "123-somesecret!" - assert builder.instance_variable_get(:@organization_id) == "123@AdobeOrg" - assert builder.instance_variable_get(:@account_id) == "456@techacct.adobe.com" - assert !builder.instance_variable_get(:@private_key).nil? end def test_chaining_method builder = ::PdfServices::CredentialsBuilder.new .with_client_id("123someclientid") .with_client_secret("123someclientsecret") - .with_organization_id("123someorganizationid") - .with_account_id("123someaccountid") - .with_private_key("123someprivatekey") assert builder.instance_variable_get(:@client_id) == "123someclientid" assert builder.instance_variable_get(:@client_secret) == "123someclientsecret" - assert builder.instance_variable_get(:@organization_id) == "123someorganizationid" - assert builder.instance_variable_get(:@account_id) == "123someaccountid" - assert builder.instance_variable_get(:@private_key) == "123someprivatekey" end end diff --git a/test/pdf_services_sdk/test_document_merge.rb b/test/pdf_services_sdk/test_document_merge.rb index 571fc0a..a67f738 100644 --- a/test/pdf_services_sdk/test_document_merge.rb +++ b/test/pdf_services_sdk/test_document_merge.rb @@ -31,9 +31,9 @@ def test_it_works private def stub_valid_response_sequence - # get JWT for requests - stub_request(:post, "https://ims-na1.adobelogin.com/ims/exchange/jwt/") - .to_return(status: 200, body: json_fixture("valid_jwt_response")) + # get OAuth token for requests + stub_request(:post, "https://ims-na1.adobelogin.com/ims/token/v3") + .to_return(status: 200, body: json_fixture("valid_oauth_response")) # get a presigned url to upload the source pdf stub_request(:post, "https://pdf-services.adobe.io/assets") diff --git a/test/pdf_services_sdk/test_html_to_pdf.rb b/test/pdf_services_sdk/test_html_to_pdf.rb index ad5e9ec..547696c 100644 --- a/test/pdf_services_sdk/test_html_to_pdf.rb +++ b/test/pdf_services_sdk/test_html_to_pdf.rb @@ -30,9 +30,9 @@ def test_it_works private def stub_valid_response_sequence - # get JWT for requests - stub_request(:post, "https://ims-na1.adobelogin.com/ims/exchange/jwt/") - .to_return(status: 200, body: json_fixture("valid_jwt_response")) + # get OAuth token for requests + stub_request(:post, "https://ims-na1.adobelogin.com/ims/token/v3") + .to_return(status: 200, body: json_fixture("valid_oauth_response")) # get a presigned url to upload the source pdf stub_request(:post, "https://pdf-services.adobe.io/assets") diff --git a/test/pdf_services_sdk/test_jwt_provider.rb b/test/pdf_services_sdk/test_jwt_provider.rb deleted file mode 100644 index 996dfd9..0000000 --- a/test/pdf_services_sdk/test_jwt_provider.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -require "test_helper" - -class JwtProviderTest < Minitest::Test - def test_it_returns_a_jwt_token - stub_valid_response - jwt = ::PdfServices::JwtProvider.get_jwt(valid_credentials) - assert_equal "fake1.fake2.fake3", jwt - end - - def test_it_raises_an_error_if_other_than_200 - stub_invalid_response - error = assert_raises RuntimeError do - _jwt = ::PdfServices::JwtProvider.get_jwt(valid_credentials) - end - assert_equal "The JWT subject is invalid", error.message - end - - private - - def stub_jwt_request - stub_request(:post, "https://ims-na1.adobelogin.com/ims/exchange/jwt/") - end - - def stub_valid_response - stub_jwt_request.to_return(status: 200, body: json_fixture("valid_jwt_response")) - end - - def stub_invalid_response - stub_jwt_request.to_return(status: 400, body: json_fixture("invalid_jwt_response")) - end - - def valid_credentials - ::PdfServices::CredentialsBuilder.new.from_file("test/fixtures/files/pdfservices-api-credentials.json").build - end -end diff --git a/test/pdf_services_sdk/test_oauth_provider.rb b/test/pdf_services_sdk/test_oauth_provider.rb new file mode 100644 index 0000000..1bb3ae8 --- /dev/null +++ b/test/pdf_services_sdk/test_oauth_provider.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +require "test_helper" + +class OauthProviderTest < Minitest::Test + def test_it_returns_an_access_token + stub_valid_response + token = ::PdfServices::OauthProvider.get_token(valid_credentials) + assert_equal "fake1.fake2.fake3", token + end + + def test_it_raises_an_error_if_other_than_200 + stub_invalid_response + error = assert_raises RuntimeError do + _token = ::PdfServices::OauthProvider.get_token(valid_credentials) + end + assert_equal "The client credentials are invalid", error.message + end + + private + + def stub_token_request + stub_request(:post, "https://ims-na1.adobelogin.com/ims/token/v3") + end + + def stub_valid_response + stub_token_request.to_return(status: 200, body: json_fixture("valid_oauth_response")) + end + + def stub_invalid_response + stub_token_request.to_return(status: 400, body: json_fixture("invalid_oauth_response")) + end +end diff --git a/test/pdf_services_sdk/test_ocr.rb b/test/pdf_services_sdk/test_ocr.rb index e890ac2..5943083 100644 --- a/test/pdf_services_sdk/test_ocr.rb +++ b/test/pdf_services_sdk/test_ocr.rb @@ -24,9 +24,9 @@ def test_it_works private def stub_valid_response_sequence - # get JWT for requests - stub_request(:post, "https://ims-na1.adobelogin.com/ims/exchange/jwt/") - .to_return(status: 200, body: json_fixture("valid_jwt_response")) + # get OAuth token for requests + stub_request(:post, "https://ims-na1.adobelogin.com/ims/token/v3") + .to_return(status: 200, body: json_fixture("valid_oauth_response")) # get a presigned url to upload the source pdf stub_request(:post, "https://pdf-services.adobe.io/assets")