Skip to content

Commit 0fc532f

Browse files
committed
## Typescript SDK Changes:
* `speakeasy.artifacts.getNamespaces()`: `response.items.[].latestRevisionMetadata` **Changed** * `speakeasy.artifacts.getRevisions()`: `response.items.[].contentsMetadata` **Changed**
1 parent b6411c2 commit 0fc532f

File tree

265 files changed

+4735
-3813
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

265 files changed

+4735
-3813
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/examples/node_modules
2+
.env
3+
.env.local
4+
.env.*.local
15
.DS_Store
26
**/.speakeasy/temp/
37
**/.speakeasy/logs/

.speakeasy/gen.lock

Lines changed: 3133 additions & 628 deletions
Large diffs are not rendered by default.

.speakeasy/workflow.lock

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
speakeasyVersion: 1.561.0
1+
speakeasyVersion: 1.669.1
22
sources:
33
my-source:
44
sourceNamespace: my-source
5-
sourceRevisionDigest: sha256:2e5dc78239617b9501f2028df534aa4601c61396c89a582390d75a797fc228cc
6-
sourceBlobDigest: sha256:0442ef7698d8979dd825b3eab0ab868ac86580f4cffcd3e0dff7afdd6191e6d9
5+
sourceRevisionDigest: sha256:01a202f9b2f5c54bbf985d5ef6db20a01d6ab1cc7f9112274d2eca38e8daf24f
6+
sourceBlobDigest: sha256:180487180cb415c9db8edd2bd57b7b893e7b0d592afd8337df061d61a2e6343a
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1746577270
9+
- speakeasy-sdk-regen-1753835013
1010
- 0.4.0
1111
targets:
1212
speakeasy-client-sdk-typescript:
1313
source: my-source
1414
sourceNamespace: my-source
15-
sourceRevisionDigest: sha256:2e5dc78239617b9501f2028df534aa4601c61396c89a582390d75a797fc228cc
16-
sourceBlobDigest: sha256:0442ef7698d8979dd825b3eab0ab868ac86580f4cffcd3e0dff7afdd6191e6d9
15+
sourceRevisionDigest: sha256:01a202f9b2f5c54bbf985d5ef6db20a01d6ab1cc7f9112274d2eca38e8daf24f
16+
sourceBlobDigest: sha256:180487180cb415c9db8edd2bd57b7b893e7b0d592afd8337df061d61a2e6343a
1717
codeSamplesNamespace: my-source-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:65717f579dccb319b073cb22e553e23bd3419cf420967387c00d148c041f5dc1
18+
codeSamplesRevisionDigest: sha256:c02ea3be935eb6739760db5b35c48b6dc9b862ca2374ffa42c4c9b21a4ec48ce
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest
2222
sources:
2323
my-source:
2424
inputs:
25-
- location: https://speakeasy.com/openapi.yaml
25+
- location: https://spec.speakeasy.com/speakeasy-self/speakeasy-self/speakeasy-api
2626
registry:
2727
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/my-source
2828
targets:

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,9 @@ bun add @tanstack/react-query react react-dom
7373
### Yarn
7474

7575
```bash
76-
yarn add @speakeasy-api/speakeasy-client-sdk-typescript zod
76+
yarn add @speakeasy-api/speakeasy-client-sdk-typescript
7777
# Install optional peer dependencies if you plan to use React hooks
7878
yarn add @tanstack/react-query react react-dom
79-
80-
# Note that Yarn does not install peer dependencies automatically. You will need
81-
# to install zod as shown above.
8279
```
8380

8481

@@ -202,7 +199,7 @@ run();
202199
<details open>
203200
<summary>Available methods</summary>
204201

205-
### [artifacts](docs/sdks/artifacts/README.md)
202+
### [Artifacts](docs/sdks/artifacts/README.md)
206203

