Skip to content
Open
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
Jump to file
Failed to load files.
Loading
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 @@
/examples/node_modules
.env
.env.local
.env.*.local
.DS_Store
**/.speakeasy/temp/
**/.speakeasy/logs/
Expand Down
33 changes: 22 additions & 11 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
lockVersion: 2.0.0
id: 89968bf0-a755-4d50-9acb-d47410010f05
management:
docChecksum: 17226457b23fc2563102eb22d263bc30
docChecksum: 9c4b2769bf8dd7d16f4dcf78898eb940
docVersion: 0.4.0
speakeasyVersion: 1.561.0
generationVersion: 2.628.0
releaseVersion: 5.0.0-rc.4
configChecksum: f3d6e491d6a8639407af1874416c9ae0
speakeasyVersion: 1.650.0
generationVersion: 2.743.2
releaseVersion: 5.0.0-rc.5
configChecksum: 1e97cf001ab77e6a1509541cf3cd9cb9
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.26.3
deepObjectParams: 0.1.0
defaultEnabledRetries: 0.1.0
deprecations: 2.81.1
downloadStreams: 0.1.1
enumUnions: 0.1.0
envVarSecurityUsage: 0.1.2
globalSecurity: 2.82.13
globalSecurity: 2.82.14
globalSecurityCallbacks: 0.1.0
globalServerURLs: 2.82.5
globalServerURLs: 2.83.0
globals: 2.82.2
mcpServer: 0.9.2
mcpServer: 0.9.3
nameOverrides: 2.81.2
nullables: 0.1.1
openEnums: 0.1.1
Expand Down Expand Up @@ -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
Expand All @@ -190,6 +191,7 @@ generatedFiles:
- docs/sdk/models/shared/schemastoreitem.md
- docs/sdk/models/shared/secrets.md
- docs/sdk/models/shared/security.md
- docs/sdk/models/shared/server.md
- docs/sdk/models/shared/shorturl.md
- docs/sdk/models/shared/ssometadata.md
- docs/sdk/models/shared/suggestiontype.md
Expand Down Expand Up @@ -226,11 +228,14 @@ generatedFiles:
- docs/sdks/reports/README.md
- docs/sdks/schemastore/README.md
- docs/sdks/shorturls/README.md
- docs/sdks/speakeasy/README.md
- docs/sdks/subscriptions/README.md
- 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
Expand Down Expand Up @@ -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
Expand All @@ -613,6 +619,7 @@ generatedFiles:
- src/sdk/models/shared/revisioncontentsmetadata.ts
- src/sdk/models/shared/schemastoreitem.ts
- src/sdk/models/shared/security.ts
- src/sdk/models/shared/server.ts
- src/sdk/models/shared/shorturl.ts
- src/sdk/models/shared/ssometadata.ts
- src/sdk/models/shared/suggestitemsrequestbody.ts
Expand Down Expand Up @@ -1335,3 +1342,7 @@ examples:
application/json: {"message": "<value>", "status_code": 436496}
examplesVersion: 1.0.2
generatedTests: {}
releaseNotes: |
## Typescript SDK Changes Detected:
* `speakeasy.artifacts.getNamespaces()`: `response.items.[].latestRevisionMetadata` **Changed**
* `speakeasy.artifacts.getRevisions()`: `response.items.[].contentsMetadata` **Changed**
16 changes: 8 additions & 8 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
speakeasyVersion: 1.561.0
speakeasyVersion: 1.650.0
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:
Expand Down
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```


Expand Down Expand Up @@ -287,7 +284,6 @@ run();

* [create](docs/sdks/shorturls/README.md#create) - Shorten a URL.


### [subscriptions](docs/sdks/subscriptions/README.md)

* [activateSubscriptionNamespace](docs/sdks/subscriptions/README.md#activatesubscriptionnamespace) - Activate an ignored namespace for a subscription
Expand Down Expand Up @@ -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>

Expand Down Expand Up @@ -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] -->

Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-11-07 00:22:03
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.650.0 (2.743.2) 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 - .
12 changes: 6 additions & 6 deletions RUNTIMES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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):

Expand All @@ -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.
11 changes: 10 additions & 1 deletion docs/sdk/models/operations/createworkspacetokenrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 15 additions & 1 deletion docs/sdk/models/operations/postworkspaceeventsrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 23 additions & 0 deletions docs/sdk/models/operations/suggestrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
};
```

Expand Down
12 changes: 11 additions & 1 deletion docs/sdk/models/operations/updateworkspacedetailsrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 8 additions & 1 deletion docs/sdk/models/operations/updateworkspacesettingsrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/models/shared/accounttype.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
```
2 changes: 1 addition & 1 deletion docs/sdk/models/shared/apikeydetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
],
Expand Down
18 changes: 18 additions & 0 deletions docs/sdk/models/shared/relativediff.md
Original file line number Diff line number Diff line change
@@ -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 |
Loading
Loading