Skip to content

Commit 0ab4839

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.193.4
1 parent 4d9b6c5 commit 0ab4839

27 files changed

+7299
-1043
lines changed

‎.speakeasy/gen.lock

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: 89968bf0-a755-4d50-9acb-d47410010f05
33
management:
4-
docChecksum: 10893fff3e9a4e77b8628de48190cd77
4+
docChecksum: 1e1fbb7b85b19b149be8f6b8a6916f76
55
docVersion: 0.4.0
66
speakeasyVersion: internal
77
generationVersion: 2.272.4
8-
releaseVersion: 3.1.6
9-
configChecksum: 6b6504331bdb6e23a4c627f3ea137c72
8+
releaseVersion: 3.1.7
9+
configChecksum: 76687d62103382dba2c9356ddb1dd007
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
@@ -84,6 +84,8 @@ generatedFiles:
8484
- src/sdk/models/operations/getembedaccesstoken.ts
8585
- src/sdk/models/operations/getvalidembedaccesstokens.ts
8686
- src/sdk/models/operations/revokeembedaccesstoken.ts
87+
- src/sdk/models/operations/getworkspaceevents.ts
88+
- src/sdk/models/operations/getworkspacetargets.ts
8789
- src/sdk/models/operations/postworkspaceevents.ts
8890
- src/sdk/models/shared/error.ts
8991
- src/sdk/models/shared/generateopenapispecdiff.ts
@@ -105,6 +107,7 @@ generatedFiles:
105107
- src/sdk/models/shared/embedaccesstokenresponse.ts
106108
- src/sdk/models/shared/embedtoken.ts
107109
- src/sdk/models/shared/clievent.ts
110+
- src/sdk/models/shared/targetsdk.ts
108111
- src/sdk/models/shared/security.ts
109112
- src/sdk/models/errors/index.ts
110113
- src/sdk/models/operations/index.ts
@@ -177,6 +180,10 @@ generatedFiles:
177180
- docs/sdk/models/operations/getvalidembedaccesstokensresponse.md
178181
- docs/sdk/models/operations/revokeembedaccesstokenrequest.md
179182
- docs/sdk/models/operations/revokeembedaccesstokenresponse.md
183+
- docs/sdk/models/operations/getworkspaceeventsrequest.md
184+
- docs/sdk/models/operations/getworkspaceeventsresponse.md
185+
- docs/sdk/models/operations/getworkspacetargetsrequest.md
186+
- docs/sdk/models/operations/getworkspacetargetsresponse.md
180187
- docs/sdk/models/operations/postworkspaceeventsrequest.md
181188
- docs/sdk/models/operations/postworkspaceeventsresponse.md
182189
- docs/sdk/models/shared/errort.md
@@ -203,6 +210,7 @@ generatedFiles:
203210
- docs/sdk/models/shared/generatebumptype.md
204211
- docs/sdk/models/shared/interactiontype.md
205212
- docs/sdk/models/shared/clievent.md
213+
- docs/sdk/models/shared/targetsdk.md
206214
- docs/sdk/models/shared/security.md
207215
- docs/sdks/speakeasy/README.md
208216
- docs/sdks/apis/README.md

‎README.md

+10-25
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ run();
110110

111111
### [events](docs/sdks/events/README.md)
112112

