Skip to content
BranchesTags

Repository files navigation

dropbox-sign

Dropbox Sign v3 API

Migrating from legacy SDK

This SDK is generated from our officially maintained OpenAPI spec. We've made important updates that introduce new functionality and create feature parity between the Dropbox Sign API and the SDK. However, some of these changes are considered "breaking" in the sense that they'll require you to update your existing code in order to continue using the SDK. Please refer to this migration guide for more information.

Version & Requirements

This is version 2.x of the Java SDK. It depends on Jakarta EE and Jersey 3.

If your project has not been updated for Jakarta or Jersey 3, you should use the V1 SDK, which uses Jersey 2 & supports compatibility with Java EEs javax namespace.

Both versions will receive updates so use whichever your application prefers.

Contributing

This repo is no longer accepting new issues or Pull Requests. All issues or Pull Requests must be opened against the hellosign/hellosign-openapi repo!

Changes to the SDK code

You must make SDK code changes in the mustache file within the templates directory that corresponds to the file you want updated.

We use OpenAPI Generator to automatically generate this SDK from the OAS, using the template files.

Building

You must have docker (or podman linked to docker) installed. Highly recommended to use rootless docker.

Run the following and everything is done for you:

./run-build

Attention: Any changes you have made to the SDK code that you have not made to the OAS file and/or the mustache template files will be lost when you run this command.

Maven users

Add this dependency to your project's POM:

