Skip to content

Commit 31ee5f8

Browse files
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.180.0
1 parent fc53592 commit 31ee5f8

File tree

26 files changed

+420
-198
lines changed

26 files changed

+420
-198
lines changed

.speakeasy/gen.lock

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
lockVersion: 2.0.0
22
id: 89968bf0-a755-4d50-9acb-d47410010f05
33
management:
4-
docChecksum: 557634d4bb5964b949ae70f79f40d856
4+
docChecksum: c81aa4e807522359d28c09ee16d252ba
55
docVersion: 0.4.0
66
speakeasyVersion: internal
7-
generationVersion: 2.250.22
8-
releaseVersion: 3.1.0
9-
configChecksum: 54549759930fcd5f880c2ea492dac967
7+
generationVersion: 2.258.0
8+
releaseVersion: 3.1.1
9+
configChecksum: 9344262737ed5942a40a8c8155a0dd50
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.6
17+
core: 3.4.7
1818
examples: 2.81.3
1919
globalSecurity: 2.82.2
2020
globalServerURLs: 2.82.1
@@ -76,6 +76,7 @@ generatedFiles:
7676
- src/sdk/models/operations/getschemarevision.ts
7777
- src/sdk/models/operations/getschemas.ts
7878
- src/sdk/models/operations/registerschema.ts
79+
- src/sdk/models/operations/getworkspaceaccess.ts
7980
- src/sdk/models/operations/validateapikey.ts
8081
- src/sdk/models/operations/generaterequestpostmancollection.ts
8182
- src/sdk/models/operations/getrequestfromeventlog.ts
@@ -94,6 +95,7 @@ generatedFiles:
9495
- src/sdk/models/shared/versionmetadatainput.ts
9596
- src/sdk/models/shared/schema.ts
9697
- src/sdk/models/shared/schemadiff.ts
98+
- src/sdk/models/shared/accessdetails.ts
9799
- src/sdk/models/shared/apikeydetails.ts
98100
- src/sdk/models/shared/unboundedrequest.ts
99101
- src/sdk/models/shared/boundedrequest.ts
@@ -161,6 +163,8 @@ generatedFiles:
161163
- docs/sdk/models/operations/registerschemarequestbody.md
162164
- docs/sdk/models/operations/registerschemarequest.md
163165
- docs/sdk/models/operations/registerschemaresponse.md
166+
- docs/sdk/models/operations/getworkspaceaccessrequest.md
167+
- docs/sdk/models/operations/getworkspaceaccessresponse.md
164168
- docs/sdk/models/operations/validateapikeyresponse.md
165169
- docs/sdk/models/operations/generaterequestpostmancollectionrequest.md
166170
- docs/sdk/models/operations/generaterequestpostmancollectionresponse.md
@@ -186,6 +190,7 @@ generatedFiles:
186190
- docs/sdk/models/shared/schema.md
187191
- docs/sdk/models/shared/valuechange.md
188192
- docs/sdk/models/shared/schemadiff.md
193+
- docs/sdk/models/shared/accessdetails.md
189194
- docs/sdk/models/shared/apikeydetails.md
190195
- docs/sdk/models/shared/unboundedrequest.md
191196
- docs/sdk/models/shared/boundedrequest.md
@@ -203,10 +208,10 @@ generatedFiles:
203208
- docs/sdks/apiendpoints/README.md
204209
- docs/sdks/metadata/README.md
205210
- docs/sdks/schemas/README.md
211+
- docs/internal/utils/retryconfig.md
206212
- docs/sdks/auth/README.md
207213
- docs/sdks/requests/README.md
208214
- docs/sdks/embeds/README.md
209-
- docs/internal/utils/retryconfig.md
210215
- docs/sdks/events/README.md
211216
- USAGE.md
212217
- .gitattributes

README.md

Lines changed: 27 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ async function run() {
2929
security: {
3030
apiKey: "<YOUR_API_KEY_HERE>",
3131
},
32-
workspaceID: "string",
32+
workspaceID: "<value>",
3333
});
3434

