Skip to content

Commit 6c4880c

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.219.2
1 parent 748e868 commit 6c4880c

File tree

19 files changed

+256
-40
lines changed

19 files changed

+256
-40
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: f5719c92-1297-4aa0-bc5f-37116859d1e3
33
management:
4-
docChecksum: 3d1ffb0cc7307a0362c5389c0fa1fdb5
4+
docChecksum: 17e2e733dfd588a7103c3c70e91b24b5
55
docVersion: 0.4.0
6-
speakeasyVersion: 1.213.0
7-
generationVersion: 2.283.1
8-
releaseVersion: 4.0.15
9-
configChecksum: 6a034d83dc6e5084ff7634c42dca403b
6+
speakeasyVersion: 1.219.2
7+
generationVersion: 2.286.7
8+
releaseVersion: 4.0.16
9+
configChecksum: 90ea74ca7875e56d7e29361ba69f9f0e
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby
@@ -136,6 +136,7 @@ generatedFiles:
136136
- lib/speakeasy_client_sdk/models/operations/registerschema_response.rb
137137
- lib/speakeasy_client_sdk/models/operations/getaccesstoken_request.rb
138138
- lib/speakeasy_client_sdk/models/operations/getaccesstoken_response.rb
139+
- lib/speakeasy_client_sdk/models/operations/getuser_response.rb
139140
- lib/speakeasy_client_sdk/models/operations/getworkspaceaccess_request.rb
140141
- lib/speakeasy_client_sdk/models/operations/getworkspaceaccess_response.rb
141142
- lib/speakeasy_client_sdk/models/operations/validateapikey_response.rb
@@ -169,9 +170,10 @@ generatedFiles:
169170
- lib/speakeasy_client_sdk/models/shared/valuechange.rb
170171
- lib/speakeasy_client_sdk/models/shared/schemadiff.rb
171172
- lib/speakeasy_client_sdk/models/shared/claims.rb
172-
- lib/speakeasy_client_sdk/models/shared/user.rb
173+
- lib/speakeasy_client_sdk/models/shared/accesstoken_user.rb
173174
- lib/speakeasy_client_sdk/models/shared/workspaces.rb
174175
- lib/speakeasy_client_sdk/models/shared/accesstoken.rb
176+
- lib/speakeasy_client_sdk/models/shared/user.rb
175177
- lib/speakeasy_client_sdk/models/shared/level.rb
176178
- lib/speakeasy_client_sdk/models/shared/accessdetails.rb
177179
- lib/speakeasy_client_sdk/models/shared/account_type.rb
@@ -249,6 +251,7 @@ generatedFiles:
249251
- docs/models/operations/registerschemaresponse.md
250252
- docs/models/operations/getaccesstokenrequest.md
251253
- docs/models/operations/getaccesstokenresponse.md
254+
- docs/models/operations/getuserresponse.md
252255
- docs/models/operations/getworkspaceaccessrequest.md
253256
- docs/models/operations/getworkspaceaccessresponse.md
254257
- docs/models/operations/validateapikeyresponse.md
@@ -282,9 +285,10 @@ generatedFiles:
282285
- docs/models/shared/valuechange.md
283286
- docs/models/shared/schemadiff.md
284287
- docs/models/shared/claims.md
285-
- docs/models/shared/user.md
288+
- docs/models/shared/accesstokenuser.md
286289
- docs/models/shared/workspaces.md
287290
- docs/models/shared/accesstoken.md
291+
- docs/models/shared/user.md
288292
- docs/models/shared/level.md
289293
- docs/models/shared/accessdetails.md
290294
- docs/models/shared/accounttype.md

‎Gemfile.lock‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
speakeasy_client_sdk_ruby (4.0.15)
4+
speakeasy_client_sdk_ruby (4.0.16)
55
faraday
66
faraday-multipart
77
rack

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ end
7979
### [Auth](docs/sdks/auth/README.md)
8080

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

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -718,4 +718,14 @@ Based on:
718718
### Generated
719719
- [ruby v4.0.15] .
720720
### Releases
721-
- [Ruby Gems v4.0.15] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.0.15 - .
721+
- [Ruby Gems v4.0.15] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.0.15 - .
722+
723+
## 2024-03-22 00:03:01
724+
### Changes
725+
Based on:
726+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
727+
- Speakeasy CLI 1.219.2 (2.286.7) https://github.com/speakeasy-api/speakeasy
728+
### Generated
729+
- [ruby v4.0.16] .
730+
### Releases
731+
- [Ruby Gems v4.0.16] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.0.16 - .

