Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.dropbox.sign</groupId>
<artifactId>dropbox-sign</artifactId>
<version>2.6.0</version>
<version>2.7.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -72,7 +72,7 @@ Add this dependency to your project's build file:
}

dependencies {
implementation "com.dropbox.sign:dropbox-sign:2.6.0"
implementation "com.dropbox.sign:dropbox-sign:2.7.0"
}
```

Expand All @@ -86,7 +86,7 @@ mvn clean package

Then manually install the following JARs:

- `target/dropbox-sign-2.6.0.jar`
- `target/dropbox-sign-2.7.0.jar`
- `target/lib/*.jar`

## Getting Started
Expand Down Expand Up @@ -232,6 +232,7 @@ Class | Method | HTTP request | Description
- [AccountGetResponse](docs/AccountGetResponse.md)
- [AccountResponse](docs/AccountResponse.md)
- [AccountResponseQuotas](docs/AccountResponseQuotas.md)
- [AccountResponseSettings](docs/AccountResponseSettings.md)
- [AccountResponseUsage](docs/AccountResponseUsage.md)
- [AccountUpdateRequest](docs/AccountUpdateRequest.md)
- [AccountVerifyRequest](docs/AccountVerifyRequest.md)
Expand Down Expand Up @@ -375,7 +376,6 @@ Class | Method | HTTP request | Description
- [TemplateCreateRequest](docs/TemplateCreateRequest.md)
- [TemplateCreateResponse](docs/TemplateCreateResponse.md)
- [TemplateCreateResponseTemplate](docs/TemplateCreateResponseTemplate.md)
- [TemplateEditResponse](docs/TemplateEditResponse.md)
- [TemplateGetResponse](docs/TemplateGetResponse.md)
- [TemplateListResponse](docs/TemplateListResponse.md)
- [TemplateRemoveUserRequest](docs/TemplateRemoveUserRequest.md)
Expand Down Expand Up @@ -453,7 +453,7 @@ apisupport@hellosign.com
This Java package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `3.0.0`
- Package version: `2.6.0`
- Package version: `2.7.0`
- Build package: `org.openapitools.codegen.languages.JavaClientCodegen`


Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.6.0
2.7.0
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ apply plugin: 'signing'

group = 'com.dropbox.sign'
archivesBaseName = 'dropbox-sign'
version = '2.6.0'
version = '2.7.0'
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8

Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "com.dropbox.sign",
name := "dropbox-sign",
version := "2.6.0",
version := "2.7.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
Compile / javacOptions ++= Seq("-Xlint:deprecation"),
Expand Down
1 change: 1 addition & 0 deletions docs/AccountResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
| `teamId` | ```String``` | The id of the team account belongs to. | |
| `locale` | ```String``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | |
| `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | |
| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) | | |



16 changes: 16 additions & 0 deletions docs/AccountResponseSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# AccountResponseSettings

Subset of configured settings

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `signerAccessCodes` | ```Boolean``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
| `smsDelivery` | ```Boolean``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
| `smsAuthentication` | ```Boolean``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |



1 change: 1 addition & 0 deletions docs/ReportCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
| USER_ACTIVITY | &quot;user_activity&quot; |
| DOCUMENT_STATUS | &quot;document_status&quot; |
| SMS_ACTIVITY | &quot;sms_activity&quot; |
| FAX_USAGE | &quot;fax_usage&quot; |



1 change: 1 addition & 0 deletions docs/ReportResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Contains information about the report request.
| USER_ACTIVITY | &quot;user_activity&quot; |
| DOCUMENT_STATUS | &quot;document_status&quot; |
| SMS_ACTIVITY | &quot;sms_activity&quot; |
| FAX_USAGE | &quot;fax_usage&quot; |



4 changes: 4 additions & 0 deletions docs/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,7 @@ public class SignatureRequestCreateEmbeddedExample
signingOptions.phone(false);
signingOptions.type(true);
signingOptions.upload(true);
signingOptions.forceAdvancedSignatureDetails(false);

var signers1 = new SubSignatureRequestSigner();
signers1.name("Jack");
Expand Down Expand Up @@ -579,6 +580,7 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample
signingOptions.phone(false);
signingOptions.type(true);
signingOptions.upload(true);
signingOptions.forceAdvancedSignatureDetails(false);

var signers1 = new SubSignatureRequestTemplateSigner();
signers1.role("Client");
Expand Down Expand Up @@ -1874,6 +1876,7 @@ public class SignatureRequestSendExample
signingOptions.phone(false);
signingOptions.type(true);
signingOptions.upload(true);
signingOptions.forceAdvancedSignatureDetails(false);

var signers1 = new SubSignatureRequestSigner();
signers1.name("Jack");
Expand Down Expand Up @@ -2000,6 +2003,7 @@ public class SignatureRequestSendWithTemplateExample
signingOptions.phone(false);
signingOptions.type(true);
signingOptions.upload(true);
signingOptions.forceAdvancedSignatureDetails(false);

var signers1 = new SubSignatureRequestTemplateSigner();
signers1.role("Client");
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestEditRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
| `formFieldRules` | [```List<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
| `formFieldsPerDocument` | [```List<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
| `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | |
| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```Map<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestEditWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
| `customFields` | [```List<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
| `files` | ```List<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
| `fileUrls` | ```List<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```Map<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestSendRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| `formFieldsPerDocument` | [```List<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
| `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | |
| `isQualifiedSignature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer&#39;s identity.&lt;br&gt;<br>**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```Map<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestSendWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
| `files` | ```List<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
| `fileUrls` | ```List<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
| `isQualifiedSignature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer&#39;s identity.&lt;br&gt;<br>**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | |
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```Map<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
5 changes: 4 additions & 1 deletion docs/SubSigningOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

# SubSigningOptions

This allows the requester to specify the types allowed for creating a signature.
This allows the requester to specify the types allowed for creating a signature and specify another signing options.

**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.

**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.

## Properties

| Name | Type | Description | Notes |
Expand All @@ -15,6 +17,7 @@ This allows the requester to specify the types allowed for creating a signature.
| `phone` | ```Boolean``` | Allows using a smartphone to email the signature | |
| `type` | ```Boolean``` | Allows typing the signature | |
| `upload` | ```Boolean``` | Allows uploading the signature | |
| `forceAdvancedSignatureDetails` | ```Boolean``` | Turning on advanced signature details for the signature request | |



Expand Down
6 changes: 5 additions & 1 deletion docs/TemplateApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,11 @@ public class TemplateAddUserExample

Create Template

Creates a template that can then be used.
Creates a template that can be used in future signature requests.

If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).

Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.

### Example

Expand Down
14 changes: 0 additions & 14 deletions docs/TemplateEditResponse.md

This file was deleted.

1 change: 1 addition & 0 deletions examples/SignatureRequestCreateEmbeddedExample.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public static void main(String[] args)
signingOptions.phone(false);
signingOptions.type(true);
signingOptions.upload(true);
signingOptions.forceAdvancedSignatureDetails(false);

var signers1 = new SubSignatureRequestSigner();
signers1.name("Jack");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public static void main(String[] args)
signingOptions.phone(false);
signingOptions.type(true);
signingOptions.upload(true);
signingOptions.forceAdvancedSignatureDetails(false);

var signers1 = new SubSignatureRequestTemplateSigner();
signers1.role("Client");
Expand Down
1 change: 1 addition & 0 deletions examples/SignatureRequestSendExample.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public static void main(String[] args)
signingOptions.phone(false);
signingOptions.type(true);
signingOptions.upload(true);
signingOptions.forceAdvancedSignatureDetails(false);

var signers1 = new SubSignatureRequestSigner();
signers1.name("Jack");
Expand Down
Loading
Loading