Skip to content

Commit 732982f

Browse files
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.219.2
1 parent 1d08b84 commit 732982f

File tree

17 files changed

+241
-29
lines changed

17 files changed

+241
-29
lines changed

.speakeasy/gen.lock

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: b0b519b1-d1d3-43b2-82dd-b4292eadd4b0
33
management:
4-
docChecksum: 3d1ffb0cc7307a0362c5389c0fa1fdb5
4+
docChecksum: 17e2e733dfd588a7103c3c70e91b24b5
55
docVersion: 0.4.0
6-
speakeasyVersion: 1.207.1
7-
generationVersion: 2.280.6
8-
releaseVersion: 5.4.2
9-
configChecksum: a976d8241daf5ce93ba1c8e2be1c6b4f
6+
speakeasyVersion: 1.219.2
7+
generationVersion: 2.286.7
8+
releaseVersion: 5.4.3
9+
configChecksum: 7fe27121cad4ded73012364cf3d6e9fd
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-python.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-python.git
@@ -16,7 +16,7 @@ features:
1616
core: 4.5.1
1717
downloadStreams: 0.0.2
1818
examples: 2.81.3
19-
globalSecurity: 2.83.4
19+
globalSecurity: 2.83.5
2020
globalServerURLs: 2.82.2
2121
globals: 2.81.1
2222
inputOutputModels: 2.83.1
@@ -70,6 +70,7 @@ generatedFiles:
7070
- src/speakeasy/models/operations/getschemas.py
7171
- src/speakeasy/models/operations/registerschema.py
7272
- src/speakeasy/models/operations/getaccesstoken.py
73+
- src/speakeasy/models/operations/getuser.py
7374
- src/speakeasy/models/operations/getworkspaceaccess.py
7475
- src/speakeasy/models/operations/validateapikey.py
7576
- src/speakeasy/models/operations/generaterequestpostmancollection.py
@@ -93,6 +94,7 @@ generatedFiles:
9394
- src/speakeasy/models/shared/schema.py
9495
- src/speakeasy/models/shared/schemadiff.py
9596
- src/speakeasy/models/shared/accesstoken.py
97+
- src/speakeasy/models/shared/user.py
9698
- src/speakeasy/models/shared/accessdetails.py
9799
- src/speakeasy/models/shared/apikeydetails.py
98100
- src/speakeasy/models/shared/unboundedrequest.py
@@ -167,6 +169,7 @@ generatedFiles:
167169
- docs/models/operations/registerschemaresponse.md
168170
- docs/models/operations/getaccesstokenrequest.md
169171
- docs/models/operations/getaccesstokenresponse.md
172+
- docs/models/operations/getuserresponse.md
170173
- docs/models/operations/getworkspaceaccessrequest.md
171174
- docs/models/operations/getworkspaceaccessresponse.md
172175
- docs/models/operations/validateapikeyresponse.md
@@ -200,9 +203,10 @@ generatedFiles:
200203
- docs/models/shared/valuechange.md
201204
- docs/models/shared/schemadiff.md
202205
- docs/models/shared/claims.md
203-
- docs/models/shared/user.md
206+
- docs/models/shared/accesstokenuser.md
204207
- docs/models/shared/workspaces.md
205208
- docs/models/shared/accesstoken.md
209+
- docs/models/shared/user.md
206210
- docs/models/shared/level.md
207211
- docs/models/shared/accessdetails.md
208212
- docs/models/shared/accounttype.md

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ if res.apis is not None:
7878
### [auth](docs/sdks/auth/README.md)
7979

