Skip to content

Commit ad84f97

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.198.1
1 parent d6bf8ec commit ad84f97

File tree

19 files changed

+6998
-997
lines changed

19 files changed

+6998
-997
lines changed

‎.speakeasy/gen.lock

Lines changed: 12 additions & 4 deletions
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: e7803aa801c8a80e23dbe21edbf4e9c5
4+
docChecksum: 9e766720141ee71ea97dae02c573b883
55
docVersion: 0.4.0
66
speakeasyVersion: internal
7-
generationVersion: 2.272.7
8-
releaseVersion: 3.1.9
9-
configChecksum: c27ee91ff3210b1f1572e2bdd7c4311c
7+
generationVersion: 2.275.4
8+
releaseVersion: 3.1.10
9+
configChecksum: 3e376a1be44287ab44510096f84d58f6
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
@@ -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/getaccesstoken.ts
7980
- src/sdk/models/operations/getworkspaceaccess.ts
8081
- src/sdk/models/operations/validateapikey.ts
8182
- src/sdk/models/operations/generaterequestpostmancollection.ts
@@ -97,6 +98,7 @@ generatedFiles:
9798
- src/sdk/models/shared/versionmetadatainput.ts
9899
- src/sdk/models/shared/schema.ts
99100
- src/sdk/models/shared/schemadiff.ts
101+
- src/sdk/models/shared/accesstoken.ts
100102
- src/sdk/models/shared/accessdetails.ts
101103
- src/sdk/models/shared/apikeydetails.ts
102104
- src/sdk/models/shared/unboundedrequest.ts
@@ -166,6 +168,8 @@ generatedFiles:
166168
- docs/sdk/models/operations/registerschemarequestbody.md
167169
- docs/sdk/models/operations/registerschemarequest.md
168170
- docs/sdk/models/operations/registerschemaresponse.md
171+
- docs/sdk/models/operations/getaccesstokenrequest.md
172+
- docs/sdk/models/operations/getaccesstokenresponse.md
169173
- docs/sdk/models/operations/getworkspaceaccessrequest.md
170174
- docs/sdk/models/operations/getworkspaceaccessresponse.md
171175
- docs/sdk/models/operations/validateapikeyresponse.md
@@ -197,6 +201,10 @@ generatedFiles:
197201
- docs/sdk/models/shared/schema.md
198202
- docs/sdk/models/shared/valuechange.md
199203
- docs/sdk/models/shared/schemadiff.md
204+
- docs/sdk/models/shared/claims.md
205+
- docs/sdk/models/shared/user.md
206+
- docs/sdk/models/shared/workspaces.md
207+
- docs/sdk/models/shared/accesstoken.md
200208
- docs/sdk/models/shared/accessdetails.md
201209
- docs/sdk/models/shared/accounttype.md
202210
- docs/sdk/models/shared/apikeydetails.md

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ run();
9393

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

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

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1236,4 +1236,14 @@ Based on:
12361236
### Generated
12371237
- [typescript v3.1.9] .
12381238
### Releases
1239-
- [NPM v3.1.9] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.9 - .
1239+
- [NPM v3.1.9] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.9 - .
1240+
1241+
## 2024-03-01 00:12:28
1242+
### Changes
1243+
Based on:
1244+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1245+
- Speakeasy CLI 1.198.1 (2.275.4) https://github.com/speakeasy-api/speakeasy
1246+
### Generated
1247+
- [typescript v3.1.10] .
1248+
### Releases
1249+
- [NPM v3.1.10] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.10 - .

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GetAccessTokenRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID |

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# GetAccessTokenResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
8+
| `accessToken` | [shared.AccessToken](../../../sdk/models/shared/accesstoken.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: | Default error response |
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/shared/accesstoken.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AccessToken
2+
3+
An AccessToken is a token that can be used to authenticate with the Speakeasy API.
4+
5+
6+
## Fields
7+
8+
| Field | Type | Required | Description |
9+
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
10+
| `accessToken` | *string* | :heavy_check_mark: | N/A |
11+
| `claims` | [shared.Claims](../../../sdk/models/shared/claims.md) | :heavy_check_mark: | N/A |
12+
| `user` | [shared.User](../../../sdk/models/shared/user.md) | :heavy_check_mark: | N/A |
13+
| `workspaces` | [shared.Workspaces](../../../sdk/models/shared/workspaces.md)[] | :heavy_minus_sign: | N/A |

‎docs/sdk/models/shared/claims.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Claims
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ----------- | ----------- | ----------- | ----------- |

‎docs/sdk/models/shared/user.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# User
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
8+
| `admin` | *boolean* | :heavy_minus_sign: | N/A |
9+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
10+
| `displayName` | *string* | :heavy_minus_sign: | N/A |
11+
| `email` | *string* | :heavy_minus_sign: | N/A |
12+
| `emailVerified` | *boolean* | :heavy_minus_sign: | N/A |
13+
| `id` | *string* | :heavy_minus_sign: | N/A |

‎docs/sdk/models/shared/workspaces.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Workspaces
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ----------- | ----------- | ----------- | ----------- |

‎docs/sdks/auth/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,53 @@ REST APIs for managing Authentication
77

88
### Available Operations
99

10+
* [getAccessToken](#getaccesstoken) - Get or refresh an access token for the current workspace.
1011
* [getWorkspaceAccess](#getworkspaceaccess) - Get access allowances for a particular workspace
1112
* [validateApiKey](#validateapikey) - Validate the current api key.
1213

14+
## getAccessToken
15+
16+
Get or refresh an access token for the current workspace.
17+
18+
### Example Usage
19+
20+
```typescript
21+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
22+
23+
async function run() {
24+
const sdk = new Speakeasy({
25+
workspaceID: "<value>",
26+
});
27+
28+
const res = await sdk.auth.getAccessToken({
29+
workspaceId: "<value>",
30+
});
31+
32+
if (res.statusCode == 200) {
33+
// handle response
34+
}
35+
}
36+
37+
run();
38+
```
39+
40+
### Parameters
41+
42+
| Parameter | Type | Required | Description |
43+
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
44+
| `request` | [operations.GetAccessTokenRequest](../../sdk/models/operations/getaccesstokenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
45+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
46+
47+
48+
### Response
49+
50+
**Promise<[operations.GetAccessTokenResponse](../../sdk/models/operations/getaccesstokenresponse.md)>**
51+
### Errors
52+
53+
| Error Object | Status Code | Content Type |
54+
| --------------- | --------------- | --------------- |
55+
| errors.SDKError | 4xx-5xx | */* |
56+
1357
## getWorkspaceAccess
1458

1559
Checks if generation is permitted for a particular run of the CLI

0 commit comments

Comments
 (0)