Skip to content

Commit 1a50074

Browse files
Version 2.20.0-RC-v2-21.1.01 release (#186)
Co-authored-by: DevCenter-DocuSign <[email protected]>
1 parent d2049d4 commit 1a50074

File tree

10 files changed

+151
-125
lines changed

10 files changed

+151
-125
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# DocuSign Java Client Changelog
22
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
33

4-
## [v2.19.0-RC2] - eSignature API v2-20.4.01 - 2020-01-20
4+
## [v2.20.0-RC1] - eSignature API v2-21.1.01 - 2021-04-13
5+
### Changed
6+
- Added support for version v2-21.1.01 of the DocuSign eSignature API.
7+
- Updated the SDK release version.
8+
9+
## [v2.19.0-RC2] - eSignature API v2-20.4.01 - 2021-01-20
510
### Changed
611
- Added support for version v2-20.4.01 of the DocuSign eSignature API.
712
- Updated the SDK release version.

README.md

Lines changed: 44 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,76 @@
1-
# The Official DocuSign Java Client
1+
# The Official DocuSign eSignature Java Client SDK
22

33
[![Build status][travis-image]][travis-url]
44
[![Maven Central status][maven-image]][maven-url]
55

66
## Requirements
77

8-
- Java 1.9+
9-
- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
8+
* Java 1.9+
9+
* Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
1010

1111
## Compatibility
1212

13-
- Java 1.9+
14-
15-
## Note
16-
17-
This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
13+
* Java 1.9+
1814

1915
## Installation
16+
This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
2017

21-
Note: DocuSign uses **Eclipse** with **Maven** for testing purposes.
18+
**Note:** DocuSign uses Eclipse with Maven for testing purposes.
2219

2320
### Maven:
24-
25-
1. In Eclipse, create a new project by selecting **File** -> **New** -> **Project**.
26-
2. In the **New Project Wizard** , expand **Maven** , then select **Maven Project.**
21+
1. In Eclipse, create a new project by selecting **File > New > Project**.
22+
2. In the New Project Wizard, expand **Maven,** then select **Maven Project.**
2723
3. Leave **Create a simple project** unchecked.
28-
4. Select **Next** , then provide a unique **Group** and **Artifact Id**.
29-
5. In the directory where you've saved your project, open the _pom.xml_ file.
30-
6. In the _pom.xml_ file, locate the **dependencies** node.
31-
7. Add:
32-
33-
```
34-
<dependency>
35-
<groupId>com.docusign</groupId>
36-
<artifactId>docusign-esign-java</artifactId>
37-
<version>2.19.0-RC2</version>
38-
</dependency>
39-
```
40-
41-
8. If your project is still open, restart **Eclipse**.
24+
4. Select **Next,** then provide a unique **groupId** and **artifactId.**
25+
5. In the directory where you've saved your project, open the pom.xml file.
26+
6. In the pom.xml file, locate the `dependencies` node.
27+
7. Add:
28+
```
29+
<dependency>
30+
<groupId>com.docusign</groupId>
31+
<artifactId>docusign-esign-java</artifactId>
32+
<version>2.20.0-RC1</version>
33+
</dependency>
34+
```
35+
8. If your project is still open, restart Eclipse.
4236
4337
## Dependencies
44-
4538
This client has the following external dependencies:
4639
47-
- swagger:swagger-annotations:jar:1.5.8
48-
- sun.jersey:jersey-client:jar:1.19.1
49-
- sun.jersey.contribs:jersey-multipart:jar:1.19.1
50-
- fasterxml.jackson.core:jackson-core:jar:2.9.9
51-
- fasterxml.jackson.core:jackson-annotations:jar:2.9.9
52-
- fasterxml.jackson.core:jackson-databind:jar:2.9.9
53-
- fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:jar:2.9.9
54-
- fasterxml.jackson.datatype:jackson-datatype-joda:jar:2.1.5
55-
- joda-time:joda-time:jar:2.9.3
56-
- brsanthu:migbase64:jar:2.2
57-
- apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2
58-
- junit:junit:jar:4.12
59-
60-
## Code Examples
61-
62-
### Launchers
40+
* swagger:swagger-annotations:jar:1.5.8
41+
* sun.jersey:jersey-client:jar:1.19.1
42+
* sun.jersey.contribs:jersey-multipart:jar:1.19.1
43+
* fasterxml.jackson.core:jackson-core:jar:2.9.9
44+
* fasterxml.jackson.core:jackson-annotations:jar:2.9.9
45+
* fasterxml.jackson.core:jackson-databind:jar:2.9.9
46+
* fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:jar:2.9.9
47+
* fasterxml.jackson.datatype:jackson-datatype-joda:jar:2.1.5
48+
* joda-time:joda-time:jar:2.9.3
49+
* brsanthu:migbase64:jar:2.2
50+
* apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2
51+
* junit:junit:jar:4.12
6352
64-
DocuSign provides a sample application referred to as a [Launcher](https://github.com/docusign/eg-03-java-auth-code-grant). The Launcher contains a set of 14 common use cases and associated source files. These examples use DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
53+
## Code examples
54+
You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-java/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
6555
66-
### Proof-of-concept applications
56+
## OAuth implementations
57+
For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/).
6758
68-
If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-java) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
69-
70-
## OAuth Implementations
71-
72-
For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
73-
74-
For security purposes, DocuSign recommends using the Authorization Code Grant flow.
75-
76-
There are other use-case scenarios, such as **single page applications** (SPA) that use **Cross-Origin Resource Sharing** (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports [JWT](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) and [Implicit](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-implicit) grants. For code examples, see the links below:
77-
78-
- [JWT (JSON Web Token)](https://github.com/docusign/eg-01-java-jwt)
79-
- Implicit Grant (coming soon)
59+
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
8060
8161
## Support
82-
8362
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
8463
8564
## License
65+
The DocuSign eSignature Java Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-java-client/blob/master/LICENSE).
8666
87-
The DocuSign Java Client is licensed under the [MIT License](https://github.com/docusign/docusign-java-client/blob/master/LICENSE).
88-
67+
### Additional resources
68+
* [DocuSign Developer Center](https://developers.docusign.com/)
69+
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
70+
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
71+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
8972
9073
[travis-image]: https://img.shields.io/travis/docusign/docusign-java-client.svg?style=flat
9174
[travis-url]: https://travis-ci.org/docusign/docusign-java-client
9275
[maven-image]: https://img.shields.io/maven-central/v/com.docusign/docusign-esign-java.svg?style=flat
93-
[maven-url]: https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.docusign%22
94-
76+
[maven-url]: https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.docusign%22

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apply plugin: 'idea'
22
apply plugin: 'eclipse'
33

44
group = 'com.docusign'
5-
version = '2.19.0-RC2'
5+
version = '2.20.0-RC1'
66

77
buildscript {
88
repositories {

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<artifactId>docusign-esign-java</artifactId>
55
<packaging>jar</packaging>
66
<name>docusign-esign-java</name>
7-
<version>2.19.0-RC2</version>
7+
<version>2.20.0-RC1</version>
88
<description>The official DocuSign eSignature JAVA client is based on version 2 of the DocuSign REST API and provides libraries for JAVA application integration. It is recommended that you use this version of the library for new development.</description>
99
<url>https://developers.docusign.com</url>
1010

src/main/java/com/docusign/esign/api/AccountsApi.java

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1893,6 +1893,53 @@ public ProvisioningInformation getProvisioning() throws ApiException {
18931893
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
18941894
}
18951895

1896+
/**
1897+
* Returns Account available seals for specified account.
1898+
*
1899+
* @param accountId The external account number (int) or account ID Guid. (required)
1900+
* @return AccountSeals
1901+
* @throws ApiException if fails to make API call
1902+
*/
1903+
public AccountSeals getSealProviders(String accountId) throws ApiException {
1904+
Object localVarPostBody = "{}";
1905+
1906+
// verify the required parameter 'accountId' is set
1907+
if (accountId == null) {
1908+
throw new ApiException(400, "Missing the required parameter 'accountId' when calling getSealProviders");
1909+
}
1910+
1911+
// create path and map variables
1912+
String localVarPath = "/v2/accounts/{accountId}/seals"
1913+
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
1914+
1915+
// query params
1916+
java.util.List<Pair> localVarQueryParams = new java.util.ArrayList<Pair>();
1917+
java.util.List<Pair> localVarCollectionQueryParams = new java.util.ArrayList<Pair>();
1918+
java.util.Map<String, String> localVarHeaderParams = new java.util.HashMap<String, String>();
1919+
java.util.Map<String, Object> localVarFormParams = new java.util.HashMap<String, Object>();
1920+
1921+
1922+
1923+
1924+
1925+
1926+
1927+
final String[] localVarAccepts = {
1928+
"application/json"
1929+
};
1930+
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
1931+
1932+
final String[] localVarContentTypes = {
1933+
1934+
};
1935+
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
1936+
1937+
String[] localVarAuthNames = new String[] { "docusignAccessCode" };
1938+
1939+
GenericType<AccountSeals> localVarReturnType = new GenericType<AccountSeals>() {};
1940+
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
1941+
}
1942+
18961943
/**
18971944
* Gets list of supported languages for recipient language setting.
18981945
*

src/main/java/com/docusign/esign/api/BillingApi.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ public CreditCardInformation getCreditCardInfo(String accountId) throws ApiExcep
127127

128128
/**
129129
* Retrieves a billing invoice.
130-
* Retrieves the specified invoice. ###### Note: If the &#x60;pdfAvailable&#x60; property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the &#x60;Accept&#x60; property in the header to &#x60;Accept: application/pdf&#x60;. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as &#39;unlimited&#39; or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different &#x60;chargeName&#x60; property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
130+
* Retrieves the specified invoice. ###### Note: If the &#x60;pdfAvailable&#x60; property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the &#x60;Accept&#x60; property in the header to &#x60;Accept: application/pdf&#x60;. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as &#39;unlimited&#39; or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different &#x60;chargeName&#x60; property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
131131
* @param accountId The external account number (int) or account ID Guid. (required)
132132
* @param invoiceId (required)
133133
* @return BillingInvoice

src/main/java/com/docusign/esign/api/ConnectApi.java

Lines changed: 1 addition & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ public void deleteConnectSecret(String accountId, String keyId) throws ApiExcept
199199
}
200200

201201
// create path and map variables
202-
String localVarPath = "/v2/accounts/{accountId}/connect/secret/{keyId}/delete"
202+
String localVarPath = "/v2/accounts/{accountId}/connect/secret/{keyId}"
203203
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
204204
.replaceAll("\\{" + "keyId" + "\\}", apiClient.escapeString(keyId.toString()));
205205

@@ -935,60 +935,6 @@ public MobileNotifierConfigurationInformation listMobileNotifiers(String account
935935
GenericType<MobileNotifierConfigurationInformation> localVarReturnType = new GenericType<MobileNotifierConfigurationInformation>() {};
936936
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
937937
}
938-
939-
/**
940-
* Test connect configuration.
941-
*
942-
* @param accountId The external account number (int) or account ID Guid. (required)
943-
* @param connectId The ID of the custom Connect configuration being accessed. (required)
944-
* @return ResourceInformation
945-
* @throws ApiException if fails to make API call
946-
*/
947-
public ResourceInformation listTests(String accountId, String connectId) throws ApiException {
948-
Object localVarPostBody = "{}";
949-
950-
// verify the required parameter 'accountId' is set
951-
if (accountId == null) {
952-
throw new ApiException(400, "Missing the required parameter 'accountId' when calling listTests");
953-
}
954-
955-
// verify the required parameter 'connectId' is set
956-
if (connectId == null) {
957-
throw new ApiException(400, "Missing the required parameter 'connectId' when calling listTests");
958-
}
959-
960-
// create path and map variables
961-
String localVarPath = "/v2/accounts/{accountId}/connect/{connectId}/tests"
962-
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
963-
.replaceAll("\\{" + "connectId" + "\\}", apiClient.escapeString(connectId.toString()));
964-
965-
// query params
966-
java.util.List<Pair> localVarQueryParams = new java.util.ArrayList<Pair>();
967-
java.util.List<Pair> localVarCollectionQueryParams = new java.util.ArrayList<Pair>();
968-
java.util.Map<String, String> localVarHeaderParams = new java.util.HashMap<String, String>();
969-
java.util.Map<String, Object> localVarFormParams = new java.util.HashMap<String, Object>();
970-
971-
972-
973-
974-
975-
976-
977-
final String[] localVarAccepts = {
978-
"application/json"
979-
};
980-
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
981-
982-
final String[] localVarContentTypes = {
983-
984-
};
985-
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
986-
987-
String[] localVarAuthNames = new String[] { "docusignAccessCode" };
988-
989-
GenericType<ResourceInformation> localVarReturnType = new GenericType<ResourceInformation>() {};
990-
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
991-
}
992938
/// <summary>
993939
/// Returns users from the configured Connect service. Returns users from the configured Connect service.
994940
/// </summary>

src/main/java/com/docusign/esign/client/ApiClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public ApiClient() {
8484
this.dateFormat = new RFC3339DateFormat();
8585

8686
// Set default User-Agent.
87-
setUserAgent("Swagger-Codegen/2.19.0-RC2/java");
87+
setUserAgent("Swagger-Codegen/2.20.0-RC1/java");
8888

8989
// Setup authentications (key: authentication name, value: authentication).
9090
authentications = new HashMap<String, Authentication>();

0 commit comments

Comments
 (0)