Skip to content

Commit c6286b4

Browse files
github-actions[bot]speakeasybotspeakeasy-github[bot]
authored
chore: 🐝 Update SDK - Generate 0.4.0 (#11)
* ## Typescript SDK Changes Detected: * `documenso.templates.find()`: `response.data.[]` **Changed** **Breaking** ⚠️ * `documenso.templates.get()`: `response` **Changed** **Breaking** ⚠️ * `documenso.template.templateCreateTemplateTemporary()`: `response.template` **Changed** **Breaking** ⚠️ * `documenso.templates.recipients.updateMany()`: `response.recipients.[]` **Changed** **Breaking** ⚠️ * `documenso.templates.recipients.update()`: `response` **Changed** **Breaking** ⚠️ * `documenso.documents.createV0()`: * `request` **Changed** * `response.document` **Changed** **Breaking** ⚠️ * `documenso.documents.fields.get()`: `response` **Changed** **Breaking** ⚠️ * `documenso.documents.fields.create()`: * `request.field.[class].fieldMeta` **Changed** * `response` **Changed** **Breaking** ⚠️ * `documenso.documents.fields.createMany()`: * `request.fields.[].[class].fieldMeta` **Changed** * `response.fields.[]` **Changed** **Breaking** ⚠️ * `documenso.documents.fields.update()`: * `request.field.[class].fieldMeta` **Changed** * `response` **Changed** **Breaking** ⚠️ * `documenso.templates.recipients.get()`: `response` **Changed** **Breaking** ⚠️ * `documenso.documents.recipients.get()`: `response` **Changed** **Breaking** ⚠️ * `documenso.templates.fields.updateMany()`: * `request.fields.[].[class].fieldMeta` **Changed** * `response.fields.[]` **Changed** **Breaking** ⚠️ * `documenso.templates.fields.update()`: * `request.field.[class].fieldMeta` **Changed** * `response` **Changed** **Breaking** ⚠️ * `documenso.documents.recipients.update()`: `response` **Changed** **Breaking** ⚠️ * `documenso.documents.recipients.updateMany()`: `response.recipients.[]` **Changed** **Breaking** ⚠️ * `documenso.templates.fields.createMany()`: * `request.fields.[].[class].fieldMeta` **Changed** * `response.fields.[]` **Changed** **Breaking** ⚠️ * `documenso.documents.get()`: `response` **Changed** **Breaking** ⚠️ * `documenso.documents.fields.updateMany()`: * `request.fields.[].[class].fieldMeta` **Changed** * `response.fields.[]` **Changed** **Breaking** ⚠️ * `documenso.templates.fields.get()`: `response` **Changed** **Breaking** ⚠️ * `documenso.templates.use()`: * `request.customDocumentData` **Added** * `response` **Changed** **Breaking** ⚠️ * `documenso.templates.fields.create()`: * `request.field.[class].fieldMeta` **Changed** * `response` **Changed** **Breaking** ⚠️ * `documenso.templates.duplicate()`: `response` **Changed** * `documenso.documents.find()`: `response.data.[]` **Changed** * `documenso.documents.recipients.createMany()`: `response.recipients.[]` **Changed** * `documenso.documents.recipients.create()`: `response` **Changed** * `documenso.templates.update()`: * `request.data.folderId` **Added** * `response` **Changed** * `documenso.templates.recipients.create()`: `response` **Changed** * `documenso.templates.recipients.createMany()`: `response.recipients.[]` **Changed** * `documenso.documents.distribute()`: `response` **Changed** * `documenso.documents.duplicate()`: `response.id` **Added** * `documenso.templates.directLink.create()`: `response.envelopeid` **Added** * `documenso.templates.directLink.toggle()`: `response.envelopeid` **Added** * `documenso.documents.update()`: * `request` **Changed** * `response` **Changed** * empty commit to trigger [run-tests] workflow --------- Co-authored-by: speakeasybot <bot@speakeasyapi.dev> Co-authored-by: speakeasy-github[bot] <128539517+speakeasy-github[bot]@users.noreply.github.com>
1 parent 2db6d06 commit c6286b4

File tree

236 files changed

+2672
-1879
lines changed

Some content is hidden

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

236 files changed

+2672
-1879
lines changed

‎.speakeasy/gen.lock‎

Lines changed: 42 additions & 41 deletions
Large diffs are not rendered by default.

‎.speakeasy/gen.yaml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,16 @@ generation:
1616
auth:
1717
oAuth2ClientCredentialsEnabled: false
1818
oAuth2PasswordEnabled: false
19+
hoistGlobalSecurity: true
20+
schemas:
21+
allOfMergeStrategy: shallowMerge
1922
tests:
2023
generateTests: true
2124
generateNewTests: false
2225
skipResponseBodyAssertions: false
2326
typescript:
24-
version: 0.3.2
27+
version: 0.4.0
28+
acceptHeaderEnum: true
2529
additionalDependencies:
2630
dependencies: {}
2731
devDependencies: {}
@@ -52,10 +56,12 @@ typescript:
5256
jsonpath: legacy
5357
maxMethodParams: 0
5458
methodArguments: require-security-and-request
59+
modelPropertyCasing: camel
5560
moduleFormat: commonjs
5661
outputModelSuffix: output
5762
packageName: '@documenso/sdk-typescript'
5863
responseFormat: flat
64+
sseFlatResponse: false
5965
templateVersion: v2
6066
usageSDKInitImports: []
6167
useIndexModules: true

‎.speakeasy/workflow.lock‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.606.10
1+
speakeasyVersion: 1.637.3
22
sources:
33
Documenso v2 beta API:
44
sourceNamespace: documenso-v-2-beta-api
5-
sourceRevisionDigest: sha256:442d296d692d7ffe641ab405c4bc6a569b8fe538a6718f3d12331a4be92e51e6
6-
sourceBlobDigest: sha256:4211e6fd5beb2648e5d85775f81ffd7cb5f213d21f156295156e01a40e61340a
5+
sourceRevisionDigest: sha256:5655c327963c859a6b2690d2f07ff5a14c557dae975710c55e1e94a3a8ca03c5
6+
sourceBlobDigest: sha256:628fee4fefdec824deaa24deaf158a9f7e61fea8a997f4e39e47dca425903deb
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1752107119
9+
- speakeasy-sdk-regen-1761011807
1010
- 0.0.0
1111
targets:
1212
documenso:
1313
source: Documenso v2 beta API
1414
sourceNamespace: documenso-v-2-beta-api
15-
sourceRevisionDigest: sha256:442d296d692d7ffe641ab405c4bc6a569b8fe538a6718f3d12331a4be92e51e6
16-
sourceBlobDigest: sha256:4211e6fd5beb2648e5d85775f81ffd7cb5f213d21f156295156e01a40e61340a
15+
sourceRevisionDigest: sha256:5655c327963c859a6b2690d2f07ff5a14c557dae975710c55e1e94a3a8ca03c5
16+
sourceBlobDigest: sha256:628fee4fefdec824deaa24deaf158a9f7e61fea8a997f4e39e47dca425903deb
1717
codeSamplesNamespace: documenso-v-2-beta-api-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:16b65d25065a50ebfeefc2cb72c565a726698d9385afa8b9fe281067747a3b58
18+
codeSamplesRevisionDigest: sha256:37b05993bb40943f140a099b917322a9f24e727e5a3c86f6caa5551e4cb41b68
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

‎README.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,7 @@ bun add @documenso/sdk-typescript
7474
### Yarn
7575

7676
```bash
77-
yarn add @documenso/sdk-typescript zod
78-
79-
# Note that Yarn does not install peer dependencies automatically. You will need
80-
# to install zod as shown above.
77+
yarn add @documenso/sdk-typescript
8178
```
8279

8380

@@ -296,7 +293,6 @@ main()
296293
<details open>
297294
<summary>Available methods</summary>
298295

299-
300296
### [document](docs/sdks/document/README.md)
301297

302298
* [documentDownload](docs/sdks/document/README.md#documentdownload) - Download document (beta)

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,14 @@ Based on:
5858
### Generated
5959
- [typescript v0.3.2] .
6060
### Releases
61-
- [NPM v0.3.2] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.3.2 - .
61+
- [NPM v0.3.2] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.3.2 - .
62+
63+
## 2025-10-21 01:56:28
64+
### Changes
65+
Based on:
66+
- OpenAPI Doc
67+
- Speakeasy CLI 1.637.3 (2.727.9) https://github.com/speakeasy-api/speakeasy
68+
### Generated
69+
- [typescript v0.4.0] .
70+
### Releases
71+
- [NPM v0.4.0] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.4.0 - .

‎RUNTIMES.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

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

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

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

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

@@ -38,11 +38,11 @@ so on):
3838
{
3939
"compilerOptions": {
4040
"target": "es2020", // or higher
41-
"lib": ["es2020", "dom", "dom.iterable"],
41+
"lib": ["es2020", "dom", "dom.iterable"]
4242
}
4343
}
4444
```
4545

4646
While `target` can be set to older ECMAScript versions, it may result in extra,
4747
unnecessary compatibility code being generated if you are not targeting old
48-
runtimes.
48+
runtimes.

‎docs/models/operations/customdocumentdatum.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# CustomDocumentDatum
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { CustomDocumentDatum } from "@documenso/sdk-typescript/models/operations";
7+
8+
let value: CustomDocumentDatum = {
9+
documentDataId: "<id>",
10+
envelopeItemId: "<id>",
11+
};
12+
```
13+
14+
## Fields
15+
16+
| Field | Type | Required | Description |
17+
| ------------------ | ------------------ | ------------------ | ------------------ |
18+
| `documentDataId` | *string* | :heavy_check_mark: | N/A |
19+
| `envelopeItemId` | *string* | :heavy_check_mark: | N/A |

‎docs/models/operations/document.md‎

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,43 +18,59 @@ let value: Document = {
1818
},
1919
formValues: {},
2020
title: "<value>",
21-
documentDataId: "<id>",
2221
createdAt: "1722717346634",
2322
updatedAt: "1735630218593",
2423
completedAt: "<value>",
2524
deletedAt: "<value>",
2625
teamId: 4947.13,
27-
templateId: 3493.89,
2826
folderId: "<id>",
27+
envelopeId: "<id>",
2928
documentData: {
3029
type: "BYTES",
3130
id: "<id>",
3231
data: "<value>",
3332
initialData: "<value>",
33+
envelopeItemId: "<id>",
34+
},
35+
documentMeta: {
36+
signingOrder: "PARALLEL",
37+
distributionMethod: "EMAIL",
38+
id: "<id>",
39+
subject: null,
40+
message: "<value>",
41+
timezone: null,
42+
dateFormat: "<value>",
43+
redirectUrl: "https://scornful-doubter.org/",
44+
typedSignatureEnabled: true,
45+
uploadSignatureEnabled: false,
46+
drawSignatureEnabled: false,
47+
allowDictateNextSigner: false,
48+
language: "<value>",
49+
emailSettings: {},
50+
emailId: "<id>",
51+
emailReplyTo: "<value>",
3452
},
35-
documentMeta: null,
3653
folder: {
3754
id: "<id>",
3855
name: "<value>",
3956
type: "DOCUMENT",
4057
visibility: "ADMIN",
41-
userId: 1957.61,
42-
teamId: 1166.69,
58+
userId: 3810.18,
59+
teamId: 9987.45,
4360
pinned: false,
4461
parentId: "<id>",
45-
createdAt: "1734873840846",
46-
updatedAt: "1735609619846",
62+
createdAt: "1727319290753",
63+
updatedAt: "1735682218085",
4764
},
4865
recipients: [
4966
{
50-
role: "APPROVER",
67+
envelopeId: "<id>",
68+
role: "SIGNER",
5169
readStatus: "OPENED",
5270
signingStatus: "SIGNED",
53-
sendStatus: "SENT",
54-
id: 5867.64,
55-
documentId: 4967.71,
56-
templateId: 3810.18,
57-
email: "Karl_Rice85@hotmail.com",
71+
sendStatus: "NOT_SENT",
72+
id: 9590.12,
73+
email: "Carmen_Keeling70@gmail.com",
5874
name: "<value>",
5975
token: "<value>",
6076
documentDeletedAt: "<value>",
@@ -66,7 +82,7 @@ let value: Document = {
6682
"TWO_FACTOR_AUTH",
6783
],
6884
},
69-
signingOrder: 1593.27,
85+
signingOrder: 5424.29,
7086
rejectionReason: "<value>",
7187
},
7288
],
@@ -87,14 +103,15 @@ let value: Document = {
87103
| `authOptions` | [operations.DocumentCreateDocumentTemporaryAuthOptions](../../models/operations/documentcreatedocumenttemporaryauthoptions.md) | :heavy_check_mark: | N/A |
88104
| `formValues` | Record<string, *operations.DocumentFormValues*> | :heavy_check_mark: | N/A |
89105
| `title` | *string* | :heavy_check_mark: | N/A |
90-
| `documentDataId` | *string* | :heavy_check_mark: | N/A |
91106
| `createdAt` | *string* | :heavy_check_mark: | N/A |
92107
| `updatedAt` | *string* | :heavy_check_mark: | N/A |
93108
| `completedAt` | *string* | :heavy_check_mark: | N/A |
94109
| `deletedAt` | *string* | :heavy_check_mark: | N/A |
95110
| `teamId` | *number* | :heavy_check_mark: | N/A |
96-
| `templateId` | *number* | :heavy_check_mark: | N/A |
97111
| `folderId` | *string* | :heavy_check_mark: | N/A |
112+
| `envelopeId` | *string* | :heavy_check_mark: | N/A |
113+
| `templateId` | *number* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. |
114+
| `documentDataId` | *string* | :heavy_minus_sign: | N/A |
98115
| `documentData` | [operations.DocumentCreateDocumentTemporaryDocumentData](../../models/operations/documentcreatedocumenttemporarydocumentdata.md) | :heavy_check_mark: | N/A |
99116
| `documentMeta` | [operations.DocumentCreateDocumentTemporaryDocumentMeta](../../models/operations/documentcreatedocumenttemporarydocumentmeta.md) | :heavy_check_mark: | N/A |
100117
| `folder` | [operations.DocumentCreateDocumentTemporaryFolder](../../models/operations/documentcreatedocumenttemporaryfolder.md) | :heavy_check_mark: | N/A |

‎docs/models/operations/documentaccessauth.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ let value: DocumentAccessAuth = "ACCOUNT";
1313
## Values
1414

1515
```typescript
16-
"ACCOUNT"
16+
"ACCOUNT" | "TWO_FACTOR_AUTH"
1717
```

‎docs/models/operations/documentcreatedocumenttemporaryaccessauthrequest.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ The type of authentication required for the recipient to access the document.
77
```typescript
88
import { DocumentCreateDocumentTemporaryAccessAuthRequest } from "@documenso/sdk-typescript/models/operations";
99

10-
let value: DocumentCreateDocumentTemporaryAccessAuthRequest = "ACCOUNT";
10+
let value: DocumentCreateDocumentTemporaryAccessAuthRequest = "TWO_FACTOR_AUTH";
1111
```
1212

1313
## Values
1414

1515
```typescript
16-
"ACCOUNT"
16+
"ACCOUNT" | "TWO_FACTOR_AUTH"
1717
```

0 commit comments

Comments
 (0)