Skip to content

chore: 🐝 Update SDK - Generate 0.4.0 #11

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 2 commits into from
Oct 21, 2025
Merged

chore: 🐝 Update SDK - Generate 0.4.0 #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
424bc08
## Typescript SDK Changes Detected:
speakeasybot Oct 21, 2025
d966733
empty commit to trigger [run-tests] workflow
speakeasy-github[bot] Oct 21, 2025
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
83 changes: 42 additions & 41 deletions .speakeasy/gen.lock
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 7 additions & 1 deletion .speakeasy/gen.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,16 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
hoistGlobalSecurity: true
schemas:
allOfMergeStrategy: shallowMerge
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 0.3.2
version: 0.4.0
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand Down Expand Up @@ -52,10 +56,12 @@ typescript:
jsonpath: legacy
maxMethodParams: 0
methodArguments: require-security-and-request
modelPropertyCasing: camel
moduleFormat: commonjs
outputModelSuffix: output
packageName: '@documenso/sdk-typescript'
responseFormat: flat
sseFlatResponse: false
templateVersion: v2
usageSDKInitImports: []
useIndexModules: true
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
speakeasyVersion: 1.606.10
speakeasyVersion: 1.637.3
sources:
Documenso v2 beta API:
sourceNamespace: documenso-v-2-beta-api
sourceRevisionDigest: sha256:442d296d692d7ffe641ab405c4bc6a569b8fe538a6718f3d12331a4be92e51e6
sourceBlobDigest: sha256:4211e6fd5beb2648e5d85775f81ffd7cb5f213d21f156295156e01a40e61340a
sourceRevisionDigest: sha256:5655c327963c859a6b2690d2f07ff5a14c557dae975710c55e1e94a3a8ca03c5
sourceBlobDigest: sha256:628fee4fefdec824deaa24deaf158a9f7e61fea8a997f4e39e47dca425903deb
tags:
- latest
- speakeasy-sdk-regen-1752107119
- speakeasy-sdk-regen-1761011807
- 0.0.0
targets:
documenso:
source: Documenso v2 beta API
sourceNamespace: documenso-v-2-beta-api
sourceRevisionDigest: sha256:442d296d692d7ffe641ab405c4bc6a569b8fe538a6718f3d12331a4be92e51e6
sourceBlobDigest: sha256:4211e6fd5beb2648e5d85775f81ffd7cb5f213d21f156295156e01a40e61340a
sourceRevisionDigest: sha256:5655c327963c859a6b2690d2f07ff5a14c557dae975710c55e1e94a3a8ca03c5
sourceBlobDigest: sha256:628fee4fefdec824deaa24deaf158a9f7e61fea8a997f4e39e47dca425903deb
codeSamplesNamespace: documenso-v-2-beta-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:16b65d25065a50ebfeefc2cb72c565a726698d9385afa8b9fe281067747a3b58
codeSamplesRevisionDigest: sha256:37b05993bb40943f140a099b917322a9f24e727e5a3c86f6caa5551e4cb41b68
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
6 changes: 1 addition & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,7 @@ bun add @documenso/sdk-typescript
### Yarn

```bash
yarn add @documenso/sdk-typescript zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
yarn add @documenso/sdk-typescript
```


Expand Down Expand Up @@ -296,7 +293,6 @@ main()
<details open>
<summary>Available methods</summary>


### [document](docs/sdks/document/README.md)

* [documentDownload](docs/sdks/document/README.md#documentdownload) - Download document (beta)
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 @@ -58,4 +58,14 @@ Based on:
### Generated
- [typescript v0.3.2] .
### Releases
- [NPM v0.3.2] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.3.2 - .
- [NPM v0.3.2] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.3.2 - .

## 2025-10-21 01:56:28
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.637.3 (2.727.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.4.0] .
### Releases
- [NPM v0.4.0] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.4.0 - .
12 changes: 6 additions & 6 deletions RUNTIMES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:

* [Web Fetch API][web-fetch]
* [Web Streams API][web-streams] and in particular `ReadableStream`
* [Async iterables][async-iter] using `Symbol.asyncIterator`
- [Web Fetch API][web-fetch]
- [Web Streams API][web-streams] and in particular `ReadableStream`
- [Async iterables][async-iter] using `Symbol.asyncIterator`

[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
Expand All @@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:

The following `tsconfig.json` options are recommended for projects using this
SDK in order to get static type support for features like async iterables,
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
so on):

Expand All @@ -38,11 +38,11 @@ so on):
{
"compilerOptions": {
"target": "es2020", // or higher
"lib": ["es2020", "dom", "dom.iterable"],
"lib": ["es2020", "dom", "dom.iterable"]
}
}
```

While `target` can be set to older ECMAScript versions, it may result in extra,
unnecessary compatibility code being generated if you are not targeting old
runtimes.
runtimes.
19 changes: 19 additions & 0 deletions docs/models/operations/customdocumentdatum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CustomDocumentDatum

## Example Usage

```typescript
import { CustomDocumentDatum } from "@documenso/sdk-typescript/models/operations";