207204
* [createRemoteSource](docs/sdks/artifacts/README.md#createremotesource) - Configure a new remote source
208205
* [getBlob](docs/sdks/artifacts/README.md#getblob) - Get blob for a particular digest
@@ -216,29 +213,29 @@ run();
216213
* [setArchived](docs/sdks/artifacts/README.md#setarchived) - Set whether a namespace is archived
217214
* [setVisibility](docs/sdks/artifacts/README.md#setvisibility) - Set visibility of a namespace with an existing metadata entry
218215

219-
### [auth](docs/sdks/auth/README.md)
216+
### [Auth](docs/sdks/auth/README.md)
220217

221218
* [getAccess](docs/sdks/auth/README.md#getaccess) - Get access allowances for a particular workspace
222219
* [getAccessToken](docs/sdks/auth/README.md#getaccesstoken) - Get or refresh an access token for the current workspace.
223220
* [getUser](docs/sdks/auth/README.md#getuser) - Get information about the current user.
224221
* [validateApiKey](docs/sdks/auth/README.md#validateapikey) - Validate the current api key.
225222

226-
### [codeSamples](docs/sdks/codesamples/README.md)
223+
### [CodeSamples](docs/sdks/codesamples/README.md)
227224

228225
* [generateCodeSamplePreview](docs/sdks/codesamples/README.md#generatecodesamplepreview) - Generate Code Sample previews from a file and configuration parameters.
229226
* [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.
230227
* [get](docs/sdks/codesamples/README.md#get) - Retrieve usage snippets
231228
* [getCodeSamplePreviewAsync](docs/sdks/codesamples/README.md#getcodesamplepreviewasync) - Poll for the result of an asynchronous Code Sample preview generation.
232229

233-
### [events](docs/sdks/events/README.md)
230+
### [Events](docs/sdks/events/README.md)
234231

235232
* [getEventsByTarget](docs/sdks/events/README.md#geteventsbytarget) - Load recent events for a particular workspace
236233
* [getTargets](docs/sdks/events/README.md#gettargets) - Load targets for a particular workspace
237234
* [getTargetsDeprecated](docs/sdks/events/README.md#gettargetsdeprecated) - Load targets for a particular workspace
238235
* [post](docs/sdks/events/README.md#post) - Post events for a specific workspace
239236
* [search](docs/sdks/events/README.md#search) - Search events for a particular workspace by any field
240237

241-
### [github](docs/sdks/github/README.md)
238+
### [Github](docs/sdks/github/README.md)
242239

243240
* [checkAccess](docs/sdks/github/README.md#checkaccess)
244241
* [checkPublishingPRs](docs/sdks/github/README.md#checkpublishingprs)
@@ -252,7 +249,7 @@ run();
252249
* [storePublishingSecrets](docs/sdks/github/README.md#storepublishingsecrets)
253250
* [triggerAction](docs/sdks/github/README.md#triggeraction)
254251

255-
### [organizations](docs/sdks/organizations/README.md)
252+
### [Organizations](docs/sdks/organizations/README.md)
256253

257254
* [create](docs/sdks/organizations/README.md#create) - Create an organization
258255
* [createBillingAddOns](docs/sdks/organizations/README.md#createbillingaddons) - Create billing add ons
@@ -263,7 +260,7 @@ run();
263260
* [getBillingAddOns](docs/sdks/organizations/README.md#getbillingaddons) - Get billing add ons
264261
* [getUsage](docs/sdks/organizations/README.md#getusage) - Get billing usage summary for a particular organization
265262

266-
### [publishingTokens](docs/sdks/publishingtokens/README.md)
263+
### [PublishingTokens](docs/sdks/publishingtokens/README.md)
267264

268265
* [create](docs/sdks/publishingtokens/README.md#create) - Create a publishing token for a workspace
269266
* [delete](docs/sdks/publishingtokens/README.md#delete) - Delete a specific publishing token
@@ -273,34 +270,33 @@ run();
273270
* [resolveTarget](docs/sdks/publishingtokens/README.md#resolvetarget) - Get a specific publishing token target
274271
* [update](docs/sdks/publishingtokens/README.md#update) - Updates the validitity period of a publishing token
275272

276-
### [reports](docs/sdks/reports/README.md)
273+
### [Reports](docs/sdks/reports/README.md)
277274

278275
* [getChangesReportSignedUrl](docs/sdks/reports/README.md#getchangesreportsignedurl) - Get the signed access url for the change reports for a particular document.
279276
* [getLintingReportSignedUrl](docs/sdks/reports/README.md#getlintingreportsignedurl) - Get the signed access url for the linting reports for a particular document.
280277
* [uploadReport](docs/sdks/reports/README.md#uploadreport) - Upload a report.
281278

282-
### [schemaStore](docs/sdks/schemastore/README.md)
279+
### [SchemaStore](docs/sdks/schemastore/README.md)
283280

284281
* [createSchemaStoreItem](docs/sdks/schemastore/README.md#createschemastoreitem) - Create a schema in the schema store
285282

286-
### [shortURLs](docs/sdks/shorturls/README.md)
283+
### [ShortURLs](docs/sdks/shorturls/README.md)
287284

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

290-
291-
### [subscriptions](docs/sdks/subscriptions/README.md)
287+
### [Subscriptions](docs/sdks/subscriptions/README.md)
292288

293289
* [activateSubscriptionNamespace](docs/sdks/subscriptions/README.md#activatesubscriptionnamespace) - Activate an ignored namespace for a subscription
294290
* [ignoreSubscriptionNamespace](docs/sdks/subscriptions/README.md#ignoresubscriptionnamespace) - Ignored a namespace for a subscription
295291

296-
### [suggest](docs/sdks/suggest/README.md)
292+
### [Suggest](docs/sdks/suggest/README.md)
297293

298294
* [suggest](docs/sdks/suggest/README.md#suggest) - Generate suggestions for improving an OpenAPI document.
299295
* [suggestItems](docs/sdks/suggest/README.md#suggestitems) - Generate generic suggestions for a list of items.
300296
* [suggestOpenAPI](docs/sdks/suggest/README.md#suggestopenapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
301297
* [suggestOpenAPIRegistry](docs/sdks/suggest/README.md#suggestopenapiregistry) - Generate suggestions for improving an OpenAPI document stored in the registry.
302298

303-
### [workspaces](docs/sdks/workspaces/README.md)
299+
### [Workspaces](docs/sdks/workspaces/README.md)
304300

305301
* [create](docs/sdks/workspaces/README.md#create) - Create a workspace
306302
* [createToken](docs/sdks/workspaces/README.md#createtoken) - Create a token for a particular workspace
@@ -379,7 +375,7 @@ run();
379375
### Error Classes
380376
**Primary errors:**
381377
* [`SpeakeasyError`](./src/sdk/models/errors/speakeasyerror.ts): The base class for HTTP error responses.
382-
* [`ErrorT`](docs/sdk/models/errors/errort.md): The `Status` type defines a logical error model. *
378+
* [`ErrorT`](./src/sdk/models/errors/errort.ts): The `Status` type defines a logical error model. *
383379

384380
<details><summary>Less common errors (6)</summary>
385381

@@ -503,7 +499,7 @@ httpClient.addHook("requestError", (error, request) => {
503499
console.groupEnd();
504500
});
505501

506-
const sdk = new Speakeasy({ httpClient });
502+
const sdk = new Speakeasy({ httpClient: httpClient });
507503
```
508504
<!-- End Custom HTTP Client [http-client] -->
509505

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1706,4 +1706,14 @@ Based on:
17061706
### Generated
17071707
- [typescript v5.0.0-rc.4] .
17081708
### Releases
1709-
- [NPM v5.0.0-rc.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.4 - .
1709+
- [NPM v5.0.0-rc.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.4 - .
1710+
1711+
## 2025-12-06 00:21:07
1712+
### Changes
1713+
Based on:
1714+
- OpenAPI Doc
1715+
- Speakeasy CLI 1.669.1 (2.772.0) https://github.com/speakeasy-api/speakeasy
1716+
### Generated
1717+
- [typescript v5.0.0-rc.5] .
1718+
### Releases
1719+
- [NPM v5.0.0-rc.5] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.5 - .

RUNTIMES.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
44

5-
* [Web Fetch API][web-fetch]
6-
* [Web Streams API][web-streams] and in particular `ReadableStream`
7-
* [Async iterables][async-iter] using `Symbol.asyncIterator`
5+
- [Web Fetch API][web-fetch]
6+
- [Web Streams API][web-streams] and in particular `ReadableStream`
7+
- [Async iterables][async-iter] using `Symbol.asyncIterator`
88

99
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
1010
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
@@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:
2525

2626
The following `tsconfig.json` options are recommended for projects using this
2727
SDK in order to get static type support for features like async iterables,
28-
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
28+
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
2929
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
3030
so on):
3131

@@ -38,11 +38,11 @@ so on):
3838
{
3939
"compilerOptions": {
4040
"target": "es2020", // or higher
41-
"lib": ["es2020", "dom", "dom.iterable"],
41+
"lib": ["es2020", "dom", "dom.iterable"]
4242
}
4343
}
4444
```
4545

4646
While `target` can be set to older ECMAScript versions, it may result in extra,
4747
unnecessary compatibility code being generated if you are not targeting old
48-
runtimes.
48+
runtimes.

docs/sdk/models/operations/createworkspacetokenrequest.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,16 @@
55
```typescript
66
import { CreateWorkspaceTokenRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
77

8-
let value: CreateWorkspaceTokenRequest = {};
8+
let value: CreateWorkspaceTokenRequest = {
9+
workspaceToken: {
10+
alg: "<value>",
11+
createdAt: new Date("2023-10-18T04:12:26.286Z"),
12+
id: "<id>",
13+
key: "<key>",
14+
name: "<value>",
15+
workspaceId: "<id>",
16+
},
17+
};
918
```
1019

1120
## Fields

docs/sdk/models/operations/postworkspaceeventsrequest.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,21 @@
55
```typescript
66
import { PostWorkspaceEventsRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
77

8-
let value: PostWorkspaceEventsRequest = {};
8+
let value: PostWorkspaceEventsRequest = {
9+
requestBody: [
10+
{
11+
createdAt: new Date("2024-04-27T01:44:18.572Z"),
12+
executionId: "<id>",
13+
id: "<id>",
14+
interactionType: "TOMBSTONE",
15+
localStartedAt: new Date("2024-11-09T15:10:21.242Z"),
16+
speakeasyApiKeyName: "<value>",
17+
speakeasyVersion: "<value>",
18+
success: false,
19+
workspaceId: "<id>",
20+
},
21+
],
22+
};
923
```
1024

1125
## Fields

docs/sdk/models/operations/suggestrequest.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,29 @@ import { SuggestRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/s
77

88
let value: SuggestRequest = {
99
xSessionId: "<id>",
10+
suggestRequestBody: {
11+
diagnostics: [
12+
{
13+
message: "<value>",
14+
path: [
15+
"/lib",
16+
"/usr/X11R6",
17+
],
18+
type: "<value>",
19+
},
20+
],
21+
oasSummary: {
22+
info: {
23+
description: "yowza huge mutate anguished wring",
24+
license: {},
25+
summary: "<value>",
26+
title: "<value>",
27+
version: "<value>",
28+
},
29+
operations: [],
30+
},
31+
suggestionType: "method-names",
32+
},
1033
};
1134
```
1235

docs/sdk/models/operations/updateworkspacedetailsrequest.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,17 @@
55
```typescript
66
import { UpdateWorkspaceDetailsRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
77

8-
let value: UpdateWorkspaceDetailsRequest = {};
8+
let value: UpdateWorkspaceDetailsRequest = {
9+
workspace: {
10+
createdAt: new Date("2023-11-16T00:00:08.537Z"),
11+
id: "<id>",
12+
name: "<value>",
13+
organizationId: "<id>",
14+
slug: "<value>",
15+
updatedAt: new Date("2024-06-14T01:29:49.528Z"),
16+
verified: true,
17+
},
18+
};
919
```
1020

1121
## Fields

0 commit comments

Comments
 (0)