Merge pull request #5 from speakeasy-api/speakeasy-sdk-regen-1722039147

chore: 🐝 Update SDK - Generate 4.1.0-rc.1

Author: ThomasRooney

.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 89968bf0-a755-4d50-9acb-d47410010f05
 management:
-  docChecksum: 5b362866a3e7a85c830c6cb1f1cf4896
+  docChecksum: 312822a7ccdbf7c77dbbfeef49fb2053
   docVersion: 0.4.0 .
-  speakeasyVersion: 1.345.3
-  generationVersion: 2.378.3
-  releaseVersion: 4.0.0
-  configChecksum: 4e0644a745eb53eb49cebe97a15c01de
+  speakeasyVersion: 1.349.0
+  generationVersion: 2.382.0
+  releaseVersion: 4.1.0-rc.1
+  configChecksum: 8f67fa7cdfd65cf01e3085996f428885
   repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript.git
   repoSubDirectory: .
   installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript
@@ -15,10 +15,11 @@ features:
   typescript:
     acceptHeaders: 2.81.2
     additionalDependencies: 0.1.0
-    core: 3.11.9
+    core: 3.11.11
     defaultEnabledRetries: 0.1.0
     deprecations: 2.81.1
     downloadStreams: 0.1.1
+    envVarSecurityUsage: 0.1.0
     examples: 2.81.4
     globalSecurity: 2.82.9
     globalSecurityCallbacks: 0.1.0
@@ -45,6 +46,7 @@ generatedFiles:
   - src/sdk/shorturls.ts
   - src/sdk/suggest.ts
   - src/sdk/embeds.ts
+  - src/sdk/workspaces.ts
   - src/sdk/events.ts
   - src/sdk/sdk.ts
   - .eslintrc.cjs
@@ -55,6 +57,7 @@ generatedFiles:
   - src/index.ts
   - src/lib/base64.ts
   - src/lib/config.ts
+  - src/lib/dlv.ts
   - src/lib/encodings.ts
   - src/lib/http.ts
   - src/lib/is-plain-object.ts
@@ -118,15 +121,16 @@ generatedFiles:
   - src/sdk/models/shared/githubmissingpublishingsecretsresponse.ts
   - src/sdk/models/shared/githubstorepublishingsecretsrequest.ts
   - src/sdk/models/shared/githubtriggeractionrequest.ts
+  - src/sdk/models/shared/organization.ts
   - src/sdk/models/shared/organizationusageresponse.ts
   - src/sdk/models/shared/organizationusage.ts
-  - src/sdk/models/shared/organization.ts
   - src/sdk/models/shared/report.ts
   - src/sdk/models/shared/shorturl.ts
   - src/sdk/models/shared/suggestedoperationids.ts
   - src/sdk/models/shared/suggestoperationidsopts.ts
   - src/sdk/models/shared/embedaccesstokenresponse.ts
   - src/sdk/models/shared/embedtoken.ts
+  - src/sdk/models/shared/workspace.ts
   - src/sdk/models/shared/clievent.ts
   - src/sdk/models/shared/interactiontype.ts
   - src/sdk/models/shared/targetsdk.ts
@@ -176,6 +180,7 @@ generatedFiles:
   - src/sdk/models/operations/fetchpublishingprs.ts
   - src/sdk/models/operations/getaction.ts
   - src/sdk/models/operations/githubcheckpublishingsecrets.ts
+  - src/sdk/models/operations/getorganization.ts
   - src/sdk/models/operations/getorganizationusage.ts
   - src/sdk/models/operations/getorganizations.ts
   - src/sdk/models/operations/getchangesreportsignedurl.ts
@@ -188,6 +193,7 @@ generatedFiles:
   - src/sdk/models/operations/getembedaccesstoken.ts
   - src/sdk/models/operations/getvalidembedaccesstokens.ts
   - src/sdk/models/operations/revokeembedaccesstoken.ts
+  - src/sdk/models/operations/getworkspace.ts
   - src/sdk/models/operations/getworkspaceeventsbytarget.ts
   - src/sdk/models/operations/getworkspacetargets.ts
   - src/sdk/models/operations/postworkspaceevents.ts
@@ -249,10 +255,10 @@ generatedFiles:
   - docs/sdk/models/shared/githubmissingpublishingsecretsresponse.md
   - docs/sdk/models/shared/githubstorepublishingsecretsrequest.md
   - docs/sdk/models/shared/githubtriggeractionrequest.md
-  - docs/sdk/models/shared/organizationusageresponse.md
-  - docs/sdk/models/shared/organizationusage.md
   - docs/sdk/models/shared/organizationaccounttype.md
   - docs/sdk/models/shared/organization.md
+  - docs/sdk/models/shared/organizationusageresponse.md
+  - docs/sdk/models/shared/organizationusage.md
   - docs/sdk/models/shared/type.md
   - docs/sdk/models/shared/report.md
   - docs/sdk/models/shared/shorturl.md
