Skip to content

Commit aeaa329

Browse files
Version 3.12.0-RC-v2.1-21.1.01 release (#188)
Co-authored-by: DevCenter-DocuSign <[email protected]>
1 parent a91f2a7 commit aeaa329

28 files changed

+4023
-163
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-
## [v3.11.0-RC2] - eSignature API v2.1-20.4.01 - 2020-01-20
4+
## [v3.12.0-RC1] - eSignature API v2.1-21.1.01 - 2021-04-13
5+
### Changed
6+
- Added support for version v2.1-21.1.01 of the DocuSign eSignature API.
7+
- Updated the SDK release version.
8+
9+
## [v3.11.0-RC2] - eSignature API v2.1-20.4.01 - 2021-01-20
510
### Changed
611
- Added support for version v2.1-20.4.01 of the DocuSign eSignature API.
712
- Updated the SDK release version.

README.md

Lines changed: 48 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,74 @@
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
7-
8-
- Java 1.9+
9-
- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
7+
* Java 1.9+
8+
* Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
109

1110
## Compatibility
12-
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.
11+
* Java 1.9+
1812

1913
## Installation
14+
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.
2015

21-
Note: DocuSign uses **Eclipse** with **Maven** for testing purposes.
16+
**Note:** DocuSign uses Eclipse with Maven for testing purposes.
2217

2318
### 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.**
19+
1. In Eclipse, create a new project by selecting **File > New > Project**.
20+
2. In the New Project Wizard, expand **Maven,** then select **Maven Project.**
2721
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>3.11.0-RC2</version>
38-
</dependency>
39-
```
40-
41-
8. If your project is still open, restart **Eclipse**.
22+
4. Select **Next,** then provide a unique **groupId** and **artifactId.**
23+
5. In the directory where you've saved your project, open the pom.xml file.
24+
6. In the pom.xml file, locate the `dependencies` node.
25+
7. Add:
26+
```
27+
<dependency>
28+
<groupId>com.docusign</groupId>
29+
<artifactId>docusign-esign-java</artifactId>
30+
<version>3.12.0-RC1</version>
31+
</dependency>
32+
```
33+
8. If your project is still open, restart Eclipse.
4234
4335
## Dependencies
44-
4536
This client has the following external dependencies:
46-
47-
- io.swagger:swagger-annotations:jar:1.5.17
48-
- org.glassfish.jersey.core:jersey-client:jar:2.29.1
49-
- org.glassfish.jersey.media:jersey-media-multipart:jar:2.29.1
50-
- org.glassfish.jersey.media:jersey-media-json-jackson:2.29.1
51-
- com.fasterxml.jackson.core:jackson-core:jar:2.10.1
52-
- com.fasterxml.jackson.core:jackson-annotations:jar:2.10.1
53-
- com.fasterxml.jackson.core:jackson-databind:2.10.1
54-
- com.fasterxml.jackson.datatype:jackson-datatype-joda:jar:2.10.1
55-
- com.brsanthu:migbase64:2.2
56-
- junit:junit:jar:4.12
57-
- com.apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2
58-
- com.auth0:java-jwt:3.4.1
59-
- org.bouncycastle:bcprov-jdk15on:1.60
60-
61-
## Code Examples
62-
63-
### Launchers
64-
65-
DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-java). The Launcher contains a set of 31 common use cases and associated source files. These examples use either DocuSign&#39;s [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows.
66-
67-
### Proof-of-concept applications
68-
69-
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.
70-
71-
## OAuth Implementations
72-
73-
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).
74-
75-
For security purposes, DocuSign recommends using the Authorization Code Grant flow.
76-
77-
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:
78-
79-
- [JWT (JSON Web Token)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken)
80-
- [Implicit Grant] (https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-implicit)
37+
* io.swagger:swagger-annotations:jar:1.5.17
38+
* org.glassfish.jersey.core:jersey-client:jar:2.29.1
39+
* org.glassfish.jersey.media:jersey-media-multipart:jar:2.29.1
40+
* org.glassfish.jersey.media:jersey-media-json-jackson:2.29.1
41+
* com.fasterxml.jackson.core:jackson-core:jar:2.10.1
42+
* com.fasterxml.jackson.core:jackson-annotations:jar:2.10.1
43+
* com.fasterxml.jackson.core:jackson-databind:2.10.1
44+
* com.fasterxml.jackson.datatype:jackson-datatype-joda:jar:2.10.1
45+
* com.brsanthu:migbase64:2.2
46+
* junit:junit:jar:4.12
47+
* com.apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2
48+
* com.auth0:java-jwt:3.4.1
49+
* org.bouncycastle:bcprov-jdk15on:1.60
50+
51+
## Code examples
52+
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.
53+
54+
## OAuth implementations
55+
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/).
56+
57+
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
8158
8259
## Support
83-
8460
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
8561
8662
## License
63+
The DocuSign eSignature Java Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-java-client/blob/master/LICENSE).
8764
88-
The DocuSign Java Client is licensed under the [MIT License](https://github.com/docusign/docusign-java-client/blob/master/LICENSE).
89-
65+
### Additional resources
66+
* [DocuSign Developer Center](https://developers.docusign.com/)
67+
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
68+
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
69+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
9070
9171
[travis-image]: https://img.shields.io/travis/docusign/docusign-java-client.svg?style=flat
9272
[travis-url]: https://travis-ci.org/docusign/docusign-java-client
9373
[maven-image]: https://img.shields.io/maven-central/v/com.docusign/docusign-esign-java.svg?style=flat
94-
[maven-url]: https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.docusign%22
95-
96-
### Additional Resources
97-
* [DocuSign Developer Center](https://developers.docusign.com)
98-
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
99-
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
100-
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
74+
[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 = '3.11.0-RC2'
5+
version = '3.12.0-RC1'
66

77
buildscript {
88
repositories {

pom.xml

Lines changed: 3 additions & 3 deletions
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>3.11.0-RC2</version>
7+
<version>3.12.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

@@ -287,9 +287,9 @@
287287
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
288288
<swagger-core-version>1.5.18</swagger-core-version>
289289
<jersey-version>2.29.1</jersey-version>
290-
<jackson-version>2.12.1</jackson-version>
290+
<jackson-version>2.10.1</jackson-version>
291291
<maven-plugin-version>1.0.0</maven-plugin-version>
292-
<junit-version>4.13.1</junit-version>
292+
<junit-version>4.12</junit-version>
293293
<oltu-version>1.0.2</oltu-version>
294294
</properties>
295295
</project>

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2680,6 +2680,53 @@ public ReportInProductList getReportInProductList(String accountId) throws ApiEx
26802680
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
26812681
}
26822682

2683+
/**
2684+
* Returns Account available seals for specified account.
2685+
*
2686+
* @param accountId The external account number (int) or account ID Guid. (required)
2687+
* @return AccountSeals
2688+
* @throws ApiException if fails to make API call
2689+
*/
2690+
public AccountSeals getSealProviders(String accountId) throws ApiException {
2691+
Object localVarPostBody = "{}";
2692+
2693+
// verify the required parameter 'accountId' is set
2694+
if (accountId == null) {
2695+
throw new ApiException(400, "Missing the required parameter 'accountId' when calling getSealProviders");
2696+
}
2697+
2698+
// create path and map variables
2699+
String localVarPath = "/v2.1/accounts/{accountId}/seals"
2700+
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
2701+
2702+
// query params
2703+
java.util.List<Pair> localVarQueryParams = new java.util.ArrayList<Pair>();
2704+
java.util.List<Pair> localVarCollectionQueryParams = new java.util.ArrayList<Pair>();
2705+
java.util.Map<String, String> localVarHeaderParams = new java.util.HashMap<String, String>();
2706+
java.util.Map<String, Object> localVarFormParams = new java.util.HashMap<String, Object>();
2707+
2708+
2709+
2710+
2711+
2712+
2713+
2714+
final String[] localVarAccepts = {
2715+
"application/json"
2716+
};
2717+
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
2718+
2719+
final String[] localVarContentTypes = {
2720+
2721+
};
2722+
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
2723+
2724+
String[] localVarAuthNames = new String[] { "docusignAccessCode" };
2725+
2726+
GenericType<AccountSeals> localVarReturnType = new GenericType<AccountSeals>() {};
2727+
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
2728+
}
2729+
26832730
/**
26842731
* Gets list of supported languages for recipient language setting.
26852732
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ public DowngradRequestBillingInfoResponse getDowngradeRequestBillingInfo(String
174174

175175
/**
176176
* Retrieves a billing invoice.
177-
* 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 |
177+
* 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 |
178178
* @param accountId The external account number (int) or account ID Guid. (required)
179179
* @param invoiceId (required)
180180
* @return BillingInvoice

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,7 @@ public class GetBulkSendBatchesOptions
303303
{
304304
private String batchIds = null;
305305
private String count = null;
306+
private String searchText = null;
306307
private String startPosition = null;
307308
private String status = null;
308309
/*
@@ -325,6 +326,16 @@ public void setCount(String count) {
325326
public String getCount() {
326327
return this.count;
327328
}
329+
/*
330+
*
331+
*/
332+
public void setSearchText(String searchText) {
333+
this.searchText = searchText;
334+
}
335+
336+
public String getSearchText() {
337+
return this.searchText;
338+
}
328339
/*
329340
*
330341
*/
@@ -387,6 +398,8 @@ public BulkSendBatchSummaries getBulkSendBatches(String accountId, BulkEnvelopes
387398
localVarQueryParams.addAll(apiClient.parameterToPair("batch_ids", options.batchIds));
388399
}if (options != null) {
389400
localVarQueryParams.addAll(apiClient.parameterToPair("count", options.count));
401+
}if (options != null) {
402+
localVarQueryParams.addAll(apiClient.parameterToPair("search_text", options.searchText));
390403
}if (options != null) {
391404
localVarQueryParams.addAll(apiClient.parameterToPair("start_position", options.startPosition));
392405
}if (options != null) {

0 commit comments

Comments
 (0)