Skip to content

chore: 🐝 Update SDK - Generate 0.1.3 #2

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

Closed
wants to merge 1 commit into from
Closed

chore: 🐝 Update SDK - Generate 0.1.3 #2

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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
248 changes: 235 additions & 13 deletions .speakeasy/gen.lock
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
typescript:
version: 0.1.2
version: 0.1.3
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand Down
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.469.10
speakeasyVersion: 1.469.11
sources:
Documenso v2 beta API:
sourceNamespace: documenso-v-2-beta-api
sourceRevisionDigest: sha256:93ee78e094f9f5de4c126c6a06c363e22412c11a874255e545a8cb610b3bf047
sourceBlobDigest: sha256:b54d7f793fedc532b07ad3a417aa86f4af3d1b4f9e7496550ce6cf5a455187fb
sourceRevisionDigest: sha256:a19238d18f54c94c6f7628ad6a104aa58eac4acbb3261612ab79c5f9a042e0ba
sourceBlobDigest: sha256:1660a3a61f026b73adb9b2fdddc49fcbf66b8534c3394b38a434cf857333a785
tags:
- latest
- speakeasy-sdk-regen-1737368101
- speakeasy-sdk-regen-1737418823
- 0.0.0
targets:
documenso:
source: Documenso v2 beta API
sourceNamespace: documenso-v-2-beta-api
sourceRevisionDigest: sha256:93ee78e094f9f5de4c126c6a06c363e22412c11a874255e545a8cb610b3bf047
sourceBlobDigest: sha256:b54d7f793fedc532b07ad3a417aa86f4af3d1b4f9e7496550ce6cf5a455187fb
sourceRevisionDigest: sha256:a19238d18f54c94c6f7628ad6a104aa58eac4acbb3261612ab79c5f9a042e0ba
sourceBlobDigest: sha256:1660a3a61f026b73adb9b2fdddc49fcbf66b8534c3394b38a434cf857333a785
codeSamplesNamespace: documenso-v-2-beta-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:88d3d249a42c45220d4b668f0fe65b78cc17890da031e29c7211419a2442e992
codeSamplesRevisionDigest: sha256:1352f97f0b5ccefb3979ee9d29cc61120026db00ab142f98d3e3fbb2e085b007
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
31 changes: 16 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,21 +344,21 @@ run();

Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `find` method may throw the following errors:

| Error Type | Status Code | Content Type |
| ------------------------------- | ----------- | ---------------- |
| errors.ErrorBADREQUEST | 400 | application/json |
| errors.ErrorNOTFOUND | 404 | application/json |
| errors.Errorinternalservererror | 500 | application/json |
| errors.APIError | 4XX, 5XX | \*/\* |
| Error Type | Status Code | Content Type |
| --------------------------------------------------------- | ----------- | ---------------- |
| errors.DocumentFindDocumentsResponseBody | 400 | application/json |
| errors.DocumentFindDocumentsDocumentsResponseBody | 404 | application/json |
| errors.DocumentFindDocumentsDocumentsResponseResponseBody | 500 | application/json |
| errors.APIError | 4XX, 5XX | \*/\* |

If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.

