Skip to content

Update java SDK #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2025
Merged

Update java SDK #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
49 changes: 41 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ The samples below show how a published SDK artifact is used:

Gradle:
```groovy
implementation 'com.docusign:iam-sdk:1.0.0-beta.6'
implementation 'com.docusign:iam-sdk:1.0.0-beta.7'
```

Maven:
```xml
<dependency>
<groupId>com.docusign</groupId>
<artifactId>iam-sdk</artifactId>
<version>1.0.0-beta.6</version>
<version>1.0.0-beta.7</version>
</dependency>
```

Expand Down Expand Up @@ -312,6 +312,11 @@ var res = sdk.auth().getUserInfo().call();
* [deleteAgreement](docs/sdks/agreements/README.md#deleteagreement) - Delete a specific agreement
* [createAgreementSummary](docs/sdks/agreements/README.md#createagreementsummary) - Create an AI-generated summary of an agreement document

#### [workspaces().workspaceBrands()](docs/sdks/workspacebrands/README.md)

* [getWorkspaceBrand](docs/sdks/workspacebrands/README.md#getworkspacebrand) - Returns details about the brand set for a workspace
* [updateWorkspaceBrand](docs/sdks/workspacebrands/README.md#updateworkspacebrand) - Updates brand for an existing workspace

#### [workspaces().workspaceDocuments()](docs/sdks/workspacedocuments/README.md)

* [getWorkspaceDocuments](docs/sdks/workspacedocuments/README.md#getworkspacedocuments) - Get documents in the workspace accessible to the calling user
Expand All @@ -324,6 +329,7 @@ var res = sdk.auth().getUserInfo().call();

* [getWorkspaces](docs/sdks/workspaces2/README.md#getworkspaces) - Gets workspaces available to the calling user
* [createWorkspace](docs/sdks/workspaces2/README.md#createworkspace) - Creates a new workspace
* [updateWorkspace](docs/sdks/workspaces2/README.md#updateworkspace) - Updates an existing workspace
* [getWorkspace](docs/sdks/workspaces2/README.md#getworkspace) - Returns details about the workspace
* [getWorkspaceAssignableRoles](docs/sdks/workspaces2/README.md#getworkspaceassignableroles) - Returns the roles the caller can assign to workspace users
* [createWorkspaceEnvelope](docs/sdks/workspaces2/README.md#createworkspaceenvelope) - Creates an envelope with the given documents. Returns the ID of the created envelope
Expand Down Expand Up @@ -461,15 +467,19 @@ public class Application {

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will throw a `models/errors/APIException` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `getTokenFromConfidentialAuthCode` method throws the following exceptions:

| Error Type | Status Code | Content Type |
| -------------------------------- | ----------- | ---------------- |
| models/errors/OAuthErrorResponse | 400 | application/json |
| models/errors/APIException | 4XX, 5XX | \*/\* |
[`IamClientError`](./src/main/java/models/errors/IamClientError.java) is the base class for all HTTP error responses. It has the following properties:

### Example
| Method | Type | Description |
| ---------------- | --------------------------- | ------------------------------------------------------------------------ |
| `message()` | `String` | Error message |
| `code()` | `int` | HTTP response status code eg `404` |
| `headers` | `Map<String, List<String>>` | HTTP response headers |
| `body()` | `byte[]` | HTTP body as a byte array. Can be empty array if no body is returned. |
| `bodyAsString()` | `String` | HTTP body as a UTF-8 string. Can be empty string if no body is returned. |
| `rawResponse()` | `HttpResponse<?>` | Raw HTTP response (body already read and not available for re-read) |

### Example
```java
package hello.world;

Expand Down Expand Up @@ -505,6 +515,29 @@ public class Application {
}
}
```

### Error Classes
**Primary error:**
* [`IamClientError`](./src/main/java/models/errors/IamClientError.java): The base class for HTTP error responses.

<details><summary>Less common errors (9)</summary>

<br />

**Network errors:**
* `java.io.IOException` (always wrapped by `java.io.UncheckedIOException`). Commonly encountered subclasses of
`IOException` include `java.net.ConnectException`, `java.net.SocketTimeoutException`, `EOFException` (there are
many more subclasses in the JDK platform).

**Inherit from [`IamClientError`](./src/main/java/models/errors/IamClientError.java)**:
* [`com.docusign.iam.sdk.models.errors.ErrorDetails`](./src/main/java/models/errors/com.docusign.iam.sdk.models.errors.ErrorDetails.java): The error response object for the Workspaces API. Applicable to 26 of 44 methods.*
* [`com.docusign.iam.sdk.models.errors.Error`](./src/main/java/models/errors/com.docusign.iam.sdk.models.errors.Error.java): Bad Request - The request could not be understood or was missing required parameters. Applicable to 11 of 44 methods.*
* [`com.docusign.iam.sdk.models.errors.OAuthErrorResponse`](./src/main/java/models/errors/com.docusign.iam.sdk.models.errors.OAuthErrorResponse.java): Status code `400`. Applicable to 5 of 44 methods.*


</details>

\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,14 @@ Based on:
### Generated
- [java v1.0.0-beta.6] .
### Releases
- [Maven Central v1.0.0-beta.6] https://central.sonatype.com/artifact/com.docusign/iam-sdk/1.0.0-beta.6 - .
- [Maven Central v1.0.0-beta.6] https://central.sonatype.com/artifact/com.docusign/iam-sdk/1.0.0-beta.6 - .

## 2025-10-17 12:40:18
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.637.0 (2.727.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v1.0.0-beta.7] .
### Releases
- [Maven Central v1.0.0-beta.7] https://central.sonatype.com/artifact/com.docusign/iam-sdk/1.0.0-beta.7 - .
1 change: 1 addition & 0 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ dependencies {
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
implementation 'commons-io:commons-io:2.18.0'
implementation 'jakarta.annotation:jakarta.annotation-api:3.0.0'
}

ext {
Expand Down
9 changes: 9 additions & 0 deletions docs/models/components/BrandColor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# BrandColor


## Fields

| Field | Type | Required | Description |
| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
| `name` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `value` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
10 changes: 10 additions & 0 deletions docs/models/components/BrandLogos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# BrandLogos


## Fields

| Field | Type | Required | Description |
| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
| `primary` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `secondary` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `email` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
21 changes: 21 additions & 0 deletions docs/models/components/GetWorkspaceBrandResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# GetWorkspaceBrandResponse

The details of a single workspace brand


## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `brandId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `brandName` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `brandCompany` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `colors` | List\<[BrandColor](../../models/components/BrandColor.md)> | :heavy_check_mark: | N/A |
| `logos` | [Optional\<BrandLogos>](../../models/components/BrandLogos.md) | :heavy_minus_sign: | N/A |
| `brandLanguages` | List\<*String*> | :heavy_check_mark: | N/A |
| `defaultBrandLanguage` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `isSendingDefault` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
| `isSigningDefault` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
| `primaryLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `secondaryLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `emailLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
8 changes: 8 additions & 0 deletions docs/models/components/UpdateWorkspaceBody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# UpdateWorkspaceBody


## Fields

| Field | Type | Required | Description |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `name` | *Optional\<String>* | :heavy_check_mark: | The updated name of the workspace |
8 changes: 8 additions & 0 deletions docs/models/components/UpdateWorkspaceBrandBody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# UpdateWorkspaceBrandBody


## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `brandId` | *JsonNullable\<String>* | :heavy_minus_sign: | A GUID value that identifies a brand. For more information, see <a href="https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/branding/">Branding</a> |
21 changes: 21 additions & 0 deletions docs/models/components/UpdateWorkspaceBrandResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# UpdateWorkspaceBrandResponse

The brand details set for a workspace


## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `brandId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `brandName` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `brandCompany` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `colors` | List\<[BrandColor](../../models/components/BrandColor.md)> | :heavy_check_mark: | N/A |
| `logos` | [Optional\<BrandLogos>](../../models/components/BrandLogos.md) | :heavy_minus_sign: | N/A |
| `brandLanguages` | List\<*String*> | :heavy_check_mark: | N/A |
| `defaultBrandLanguage` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `isSendingDefault` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
| `isSigningDefault` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
| `primaryLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `secondaryLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
| `emailLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
Loading