speakeasy-api · github-actions · Dec 7, 2025 · Dec 7, 2025
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+/examples/node_modules
+.env
+.env.local
+.env.*.local
 .DS_Store
 **/.speakeasy/temp/
 **/.speakeasy/logs/

diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,28 +1,28 @@
-speakeasyVersion: 1.561.0
+speakeasyVersion: 1.669.1
 sources:
     my-source:
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:2e5dc78239617b9501f2028df534aa4601c61396c89a582390d75a797fc228cc
-        sourceBlobDigest: sha256:0442ef7698d8979dd825b3eab0ab868ac86580f4cffcd3e0dff7afdd6191e6d9
+        sourceRevisionDigest: sha256:01a202f9b2f5c54bbf985d5ef6db20a01d6ab1cc7f9112274d2eca38e8daf24f
+        sourceBlobDigest: sha256:180487180cb415c9db8edd2bd57b7b893e7b0d592afd8337df061d61a2e6343a
         tags:
             - latest
-            - speakeasy-sdk-regen-1746577270
+            - speakeasy-sdk-regen-1753835013
             - 0.4.0
 targets:
     speakeasy-client-sdk-typescript:
         source: my-source
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:2e5dc78239617b9501f2028df534aa4601c61396c89a582390d75a797fc228cc
-        sourceBlobDigest: sha256:0442ef7698d8979dd825b3eab0ab868ac86580f4cffcd3e0dff7afdd6191e6d9
+        sourceRevisionDigest: sha256:01a202f9b2f5c54bbf985d5ef6db20a01d6ab1cc7f9112274d2eca38e8daf24f
+        sourceBlobDigest: sha256:180487180cb415c9db8edd2bd57b7b893e7b0d592afd8337df061d61a2e6343a
         codeSamplesNamespace: my-source-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:65717f579dccb319b073cb22e553e23bd3419cf420967387c00d148c041f5dc1
+        codeSamplesRevisionDigest: sha256:c02ea3be935eb6739760db5b35c48b6dc9b862ca2374ffa42c4c9b21a4ec48ce
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
     sources:
         my-source:
             inputs:
-                - location: https://speakeasy.com/openapi.yaml
+                - location: https://spec.speakeasy.com/speakeasy-self/speakeasy-self/speakeasy-api
             registry:
                 location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/my-source
     targets:

diff --git a/README.md b/README.md
@@ -73,12 +73,9 @@ bun add @tanstack/react-query react react-dom
 ### Yarn
 
 ```bash
-yarn add @speakeasy-api/speakeasy-client-sdk-typescript zod
+yarn add @speakeasy-api/speakeasy-client-sdk-typescript
 # Install optional peer dependencies if you plan to use React hooks
 yarn add @tanstack/react-query react react-dom
-
-# Note that Yarn does not install peer dependencies automatically. You will need
-# to install zod as shown above.
 ```
 
 
@@ -202,7 +199,7 @@ run();
 <details open>
 <summary>Available methods</summary>
 
