Skip to content

Commit 4d177fc

Browse files
committed
## Typescript SDK Changes:
* `speakeasy.publishingTokens.list()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.organizations.getAll()`: * `request.security` **Added** (Breaking ⚠️) * `response.[]` **Changed** (Breaking ⚠️) * `speakeasy.auth.validateApiKey()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.codeSamples.generateCodeSamplePreview()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.codeSamples.generateCodeSamplePreviewAsync()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.events.search()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.events.post()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.events.getTargetsSummary()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.events.getTargetsDeprecated()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.events.getTargets()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.events.getEventsByTarget()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.updateSettings()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.update()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.codeSamples.get()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.codeSamples.getCodeSamplePreviewAsync()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.checkAccess()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.checkPublishingPRs()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.checkPublishingSecrets()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.configureCodeSamples()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.configureMintlifyRepo()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.configureTarget()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.getAction()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.getSetup()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.linkGithub()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.storePublishingSecrets()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.github.triggerAction()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.organizations.create()`: * `request` **Changed** (Breaking ⚠️) * `response` **Changed** (Breaking ⚠️) * `speakeasy.organizations.createBillingAddOns()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.organizations.createFreeTrial()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.organizations.deleteBillingAddOn()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.organizations.get()`: * `request.security` **Added** (Breaking ⚠️) * `response` **Changed** (Breaking ⚠️) * `speakeasy.publishingTokens.resolveMetadata()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.organizations.getBillingAddOns()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.organizations.getBillingOperations()`: * `request` **Changed** (Breaking ⚠️) * `response` **Changed** (Breaking ⚠️) * `speakeasy.organizations.getUsage()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.publishingTokens.create()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.publishingTokens.delete()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.publishingTokens.get()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.auth.getUser()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.auth.getAccess()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.schemaStore.createSchemaStoreItem()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.publishingTokens.update()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.reports.getChangesReportSignedUrl()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.reports.getLintingReportSignedUrl()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.reports.uploadReport()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.publishingTokens.resolveTarget()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.shortUrLs.create()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.suggest.suggest()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.suggest.suggestItems()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.suggest.suggestOpenApi()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.suggest.suggestOpenApiRegistry()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.create()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.createToken()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.deleteToken()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.get()`: * `request.security` **Added** (Breaking ⚠️) * `response.organization` **Changed** (Breaking ⚠️) * `speakeasy.workspaces.getAll()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.getById()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.getFeatureFlags()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.getSettings()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.getTeam()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.getTokens()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.grantAccess()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.revokeAccess()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.workspaces.setFeatureFlags()`: `request.security` **Added** (Breaking ⚠️) * `speakeasy.organizations.upsertBillingEmail()`: **Added** * `speakeasy.organizations.getLanguages()`: **Added** * `speakeasy.organizations.getBusinessTierPrices()`: **Added** * `speakeasy.organizations.getBillingEmail()`: **Added** * `speakeasy.organizations.deactivateLanguage()`: **Added** * `speakeasy.organizations.activateLanguage()`: **Added** * `speakeasy.organizations.createLanguageCheckoutSession()`: **Added** * `speakeasy.organizations.getSubscription()`: **Added** * `speakeasy.organizations.getTrialTargets()`: **Added** * `speakeasy.organizations.handleCheckoutCallback()`: **Added** * `speakeasy.organizations.revertSubscriptionCancellation()`: **Added** * `speakeasy.organizations.cancelSubscription()`: **Added** * `speakeasy.webhooks.handleStripeWebhook()`: **Added**
1 parent d67fd88 commit 4d177fc

535 files changed

Lines changed: 19645 additions & 4982 deletions

File tree

Some content is hidden

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

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
!/**/*.map
1313

1414
/eslint.config.mjs
15+
/.oxlintrc.json
1516
/cjs
1617
/.tshy
1718
/.tshy-*

.speakeasy/gen.lock

Lines changed: 1413 additions & 842 deletions
Large diffs are not rendered by default.