3535
const res = await sdk.apis.getApis({
3636
metadata: {
37-
key: ["string"],
37+
key: ["<value>"],
3838
},
3939
op: {
4040
and: false,
@@ -93,6 +93,7 @@ run();
9393

9494
### [auth](docs/sdks/auth/README.md)
9595

96+
* [getWorkspaceAccess](docs/sdks/auth/README.md#getworkspaceaccess) - Get access allowances for a particular workspace
9697
* [validateApiKey](docs/sdks/auth/README.md#validateapikey) - Validate the current api key.
9798

9899
### [requests](docs/sdks/requests/README.md)
@@ -137,14 +138,14 @@ async function run() {
137138
security: {
138139
apiKey: "<YOUR_API_KEY_HERE>",
139140
},
140-
workspaceID: "string",
141+
workspaceID: "<value>",
141142
});
142143

143144
let res;
144145
try {
145146
res = await sdk.apis.deleteApi({
146-
apiID: "string",
147-
versionID: "string",
147+
apiID: "<value>",
148+
versionID: "<value>",
148149
});
149150
} catch (err) {
150151
if (err instanceof errors.SDKError) {
@@ -187,12 +188,12 @@ async function run() {
187188
security: {
188189
apiKey: "<YOUR_API_KEY_HERE>",
189190
},
190-
workspaceID: "string",
191+
workspaceID: "<value>",
191192
});
192193

193194
const res = await sdk.apis.deleteApi({
194-
apiID: "string",
195-
versionID: "string",
195+
apiID: "<value>",
196+
versionID: "<value>",
196197
});
197198

198199
if (res.statusCode == 200) {
@@ -217,12 +218,12 @@ async function run() {
217218
security: {
218219
apiKey: "<YOUR_API_KEY_HERE>",
219220
},
220-
workspaceID: "string",
221+
workspaceID: "<value>",
221222
});
222223

223224
const res = await sdk.apis.deleteApi({
224-
apiID: "string",
225-
versionID: "string",
225+
apiID: "<value>",
226+
versionID: "<value>",
226227
});
227228

228229
if (res.statusCode == 200) {
@@ -278,12 +279,12 @@ async function run() {
278279
security: {
279280
apiKey: "<YOUR_API_KEY_HERE>",
280281
},
281-
workspaceID: "string",
282+
workspaceID: "<value>",
282283
});
283284

284285
const res = await sdk.apis.deleteApi({
285-
apiID: "string",
286-
versionID: "string",
286+
apiID: "<value>",
287+
versionID: "<value>",
287288
});
288289

289290
if (res.statusCode == 200) {
@@ -301,7 +302,7 @@ run();
301302

302303
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.
303304

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+
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.
305306

306307

307308
### Available Globals
@@ -327,21 +328,21 @@ async function run() {
327328
security: {
328329
apiKey: "<YOUR_API_KEY_HERE>",
329330
},
330-
workspaceID: "string",
331+
workspaceID: "<value>",
331332
});
332333

333334
const res = await sdk.events.postWorkspaceEvents({
334335
requestBody: [
335336
{
336337
createdAt: new Date("2024-11-21T06:58:42.120Z"),
337-
executionId: "string",
338-
id: "<ID>",
338+
executionId: "<value>",
339+
id: "<id>",
339340
interactionType: InteractionType.CliExec,
340341
localStartedAt: new Date("2024-05-07T12:35:47.182Z"),
341-
speakeasyApiKeyName: "string",
342-
speakeasyVersion: "string",
342+
speakeasyApiKeyName: "<value>",
343+
speakeasyVersion: "<value>",
343344
success: false,
344-
workspaceId: "string",
345+
workspaceId: "<value>",
345346
},
346347
],
347348
});
@@ -364,35 +365,17 @@ Some of the endpoints in this SDK support retries. If you use the SDK without a
364365
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
365366
```typescript
366367
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
367-
import {
368-
GenerateBumpType,
369-
InteractionType,
370-
} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/shared";
371368

372369
async function run() {
373370
const sdk = new Speakeasy({
374371
security: {
375372
apiKey: "<YOUR_API_KEY_HERE>",
376373
},
377-
workspaceID: "string",
374+
workspaceID: "<value>",
378375
});
379376

380-
const res = await sdk.events.postWorkspaceEvents(
381-
{
382-
requestBody: [
383-
{
384-
createdAt: new Date("2024-11-21T06:58:42.120Z"),
385-
executionId: "string",
386-
id: "<ID>",
387-
interactionType: InteractionType.CliExec,
388-
localStartedAt: new Date("2024-05-07T12:35:47.182Z"),
389-
speakeasyApiKeyName: "string",
390-
speakeasyVersion: "string",
391-
success: false,
392-
workspaceId: "string",
393-
},
394-
],
395-
},
377+
const res = await sdk.auth.getWorkspaceAccess(
378+
{},
396379
{
397380
strategy: "backoff",
398381
backoff: {
@@ -417,10 +400,6 @@ run();
417400
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
418401
```typescript
419402
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
420-
import {
421-
GenerateBumpType,
422-
InteractionType,
423-
} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/shared";
424403

425404
async function run() {
426405
const sdk = new Speakeasy({
@@ -437,24 +416,10 @@ async function run() {
437416
security: {
438417
apiKey: "<YOUR_API_KEY_HERE>",
439418
},
440-
workspaceID: "string",
419+
workspaceID: "<value>",
441420
});
442421

443-
const res = await sdk.events.postWorkspaceEvents({
444-
requestBody: [
445-
{
446-
createdAt: new Date("2024-11-21T06:58:42.120Z"),
447-
executionId: "string",
448-
id: "<ID>",
449-
interactionType: InteractionType.CliExec,
450-
localStartedAt: new Date("2024-05-07T12:35:47.182Z"),
451-
speakeasyApiKeyName: "string",
452-
speakeasyVersion: "string",
453-
success: false,
454-
workspaceId: "string",
455-
},
456-
],
457-
});
422+
const res = await sdk.auth.getWorkspaceAccess({});
458423

459424
if (res.statusCode == 200) {
460425
// handle response

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1126,4 +1126,14 @@ Based on:
11261126
### Generated
11271127
- [typescript v3.1.0] .
11281128
### Releases
1129-
- [NPM v3.1.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.0 - .
1129+
- [NPM v3.1.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.0 - .
1130+
1131+
## 2024-02-15 00:11:03
1132+
### Changes
1133+
Based on:
1134+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1135+
- Speakeasy CLI 1.180.0 (2.258.0) https://github.com/speakeasy-api/speakeasy
1136+
### Generated
1137+
- [typescript v3.1.1] .
1138+
### Releases
1139+
- [NPM v3.1.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.1 - .

USAGE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ async function run() {
77
security: {
88
apiKey: "<YOUR_API_KEY_HERE>",
99
},
10-
workspaceID: "string",
10+
workspaceID: "<value>",
1111
});
1212

1313
const res = await sdk.apis.getApis({
1414
metadata: {
15-
key: ["string"],
15+
key: ["<value>"],
1616
},
1717
op: {
1818
and: false,
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GetWorkspaceAccessRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
8+
| `genLockId` | *string* | :heavy_minus_sign: | Unique identifier of the generation target. |
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# GetWorkspaceAccessResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
8+
| `accessDetails` | [shared.AccessDetails](../../../sdk/models/shared/accessdetails.md) | :heavy_minus_sign: | OK |
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: | N/A |
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 |
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# AccessDetails
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------- | ------------------- | ------------------- | ------------------- |
8+
| `generationAllowed` | *boolean* | :heavy_check_mark: | N/A |

docs/sdk/models/shared/apikeydetails.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description |
7-
| ------------------ | ------------------ | ------------------ | ------------------ |
8-
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
6+
| Field | Type | Required | Description |
7+
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
8+
| `generationAccessUnlimited` | *boolean* | :heavy_minus_sign: | N/A |
9+
| `workspaceId` | *string* | :heavy_check_mark: | N/A |

0 commit comments

Comments
 (0)