Skip to content

Commit

Permalink
Version 2.20.0-RC-v2-21.1.01 release (#186)
Browse files Browse the repository at this point in the history
Co-authored-by: DevCenter-DocuSign <[email protected]>
  • Loading branch information
mmallis87 and DevCenter-DocuSign authored Apr 14, 2021
1 parent d2049d4 commit 1a50074
Show file tree
Hide file tree
Showing 10 changed files with 151 additions and 125 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# DocuSign Java Client Changelog
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.

## [v2.19.0-RC2] - eSignature API v2-20.4.01 - 2020-01-20
## [v2.20.0-RC1] - eSignature API v2-21.1.01 - 2021-04-13
### Changed
- Added support for version v2-21.1.01 of the DocuSign eSignature API.
- Updated the SDK release version.

## [v2.19.0-RC2] - eSignature API v2-20.4.01 - 2021-01-20
### Changed
- Added support for version v2-20.4.01 of the DocuSign eSignature API.
- Updated the SDK release version.
Expand Down
106 changes: 44 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,76 @@
# The Official DocuSign Java Client
# The Official DocuSign eSignature Java Client SDK

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

## Requirements

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

## Compatibility

- Java 1.9+

## Note

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.
* Java 1.9+

## Installation
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.

Note: DocuSign uses **Eclipse** with **Maven** for testing purposes.
**Note:** DocuSign uses Eclipse with Maven for testing purposes.

### Maven:

1. In Eclipse, create a new project by selecting **File** -> **New** -> **Project**.
2. In the **New Project Wizard** , expand **Maven** , then select **Maven Project.**
1. In Eclipse, create a new project by selecting **File > New > Project**.
2. In the New Project Wizard, expand **Maven,** then select **Maven Project.**
3. Leave **Create a simple project** unchecked.
4. Select **Next** , then provide a unique **Group** and **Artifact Id**.
5. In the directory where you've saved your project, open the _pom.xml_ file.
6. In the _pom.xml_ file, locate the **dependencies** node.
7. Add:

```
<dependency>
<groupId>com.docusign</groupId>
<artifactId>docusign-esign-java</artifactId>
<version>2.19.0-RC2</version>
</dependency>
```

8. If your project is still open, restart **Eclipse**.
4. Select **Next,** then provide a unique **groupId** and **artifactId.**
5. In the directory where you've saved your project, open the pom.xml file.
6. In the pom.xml file, locate the `dependencies` node.
7. Add:
```
<dependency>
<groupId>com.docusign</groupId>
<artifactId>docusign-esign-java</artifactId>
<version>2.20.0-RC1</version>
</dependency>
```
8. If your project is still open, restart Eclipse.
## Dependencies

This client has the following external dependencies:
- swagger:swagger-annotations:jar:1.5.8
- sun.jersey:jersey-client:jar:1.19.1
- sun.jersey.contribs:jersey-multipart:jar:1.19.1
- fasterxml.jackson.core:jackson-core:jar:2.9.9
- fasterxml.jackson.core:jackson-annotations:jar:2.9.9
- fasterxml.jackson.core:jackson-databind:jar:2.9.9
- fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:jar:2.9.9
- fasterxml.jackson.datatype:jackson-datatype-joda:jar:2.1.5
- joda-time:joda-time:jar:2.9.3
- brsanthu:migbase64:jar:2.2
- apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2
- junit:junit:jar:4.12

## Code Examples

### Launchers
* swagger:swagger-annotations:jar:1.5.8
* sun.jersey:jersey-client:jar:1.19.1
* sun.jersey.contribs:jersey-multipart:jar:1.19.1
* fasterxml.jackson.core:jackson-core:jar:2.9.9
* fasterxml.jackson.core:jackson-annotations:jar:2.9.9
* fasterxml.jackson.core:jackson-databind:jar:2.9.9
* fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:jar:2.9.9
* fasterxml.jackson.datatype:jackson-datatype-joda:jar:2.1.5
* joda-time:joda-time:jar:2.9.3
* brsanthu:migbase64:jar:2.2
* apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2
* junit:junit:jar:4.12
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.
## Code examples
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.
### Proof-of-concept applications
## OAuth implementations
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/).
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.

## OAuth Implementations

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).

For security purposes, DocuSign recommends using the Authorization Code Grant flow.

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:

