Skip to content

Commit cb931be

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.173.0
1 parent 6c44af0 commit cb931be

Some content is hidden

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

61 files changed

+1129
-906
lines changed

‎.speakeasy/gen.lock

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,35 @@
11
lockVersion: 2.0.0
22
id: 89968bf0-a755-4d50-9acb-d47410010f05
33
management:
4-
docChecksum: ba638b2ad28966c596e28321a2003686
5-
docVersion: 0.3.0
4+
docChecksum: dff663dce4f21ddf3fc2332b7d7be92b
5+
docVersion: 0.4.0
66
speakeasyVersion: internal
7-
generationVersion: 2.225.2
8-
releaseVersion: 2.3.0
9-
configChecksum: d3cb2bcd3c1a62548523f1084b6281f9
7+
generationVersion: 2.250.16
8+
releaseVersion: 3.0.0
9+
configChecksum: 960170d859286757349f42a181e49caa
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript
1313
published: true
1414
features:
1515
typescript:
1616
acceptHeaders: 2.81.1
17-
core: 3.4.1
17+
core: 3.4.6
1818
examples: 2.81.3
1919
globalSecurity: 2.82.2
2020
globalServerURLs: 2.82.1
21+
globals: 2.81.1
2122
inputOutputModels: 2.83.0
2223
serverIDs: 2.81.2
2324
generatedFiles:
2425
- src/sdk/apis.ts
2526
- src/sdk/apiendpoints.ts
2627
- src/sdk/metadata.ts
2728
- src/sdk/schemas.ts
29+
- src/sdk/auth.ts
2830
- src/sdk/requests.ts
29-
- src/sdk/plugins.ts
3031
- src/sdk/embeds.ts
32+
- src/sdk/events.ts
3133
- src/sdk/sdk.ts
3234
- .eslintrc.yml
3335
- jest.config.js
@@ -48,7 +50,6 @@ generatedFiles:
4850
- src/sdk/types/index.ts
4951
- src/sdk/types/rfcdate.ts
5052
- tsconfig.json
51-
- src/sdk/models/operations/validateapikey.ts
5253
- src/sdk/models/operations/deleteapi.ts
5354
- src/sdk/models/operations/generateopenapispec.ts
5455
- src/sdk/models/operations/generatepostmancollection.ts
@@ -74,15 +75,14 @@ generatedFiles:
7475
- src/sdk/models/operations/getschemarevision.ts
7576
- src/sdk/models/operations/getschemas.ts
7677
- src/sdk/models/operations/registerschema.ts
78+
- src/sdk/models/operations/validateapikey.ts
7779
- src/sdk/models/operations/generaterequestpostmancollection.ts
7880
- src/sdk/models/operations/getrequestfromeventlog.ts
7981
- src/sdk/models/operations/queryeventlog.ts
80-
- src/sdk/models/operations/getplugins.ts
81-
- src/sdk/models/operations/runplugin.ts
82-
- src/sdk/models/operations/upsertplugin.ts
8382
- src/sdk/models/operations/getembedaccesstoken.ts
8483
- src/sdk/models/operations/getvalidembedaccesstokens.ts
8584
- src/sdk/models/operations/revokeembedaccesstoken.ts
85+
- src/sdk/models/operations/postworkspaceevents.ts
8686
- src/sdk/models/shared/error.ts
8787
- src/sdk/models/shared/generateopenapispecdiff.ts
8888
- src/sdk/models/shared/api.ts
@@ -93,19 +93,19 @@ generatedFiles:
9393
- src/sdk/models/shared/versionmetadatainput.ts
9494
- src/sdk/models/shared/schema.ts
9595
- src/sdk/models/shared/schemadiff.ts
96+
- src/sdk/models/shared/apikeydetails.ts
9697
- src/sdk/models/shared/unboundedrequest.ts
9798
- src/sdk/models/shared/boundedrequest.ts
9899
- src/sdk/models/shared/requestmetadata.ts
99100
- src/sdk/models/shared/filters.ts
100101
- src/sdk/models/shared/filter.ts
101-
- src/sdk/models/shared/plugin.ts
102102
- src/sdk/models/shared/embedaccesstokenresponse.ts
103103
- src/sdk/models/shared/embedtoken.ts
104+
- src/sdk/models/shared/clievent.ts
104105
- src/sdk/models/shared/security.ts
105106
- src/sdk/models/errors/index.ts
106107
- src/sdk/models/operations/index.ts
107108
- src/sdk/models/shared/index.ts
108-
- docs/sdk/models/operations/validateapikeyresponse.md
109109
- docs/sdk/models/operations/deleteapirequest.md
110110
- docs/sdk/models/operations/deleteapiresponse.md
111111
- docs/sdk/models/operations/generateopenapispecrequest.md
@@ -160,21 +160,20 @@ generatedFiles:
160160
- docs/sdk/models/operations/registerschemarequestbody.md
161161
- docs/sdk/models/operations/registerschemarequest.md
162162
- docs/sdk/models/operations/registerschemaresponse.md
163+
- docs/sdk/models/operations/validateapikeyresponse.md
163164
- docs/sdk/models/operations/generaterequestpostmancollectionrequest.md
164165
- docs/sdk/models/operations/generaterequestpostmancollectionresponse.md
165166
- docs/sdk/models/operations/getrequestfromeventlogrequest.md
166167
- docs/sdk/models/operations/getrequestfromeventlogresponse.md
167168
- docs/sdk/models/operations/queryeventlogrequest.md
168169
- docs/sdk/models/operations/queryeventlogresponse.md
169-
- docs/sdk/models/operations/getpluginsresponse.md
170-
- docs/sdk/models/operations/runpluginrequest.md
171-
- docs/sdk/models/operations/runpluginresponse.md
172-
- docs/sdk/models/operations/upsertpluginresponse.md
173170
- docs/sdk/models/operations/getembedaccesstokenrequest.md
174171
- docs/sdk/models/operations/getembedaccesstokenresponse.md
175172
- docs/sdk/models/operations/getvalidembedaccesstokensresponse.md
176173
- docs/sdk/models/operations/revokeembedaccesstokenrequest.md
177174
- docs/sdk/models/operations/revokeembedaccesstokenresponse.md
175+
- docs/sdk/models/operations/postworkspaceeventsrequest.md
176+
- docs/sdk/models/operations/postworkspaceeventsresponse.md
178177
- docs/sdk/models/shared/errort.md
179178
- docs/sdk/models/shared/generateopenapispecdiff.md
180179
- docs/sdk/models/shared/api.md
@@ -186,22 +185,26 @@ generatedFiles:
186185
- docs/sdk/models/shared/schema.md
187186
- docs/sdk/models/shared/valuechange.md
188187
- docs/sdk/models/shared/schemadiff.md
188+
- docs/sdk/models/shared/apikeydetails.md
189189
- docs/sdk/models/shared/unboundedrequest.md
190190
- docs/sdk/models/shared/boundedrequest.md
191191
- docs/sdk/models/shared/requestmetadata.md
192192
- docs/sdk/models/shared/filters.md
193193
- docs/sdk/models/shared/filter.md
194-
- docs/sdk/models/shared/plugin.md
195194
- docs/sdk/models/shared/embedaccesstokenresponse.md
196195
- docs/sdk/models/shared/embedtoken.md
196+
- docs/sdk/models/shared/generatebumptype.md
197+
- docs/sdk/models/shared/interactiontype.md
198+
- docs/sdk/models/shared/clievent.md
197199
- docs/sdk/models/shared/security.md
198200
- docs/sdks/speakeasy/README.md
199201
- docs/sdks/apis/README.md
200202
- docs/sdks/apiendpoints/README.md
201203
- docs/sdks/metadata/README.md
202204
- docs/sdks/schemas/README.md
205+
- docs/sdks/auth/README.md
203206
- docs/sdks/requests/README.md
204-
- docs/sdks/plugins/README.md
205207
- docs/sdks/embeds/README.md
208+
- docs/sdks/events/README.md
206209
- USAGE.md
207210
- .gitattributes