-### [artifacts](docs/sdks/artifacts/README.md)
+### [Artifacts](docs/sdks/artifacts/README.md)
 
 * [createRemoteSource](docs/sdks/artifacts/README.md#createremotesource) - Configure a new remote source
 * [getBlob](docs/sdks/artifacts/README.md#getblob) - Get blob for a particular digest
@@ -216,29 +213,29 @@ run();
 * [setArchived](docs/sdks/artifacts/README.md#setarchived) - Set whether a namespace is archived
 * [setVisibility](docs/sdks/artifacts/README.md#setvisibility) - Set visibility of a namespace with an existing metadata entry
 
-### [auth](docs/sdks/auth/README.md)
+### [Auth](docs/sdks/auth/README.md)
 
 * [getAccess](docs/sdks/auth/README.md#getaccess) - Get access allowances for a particular workspace
 * [getAccessToken](docs/sdks/auth/README.md#getaccesstoken) - Get or refresh an access token for the current workspace.
 * [getUser](docs/sdks/auth/README.md#getuser) - Get information about the current user.
 * [validateApiKey](docs/sdks/auth/README.md#validateapikey) - Validate the current api key.
 
-### [codeSamples](docs/sdks/codesamples/README.md)
+### [CodeSamples](docs/sdks/codesamples/README.md)
 
 * [generateCodeSamplePreview](docs/sdks/codesamples/README.md#generatecodesamplepreview) - Generate Code Sample previews from a file and configuration parameters.
 * [generateCodeSamplePreviewAsync](docs/sdks/codesamples/README.md#generatecodesamplepreviewasync) - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling.
 * [get](docs/sdks/codesamples/README.md#get) - Retrieve usage snippets
 * [getCodeSamplePreviewAsync](docs/sdks/codesamples/README.md#getcodesamplepreviewasync) - Poll for the result of an asynchronous Code Sample preview generation.
 
-### [events](docs/sdks/events/README.md)
+### [Events](docs/sdks/events/README.md)
 
 * [getEventsByTarget](docs/sdks/events/README.md#geteventsbytarget) - Load recent events for a particular workspace
 * [getTargets](docs/sdks/events/README.md#gettargets) - Load targets for a particular workspace
 * [getTargetsDeprecated](docs/sdks/events/README.md#gettargetsdeprecated) - Load targets for a particular workspace
 * [post](docs/sdks/events/README.md#post) - Post events for a specific workspace
 * [search](docs/sdks/events/README.md#search) - Search events for a particular workspace by any field
 
-### [github](docs/sdks/github/README.md)
+### [Github](docs/sdks/github/README.md)
 
 * [checkAccess](docs/sdks/github/README.md#checkaccess)
 * [checkPublishingPRs](docs/sdks/github/README.md#checkpublishingprs)
@@ -252,7 +249,7 @@ run();
 * [storePublishingSecrets](docs/sdks/github/README.md#storepublishingsecrets)
 * [triggerAction](docs/sdks/github/README.md#triggeraction)
 
-### [organizations](docs/sdks/organizations/README.md)
+### [Organizations](docs/sdks/organizations/README.md)
 
 * [create](docs/sdks/organizations/README.md#create) - Create an organization
 * [createBillingAddOns](docs/sdks/organizations/README.md#createbillingaddons) - Create billing add ons
@@ -263,7 +260,7 @@ run();
 * [getBillingAddOns](docs/sdks/organizations/README.md#getbillingaddons) - Get billing add ons
 * [getUsage](docs/sdks/organizations/README.md#getusage) - Get billing usage summary for a particular organization
 
-### [publishingTokens](docs/sdks/publishingtokens/README.md)
+### [PublishingTokens](docs/sdks/publishingtokens/README.md)
 
 * [create](docs/sdks/publishingtokens/README.md#create) - Create a publishing token for a workspace
 * [delete](docs/sdks/publishingtokens/README.md#delete) - Delete a specific publishing token
@@ -273,34 +270,33 @@ run();
 * [resolveTarget](docs/sdks/publishingtokens/README.md#resolvetarget) - Get a specific publishing token target
 * [update](docs/sdks/publishingtokens/README.md#update) - Updates the validitity period of a publishing token
 
-### [reports](docs/sdks/reports/README.md)
+### [Reports](docs/sdks/reports/README.md)
 
 * [getChangesReportSignedUrl](docs/sdks/reports/README.md#getchangesreportsignedurl) - Get the signed access url for the change reports for a particular document.
 * [getLintingReportSignedUrl](docs/sdks/reports/README.md#getlintingreportsignedurl) - Get the signed access url for the linting reports for a particular document.
 * [uploadReport](docs/sdks/reports/README.md#uploadreport) - Upload a report.
 
-### [schemaStore](docs/sdks/schemastore/README.md)
+### [SchemaStore](docs/sdks/schemastore/README.md)
 
 * [createSchemaStoreItem](docs/sdks/schemastore/README.md#createschemastoreitem) - Create a schema in the schema store
 
-### [shortURLs](docs/sdks/shorturls/README.md)
+### [ShortURLs](docs/sdks/shorturls/README.md)
 
 * [create](docs/sdks/shorturls/README.md#create) - Shorten a URL.
 
-
-### [subscriptions](docs/sdks/subscriptions/README.md)
+### [Subscriptions](docs/sdks/subscriptions/README.md)
 
 * [activateSubscriptionNamespace](docs/sdks/subscriptions/README.md#activatesubscriptionnamespace) - Activate an ignored namespace for a subscription
 * [ignoreSubscriptionNamespace](docs/sdks/subscriptions/README.md#ignoresubscriptionnamespace) - Ignored a namespace for a subscription
 
-### [suggest](docs/sdks/suggest/README.md)
+### [Suggest](docs/sdks/suggest/README.md)
 
 * [suggest](docs/sdks/suggest/README.md#suggest) - Generate suggestions for improving an OpenAPI document.
 * [suggestItems](docs/sdks/suggest/README.md#suggestitems) - Generate generic suggestions for a list of items.
 * [suggestOpenAPI](docs/sdks/suggest/README.md#suggestopenapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
 * [suggestOpenAPIRegistry](docs/sdks/suggest/README.md#suggestopenapiregistry) - Generate suggestions for improving an OpenAPI document stored in the registry.
 
-### [workspaces](docs/sdks/workspaces/README.md)
+### [Workspaces](docs/sdks/workspaces/README.md)
 
 * [create](docs/sdks/workspaces/README.md#create) - Create a workspace
 * [createToken](docs/sdks/workspaces/README.md#createtoken) - Create a token for a particular workspace
@@ -379,7 +375,7 @@ run();
 ### Error Classes
 **Primary errors:**
 * [`SpeakeasyError`](./src/sdk/models/errors/speakeasyerror.ts): The base class for HTTP error responses.
-  * [`ErrorT`](docs/sdk/models/errors/errort.md): The `Status` type defines a logical error model. *
+  * [`ErrorT`](./src/sdk/models/errors/errort.ts): The `Status` type defines a logical error model. *
 
 <details><summary>Less common errors (6)</summary>
 
@@ -503,7 +499,7 @@ httpClient.addHook("requestError", (error, request) => {
   console.groupEnd();
 });
 
-const sdk = new Speakeasy({ httpClient });
+const sdk = new Speakeasy({ httpClient: httpClient });
 ```
 <!-- End Custom HTTP Client [http-client] -->
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -1706,4 +1706,14 @@ Based on:
 ### Generated
 - [typescript v5.0.0-rc.4] .
 ### Releases
-- [NPM v5.0.0-rc.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.4 - .
+- [NPM v5.0.0-rc.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.4 - .
+
+## 2025-12-07 00:24:51
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.669.1 (2.772.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v5.0.0-rc.5] .
+### Releases
+- [NPM v5.0.0-rc.5] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.5 - .
diff --git a/RUNTIMES.md b/RUNTIMES.md
@@ -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
@@ -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):
 
@@ -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.
diff --git a/docs/sdk/models/operations/createworkspacetokenrequest.md b/docs/sdk/models/operations/createworkspacetokenrequest.md
@@ -5,7 +5,16 @@
 ```typescript
 import { CreateWorkspaceTokenRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
 
-let value: CreateWorkspaceTokenRequest = {};
+let value: CreateWorkspaceTokenRequest = {
+  workspaceToken: {
+    alg: "<value>",
+    createdAt: new Date("2023-10-18T04:12:26.286Z"),
+    id: "<id>",
+    key: "<key>",
+    name: "<value>",
+    workspaceId: "<id>",
+  },
+};
 ```
 
 ## Fields

diff --git a/docs/sdk/models/operations/postworkspaceeventsrequest.md b/docs/sdk/models/operations/postworkspaceeventsrequest.md
@@ -5,7 +5,21 @@
 ```typescript
 import { PostWorkspaceEventsRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
 
-let value: PostWorkspaceEventsRequest = {};
+let value: PostWorkspaceEventsRequest = {
+  requestBody: [
+    {
+      createdAt: new Date("2024-04-27T01:44:18.572Z"),
+      executionId: "<id>",
+      id: "<id>",
+      interactionType: "TOMBSTONE",
+      localStartedAt: new Date("2024-11-09T15:10:21.242Z"),
+      speakeasyApiKeyName: "<value>",
+      speakeasyVersion: "<value>",
+      success: false,
+      workspaceId: "<id>",
+    },
+  ],
+};
 ```
 
 ## Fields

diff --git a/docs/sdk/models/operations/suggestrequest.md b/docs/sdk/models/operations/suggestrequest.md
@@ -7,6 +7,29 @@ import { SuggestRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/s
 
 let value: SuggestRequest = {
   xSessionId: "<id>",
+  suggestRequestBody: {
+    diagnostics: [
+      {
+        message: "<value>",
+        path: [
+          "/lib",
+          "/usr/X11R6",
+        ],
+        type: "<value>",
+      },
+    ],
+    oasSummary: {
+      info: {
+        description: "yowza huge mutate anguished wring",
+        license: {},
+        summary: "<value>",
+        title: "<value>",
+        version: "<value>",
+      },
+      operations: [],
+    },
+    suggestionType: "method-names",
+  },
 };
 ```
 

diff --git a/docs/sdk/models/operations/updateworkspacedetailsrequest.md b/docs/sdk/models/operations/updateworkspacedetailsrequest.md
@@ -5,7 +5,17 @@
 ```typescript
 import { UpdateWorkspaceDetailsRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
 
-let value: UpdateWorkspaceDetailsRequest = {};
+let value: UpdateWorkspaceDetailsRequest = {
+  workspace: {
+    createdAt: new Date("2023-11-16T00:00:08.537Z"),
+    id: "<id>",
+    name: "<value>",
+    organizationId: "<id>",
+    slug: "<value>",
+    updatedAt: new Date("2024-06-14T01:29:49.528Z"),
+    verified: true,
+  },
+};
 ```
 
 ## Fields

diff --git a/docs/sdk/models/operations/updateworkspacesettingsrequest.md b/docs/sdk/models/operations/updateworkspacesettingsrequest.md
@@ -5,7 +5,14 @@
 ```typescript
 import { UpdateWorkspaceSettingsRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
 
-let value: UpdateWorkspaceSettingsRequest = {};
+let value: UpdateWorkspaceSettingsRequest = {
+  workspaceSettings: {
+    createdAt: new Date("2024-01-11T14:49:22.396Z"),
+    updatedAt: new Date("2023-02-11T06:08:15.713Z"),
+    webhookUrl: "https://damaged-role.org",
+    workspaceId: "<id>",
+  },
+};
 ```
 
 ## Fields

diff --git a/docs/sdk/models/shared/accounttype.md b/docs/sdk/models/shared/accounttype.md
@@ -13,5 +13,5 @@ let value: AccountType = "enterprise";
 This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
 
 ```typescript
-"free" | "scale-up" | "business" | "enterprise" | Unrecognized<string>
+"free" | "scale-up" | "business" | "oss" | "enterprise" | Unrecognized<string>
 ```
diff --git a/docs/sdk/models/shared/apikeydetails.md b/docs/sdk/models/shared/apikeydetails.md
@@ -6,7 +6,7 @@
 import { ApiKeyDetails } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/shared";
 
 let value: ApiKeyDetails = {
-  accountTypeV2: "enterprise",
+  accountTypeV2: "oss",
   billingAddOns: [
     "snippet_ai",
   ],

diff --git a/docs/sdk/models/shared/relativediff.md b/docs/sdk/models/shared/relativediff.md
@@ -0,0 +1,18 @@
+# RelativeDiff
+
+A relative diff between the current revision and the previous revision.
+
+## Example Usage
+
+```typescript
+import { RelativeDiff } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/shared";
+
+let value: RelativeDiff = {};
+```
+
+## Fields
+
+| Field                                                     | Type                                                      | Required                                                  | Description                                               |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| `addedLines`                                              | *number*                                                  | :heavy_minus_sign:                                        | The number of lines added against the previous revision   |
+| `removedLines`                                            | *number*                                                  | :heavy_minus_sign:                                        | The number of lines removed against the previous revision |