- [JWT (JSON Web Token)](https://github.com/docusign/eg-01-java-jwt)
- Implicit Grant (coming soon)
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
## Support

Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
## License
The DocuSign eSignature Java Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-java-client/blob/master/LICENSE).
The DocuSign Java Client is licensed under the [MIT License](https://github.com/docusign/docusign-java-client/blob/master/LICENSE).

### Additional resources
* [DocuSign Developer Center](https://developers.docusign.com/)
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
[travis-image]: https://img.shields.io/travis/docusign/docusign-java-client.svg?style=flat
[travis-url]: https://travis-ci.org/docusign/docusign-java-client
[maven-image]: https://img.shields.io/maven-central/v/com.docusign/docusign-esign-java.svg?style=flat
[maven-url]: https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.docusign%22

[maven-url]: https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.docusign%22
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apply plugin: 'idea'
apply plugin: 'eclipse'

group = 'com.docusign'
version = '2.19.0-RC2'
version = '2.20.0-RC1'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<artifactId>docusign-esign-java</artifactId>
<packaging>jar</packaging>
<name>docusign-esign-java</name>
<version>2.19.0-RC2</version>
<version>2.20.0-RC1</version>
<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>
<url>https://developers.docusign.com</url>

Expand Down
47 changes: 47 additions & 0 deletions src/main/java/com/docusign/esign/api/AccountsApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -1893,6 +1893,53 @@ public ProvisioningInformation getProvisioning() throws ApiException {
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}

/**
* Returns Account available seals for specified account.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return AccountSeals
* @throws ApiException if fails to make API call
*/
public AccountSeals getSealProviders(String accountId) throws ApiException {
Object localVarPostBody = "{}";

// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(400, "Missing the required parameter 'accountId' when calling getSealProviders");
}

// create path and map variables
String localVarPath = "/v2/accounts/{accountId}/seals"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));

// query params
java.util.List<Pair> localVarQueryParams = new java.util.ArrayList<Pair>();
java.util.List<Pair> localVarCollectionQueryParams = new java.util.ArrayList<Pair>();
java.util.Map<String, String> localVarHeaderParams = new java.util.HashMap<String, String>();
java.util.Map<String, Object> localVarFormParams = new java.util.HashMap<String, Object>();







final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);

final String[] localVarContentTypes = {

};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

String[] localVarAuthNames = new String[] { "docusignAccessCode" };

GenericType<AccountSeals> localVarReturnType = new GenericType<AccountSeals>() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}

/**
* Gets list of supported languages for recipient language setting.
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/docusign/esign/api/BillingApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ public CreditCardInformation getCreditCardInfo(String accountId) throws ApiExcep

/**
* Retrieves a billing invoice.
* 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 |
* 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 |
* @param accountId The external account number (int) or account ID Guid. (required)
* @param invoiceId (required)
* @return BillingInvoice
Expand Down
56 changes: 1 addition & 55 deletions src/main/java/com/docusign/esign/api/ConnectApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ public void deleteConnectSecret(String accountId, String keyId) throws ApiExcept
}

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

Expand Down Expand Up @@ -935,60 +935,6 @@ public MobileNotifierConfigurationInformation listMobileNotifiers(String account
GenericType<MobileNotifierConfigurationInformation> localVarReturnType = new GenericType<MobileNotifierConfigurationInformation>() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}

/**
* Test connect configuration.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectId The ID of the custom Connect configuration being accessed. (required)
* @return ResourceInformation
* @throws ApiException if fails to make API call
*/
public ResourceInformation listTests(String accountId, String connectId) throws ApiException {
Object localVarPostBody = "{}";

// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(400, "Missing the required parameter 'accountId' when calling listTests");
}

// verify the required parameter 'connectId' is set
if (connectId == null) {
throw new ApiException(400, "Missing the required parameter 'connectId' when calling listTests");
}

// create path and map variables
String localVarPath = "/v2/accounts/{accountId}/connect/{connectId}/tests"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "connectId" + "\\}", apiClient.escapeString(connectId.toString()));

// query params
java.util.List<Pair> localVarQueryParams = new java.util.ArrayList<Pair>();
java.util.List<Pair> localVarCollectionQueryParams = new java.util.ArrayList<Pair>();
java.util.Map<String, String> localVarHeaderParams = new java.util.HashMap<String, String>();
java.util.Map<String, Object> localVarFormParams = new java.util.HashMap<String, Object>();







final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);

final String[] localVarContentTypes = {

};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

String[] localVarAuthNames = new String[] { "docusignAccessCode" };

GenericType<ResourceInformation> localVarReturnType = new GenericType<ResourceInformation>() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/// <summary>
/// Returns users from the configured Connect service. Returns users from the configured Connect service.
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/docusign/esign/client/ApiClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public ApiClient() {
this.dateFormat = new RFC3339DateFormat();

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

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

0 comments on commit 1a50074

Please sign in to comment.