speakeasy-api · github-actions · Aug 11, 2025 · Aug 11, 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
@@ -1,21 +1,21 @@
 lockVersion: 2.0.0
 id: 89968bf0-a755-4d50-9acb-d47410010f05
 management:
-  docChecksum: 17226457b23fc2563102eb22d263bc30
+  docChecksum: 9fe547b1abb3170dfb491aa3c76e07b2
   docVersion: 0.4.0
-  speakeasyVersion: 1.561.0
-  generationVersion: 2.628.0
-  releaseVersion: 5.0.0-rc.4
-  configChecksum: f3d6e491d6a8639407af1874416c9ae0
+  speakeasyVersion: 1.600.2
+  generationVersion: 2.677.3
+  releaseVersion: 5.0.0-rc.5
+  configChecksum: 8f32dff730a6cfb096db6739defc4fe5
   repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript.git
   repoSubDirectory: .
   installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript
   published: true
 features:
   typescript:
     additionalDependencies: 0.1.0
-    constsAndDefaults: 0.1.11
-    core: 3.21.11
+    constsAndDefaults: 0.1.12
+    core: 3.21.20
     deepObjectParams: 0.1.0
     defaultEnabledRetries: 0.1.0
     deprecations: 2.81.1
@@ -26,7 +26,7 @@ features:
     globalSecurityCallbacks: 0.1.0
     globalServerURLs: 2.82.5
     globals: 2.82.2
-    mcpServer: 0.9.2
+    mcpServer: 0.9.3
     nameOverrides: 2.81.2
     nullables: 0.1.1
     openEnums: 0.1.1
@@ -179,6 +179,7 @@ generatedFiles:
   - docs/sdk/models/shared/publishingtoken.md
   - docs/sdk/models/shared/pullrequestmetadata.md
   - docs/sdk/models/shared/relationship.md
+  - docs/sdk/models/shared/relativediff.md
   - docs/sdk/models/shared/remotedocument.md
   - docs/sdk/models/shared/remotesource.md
   - docs/sdk/models/shared/remotesourcesubscriptionsettings.md
@@ -231,6 +232,10 @@ generatedFiles:
   - docs/sdks/suggest/README.md
   - docs/sdks/workspaces/README.md
   - eslint.config.mjs
+  - examples/.env.template
+  - examples/README.md
+  - examples/artifactsCreateRemoteSource.example.ts
+  - examples/package.json
   - jsr.json
   - package.json
   - src/core.ts
@@ -605,6 +610,7 @@ generatedFiles:
   - src/sdk/models/shared/preflightrequest.ts
   - src/sdk/models/shared/preflighttoken.ts
   - src/sdk/models/shared/publishingtoken.ts
+  - src/sdk/models/shared/relativediff.ts
   - src/sdk/models/shared/remotedocument.ts
   - src/sdk/models/shared/remotesource.ts
   - src/sdk/models/shared/remotesourcesubscriptionsettings.ts

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,30 +1,30 @@
-speakeasyVersion: 1.561.0
+speakeasyVersion: 1.600.2
 sources:
     my-source:
-        sourceNamespace: my-source
-        sourceRevisionDigest: sha256:2e5dc78239617b9501f2028df534aa4601c61396c89a582390d75a797fc228cc
-        sourceBlobDigest: sha256:0442ef7698d8979dd825b3eab0ab868ac86580f4cffcd3e0dff7afdd6191e6d9
+        sourceNamespace: ts-client-source
+        sourceRevisionDigest: sha256:802dc7b246c02d418741629981a8b0d57f6993d67f0d2cf26bc3654db30ba01a
+        sourceBlobDigest: sha256:ec4ec370491ceb2ff1df4ba4a12bb743c761566998c5dd22e1d8730a8654d7e3
         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
+        sourceNamespace: ts-client-source
+        sourceRevisionDigest: sha256:802dc7b246c02d418741629981a8b0d57f6993d67f0d2cf26bc3654db30ba01a
+        sourceBlobDigest: sha256:ec4ec370491ceb2ff1df4ba4a12bb743c761566998c5dd22e1d8730a8654d7e3
         codeSamplesNamespace: my-source-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:65717f579dccb319b073cb22e553e23bd3419cf420967387c00d148c041f5dc1