let value: CustomDocumentDatum = {
documentDataId: "<id>",
envelopeItemId: "<id>",
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `documentDataId` | *string* | :heavy_check_mark: | N/A |
| `envelopeItemId` | *string* | :heavy_check_mark: | N/A |
49 changes: 33 additions & 16 deletions docs/models/operations/document.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,43 +18,59 @@ let value: Document = {
},
formValues: {},
title: "<value>",
documentDataId: "<id>",
createdAt: "1722717346634",
updatedAt: "1735630218593",
completedAt: "<value>",
deletedAt: "<value>",
teamId: 4947.13,
templateId: 3493.89,
folderId: "<id>",
envelopeId: "<id>",
documentData: {
type: "BYTES",
id: "<id>",
data: "<value>",
initialData: "<value>",
envelopeItemId: "<id>",
},
documentMeta: {
signingOrder: "PARALLEL",
distributionMethod: "EMAIL",
id: "<id>",
subject: null,
message: "<value>",
timezone: null,
dateFormat: "<value>",
redirectUrl: "https://scornful-doubter.org/",
typedSignatureEnabled: true,
uploadSignatureEnabled: false,
drawSignatureEnabled: false,
allowDictateNextSigner: false,
language: "<value>",
emailSettings: {},
emailId: "<id>",
emailReplyTo: "<value>",
},
documentMeta: null,
folder: {
id: "<id>",
name: "<value>",
type: "DOCUMENT",
visibility: "ADMIN",
userId: 1957.61,
teamId: 1166.69,
userId: 3810.18,
teamId: 9987.45,
pinned: false,
parentId: "<id>",
createdAt: "1734873840846",
updatedAt: "1735609619846",
createdAt: "1727319290753",
updatedAt: "1735682218085",
},
recipients: [
{
role: "APPROVER",
envelopeId: "<id>",
role: "SIGNER",
readStatus: "OPENED",
signingStatus: "SIGNED",
sendStatus: "SENT",
id: 5867.64,
documentId: 4967.71,
templateId: 3810.18,
email: "Karl_Rice85@hotmail.com",
sendStatus: "NOT_SENT",
id: 9590.12,
email: "Carmen_Keeling70@gmail.com",
name: "<value>",
token: "<value>",
documentDeletedAt: "<value>",
Expand All @@ -66,7 +82,7 @@ let value: Document = {
"TWO_FACTOR_AUTH",
],
},
signingOrder: 1593.27,
signingOrder: 5424.29,
rejectionReason: "<value>",
},
],
Expand All @@ -87,14 +103,15 @@ let value: Document = {
| `authOptions` | [operations.DocumentCreateDocumentTemporaryAuthOptions](../../models/operations/documentcreatedocumenttemporaryauthoptions.md) | :heavy_check_mark: | N/A |
| `formValues` | Record<string, *operations.DocumentFormValues*> | :heavy_check_mark: | N/A |
| `title` | *string* | :heavy_check_mark: | N/A |
| `documentDataId` | *string* | :heavy_check_mark: | N/A |
| `createdAt` | *string* | :heavy_check_mark: | N/A |
| `updatedAt` | *string* | :heavy_check_mark: | N/A |
| `completedAt` | *string* | :heavy_check_mark: | N/A |
| `deletedAt` | *string* | :heavy_check_mark: | N/A |
| `teamId` | *number* | :heavy_check_mark: | N/A |
| `templateId` | *number* | :heavy_check_mark: | N/A |
| `folderId` | *string* | :heavy_check_mark: | N/A |
| `envelopeId` | *string* | :heavy_check_mark: | N/A |
| `templateId` | *number* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. |
| `documentDataId` | *string* | :heavy_minus_sign: | N/A |
| `documentData` | [operations.DocumentCreateDocumentTemporaryDocumentData](../../models/operations/documentcreatedocumenttemporarydocumentdata.md) | :heavy_check_mark: | N/A |
| `documentMeta` | [operations.DocumentCreateDocumentTemporaryDocumentMeta](../../models/operations/documentcreatedocumenttemporarydocumentmeta.md) | :heavy_check_mark: | N/A |
| `folder` | [operations.DocumentCreateDocumentTemporaryFolder](../../models/operations/documentcreatedocumenttemporaryfolder.md) | :heavy_check_mark: | N/A |
Expand Down
2 changes: 1 addition & 1 deletion docs/models/operations/documentaccessauth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ let value: DocumentAccessAuth = "ACCOUNT";
## Values

```typescript
"ACCOUNT"
"ACCOUNT" | "TWO_FACTOR_AUTH"
```
4 changes: 2 additions & 2 deletions docs/models/operations/documentcreatedocumenttemporaryaccessauthrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document.
```typescript
import { DocumentCreateDocumentTemporaryAccessAuthRequest } from "@documenso/sdk-typescript/models/operations";

let value: DocumentCreateDocumentTemporaryAccessAuthRequest = "ACCOUNT";
let value: DocumentCreateDocumentTemporaryAccessAuthRequest = "TWO_FACTOR_AUTH";
```

## Values

```typescript
"ACCOUNT"
"ACCOUNT" | "TWO_FACTOR_AUTH"
```
4 changes: 2 additions & 2 deletions docs/models/operations/documentcreatedocumenttemporarydateformat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ The date format to use for date fields and signing the document.
```typescript
import { DocumentCreateDocumentTemporaryDateFormat } from "@documenso/sdk-typescript/models/operations";

let value: DocumentCreateDocumentTemporaryDateFormat = "yyyy-MM-dd HH:mm:ss";
let value: DocumentCreateDocumentTemporaryDateFormat = "yy-MM-dd HH:mm";
```

## Values

```typescript
"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy hh:mm a" | "MM/dd/yyyy hh:mm a" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy hh:mm a" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
"yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy" | "MM/dd/yyyy" | "yy-MM-dd" | "MMMM dd, yyyy" | "EEEE, MMMM dd, yyyy" | "dd/MM/yyyy hh:mm a" | "dd/MM/yyyy HH:mm" | "MM/dd/yyyy hh:mm a" | "MM/dd/yyyy HH:mm" | "dd.MM.yyyy" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yy-MM-dd HH:mm" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "MMMM dd, yyyy HH:mm" | "EEEE, MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy HH:mm" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
```
Loading