<dependency>
<groupId>com.dropbox.sign</groupId>
<artifactId>dropbox-sign</artifactId>
<version>2.7.0</version>
<scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

 repositories {
mavenCentral() // Needed if the 'dropbox-sign' jar has been published to maven central.
mavenLocal() // Needed if the 'dropbox-sign' jar has been published to the local maven repo.
}
dependencies {
implementation "com.dropbox.sign:dropbox-sign:2.7.0"
}

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/dropbox-sign-2.7.0.jar
  • target/lib/*.jar

Getting Started

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

packagecom.dropbox.sign_sandbox;
importcom.dropbox.sign.ApiException;
importcom.dropbox.sign.Configuration;
importcom.dropbox.sign.api.*;
importcom.dropbox.sign.auth.*;
importcom.dropbox.sign.JSON;
importcom.dropbox.sign.model.*;
importjava.io.File;
importjava.math.BigDecimal;
importjava.time.LocalDate;
importjava.time.OffsetDateTime;
importjava.util.ArrayList;
importjava.util.List;
importjava.util.Map;
publicclassAccountCreateExample
{
publicstaticvoidmain(String[] args)
{
varconfig = Configuration.getDefaultApiClient();
((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY");
// ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN");varaccountCreateRequest = newAccountCreateRequest();
accountCreateRequest.emailAddress("newuser@dropboxsign.com");
try
{
varresponse = newAccountApi(config).accountCreate(
accountCreateRequest
);
System.out.println(response);
} catch (ApiExceptione) {
System.err.println("Exception when calling AccountApi#accountCreate");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Documentation for API Endpoints

All URIs are relative to https://api.hellosign.com/v3

ClassMethodHTTP requestDescription
AccountApiaccountCreatePOST /account/createCreate Account
AccountApiaccountGetGET /accountGet Account
AccountApiaccountUpdatePUT /accountUpdate Account
AccountApiaccountVerifyPOST /account/verifyVerify Account
ApiAppApiapiAppCreatePOST /api_appCreate API App
ApiAppApiapiAppDeleteDELETE /api_app/{client_id}Delete API App
ApiAppApiapiAppGetGET /api_app/{client_id}Get API App
ApiAppApiapiAppListGET /api_app/listList API Apps
ApiAppApiapiAppUpdatePUT /api_app/{client_id}Update API App
BulkSendJobApibulkSendJobGetGET /bulk_send_job/{bulk_send_job_id}Get Bulk Send Job
BulkSendJobApibulkSendJobListGET /bulk_send_job/listList Bulk Send Jobs
EmbeddedApiembeddedEditUrlPOST /embedded/edit_url/{template_id}Get Embedded Template Edit URL
EmbeddedApiembeddedSignUrlGET /embedded/sign_url/{signature_id}Get Embedded Sign URL
FaxApifaxDeleteDELETE /fax/{fax_id}Delete Fax
FaxApifaxFilesGET /fax/files/{fax_id}Download Fax Files
FaxApifaxGetGET /fax/{fax_id}Get Fax
FaxApifaxListGET /fax/listLists Faxes
FaxApifaxSendPOST /fax/sendSend Fax
FaxLineApifaxLineAddUserPUT /fax_line/add_userAdd Fax Line User
FaxLineApifaxLineAreaCodeGetGET /fax_line/area_codesGet Available Fax Line Area Codes
FaxLineApifaxLineCreatePOST /fax_line/createPurchase Fax Line
FaxLineApifaxLineDeleteDELETE /fax_lineDelete Fax Line
FaxLineApifaxLineGetGET /fax_lineGet Fax Line
FaxLineApifaxLineListGET /fax_line/listList Fax Lines
FaxLineApifaxLineRemoveUserPUT /fax_line/remove_userRemove Fax Line Access
OAuthApioauthTokenGeneratePOST /oauth/tokenOAuth Token Generate
OAuthApioauthTokenRefreshPOST /oauth/token?refreshOAuth Token Refresh
ReportApireportCreatePOST /report/createCreate Report
SignatureRequestApisignatureRequestBulkCreateEmbeddedWithTemplatePOST /signature_request/bulk_create_embedded_with_templateEmbedded Bulk Send with Template
SignatureRequestApisignatureRequestBulkSendWithTemplatePOST /signature_request/bulk_send_with_templateBulk Send with Template
SignatureRequestApisignatureRequestCancelPOST /signature_request/cancel/{signature_request_id}Cancel Incomplete Signature Request
SignatureRequestApisignatureRequestCreateEmbeddedPOST /signature_request/create_embeddedCreate Embedded Signature Request
SignatureRequestApisignatureRequestCreateEmbeddedWithTemplatePOST /signature_request/create_embedded_with_templateCreate Embedded Signature Request with Template
SignatureRequestApisignatureRequestEditPUT /signature_request/edit/{signature_request_id}Edit Signature Request
SignatureRequestApisignatureRequestEditEmbeddedPUT /signature_request/edit_embedded/{signature_request_id}Edit Embedded Signature Request
SignatureRequestApisignatureRequestEditEmbeddedWithTemplatePUT /signature_request/edit_embedded_with_template/{signature_request_id}Edit Embedded Signature Request with Template
SignatureRequestApisignatureRequestEditWithTemplatePUT /signature_request/edit_with_template/{signature_request_id}Edit Signature Request With Template
SignatureRequestApisignatureRequestFilesGET /signature_request/files/{signature_request_id}Download Files
SignatureRequestApisignatureRequestFilesAsDataUriGET /signature_request/files_as_data_uri/{signature_request_id}Download Files as Data Uri
SignatureRequestApisignatureRequestFilesAsFileUrlGET /signature_request/files_as_file_url/{signature_request_id}Download Files as File Url
SignatureRequestApisignatureRequestGetGET /signature_request/{signature_request_id}Get Signature Request
SignatureRequestApisignatureRequestListGET /signature_request/listList Signature Requests
SignatureRequestApisignatureRequestReleaseHoldPOST /signature_request/release_hold/{signature_request_id}Release On-Hold Signature Request
SignatureRequestApisignatureRequestRemindPOST /signature_request/remind/{signature_request_id}Send Request Reminder
SignatureRequestApisignatureRequestRemovePOST /signature_request/remove/{signature_request_id}Remove Signature Request Access
SignatureRequestApisignatureRequestSendPOST /signature_request/sendSend Signature Request
SignatureRequestApisignatureRequestSendWithTemplatePOST /signature_request/send_with_templateSend with Template
SignatureRequestApisignatureRequestUpdatePOST /signature_request/update/{signature_request_id}Update Signature Request
TeamApiteamAddMemberPUT /team/add_memberAdd User to Team
TeamApiteamCreatePOST /team/createCreate Team
TeamApiteamDeleteDELETE /team/destroyDelete Team
TeamApiteamGetGET /teamGet Team
TeamApiteamInfoGET /team/infoGet Team Info
TeamApiteamInvitesGET /team/invitesList Team Invites
TeamApiteamMembersGET /team/members/{team_id}List Team Members
TeamApiteamRemoveMemberPOST /team/remove_memberRemove User from Team
TeamApiteamSubTeamsGET /team/sub_teams/{team_id}List Sub Teams
TeamApiteamUpdatePUT /teamUpdate Team
TemplateApitemplateAddUserPOST /template/add_user/{template_id}Add User to Template
TemplateApitemplateCreatePOST /template/createCreate Template
TemplateApitemplateCreateEmbeddedDraftPOST /template/create_embedded_draftCreate Embedded Template Draft
TemplateApitemplateDeletePOST /template/delete/{template_id}Delete Template
TemplateApitemplateFilesGET /template/files/{template_id}Get Template Files
TemplateApitemplateFilesAsDataUriGET /template/files_as_data_uri/{template_id}Get Template Files as Data Uri
TemplateApitemplateFilesAsFileUrlGET /template/files_as_file_url/{template_id}Get Template Files as File Url
TemplateApitemplateGetGET /template/{template_id}Get Template
TemplateApitemplateListGET /template/listList Templates
TemplateApitemplateRemoveUserPOST /template/remove_user/{template_id}Remove User from Template
TemplateApitemplateUpdateFilesPOST /template/update_files/{template_id}Update Template Files
UnclaimedDraftApiunclaimedDraftCreatePOST /unclaimed_draft/createCreate Unclaimed Draft
UnclaimedDraftApiunclaimedDraftCreateEmbeddedPOST /unclaimed_draft/create_embeddedCreate Embedded Unclaimed Draft
UnclaimedDraftApiunclaimedDraftCreateEmbeddedWithTemplatePOST /unclaimed_draft/create_embedded_with_templateCreate Embedded Unclaimed Draft with Template
UnclaimedDraftApiunclaimedDraftEditAndResendPOST /unclaimed_draft/edit_and_resend/{signature_request_id}Edit and Resend Unclaimed Draft

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api_key

  • Type: HTTP basic authentication

oauth2

  • Type: HTTP Bearer Token authentication (JWT)

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

apisupport@hellosign.com

About this package

This Java package is automatically generated by the OpenAPI Generator project:

  • API version: 3.0.0
    • Package version: 2.7.0
  • Build package: org.openapitools.codegen.languages.JavaClientCodegen

Working on this SDK

This section includes documentation about how to generate the SDK in case you want to make a contribution.

Building the SDK with Docker

Run ./run-build

Installation / Deployment

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.

About

Official Java SDK for the Dropbox Sign API

repo1.maven.org/maven2/com/dropbox/sign/dropbox-sign/

Topics

dropboxdropbox-signhellosignhellosign-apiopenapi

Resources

Readme
MIT license
Activity
Custom properties

Stars

1 star

Watchers

6 watching

Forks

3 forks
Report repository

Releases

Used by

Contributors

Languages