Skip to content

Commit

Permalink
Release 2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jtreminio-dropbox committed Sep 9, 2024
1 parent 837a8c0 commit 6d63c26
Show file tree
Hide file tree
Showing 728 changed files with 20,973 additions and 16,605 deletions.
19 changes: 8 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
*.war
*.ear

# exclude jar for gradle wrapper
!gradle/wrapper/*.jar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
Expand All @@ -18,12 +16,11 @@ hs_err_pid*
**/target
target
.gradle
build/

.composer
vendor

# Intellij
.idea/

.openapi-generator
build

/.composer
/vendor
/.idea/
/.openapi-generator
/.github/workflows/maven.yml
/gradle
397 changes: 0 additions & 397 deletions .openapi-generator/FILES

This file was deleted.

1 change: 0 additions & 1 deletion .openapi-generator/VERSION

This file was deleted.

58 changes: 27 additions & 31 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.1.0</version>
<version>2.2.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.1.0"
implementation "com.dropbox.sign:dropbox-sign:2.2.0"
}
```

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

Then manually install the following JARs:

- `target/dropbox-sign-2.1.0.jar`
- `target/dropbox-sign-2.2.0.jar`
- `target/lib/*.jar`

## Getting Started
Expand Down Expand Up @@ -133,32 +133,6 @@ public class Example {
```


## Using a Proxy

To add a HTTP proxy for the API client, use `ClientConfig`:

```java

import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import com.dropbox.sign.*;
import com.dropbox.sign.api.AccountApi;

...

ApiClient defaultClient = Configuration.getDefaultApiClient();
ClientConfig clientConfig = defaultClient.getClientConfig();
clientConfig.connectorProvider(new ApacheConnectorProvider());
clientConfig.property(ClientProperties.PROXY_URI, "http://proxy_url_here");
clientConfig.property(ClientProperties.PROXY_USERNAME, "proxy_username");
clientConfig.property(ClientProperties.PROXY_PASSWORD, "proxy_password");
defaultClient.setClientConfig(clientConfig);

AccountApi apiInstance = new AccountApi(defaultClient);

```


## Documentation for API Endpoints

Expand All @@ -179,6 +153,13 @@ Class | Method | HTTP request | Description
*BulkSendJobApi* | [**bulkSendJobList**](docs/BulkSendJobApi.md#bulkSendJobList) | **GET** /bulk_send_job/list | List Bulk Send Jobs
*EmbeddedApi* | [**embeddedEditUrl**](docs/EmbeddedApi.md#embeddedEditUrl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL
*EmbeddedApi* | [**embeddedSignUrl**](docs/EmbeddedApi.md#embeddedSignUrl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL
*FaxLineApi* | [**faxLineAddUser**](docs/FaxLineApi.md#faxLineAddUser) | **PUT** /fax_line/add_user | Add Fax Line User
*FaxLineApi* | [**faxLineAreaCodeGet**](docs/FaxLineApi.md#faxLineAreaCodeGet) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes
*FaxLineApi* | [**faxLineCreate**](docs/FaxLineApi.md#faxLineCreate) | **POST** /fax_line/create | Purchase Fax Line
*FaxLineApi* | [**faxLineDelete**](docs/FaxLineApi.md#faxLineDelete) | **DELETE** /fax_line | Delete Fax Line
*FaxLineApi* | [**faxLineGet**](docs/FaxLineApi.md#faxLineGet) | **GET** /fax_line | Get Fax Line
*FaxLineApi* | [**faxLineList**](docs/FaxLineApi.md#faxLineList) | **GET** /fax_line/list | List Fax Lines
*FaxLineApi* | [**faxLineRemoveUser**](docs/FaxLineApi.md#faxLineRemoveUser) | **PUT** /fax_line/remove_user | Remove Fax Line Access
*OAuthApi* | [**oauthTokenGenerate**](docs/OAuthApi.md#oauthTokenGenerate) | **POST** /oauth/token | OAuth Token Generate
*OAuthApi* | [**oauthTokenRefresh**](docs/OAuthApi.md#oauthTokenRefresh) | **POST** /oauth/token?refresh | OAuth Token Refresh
*ReportApi* | [**reportCreate**](docs/ReportApi.md#reportCreate) | **POST** /report/create | Create Report
Expand Down Expand Up @@ -261,6 +242,17 @@ Class | Method | HTTP request | Description
- [EventCallbackRequest](docs/EventCallbackRequest.md)
- [EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md)
- [EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md)
- [FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md)
- [FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md)
- [FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md)
- [FaxLineAreaCodeGetResponse](docs/FaxLineAreaCodeGetResponse.md)
- [FaxLineAreaCodeGetStateEnum](docs/FaxLineAreaCodeGetStateEnum.md)
- [FaxLineCreateRequest](docs/FaxLineCreateRequest.md)
- [FaxLineDeleteRequest](docs/FaxLineDeleteRequest.md)
- [FaxLineListResponse](docs/FaxLineListResponse.md)
- [FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md)
- [FaxLineResponse](docs/FaxLineResponse.md)
- [FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md)
- [FileResponse](docs/FileResponse.md)
- [FileResponseDataUri](docs/FileResponseDataUri.md)
- [ListInfoResponse](docs/ListInfoResponse.md)
Expand Down Expand Up @@ -401,18 +393,22 @@ Class | Method | HTTP request | Description
- [WarningResponse](docs/WarningResponse.md)


<a id="documentation-for-authorization"></a>
## Documentation for Authorization


Authentication schemes defined for the API:
<a id="api_key"></a>
### api_key


- **Type**: HTTP basic authentication

<a id="oauth2"></a>
### oauth2


- **Type**: HTTP basic authentication
- **Type**: HTTP Bearer Token authentication (JWT)


## Recommendation
Expand All @@ -429,7 +425,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.1.0`
- Package version: `2.2.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.1.0
2.2.0
18 changes: 11 additions & 7 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

buildscript {
repositories {
mavenCentral()
Expand All @@ -20,7 +21,7 @@ apply plugin: 'signing'

group = 'com.dropbox.sign'
archivesBaseName = 'dropbox-sign'
version = '2.1.0'
version = '2.2.0'
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8

Expand Down Expand Up @@ -116,12 +117,11 @@ publishing {

ext {
swagger_annotations_version = "1.6.5"
jackson_version = "2.13.4"
jackson_databind_version = "2.13.4.2"
jackson_version = "2.17.1"
jackson_databind_version = "2.17.1"
jakarta_annotation_version = "2.1.0"
jackson_threetenbp_version = "2.9.10"
jersey_version = "3.0.4"
junit_version = "4.13.1"
junit_version = "5.8.2"
mockito_version = "3.12.4"
}

Expand All @@ -137,12 +137,16 @@ dependencies {
implementation "com.fasterxml.jackson.core:jackson-annotations:$jackson_version"
implementation "com.fasterxml.jackson.core:jackson-databind:$jackson_databind_version"
implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:$jackson_version"
implementation "com.github.joschi.jackson:jackson-datatype-threetenbp:$jackson_threetenbp_version"
implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version"
testImplementation "junit:junit:$junit_version"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_version"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junit_version"
testImplementation "org.mockito:mockito-core:$mockito_version"
}

test {
useJUnitPlatform()
}

javadoc {
options.tags = [ "http.response.details:a:Http Response Details" ]
Expand Down
14 changes: 7 additions & 7 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@ lazy val root = (project in file(".")).
settings(
organization := "com.dropbox.sign",
name := "dropbox-sign",
version := "2.1.0",
version := "2.2.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
Compile / javacOptions ++= Seq("-Xlint:deprecation"),
Compile / packageDoc / publishArtifact := false,
resolvers += Resolver.mavenLocal,
libraryDependencies ++= Seq(
libraryDependencies += "commons-codec" % "commons-codec" % "1.15"
"com.google.code.findbugs" % "jsr305" % "3.0.0",
"io.swagger" % "swagger-annotations" % "1.6.5",
"org.glassfish.jersey.core" % "jersey-client" % "3.0.4",
"org.glassfish.jersey.inject" % "jersey-hk2" % "3.0.4",
"org.glassfish.jersey.media" % "jersey-media-multipart" % "3.0.4",
"org.glassfish.jersey.media" % "jersey-media-json-jackson" % "3.0.4",
"org.glassfish.jersey.connectors" % "jersey-apache-connector" % "3.0.4",
"com.fasterxml.jackson.core" % "jackson-core" % "2.13.4" % "compile",
"com.fasterxml.jackson.core" % "jackson-annotations" % "2.13.4" % "compile",
"com.fasterxml.jackson.core" % "jackson-databind" % "2.13.4.2" % "compile",
"com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.13.2" % "compile",
"com.github.joschi.jackson" % "jackson-datatype-threetenbp" % "2.12.5" % "compile",
"com.fasterxml.jackson.core" % "jackson-core" % "2.17.1" % "compile",
"com.fasterxml.jackson.core" % "jackson-annotations" % "2.17.1" % "compile",
"com.fasterxml.jackson.core" % "jackson-databind" % "2.17.1" % "compile",
"com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.17.1" % "compile",
"jakarta.annotation" % "jakarta.annotation-api" % "2.1.0" % "compile",
"junit" % "junit" % "4.13.2" % "test"
"org.junit.jupiter" % "junit-jupiter-api" % "5.8.2" % "test"
)
)
20 changes: 10 additions & 10 deletions docs/AccountApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

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

Method | HTTP request | Description
------------- | ------------- | -------------
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
[**accountCreate**](AccountApi.md#accountCreate) | **POST** /account/create | Create Account
[**accountGet**](AccountApi.md#accountGet) | **GET** /account | Get Account
[**accountUpdate**](AccountApi.md#accountUpdate) | **PUT** /account | Update Account
Expand Down Expand Up @@ -62,8 +62,8 @@ public class Example {
### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
**accountCreateRequest** | [**AccountCreateRequest**](AccountCreateRequest.md)| |

### Return type
Expand Down Expand Up @@ -134,8 +134,8 @@ public class Example {
### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
**accountId** | **String**| `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. | [optional]
**emailAddress** | **String**| `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. | [optional]

Expand Down Expand Up @@ -210,8 +210,8 @@ public class Example {
### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
**accountUpdateRequest** | [**AccountUpdateRequest**](AccountUpdateRequest.md)| |

### Return type
Expand Down Expand Up @@ -285,8 +285,8 @@ public class Example {
### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
**accountVerifyRequest** | [**AccountVerifyRequest**](AccountVerifyRequest.md)| |

### Return type
Expand Down
4 changes: 2 additions & 2 deletions docs/AccountCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `emailAddress`<sup>*_required_</sup> | ```String``` | The email address which will be associated with the new Account. | |
| `clientId` | ```String``` | Used when creating a new account with OAuth authorization.<br><br>See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | |
| `clientSecret` | ```String``` | Used when creating a new account with OAuth authorization.<br><br>See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | |
Expand Down
6 changes: 3 additions & 3 deletions docs/AccountCreateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `account` | [```AccountResponse```](AccountResponse.md) | | |
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `account`<sup>*_required_</sup> | [```AccountResponse```](AccountResponse.md) | | |
| `oauthData` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | |
| `warnings` | [```List<WarningResponse>```](WarningResponse.md) | A list of warnings. | |

Expand Down
6 changes: 3 additions & 3 deletions docs/AccountGetResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `account` | [```AccountResponse```](AccountResponse.md) | | |
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `account`<sup>*_required_</sup> | [```AccountResponse```](AccountResponse.md) | | |
| `warnings` | [```List<WarningResponse>```](WarningResponse.md) | A list of warnings. | |


Expand Down
4 changes: 2 additions & 2 deletions docs/AccountResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | The ID of the Account | |
| `emailAddress` | ```String``` | The email address associated with the Account. | |
| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | |
Expand Down
4 changes: 2 additions & 2 deletions docs/AccountResponseQuotas.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Details concerning remaining monthly quotas.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | |
| `documentsLeft` | ```Integer``` | Signature requests remaining. | |
| `templatesTotal` | ```Integer``` | Total API templates allowed. | |
Expand Down
4 changes: 2 additions & 2 deletions docs/AccountResponseUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Details concerning monthly usage

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `faxPagesSent` | ```Integer``` | Number of fax pages sent | |


Expand Down
4 changes: 2 additions & 2 deletions docs/AccountUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | The ID of the Account | |
| `callbackUrl` | ```String``` | The URL that Dropbox Sign should POST events 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. | |
Expand Down
4 changes: 2 additions & 2 deletions docs/AccountVerifyRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| `emailAddress`<sup>*_required_</sup> | ```String``` | Email address to run the verification for. | |


Expand Down
Loading

0 comments on commit 6d63c26

Please sign in to comment.