The Official PandaDoc Java client SDK

PandaDoc SDK spans a broad range of functionality to help you build incredible documents automation experiences inside your product.

Docs

• Official public API documentation

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.pandadoc</groupId>
  <artifactId>pandadoc-java-client</artifactId>
  <version>6.2.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.pandadoc:pandadoc-java-client:6.2.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/pandadoc-java-client-6.2.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.pandadoc.client.ApiClient;
import com.pandadoc.client.ApiException;
import com.pandadoc.client.Configuration;
import com.pandadoc.client.auth.*;
import com.pandadoc.client.models.*;
import com.pandadoc.client.api.TemplatesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.pandadoc.com");

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "API-Key" (defaults to null)
        //apiKey.setApiKeyPrefix("API-Key");

        TemplatesApi apiInstance = new TemplatesApi(defaultClient);
        // Boolean | Optional. Returns only not deleted templates.
        Boolean deleted = false;
        // Integer | Optionally, specify how many templates to return.
        // Default is 50 templates, maximum is 100 templates.
        Integer count = 10;
        try {
            TemplateListResponse result = apiInstance.listTemplates(null, null, deleted, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplatesApi#listTemplates");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Examples

• Create and send document from a template
• Create and send document from the pdf url

Documentation for API Endpoints

All URIs are relative to https://api.pandadoc.com

Class	Method	HTTP request	Description
ApiLogsApi	detailsLog	GET /public/v1/logs/{id}	Details API Log
ApiLogsApi	listLogs	GET /public/v1/logs	List API Log
ContactsApi	createContact	POST /public/v1/contacts	Create contact
ContactsApi	deleteContact	DELETE /public/v1/contacts/{id}	Delete contact by id
ContactsApi	detailsContact	GET /public/v1/contacts/{id}	Get contact details by id
ContactsApi	listContacts	GET /public/v1/contacts	List contacts
ContactsApi	updateContact	PATCH /public/v1/contacts/{id}	Update contact by id
ContentLibraryItemsApi	detailsContentLibraryItem	GET /public/v1/content-library-items/{id}/details	Details Content Library Item
ContentLibraryItemsApi	listContentLibraryItems	GET /public/v1/content-library-items	List Content Library Item
DocumentAttachmentsApi	createDocumentAttachment	POST /public/v1/documents/{id}/attachments	Document Attachment Create
DocumentAttachmentsApi	deleteDocumentAttachment	DELETE /public/v1/documents/{id}/attachments/{attachment_id}	Document Attachment Delete
DocumentAttachmentsApi	detailsDocumentAttachment	GET /public/v1/documents/{id}/attachments/{attachment_id}	Document Attachment Details
DocumentAttachmentsApi	downloadDocumentAttachment	GET /public/v1/documents/{id}/attachments/{attachment_id}/download	Document Attachment Download
DocumentAttachmentsApi	listDocumentAttachments	GET /public/v1/documents/{id}/attachments	Document Attachment List
DocumentRecipientsApi	addDocumentRecipient	POST /public/v1/documents/{id}/recipients	Add Document Recipient
DocumentRecipientsApi	deleteDocumentRecipient	DELETE /public/v1/documents/{id}/recipients/{recipient_id}	Delete Document Recipient
DocumentRecipientsApi	editDocumentRecipient	PATCH /public/v1/documents/{id}/recipients/recipient/{recipient_id}	Edit Document Recipient
DocumentRecipientsApi	reassignDocumentRecipient	POST /public/v1/documents/{id}/recipients/{recipient_id}/reassign	Reassign Document Recipient
DocumentsApi	changeDocumentStatus	PATCH /public/v1/documents/{id}/status	Document status change
DocumentsApi	createDocument	POST /public/v1/documents	Create document
DocumentsApi	createDocumentLink	POST /public/v1/documents/{id}/session	Create a Document Link
DocumentsApi	createLinkedObject	POST /public/v1/documents/{id}/linked-objects	Create Linked Object
DocumentsApi	deleteDocument	DELETE /public/v1/documents/{id}	Delete document by id
DocumentsApi	deleteLinkedObject	DELETE /public/v1/documents/{id}/linked-objects/{linked_object_id}	Delete Linked Object
DocumentsApi	detailsDocument	GET /public/v1/documents/{id}/details	Document details
DocumentsApi	documentMoveToFolder	POST /public/v1/documents/{id}/move-to-folder/{folder_id}	Document move to folder
DocumentsApi	downloadDocument	GET /public/v1/documents/{id}/download	Document download
DocumentsApi	downloadProtectedDocument	GET /public/v1/documents/{id}/download-protected	Download document protected
DocumentsApi	listDocuments	GET /public/v1/documents	List documents
DocumentsApi	listLinkedObjects	GET /public/v1/documents/{id}/linked-objects	List Linked Objects
DocumentsApi	sendDocument	POST /public/v1/documents/{id}/send	Send Document
DocumentsApi	statusDocument	GET /public/v1/documents/{id}	Document status
DocumentsApi	transferAllDocumentsOwnership	PATCH /public/v1/documents/ownership	Transfer all documents ownership
DocumentsApi	transferDocumentOwnership	PATCH /public/v1/documents/{id}/ownership	Update document ownership
DocumentsApi	updateDocument	PATCH /public/v1/documents/{id}	Update Document only in the draft status
FoldersApiApi	createDocumentFolder	POST /public/v1/documents/folders	Create Documents Folder
FoldersApiApi	createTemplateFolder	POST /public/v1/templates/folders	Create Templates Folder
FoldersApiApi	listDocumentFolders	GET /public/v1/documents/folders	List Documents Folders
FoldersApiApi	listTemplateFolders	GET /public/v1/templates/folders	List Templates Folders
FoldersApiApi	renameDocumentFolder	PUT /public/v1/documents/folders/{id}	Rename Documents Folder
FoldersApiApi	renameTemplateFolder	PUT /public/v1/templates/folders/{id}	Rename Templates Folder
FormsApi	listForm	GET /public/v1/forms	Forms
MembersApi	detailsCurrentMember	GET /public/v1/members/current	Current member details
MembersApi	detailsMember	GET /public/v1/members/{id}	Member details
MembersApi	listMembers	GET /public/v1/members	List members
OAuth20AuthenticationApi	accessToken	POST /oauth2/access_token	Create/Refresh Access Token
QuotesApi	quoteUpdate	PUT /public/v1/documents/{document_id}/quotes/{quote_id}	Quote update
SectionsApi	listSections	GET /public/v1/documents/{document_id}/sections	List sections
SectionsApi	sectionDetails	GET /public/v1/documents/{document_id}/sections/uploads/{upload_id}	Section details
SectionsApi	sectionInfo	GET /public/v1/documents/{document_id}/sections/{section_id}	Section Info
SectionsApi	uploadSection	POST /public/v1/documents/{document_id}/sections/uploads	Upload section
TemplatesApi	deleteTemplate	DELETE /public/v1/templates/{id}	Delete Template
TemplatesApi	detailsTemplate	GET /public/v1/templates/{id}/details	Details Template
TemplatesApi	listTemplates	GET /public/v1/templates	List Templates
UserAndWorkspaceManagementApi	addMember	POST /public/v1/workspaces/{workspace_id}/members	Add member
UserAndWorkspaceManagementApi	createUser	POST /public/v1/users	Create User
UserAndWorkspaceManagementApi	createWorkspace	POST /public/v1/workspaces	Create Workspace
WebhookEventsApi	detailsWebhookEvent	GET /public/v1/webhook-events/{id}	Get webhook event by uuid
WebhookEventsApi	listWebhookEvent	GET /public/v1/webhook-events	Get webhook event page
WebhookSubscriptionsApi	createWebhookSubscription	POST /public/v1/webhook-subscriptions	Create webhook subscription
WebhookSubscriptionsApi	deleteWebhookSubscription	DELETE /public/v1/webhook-subscriptions/{id}	Delete webhook subscription
WebhookSubscriptionsApi	detailsWebhookSubscription	GET /public/v1/webhook-subscriptions/{id}	Get webhook subscription by uuid
WebhookSubscriptionsApi	listWebhookSubscriptions	GET /public/v1/webhook-subscriptions	Get all webhook subscriptions
WebhookSubscriptionsApi	updateWebhookSubscription	PATCH /public/v1/webhook-subscriptions/{id}	Update webhook subscription
WebhookSubscriptionsApi	updateWebhookSubscriptionSharedKey	PATCH /public/v1/webhook-subscriptions/{id}/shared-key	Regenerate webhook subscription shared key

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://app.pandadoc.com/oauth2/authorize
• Scopes:
  • read+write: Use `read+write` to create, send, delete, and download documents, and `read` to view templates and document details.

License

SDK is licensed under the following License.