@@ -262,6 +268,7 @@ generatedFiles:
   - docs/sdk/models/shared/suggestoperationidsopts.md
   - docs/sdk/models/shared/embedaccesstokenresponse.md
   - docs/sdk/models/shared/embedtoken.md
+  - docs/sdk/models/shared/workspace.md
   - docs/sdk/models/shared/generatebumptype.md
   - docs/sdk/models/shared/openapidiffbumptype.md
   - docs/sdk/models/shared/clievent.md
@@ -349,6 +356,8 @@ generatedFiles:
   - docs/sdk/models/operations/getactionresponse.md
   - docs/sdk/models/operations/githubcheckpublishingsecretsrequest.md
   - docs/sdk/models/operations/githubcheckpublishingsecretsresponse.md
+  - docs/sdk/models/operations/getorganizationrequest.md
+  - docs/sdk/models/operations/getorganizationresponse.md
   - docs/sdk/models/operations/getorganizationusageresponse.md
   - docs/sdk/models/operations/getorganizationsresponse.md
   - docs/sdk/models/operations/getchangesreportsignedurlrequest.md
@@ -370,6 +379,9 @@ generatedFiles:
   - docs/sdk/models/operations/getembedaccesstokenresponse.md
   - docs/sdk/models/operations/getvalidembedaccesstokensresponse.md
   - docs/sdk/models/operations/revokeembedaccesstokenrequest.md
+  - docs/sdk/models/operations/getworkspaceglobals.md
+  - docs/sdk/models/operations/getworkspacerequest.md
+  - docs/sdk/models/operations/getworkspaceresponse.md
   - docs/sdk/models/operations/getworkspaceeventsbytargetglobals.md
   - docs/sdk/models/operations/getworkspaceeventsbytargetrequest.md
   - docs/sdk/models/operations/getworkspaceeventsbytargetresponse.md
@@ -396,6 +408,7 @@ generatedFiles:
   - docs/sdks/shorturls/README.md
   - docs/sdks/suggest/README.md
   - docs/sdks/embeds/README.md
+  - docs/sdks/workspaces/README.md
   - docs/sdks/events/README.md
   - USAGE.md
   - .gitattributes

.speakeasy/workflow.lock

@@ -1,18 +1,18 @@
-speakeasyVersion: 1.345.3
+speakeasyVersion: 1.349.0
 sources:
     my-source:
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:8848109787e4f3fff8ce742b76a440e359126a64bfbf7d296e268c07b22f0688
-        sourceBlobDigest: sha256:df932434792c6cecedad99f00e5d48ef90cfc7410c41079062384a36eb76adf2
+        sourceRevisionDigest: sha256:417c12e58371aea5d13d8371f6701239551b2867851855d500610693a68c7c0d
+        sourceBlobDigest: sha256:67a2d40a2a3e329e03a5c9a9270f0996f9727863eb3083a9e38ccdc796844031
         tags:
             - latest
             - main
 targets:
     speakeasy-client-sdk-typescript:
         source: my-source
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:8848109787e4f3fff8ce742b76a440e359126a64bfbf7d296e268c07b22f0688
-        sourceBlobDigest: sha256:df932434792c6cecedad99f00e5d48ef90cfc7410c41079062384a36eb76adf2
+        sourceRevisionDigest: sha256:417c12e58371aea5d13d8371f6701239551b2867851855d500610693a68c7c0d
+        sourceBlobDigest: sha256:67a2d40a2a3e329e03a5c9a9270f0996f9727863eb3083a9e38ccdc796844031
         outLocation: /github/workspace/repo
 workflow:
     workflowVersion: 1.0.0

README.md