.speakeasy/workflow.lock

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
speakeasyVersion: 1.736.1
1+
speakeasyVersion: 1.774.0
22
sources:
33
my-source:
44
sourceNamespace: my-source
5-
sourceRevisionDigest: sha256:b2a524854e5ca52cdd7bec6ad83685feaf1fa49010e9da4f990a337908e630e3
6-
sourceBlobDigest: sha256:d4720c8b89c02fb53a33d4c58b04b0661044bc4a2c02226a328e0d35772defc9
5+
sourceRevisionDigest: sha256:cb6d81a7240885b8fd1ec1b3337633bd712a766af0495d8b02b49039cb2b91c2
6+
sourceBlobDigest: sha256:b52b712a4fbc22652fafe9dce91309e0db72fa8c8755b9821e56ec1775681978
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1753835013
109
- 0.4.0
1110
targets:
1211
speakeasy-client-sdk-typescript:
1312
source: my-source
1413
sourceNamespace: my-source
15-
sourceRevisionDigest: sha256:b2a524854e5ca52cdd7bec6ad83685feaf1fa49010e9da4f990a337908e630e3
16-
sourceBlobDigest: sha256:d4720c8b89c02fb53a33d4c58b04b0661044bc4a2c02226a328e0d35772defc9
14+
sourceRevisionDigest: sha256:cb6d81a7240885b8fd1ec1b3337633bd712a766af0495d8b02b49039cb2b91c2
15+
sourceBlobDigest: sha256:b52b712a4fbc22652fafe9dce91309e0db72fa8c8755b9821e56ec1775681978
1716
codeSamplesNamespace: my-source-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:63ed5704a7f9637a517c123c4e07b4b68c5e10eb327ff226e07d9686087bb6f7
17+
codeSamplesRevisionDigest: sha256:9b1f30bf17dc47711769e9573866318ef5fb75413def8d1fe92b9c01b3aebe3e
1918
workflow:
2019
workflowVersion: 1.0.0
2120
speakeasyVersion: latest

FUNCTIONS.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Standalone Functions
22

33
> [!NOTE]
4-
> This section is useful if you are using a bundler and targetting browsers and
4+
> This section is useful if you are using a bundler and targeting browsers and
55
> runtimes where the size of an application affects performance and load times.
66
77
Every method in this SDK is also available as a standalone function. This
8-
alternative API is suitable when targetting the browser or serverless runtimes
8+
alternative API is suitable when targeting the browser or serverless runtimes
99
and using a bundler to build your application since all unused functionality
1010
will be tree-shaken away. This includes code for unused methods, Zod schemas,
1111
encoding helpers and response handlers. The result is dramatically smaller
@@ -24,11 +24,7 @@ import { artifactsCreateRemoteSource } from "@speakeasy-api/speakeasy-client-sdk
2424

2525
// Use `SpeakeasyCore` for best tree-shaking performance.
2626
// You can create one instance of it to use across an application.
27-
const speakeasy = new SpeakeasyCore({
28-
security: {
29-
apiKey: "<YOUR_API_KEY_HERE>",
30-
},
31-
});
27+
const speakeasy = new SpeakeasyCore();
3228

3329
async function run() {
3430
const res = await artifactsCreateRemoteSource(speakeasy);

REACT_QUERY.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,7 @@ import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript";
2222
import { SpeakeasyProvider } from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query";
2323

2424
const queryClient = new QueryClient();
25-
const speakeasy = new SpeakeasyCore({
26-
security: {
27-
apiKey: "<YOUR_API_KEY_HERE>",
28-
},
29-
});
25+
const speakeasy = new SpeakeasyCore();
3026

3127
// Retries are handled by the underlying SDK.
3228
queryClient.setQueryDefaults(["@speakeasy-api/speakeasy-client-sdk-typescript"], { retry: false });
@@ -233,7 +229,9 @@ infinite scrolling and "load more" user interfaces.
233229
import { useEventsGetTargetsSummaryInfinite } from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/eventsGetTargetsSummary.js";
234230

235231
export function Example() {
236-
const { data, error, status, fetchNextPage, hasNextPage } = useEventsGetTargetsSummaryInfinite({});
232+
const { data, error, status, fetchNextPage, hasNextPage } = useEventsGetTargetsSummaryInfinite({
233+
apiKey: "<YOUR_API_KEY_HERE>",
234+
}, {});
237235

238236
return (
239237
<div>
@@ -267,11 +265,7 @@ import { SpeakeasyProvider } from "@speakeasy-api/speakeasy-client-sdk-typescrip
267265
import { useArtifactsGetBlobSuspense } from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/artifactsGetBlob.js";
268266

269267
const queryClient = new QueryClient();
270-
const speakeasy = new SpeakeasyCore({
271-
security: {
272-
apiKey: "<YOUR_API_KEY_HERE>",
273-
},
274-
});
268+
const speakeasy = new SpeakeasyCore();
275269

276270
export function App() {
277271
return (
@@ -330,11 +324,7 @@ import { prefetchArtifactsGetBlob } from "@speakeasy-api/speakeasy-client-sdk-ty
330324

331325
export default async function Page() {
332326
const queryClient = new QueryClient();
333-
const speakeasy = new SpeakeasyCore({
334-
security: {
335-
apiKey: "<YOUR_API_KEY_HERE>",
336-
},
337-
});
327+
const speakeasy = new SpeakeasyCore();
338328

339329
await prefetchArtifactsGetBlob(queryClient, speakeasy, {
340330
organizationSlug: "<value>",

0 commit comments

Comments
 (0)