8080
* [get_access_token](docs/sdks/auth/README.md#get_access_token) - Get or refresh an access token for the current workspace.
81+
* [get_user](docs/sdks/auth/README.md#get_user) - Get information about the current user.
8182
* [get_workspace_access](docs/sdks/auth/README.md#get_workspace_access) - Get access allowances for a particular workspace
8283
* [validate_api_key](docs/sdks/auth/README.md#validate_api_key) - Validate the current api key.
8384

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1346,4 +1346,14 @@ Based on:
13461346
### Generated
13471347
- [python v5.4.2] .
13481348
### Releases
1349-
- [PyPI v5.4.2] https://pypi.org/project/speakeasy-client-sdk-python/5.4.2 - .
1349+
- [PyPI v5.4.2] https://pypi.org/project/speakeasy-client-sdk-python/5.4.2 - .
1350+
1351+
## 2024-03-22 00:10:17
1352+
### Changes
1353+
Based on:
1354+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1355+
- Speakeasy CLI 1.219.2 (2.286.7) https://github.com/speakeasy-api/speakeasy
1356+
### Generated
1357+
- [python v5.4.3] .
1358+
### Releases
1359+
- [PyPI v5.4.3] https://pypi.org/project/speakeasy-client-sdk-python/5.4.3 - .
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# GetUserResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
10+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11+
| `error` | *Optional[errors.Error]* | :heavy_minus_sign: | Default error response |
12+
| `user` | [Optional[shared.User]](../../models/shared/user.md) | :heavy_minus_sign: | OK |

docs/models/shared/accesstoken.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ An AccessToken is a token that can be used to authenticate with the Speakeasy AP
55

66
## Fields
77

8-
| Field | Type | Required | Description |
9-
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
10-
| `access_token` | *str* | :heavy_check_mark: | N/A |
11-
| `claims` | [shared.Claims](../../models/shared/claims.md) | :heavy_check_mark: | N/A |
12-
| `user` | [shared.User](../../models/shared/user.md) | :heavy_check_mark: | N/A |
13-
| `workspaces` | List[[shared.Workspaces](../../models/shared/workspaces.md)] | :heavy_minus_sign: | N/A |
8+
| Field | Type | Required | Description |
9+
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
10+
| `access_token` | *str* | :heavy_check_mark: | N/A |
11+
| `claims` | [shared.Claims](../../models/shared/claims.md) | :heavy_check_mark: | N/A |
12+
| `user` | [shared.AccessTokenUser](../../models/shared/accesstokenuser.md) | :heavy_check_mark: | N/A |
13+
| `workspaces` | List[[shared.Workspaces](../../models/shared/workspaces.md)] | :heavy_minus_sign: | N/A |

docs/models/shared/accesstokenuser.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AccessTokenUser
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
8+
| `admin` | *Optional[bool]* | :heavy_minus_sign: | N/A |
9+
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A |
10+
| `display_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
11+
| `email` | *Optional[str]* | :heavy_minus_sign: | N/A |
12+
| `email_verified` | *Optional[bool]* | :heavy_minus_sign: | N/A |
13+
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A |

docs/models/shared/user.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,16 @@
55

66
| Field | Type | Required | Description |
77
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
8-
| `admin` | *Optional[bool]* | :heavy_minus_sign: | N/A |
9-
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A |
10-
| `display_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
11-
| `email` | *Optional[str]* | :heavy_minus_sign: | N/A |
12-
| `email_verified` | *Optional[bool]* | :heavy_minus_sign: | N/A |
13-
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A |
8+
| `admin` | *bool* | :heavy_check_mark: | Indicates whether the user is an admin. |
9+
| `confirmed` | *bool* | :heavy_check_mark: | Indicates whether the user has been confirmed. |
10+
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Timestamp of the user's creation. |
11+
| `display_name` | *str* | :heavy_check_mark: | Display name of the user. |
12+
| `email` | *str* | :heavy_check_mark: | Email address of the user. |
13+
| `email_verified` | *bool* | :heavy_check_mark: | Indicates whether the email address has been verified. |
14+
| `id` | *str* | :heavy_check_mark: | Unique identifier for the user. |
15+
| `last_login_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Timestamp of the last login. |
16+
| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Timestamp of the user's last update. |
17+
| `whitelisted` | *bool* | :heavy_check_mark: | Indicates whether the user has been whitelisted. |
18+
| `default_workspace_id` | *Optional[str]* | :heavy_minus_sign: | Identifier of the default workspace. |
19+
| `github_handle` | *Optional[str]* | :heavy_minus_sign: | GitHub handle of the user. |
20+
| `photo_url` | *Optional[str]* | :heavy_minus_sign: | URL of the user's photo. |

docs/sdks/auth/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ REST APIs for managing Authentication
88
### Available Operations
99

1010
* [get_access_token](#get_access_token) - Get or refresh an access token for the current workspace.
11+
* [get_user](#get_user) - Get information about the current user.
1112
* [get_workspace_access](#get_workspace_access) - Get access allowances for a particular workspace
1213
* [validate_api_key](#validate_api_key) - Validate the current api key.
1314

@@ -53,6 +54,42 @@ if res.access_token is not None:
5354
| --------------- | --------------- | --------------- |
5455
| errors.SDKError | 4x-5xx | */* |
5556

57+
## get_user
58+
59+
Get information about the current user.
60+
61+
### Example Usage
62+
63+
```python
64+
import speakeasy
65+
from speakeasy.models import shared
66+
67+
s = speakeasy.Speakeasy(
68+
security=shared.Security(
69+
api_key="<YOUR_API_KEY_HERE>",
70+
),
71+
workspace_id='<value>',
72+
)
73+
74+
75+
res = s.auth.get_user()
76+
77+
if res.user is not None:
78+
# handle response
79+
pass
80+
81+
```
82+
83+
84+
### Response
85+
86+
**[operations.GetUserResponse](../../models/operations/getuserresponse.md)**
87+
### Errors
88+
89+
| Error Object | Status Code | Content Type |
90+
| --------------- | --------------- | --------------- |
91+
| errors.SDKError | 4x-5xx | */* |
92+
5693
## get_workspace_access
5794

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

gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ generation:
1010
auth:
1111
oAuth2ClientCredentialsEnabled: false
1212
python:
13-
version: 5.4.2
13+
version: 5.4.3
1414
additionalDependencies:
1515
dependencies: {}
1616
extraDependencies:

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
setuptools.setup(
1212
name="speakeasy-client-sdk-python",
13-
version="5.4.2",
13+
version="5.4.3",
1414
author="Speakeasy",
1515
description="Speakeasy API Client SDK for Python",
1616
long_description=long_description,

0 commit comments

Comments
 (0)