Skip to content

Commit c757b87

Browse files
prudhvik-docusignprudhvik-docusign
authored
Merge pull request #6 from docusign/sdk-update-java-1.0.0-beta.7
Update java SDK
2 parents 85adfee + 8f5cb68 commit c757b87

File tree

147 files changed

+6502
-2828
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+6502
-2828
lines changed

‎README.md‎

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ The samples below show how a published SDK artifact is used:
5454

5555
Gradle:
5656
```groovy
57-
implementation 'com.docusign:iam-sdk:1.0.0-beta.6'
57+
implementation 'com.docusign:iam-sdk:1.0.0-beta.7'
5858
```
5959

6060
Maven:
6161
```xml
6262
<dependency>
6363
<groupId>com.docusign</groupId>
6464
<artifactId>iam-sdk</artifactId>
65-
<version>1.0.0-beta.6</version>
65+
<version>1.0.0-beta.7</version>
6666
</dependency>
6767
```
6868

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

315+
#### [workspaces().workspaceBrands()](docs/sdks/workspacebrands/README.md)
316+
317+
* [getWorkspaceBrand](docs/sdks/workspacebrands/README.md#getworkspacebrand) - Returns details about the brand set for a workspace
318+
* [updateWorkspaceBrand](docs/sdks/workspacebrands/README.md#updateworkspacebrand) - Updates brand for an existing workspace
319+
315320
#### [workspaces().workspaceDocuments()](docs/sdks/workspacedocuments/README.md)
316321

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

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

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

464-
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:
465470

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

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

482+
### Example
473483
```java
474484
package hello.world;
475485

@@ -505,6 +515,29 @@ public class Application {
505515
}
506516
}
507517
```
518+
519+
### Error Classes
520+
**Primary error:**
521+
* [`IamClientError`](./src/main/java/models/errors/IamClientError.java): The base class for HTTP error responses.
522+
523+
<details><summary>Less common errors (9)</summary>
524+
525+
<br />
526+
527+
**Network errors:**
528+
* `java.io.IOException` (always wrapped by `java.io.UncheckedIOException`). Commonly encountered subclasses of
529+
`IOException` include `java.net.ConnectException`, `java.net.SocketTimeoutException`, `EOFException` (there are
530+
many more subclasses in the JDK platform).
531+
532+
**Inherit from [`IamClientError`](./src/main/java/models/errors/IamClientError.java)**:
533+
* [`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.*
534+
* [`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.*
535+
* [`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.*
536+
537+
538+
</details>
539+
540+
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
508541
<!-- End Error Handling [errors] -->
509542

510543
<!-- Start Server Selection [server] -->

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,14 @@ Based on:
6767
### Generated
6868
- [java v1.0.0-beta.6] .
6969
### Releases
70-
- [Maven Central v1.0.0-beta.6] https://central.sonatype.com/artifact/com.docusign/iam-sdk/1.0.0-beta.6 - .
70+
- [Maven Central v1.0.0-beta.6] https://central.sonatype.com/artifact/com.docusign/iam-sdk/1.0.0-beta.6 - .
71+
72+
## 2025-10-17 12:40:18
73+
### Changes
74+
Based on:
75+
- OpenAPI Doc
76+
- Speakeasy CLI 1.637.0 (2.727.4) https://github.com/speakeasy-api/speakeasy
77+
### Generated
78+
- [java v1.0.0-beta.7] .
79+
### Releases
80+
- [Maven Central v1.0.0-beta.7] https://central.sonatype.com/artifact/com.docusign/iam-sdk/1.0.0-beta.7 - .

‎build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ dependencies {
8181
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
8282
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
8383
implementation 'commons-io:commons-io:2.18.0'
84+
implementation 'jakarta.annotation:jakarta.annotation-api:3.0.0'
8485
}
8586

8687
ext {

‎docs/models/components/BrandColor.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# BrandColor
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
8+
| `name` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
9+
| `value` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |

‎docs/models/components/BrandLogos.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# BrandLogos
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
8+
| `primary` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
9+
| `secondary` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
10+
| `email` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |

‎docs/models/components/GetWorkspaceBrandResponse.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# GetWorkspaceBrandResponse
2+
3+
The details of a single workspace brand
4+
5+
6+
## Fields
7+
8+
| Field | Type | Required | Description |
9+
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
10+
| `brandId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
11+
| `brandName` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
12+
| `brandCompany` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
13+
| `colors` | List\<[BrandColor](../../models/components/BrandColor.md)> | :heavy_check_mark: | N/A |
14+
| `logos` | [Optional\<BrandLogos>](../../models/components/BrandLogos.md) | :heavy_minus_sign: | N/A |
15+
| `brandLanguages` | List\<*String*> | :heavy_check_mark: | N/A |
16+
| `defaultBrandLanguage` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
17+
| `isSendingDefault` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
18+
| `isSigningDefault` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
19+
| `primaryLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
20+
| `secondaryLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
21+
| `emailLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |

‎docs/models/components/UpdateWorkspaceBody.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# UpdateWorkspaceBody
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
8+
| `name` | *Optional\<String>* | :heavy_check_mark: | The updated name of the workspace |

‎docs/models/components/UpdateWorkspaceBrandBody.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# UpdateWorkspaceBrandBody
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8+
| `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> |

‎docs/models/components/UpdateWorkspaceBrandResponse.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# UpdateWorkspaceBrandResponse
2+
3+
The brand details set for a workspace
4+
5+
6+
## Fields
7+
8+
| Field | Type | Required | Description |
9+
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
10+
| `brandId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
11+
| `brandName` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
12+
| `brandCompany` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
13+
| `colors` | List\<[BrandColor](../../models/components/BrandColor.md)> | :heavy_check_mark: | N/A |
14+
| `logos` | [Optional\<BrandLogos>](../../models/components/BrandLogos.md) | :heavy_minus_sign: | N/A |
15+
| `brandLanguages` | List\<*String*> | :heavy_check_mark: | N/A |
16+
| `defaultBrandLanguage` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
17+
| `isSendingDefault` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
18+
| `isSigningDefault` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
19+
| `primaryLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
20+
| `secondaryLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |
21+
| `emailLogoId` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A |

0 commit comments

Comments
 (0)