Skip to content

chore: 🐝 Update SDK - Generate 0.3.0 #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.

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
Jun 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.DS_Store
**/.speakeasy/temp/
**/.speakeasy/logs/
.DS_Store
/mcp-server
/bin
/.eslintcache
Expand Down
856 changes: 458 additions & 398 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,27 @@ generation:
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
sdkInitStyle: constructor
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
nameResolutionFeb2025: true
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
securityFeb2025: false
sharedErrorComponentsApr2025: false
auth:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
typescript:
version: 0.2.0
version: 0.3.0
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
author: Speakeasy
baseErrorName: DocumensoError
clientServerStatusCodesAsErrors: true
defaultErrorName: APIError
enableCustomCodeRegions: false
Expand Down
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
speakeasyVersion: 1.531.0
speakeasyVersion: 1.557.0
sources:
Documenso v2 beta API:
sourceNamespace: documenso-v-2-beta-api
sourceRevisionDigest: sha256:f6430b0cc0c2d5b7a14e59359376c04f78458dd953a630f4a58093e86b4b56f7
sourceBlobDigest: sha256:b5ace18675a2927ed909e9e7210586bfd0bad91e1efebe408005432746a1511c
sourceRevisionDigest: sha256:4a3eda4d4da023cae10ad3029a2b254e8e115dd38bb3ea9a56a570441f031b98
sourceBlobDigest: sha256:98889fe156a5607596eb2c3682bdd80aeb8050f574eec2dcb1512b6172b1388b
tags:
- latest
- speakeasy-sdk-regen-1738455725
- speakeasy-sdk-regen-1744935756
- 0.0.0
targets:
documenso:
source: Documenso v2 beta API
sourceNamespace: documenso-v-2-beta-api
sourceRevisionDigest: sha256:f6430b0cc0c2d5b7a14e59359376c04f78458dd953a630f4a58093e86b4b56f7
sourceBlobDigest: sha256:b5ace18675a2927ed909e9e7210586bfd0bad91e1efebe408005432746a1511c
sourceRevisionDigest: sha256:4a3eda4d4da023cae10ad3029a2b254e8e115dd38bb3ea9a56a570441f031b98
sourceBlobDigest: sha256:98889fe156a5607596eb2c3682bdd80aeb8050f574eec2dcb1512b6172b1388b
codeSamplesNamespace: documenso-v-2-beta-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:7e83428fa1487934908f1a11ba3bea73bbe1d662ab1fbed2c80e7f33ac7f99d2
codeSamplesRevisionDigest: sha256:8eea490aba249e3eac97131de6744739de80e45cd2a997c8d6c4b30ac069d585
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
27 changes: 5 additions & 22 deletions FUNCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ specific category of applications.
```typescript
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
import { documentsFind } from "@documenso/sdk-typescript/funcs/documentsFind.js";
import { SDKValidationError } from "@documenso/sdk-typescript/models/errors/sdkvalidationerror.js";

// Use `DocumensoCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
Expand All @@ -31,28 +30,12 @@ const documenso = new DocumensoCore({

async function run() {
const res = await documentsFind(documenso, {});

switch (true) {
case res.ok:
// The success case will be handled outside of the switch block
break;
case res.error instanceof SDKValidationError:
// Pretty-print validation errors.
return console.log(res.error.pretty());
case res.error instanceof Error:
return console.log(res.error);
default:
// TypeScript's type checking will fail on the following line if the above
// cases were not exhaustive.
res.error satisfies never;
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("documentsFind failed:", res.error);
}


const { value: result } = res;

// Handle the result
console.log(result);
}

run();
Expand Down
206 changes: 148 additions & 58 deletions README.md

Large diffs are not rendered by default.

12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,14 @@ Based on:
### Generated
- [typescript v0.2.0] .
### Releases
- [NPM v0.2.0] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.2.0 - .
- [NPM v0.2.0] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.2.0 - .

## 2025-06-09 00:26:00
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.0] .
### Releases
- [NPM v0.3.0] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.3.0 - .
1 change: 0 additions & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ const documenso = new Documenso({
async function run() {
const result = await documenso.documents.find({});

// Handle the result
console.log(result);
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError

Invalid input data

## Example Usage

```typescript
import { EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError } from "@documenso/sdk-typescript/models/errors";

// No examples available for this model
```

## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message` | *string* | :heavy_check_mark: | N/A |
| `code` | *string* | :heavy_check_mark: | N/A |
| `issues` | [errors.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue](../../models/errors/embeddingpresigncreateembeddingpresigntokenbadrequestissue.md)[] | :heavy_minus_sign: | N/A |
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue

## Example Usage

```typescript
import { EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue } from "@documenso/sdk-typescript/models/errors";

let value: EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue = {
message: "<value>",
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError

Internal server error

## Example Usage

```typescript
import { EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError } from "@documenso/sdk-typescript/models/errors";

// No examples available for this model
```

## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message` | *string* | :heavy_check_mark: | N/A |
| `code` | *string* | :heavy_check_mark: | N/A |
| `issues` | [errors.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue](../../models/errors/embeddingpresigncreateembeddingpresigntokeninternalservererrorissue.md)[] | :heavy_minus_sign: | N/A |
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue

## Example Usage

```typescript
import { EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue } from "@documenso/sdk-typescript/models/errors";

let value: EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue =
{
message: "<value>",
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError

Invalid input data

## Example Usage

```typescript
import { EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError } from "@documenso/sdk-typescript/models/errors";

// No examples available for this model
```

## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message` | *string* | :heavy_check_mark: | N/A |
| `code` | *string* | :heavy_check_mark: | N/A |
| `issues` | [errors.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue](../../models/errors/embeddingpresignverifyembeddingpresigntokenbadrequestissue.md)[] | :heavy_minus_sign: | N/A |
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue

## Example Usage

```typescript
import { EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue } from "@documenso/sdk-typescript/models/errors";

let value: EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue = {
message: "<value>",
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |
Loading