113+
* [getWorkspaceEvents](docs/sdks/events/README.md#getworkspaceevents) - Load recent events for a particular workspace
114+
* [getWorkspaceTargets](docs/sdks/events/README.md#getworkspacetargets) - Load targets for a particular workspace
113115
* [postWorkspaceEvents](docs/sdks/events/README.md#postworkspaceevents) - Post events for a specific workspace
114116
<!-- End Available Resources and Operations [operations] -->
115117

@@ -264,13 +266,14 @@ const sdk = new Speakeasy({defaultClient: httpClient});
264266

265267
### Per-Client Security Schemes
266268

267-
This SDK supports the following security scheme globally:
269+
This SDK supports the following security schemes globally:
268270

269-
| Name | Type | Scheme |
270-
| -------- | -------- | -------- |
271-
| `apiKey` | apiKey | API key |
271+
| Name | Type | Scheme |
272+
| ----------- | ----------- | ----------- |
273+
| `apiKey` | apiKey | API key |
274+
| `bearer` | http | HTTP Bearer |
272275

273-
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
276+
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
274277
```typescript
275278
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
276279

@@ -302,7 +305,7 @@ run();
302305

303306
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.
304307

305-
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 `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.
308+
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 `getWorkspaceEvents`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
306309

307310

308311
### Available Globals
@@ -318,10 +321,6 @@ The following global parameter is available.
318321

319322
```typescript
320323
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
321-
import {
322-
GenerateBumpType,
323-
InteractionType,
324-
} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/shared";
325324

326325
async function run() {
327326
const sdk = new Speakeasy({
@@ -331,21 +330,7 @@ async function run() {
331330
workspaceID: "<value>",
332331
});
333332

334-
const res = await sdk.events.postWorkspaceEvents({
335-
requestBody: [
336-
{
337-
createdAt: new Date("2024-11-21T06:58:42.120Z"),
338-
executionId: "<value>",
339-
id: "<id>",
340-
interactionType: InteractionType.CliExec,
341-
localStartedAt: new Date("2024-05-07T12:35:47.182Z"),
342-
speakeasyApiKeyName: "<value>",
343-
speakeasyVersion: "<value>",
344-
success: false,
345-
workspaceId: "<value>",
346-
},
347-
],
348-
});
333+
const res = await sdk.events.getWorkspaceEvents({});
349334

350335
if (res.statusCode == 200) {
351336
// handle response

‎RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1206,4 +1206,14 @@ Based on:
12061206
### Generated
12071207
- [typescript v3.1.6] .
12081208
### Releases
1209-
- [NPM v3.1.6] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.6 - .
1209+
- [NPM v3.1.6] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.6 - .
1210+
1211+
## 2024-02-25 00:11:58
1212+
### Changes
1213+
Based on:
1214+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1215+
- Speakeasy CLI 1.193.4 (2.272.4) https://github.com/speakeasy-api/speakeasy
1216+
### Generated
1217+
- [typescript v3.1.7] .
1218+
### Releases
1219+
- [NPM v3.1.7] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.7 - .

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

-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,5 @@
77
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
88
| `accessDetails` | [shared.AccessDetails](../../../sdk/models/shared/accessdetails.md) | :heavy_minus_sign: | OK |
99
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
10-
| `error` | [shared.ErrorT](../../../sdk/models/shared/errort.md) | :heavy_minus_sign: | N/A |
1110
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
1211
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

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

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# GetWorkspaceEventsRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
8+
| `generateGenLockId` | *string* | :heavy_minus_sign: | Filter to only return events corresponding to a particular gen_lock_id |
9+
| `workspaceID` | *string* | :heavy_minus_sign: | Unique identifier of the workspace. |

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

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# GetWorkspaceEventsResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
8+
| `cliEventBatch` | [shared.CliEvent](../../../sdk/models/shared/clievent.md)[] | :heavy_minus_sign: | Success |
9+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
10+
| `error` | [shared.ErrorT](../../../sdk/models/shared/errort.md) | :heavy_minus_sign: | Error |
11+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
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/getworkspacetargetsrequest.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GetWorkspaceTargetsRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
8+
| `workspaceID` | *string* | :heavy_minus_sign: | Unique identifier of the workspace. |

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

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# GetWorkspaceTargetsResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
8+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `error` | [shared.ErrorT](../../../sdk/models/shared/errort.md) | :heavy_minus_sign: | N/A |
10+
| `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+
| `targetSDKList` | [shared.TargetSDK](../../../sdk/models/shared/targetsdk.md)[] | :heavy_minus_sign: | Success |

0 commit comments

Comments
 (0)