```typescript
import { Documenso } from "@documenso/sdk-typescript";
import {
ErrorBADREQUEST,
Errorinternalservererror,
ErrorNOTFOUND,
DocumentFindDocumentsDocumentsResponseBody,
DocumentFindDocumentsDocumentsResponseResponseBody,
DocumentFindDocumentsResponseBody,
SDKValidationError,
} from "@documenso/sdk-typescript/models/errors";

Expand All @@ -385,18 +385,19 @@ async function run() {
console.error(err.rawValue);
return;
}
case (err instanceof ErrorBADREQUEST): {
// Handle err.data$: ErrorBADREQUESTData
case (err instanceof DocumentFindDocumentsResponseBody): {
// Handle err.data$: DocumentFindDocumentsResponseBodyData
console.error(err);
return;
}
case (err instanceof ErrorNOTFOUND): {
// Handle err.data$: ErrorNOTFOUNDData
case (err instanceof DocumentFindDocumentsDocumentsResponseBody): {
// Handle err.data$: DocumentFindDocumentsDocumentsResponseBodyData
console.error(err);
return;
}
case (err instanceof Errorinternalservererror): {
// Handle err.data$: ErrorinternalservererrorData
case (err
instanceof DocumentFindDocumentsDocumentsResponseResponseBody): {
// Handle err.data$: DocumentFindDocumentsDocumentsResponseResponseBodyData
console.error(err);
return;
}
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 @@ -8,4 +8,14 @@ Based on:
### Generated
- [typescript v0.1.2] .
### Releases
- [NPM v0.1.2] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.1.2 - .
- [NPM v0.1.2] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.1.2 - .

## 2025-01-21 00:20:08
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.469.11 (2.493.32) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.1.3] .
### Releases
- [NPM v0.1.3] https://www.npmjs.com/package/@documenso/sdk-typescript/v/0.1.3 - .
17 changes: 17 additions & 0 deletions docs/models/errors/documentcreatedocumenttemporarydocumentsissues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DocumentCreateDocumentTemporaryDocumentsIssues

## Example Usage

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

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

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |
19 changes: 19 additions & 0 deletions docs/models/errors/documentcreatedocumenttemporarydocumentsresponsebody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DocumentCreateDocumentTemporaryDocumentsResponseBody

Internal server error

## Example Usage

```typescript
import { DocumentCreateDocumentTemporaryDocumentsResponseBody } 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.DocumentCreateDocumentTemporaryDocumentsIssues](../../models/errors/documentcreatedocumenttemporarydocumentsissues.md)[] | :heavy_minus_sign: | N/A |
17 changes: 17 additions & 0 deletions docs/models/errors/documentcreatedocumenttemporaryissues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DocumentCreateDocumentTemporaryIssues

## Example Usage

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

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

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |
19 changes: 19 additions & 0 deletions docs/models/errors/documentcreatedocumenttemporaryresponsebody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DocumentCreateDocumentTemporaryResponseBody

Invalid input data

## Example Usage

```typescript
import { DocumentCreateDocumentTemporaryResponseBody } 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.DocumentCreateDocumentTemporaryIssues](../../models/errors/documentcreatedocumenttemporaryissues.md)[] | :heavy_minus_sign: | N/A |
17 changes: 17 additions & 0 deletions docs/models/errors/documentdeletedocumentdocumentsissues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DocumentDeleteDocumentDocumentsIssues

## Example Usage

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

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

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |
19 changes: 19 additions & 0 deletions docs/models/errors/documentdeletedocumentdocumentsresponsebody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DocumentDeleteDocumentDocumentsResponseBody

Internal server error

## Example Usage

```typescript
import { DocumentDeleteDocumentDocumentsResponseBody } 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.DocumentDeleteDocumentDocumentsIssues](../../models/errors/documentdeletedocumentdocumentsissues.md)[] | :heavy_minus_sign: | N/A |
17 changes: 17 additions & 0 deletions docs/models/errors/documentdeletedocumentissues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DocumentDeleteDocumentIssues

## Example Usage

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

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

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |
19 changes: 19 additions & 0 deletions docs/models/errors/documentdeletedocumentresponsebody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DocumentDeleteDocumentResponseBody

Invalid input data

## Example Usage

```typescript
import { DocumentDeleteDocumentResponseBody } 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.DocumentDeleteDocumentIssues](../../models/errors/documentdeletedocumentissues.md)[] | :heavy_minus_sign: | N/A |
17 changes: 17 additions & 0 deletions docs/models/errors/documentduplicatedocumentdocumentsissues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DocumentDuplicateDocumentDocumentsIssues

## Example Usage

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

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

## Fields

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