‎docs/models/operations/getuserresponse.md‎

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` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `error` | [T.nilable(::SpeakeasyClientSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
10+
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
12+
| `user` | [T.nilable(::SpeakeasyClientSDK::Shared::User)](../../models/shared/user.md) | :heavy_minus_sign: | OK |

‎docs/models/shared/accesstoken.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ An AccessToken is a token that can be used to authenticate with the Speakeasy AP
99
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
1010
| `access_token` | *::String* | :heavy_check_mark: | N/A |
1111
| `claims` | [::SpeakeasyClientSDK::Shared::Claims](../../models/shared/claims.md) | :heavy_check_mark: | N/A |
12-
| `user` | [::SpeakeasyClientSDK::Shared::User](../../models/shared/user.md) | :heavy_check_mark: | N/A |
12+
| `user` | [::SpeakeasyClientSDK::Shared::AccessTokenUser](../../models/shared/accesstokenuser.md) | :heavy_check_mark: | N/A |
1313
| `workspaces` | T::Array<[::SpeakeasyClientSDK::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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
9+
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A |
10+
| `display_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
11+
| `email` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
12+
| `email_verified` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
13+
| `id` | *T.nilable(::String)* | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
9-
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A |
10-
| `display_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
11-
| `email` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
12-
| `email_verified` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
13-
| `id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
8+
| `admin` | *T::Boolean* | :heavy_check_mark: | Indicates whether the user is an admin. |
9+
| `confirmed` | *T::Boolean* | :heavy_check_mark: | Indicates whether the user has been confirmed. |
10+
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | Timestamp of the user's creation. |
11+
| `default_workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Identifier of the default workspace. |
12+
| `display_name` | *::String* | :heavy_check_mark: | Display name of the user. |
13+
| `email` | *::String* | :heavy_check_mark: | Email address of the user. |
14+
| `email_verified` | *T::Boolean* | :heavy_check_mark: | Indicates whether the email address has been verified. |
15+
| `github_handle` | *T.nilable(::String)* | :heavy_minus_sign: | GitHub handle of the user. |
16+
| `id` | *::String* | :heavy_check_mark: | Unique identifier for the user. |
17+
| `last_login_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | Timestamp of the last login. |
18+
| `photo_url` | *T.nilable(::String)* | :heavy_minus_sign: | URL of the user's photo. |
19+
| `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | Timestamp of the user's last update. |
20+
| `whitelisted` | *T::Boolean* | :heavy_check_mark: | Indicates whether the user has been whitelisted. |

‎docs/sdks/auth/README.md‎

Lines changed: 35 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

@@ -50,6 +51,40 @@ end
5051
**[T.nilable(::SpeakeasyClientSDK::Operations::GetAccessTokenResponse)](../../models/operations/getaccesstokenresponse.md)**
5152

5253

54+
## get_user
55+
56+
Get information about the current user.
57+
58+
### Example Usage
59+
60+
```ruby
61+
require 'speakeasy_client_sdk_ruby'
62+
63+
64+
s = ::SpeakeasyClientSDK::SDK.new(
65+
workspace_id: "<value>",
66+
)
67+
s.config_security(
68+
::SpeakeasyClientSDK::Shared::Security.new(
69+
api_key: "<YOUR_API_KEY_HERE>",
70+
)
71+
)
72+
73+
74+
res = s.auth.get_user()
75+
76+
if ! res.user.nil?
77+
# handle response
78+
end
79+
80+
```
81+
82+
83+
### Response
84+
85+
**[T.nilable(::SpeakeasyClientSDK::Operations::GetUserResponse)](../../models/operations/getuserresponse.md)**
86+
87+
5388
## get_workspace_access
5489

5590
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
ruby:
13-
version: 4.0.15
13+
version: 4.0.16
1414
author: Speakeasy
1515
description: Ruby Client SDK Generated by Speakeasy
1616
imports:

0 commit comments

Comments
 (0)