@@ -39,11 +39,7 @@ yarn add @speakeasy-api/speakeasy-client-sdk-typescript zod
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
-const speakeasy = new Speakeasy({
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
-});
+const speakeasy = new Speakeasy();
 
 async function run() {
     const result = await speakeasy.apis.getApis({});
@@ -136,6 +132,7 @@ run();
 ### [organizations](docs/sdks/organizations/README.md)
 
 * [createFreeTrial](docs/sdks/organizations/README.md#createfreetrial) - Create a free trial for an organization
+* [getOrganization](docs/sdks/organizations/README.md#getorganization) - Get organization
 * [getOrganizationUsage](docs/sdks/organizations/README.md#getorganizationusage) - Get billing usage summary for a particular organization
 * [getOrganizations](docs/sdks/organizations/README.md#getorganizations) - Get organizations for a user
 
@@ -161,6 +158,10 @@ run();
 * [getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
 * [revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.
 
+### [workspaces](docs/sdks/workspaces/README.md)
+
+* [getWorkspace](docs/sdks/workspaces/README.md#getworkspace) - Get workspace
+
 ### [events](docs/sdks/events/README.md)
 
 * [getWorkspaceEventsByTarget](docs/sdks/events/README.md#getworkspaceeventsbytarget) - Load recent events for a particular workspace
@@ -191,11 +192,7 @@ Validation errors can also occur when either method arguments or data returned f
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 import { SDKValidationError } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/errors";
 
-const speakeasy = new Speakeasy({
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
-});
+const speakeasy = new Speakeasy();
 
 async function run() {
     let result;
@@ -246,9 +243,6 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
 const speakeasy = new Speakeasy({
     server: "prod",
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
 });
 
 async function run() {
@@ -275,9 +269,6 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
 const speakeasy = new Speakeasy({
     serverURL: "https://api.prod.speakeasyapi.dev",
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
 });
 
 async function run() {
@@ -364,11 +355,7 @@ You can set the security parameters through the `security` optional parameter wh
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
-const speakeasy = new Speakeasy({
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
-});
+const speakeasy = new Speakeasy();
 
 async function run() {
     const result = await speakeasy.apis.deleteApi({
@@ -390,7 +377,7 @@ run();
 
 A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
 
-For example, you can set `workspaceID` to `"<value>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getWorkspaceEventsByTarget`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
+For example, you can set `workspaceID` to `"<value>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getWorkspace`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
 
 
 ### Available Globals
@@ -407,16 +394,10 @@ The following global parameter is available.
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
-const speakeasy = new Speakeasy({
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
-});
+const speakeasy = new Speakeasy();
 
 async function run() {
-    const result = await speakeasy.events.getWorkspaceEventsByTarget({
-        targetID: "<value>",
-    });
+    const result = await speakeasy.workspaces.getWorkspace({});
 
     // Handle the result
     console.log(result);
@@ -436,11 +417,7 @@ To change the default retry strategy for a single API call, simply provide a ret
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
-const speakeasy = new Speakeasy({
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
-});
+const speakeasy = new Speakeasy();
 
 async function run() {
     const result = await speakeasy.apis.deleteApi(
@@ -485,9 +462,6 @@ const speakeasy = new Speakeasy({
         },
         retryConnectionErrors: false,
     },
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
 });
 
 async function run() {
@@ -529,11 +503,7 @@ Certain SDK methods accept files as part of a multi-part request. It is possible
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 import { openAsBlob } from "node:fs";
 
-const speakeasy = new Speakeasy({
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
-});
+const speakeasy = new Speakeasy();
 
 async function run() {
     const result = await speakeasy.schemas.registerSchema({

RELEASES.md

@@ -1626,4 +1626,14 @@ Based on:
 ### Generated
 - [typescript v4.0.0] .
 ### Releases
-- [NPM v4.0.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/4.0.0 - .
+- [NPM v4.0.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/4.0.0 - .
+
+## 2024-07-31 10:17:43
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.349.0 (2.382.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v4.1.0-rc.1] .
+### Releases
+- [NPM v4.1.0-rc.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/4.1.0-rc.1 - .

USAGE.md

@@ -2,11 +2,7 @@
 ```typescript
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
-const speakeasy = new Speakeasy({
-    security: {
-        apiKey: "<YOUR_API_KEY_HERE>",
-    },
-});
+const speakeasy = new Speakeasy();
 
 async function run() {
     const result = await speakeasy.apis.getApis({});

docs/sdk/models/operations/getorganizationrequest.md

@@ -0,0 +1,8 @@
+# GetOrganizationRequest
+
+
+## Fields
+
+| Field                                  | Type                                   | Required                               | Description                            |
+| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
+| `organizationID`                       | *string*                               | :heavy_check_mark:                     | Unique identifier of the organization. |

docs/sdk/models/operations/getorganizationresponse.md

@@ -0,0 +1,17 @@
+# GetOrganizationResponse
+
+
+## Supported Types
+
+### `shared.ErrorT`
+
+```typescript
+const value: shared.ErrorT = /* values here */
+```
+
+### `shared.Organization`
+
+```typescript
+const value: shared.Organization = /* values here */
+```
+

docs/sdk/models/operations/getworkspaceglobals.md

@@ -0,0 +1,8 @@
+# GetWorkspaceGlobals
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `workspaceID`      | *string*           | :heavy_minus_sign: | N/A                |

docs/sdk/models/operations/getworkspacerequest.md

@@ -0,0 +1,8 @@
+# GetWorkspaceRequest
+
+
+## Fields
+
+| Field                               | Type                                | Required                            | Description                         |
+| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
+| `workspaceID`                       | *string*                            | :heavy_minus_sign:                  | Unique identifier of the workspace. |

docs/sdk/models/operations/getworkspaceresponse.md

@@ -0,0 +1,17 @@
+# GetWorkspaceResponse
+
+
+## Supported Types
+
+### `shared.ErrorT`
+
+```typescript
+const value: shared.ErrorT = /* values here */
+```
+
+### `shared.Workspace`
+
+```typescript
+const value: shared.Workspace = /* values here */
+```
+