‎README.md

Lines changed: 89 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ async function run() {
2929
security: {
3030
apiKey: "<YOUR_API_KEY_HERE>",
3131
},
32+
workspaceID: "string",
3233
});
3334

3435
const res = await sdk.apis.getApis({
@@ -53,10 +54,6 @@ run();
5354
<!-- Start Available Resources and Operations [operations] -->
5455
## Available Resources and Operations
5556

56-
### [Speakeasy SDK](docs/sdks/speakeasy/README.md)
57-
58-
* [validateApiKey](docs/sdks/speakeasy/README.md#validateapikey) - Validate the current api key.
59-
6057
### [apis](docs/sdks/apis/README.md)
6158

6259
* [deleteApi](docs/sdks/apis/README.md#deleteapi) - Delete an Api.
@@ -94,23 +91,25 @@ run();
9491
* [getSchemas](docs/sdks/schemas/README.md#getschemas) - Get information about all schemas associated with a particular apiID.
9592
* [registerSchema](docs/sdks/schemas/README.md#registerschema) - Register a schema.
9693

94+
### [auth](docs/sdks/auth/README.md)
95+
96+
* [validateApiKey](docs/sdks/auth/README.md#validateapikey) - Validate the current api key.
97+
9798
### [requests](docs/sdks/requests/README.md)
9899

99100
* [generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
100101
* [getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
101102
* [queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.
102103

103-
### [plugins](docs/sdks/plugins/README.md)
104-
105-
* [getPlugins](docs/sdks/plugins/README.md#getplugins) - Get all plugins for the current workspace.
106-
* [runPlugin](docs/sdks/plugins/README.md#runplugin) - Run a plugin
107-
* [upsertPlugin](docs/sdks/plugins/README.md#upsertplugin) - Upsert a plugin
108-
109104
### [embeds](docs/sdks/embeds/README.md)
110105

111106
* [getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
112107
* [getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
113108
* [revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.
109+
110+
### [events](docs/sdks/events/README.md)
111+
112+
* [postWorkspaceEvents](docs/sdks/events/README.md#postworkspaceevents) - Post events for a specific workspace
114113
<!-- End Available Resources and Operations [operations] -->
115114

116115

@@ -138,11 +137,15 @@ async function run() {
138137
security: {
139138
apiKey: "<YOUR_API_KEY_HERE>",
140139
},
140+
workspaceID: "string",
141141
});
142142

143143
let res;
144144
try {
145-
res = await sdk.validateApiKey();
145+
res = await sdk.apis.deleteApi({
146+
apiID: "string",
147+
versionID: "string",
148+
});
146149
} catch (err) {
147150
if (err instanceof errors.SDKError) {
148151
console.error(err); // handle exception
@@ -184,9 +187,13 @@ async function run() {
184187
security: {
185188
apiKey: "<YOUR_API_KEY_HERE>",
186189
},
190+
workspaceID: "string",
187191
});
188192

189-
const res = await sdk.validateApiKey();
193+
const res = await sdk.apis.deleteApi({
194+
apiID: "string",
195+
versionID: "string",
196+
});
190197

191198
if (res.statusCode == 200) {
192199
// handle response
@@ -210,9 +217,13 @@ async function run() {
210217
security: {
211218
apiKey: "<YOUR_API_KEY_HERE>",
212219
},
220+
workspaceID: "string",
213221
});
214222

215-
const res = await sdk.validateApiKey();
223+
const res = await sdk.apis.deleteApi({
224+
apiID: "string",
225+
versionID: "string",
226+
});
216227

217228
if (res.statusCode == 200) {
218229
// handle response
@@ -267,9 +278,13 @@ async function run() {
267278
security: {
268279
apiKey: "<YOUR_API_KEY_HERE>",
269280
},
281+
workspaceID: "string",
270282
});
271283

272-
const res = await sdk.validateApiKey();
284+
const res = await sdk.apis.deleteApi({
285+
apiID: "string",
286+
versionID: "string",
287+
});
273288

274289
if (res.statusCode == 200) {
275290
// handle response
@@ -281,6 +296,66 @@ run();
281296
```
282297
<!-- End Authentication [security] -->
283298

299+
<!-- Start Global Parameters [global-parameters] -->
300+
## Global Parameters
301+
302+
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.
303+
304+
For example, you can set `workspaceID` to `"string"` at SDK initialization and then you do not have to pass the same value on calls to operations like `postWorkspaceEvents`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
305+
306+
307+
### Available Globals
308+
309+
The following global parameter is available.
310+
311+
| Name | Type | Required | Description |
312+
| ---- | ---- |:--------:| ----------- |
313+
| workspaceID | string | | The workspaceID parameter. |
314+
315+
316+
### Example
317+
318+
```typescript
319+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
320+
import {
321+
GenerateBumpType,
322+
InteractionType,
323+
} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/shared";
324+
325+
async function run() {
326+
const sdk = new Speakeasy({
327+
security: {
328+
apiKey: "<YOUR_API_KEY_HERE>",
329+
},
330+
workspaceID: "string",
331+
});
332+
333+
const res = await sdk.events.postWorkspaceEvents({
334+
requestBody: [
335+
{
336+
createdAt: new Date("2024-11-21T06:58:42.120Z"),
337+
executionId: "string",
338+
id: "<ID>",
339+
interactionType: InteractionType.CliExec,
340+
localStartedAt: new Date("2024-05-07T12:35:47.182Z"),
341+
speakeasyApiKeyName: "string",
342+
speakeasyVersion: "string",
343+
success: false,
344+
workspaceId: "string",
345+
},
346+
],
347+
});
348+
349+
if (res.statusCode == 200) {
350+
// handle response
351+
}
352+
}
353+
354+
run();
355+
356+
```
357+
<!-- End Global Parameters [global-parameters] -->
358+
284359
<!-- Placeholder for Future Speakeasy SDK Sections -->
285360

286361

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1096,4 +1096,14 @@ Based on:
10961096
### Generated
10971097
- [typescript v2.3.0] .
10981098
### Releases
1099-
- [NPM v2.3.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/2.3.0 - .
1099+
- [NPM v2.3.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/2.3.0 - .
1100+
1101+
## 2024-02-08 00:10:48
1102+
### Changes
1103+
Based on:
1104+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1105+
- Speakeasy CLI 1.173.0 (2.250.16) https://github.com/speakeasy-api/speakeasy
1106+
### Generated
1107+
- [typescript v3.0.0] .
1108+
### Releases
1109+
- [NPM v3.0.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.0.0 - .

‎USAGE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ async function run() {
77
security: {
88
apiKey: "<YOUR_API_KEY_HERE>",
99
},
10+
workspaceID: "string",
1011
});
1112

1213
const res = await sdk.apis.getApis({

‎docs/sdk/models/operations/getallapiendpointsresponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
| Field | Type | Required | Description |
77
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
8+
| `apiEndpoints` | [shared.ApiEndpoint](../../../sdk/models/shared/apiendpoint.md)[] | :heavy_minus_sign: | OK |
89
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
910
| `error` | [shared.ErrorT](../../../sdk/models/shared/errort.md) | :heavy_minus_sign: | Default error response |
1011
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11-
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
12-
| `classes` | [shared.ApiEndpoint](../../../sdk/models/shared/apiendpoint.md)[] | :heavy_minus_sign: | OK |
12+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

‎docs/sdk/models/operations/getallapiversionsresponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8+
| `apis` | [shared.Api](../../../sdk/models/shared/api.md)[] | :heavy_minus_sign: | OK |
89
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
910
| `error` | [shared.ErrorT](../../../sdk/models/shared/errort.md) | :heavy_minus_sign: | Default error response |
1011
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11-
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
12-
| `classes` | [shared.Api](../../../sdk/models/shared/api.md)[] | :heavy_minus_sign: | OK |
12+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

‎docs/sdk/models/operations/getallforversionapiendpointsresponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
| Field | Type | Required | Description |
77
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
8+
| `apiEndpoints` | [shared.ApiEndpoint](../../../sdk/models/shared/apiendpoint.md)[] | :heavy_minus_sign: | OK |
89
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
910
| `error` | [shared.ErrorT](../../../sdk/models/shared/errort.md) | :heavy_minus_sign: | Default error response |
1011
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11-
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
12-
| `classes` | [shared.ApiEndpoint](../../../sdk/models/shared/apiendpoint.md)[] | :heavy_minus_sign: | OK |
12+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

0 commit comments

Comments
 (0)