+        codeSamplesRevisionDigest: sha256:45183a9500c3d20e52ad7fb69cba2ff792e1b68bcb584cd48829aead5309a960
 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
+                location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/ts-client-source
     targets:
         speakeasy-client-sdk-typescript:
             target: typescript

diff --git a/README.md b/README.md
@@ -379,7 +379,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>
 

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-08-11 00:24:12
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.600.2 (2.677.3) 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/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 |
diff --git a/docs/sdk/models/shared/revisioncontentsmetadata.md b/docs/sdk/models/shared/revisioncontentsmetadata.md
@@ -40,6 +40,7 @@ let value: RevisionContentsMetadata = {
 | `namespace`                                                                                       | *string*                                                                                          | :heavy_check_mark:                                                                                | The fully qualified namespace                                                                     |
 | `numOverlayActions`                                                                               | *number*                                                                                          | :heavy_check_mark:                                                                                | The number of overlay actions in the OAS. Will be 0 if the OAS is not an overlay.                 |
 | `operationIds`                                                                                    | *string*[]                                                                                        | :heavy_check_mark:                                                                                | The operation IDs contained in the OAS. Will be empty if the OAS is an overlay.                   |
+| `relativeDiff`                                                                                    | [shared.RelativeDiff](../../../sdk/models/shared/relativediff.md)                                 | :heavy_minus_sign:                                                                                | A relative diff between the current revision and the previous revision.                           |
 | `revisionDigest`                                                                                  | *string*                                                                                          | :heavy_check_mark:                                                                                | The digest of the parent bundle                                                                   |
 | `tags`                                                                                            | *string*[]                                                                                        | :heavy_check_mark:                                                                                | The tags contained in the OAS -- NOT the OCI tags. Will be empty if the OAS is an overlay.        |
 | `title`                                                                                           | *string*                                                                                          | :heavy_check_mark:                                                                                | The OAS title                                                                                     |

diff --git a/docs/sdk/models/shared/workspaceandorganization.md b/docs/sdk/models/shared/workspaceandorganization.md
@@ -9,7 +9,7 @@ import { WorkspaceAndOrganization } from "@speakeasy-api/speakeasy-client-sdk-ty
 
 let value: WorkspaceAndOrganization = {
   organization: {
-    accountType: "business",
+    accountType: "oss",
     createdAt: new Date("2023-06-23T09:04:56.583Z"),
     id: "<id>",
     name: "<value>",

diff --git a/docs/sdks/artifacts/README.md b/docs/sdks/artifacts/README.md
@@ -25,6 +25,7 @@ Configure a new remote source
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createRemoteSource" method="post" path="/v1/artifacts/remote_sources" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -115,6 +116,7 @@ Get blob for a particular digest
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getBlob" method="get" path="/v1/oci/v2/{organization_slug}/{workspace_slug}/{namespace_name}/blobs/{digest}" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -226,6 +228,7 @@ Get manifest for a particular reference
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getManifest" method="get" path="/v1/oci/v2/{organization_slug}/{workspace_slug}/{namespace_name}/manifests/{revision_reference}" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -337,6 +340,7 @@ Each namespace contains many revisions.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getNamespaces" method="get" path="/v1/artifacts/namespaces" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -434,6 +438,7 @@ import {
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getRevisions" method="get" path="/v1/artifacts/namespaces/{namespace_name}/revisions" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -537,6 +542,7 @@ import {
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getTags" method="get" path="/v1/artifacts/namespaces/{namespace_name}/tags" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -642,6 +648,7 @@ Get remote sources attached to a particular namespace
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listRemoteSources" method="get" path="/v1/artifacts/remote_sources" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -747,6 +754,7 @@ Add tags to an existing revision
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="postTags" method="post" path="/v1/artifacts/namespaces/{namespace_name}/tags" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -841,6 +849,7 @@ Get access token for communicating with OCI distribution endpoints
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="preflight" method="post" path="/v1/artifacts/preflight" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -931,6 +940,7 @@ Set whether a namespace is archived
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="archiveNamespace" method="post" path="/v1/artifacts/namespaces/{namespace_name}/archive" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
@@ -1025,6 +1035,7 @@ Set visibility of a namespace with an existing metadata entry
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="setVisibility" method="post" path="/v1/artifacts/namespaces/{namespace_name}/visibility" -->
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";