Skip to content

Commit bb7e596

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.173.0
1 parent a994d4c commit bb7e596

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+1167
-960
lines changed

‎.speakeasy/gen.lock‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
lockVersion: 2.0.0
22
id: f5719c92-1297-4aa0-bc5f-37116859d1e3
33
management:
4-
docChecksum: ba638b2ad28966c596e28321a2003686
5-
docVersion: 0.3.0
4+
docChecksum: dff663dce4f21ddf3fc2332b7d7be92b
5+
docVersion: 0.4.0
66
speakeasyVersion: internal
7-
generationVersion: 2.250.2
8-
releaseVersion: 3.0.0
9-
configChecksum: 1c7f8f825d9394149813b4d6d87336dc
7+
generationVersion: 2.250.16
8+
releaseVersion: 4.0.0
9+
configChecksum: 54cd3cfd318ae1fbd63dac91215918dd
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
1313
published: true
1414
features:
1515
ruby:
16-
core: 3.2.3
16+
core: 3.2.5
1717
examples: 2.81.3
1818
globalSecurity: 2.81.3
1919
globalServerURLs: 2.82.1
20+
globals: 2.81.1
2021
inputOutputModels: 2.83.0
2122
serverIDs: 2.81.1
2223
generatedFiles:
@@ -25,9 +26,10 @@ generatedFiles:
2526
- lib/speakeasy_client_sdk/apiendpoints.rb
2627
- lib/speakeasy_client_sdk/metadata.rb
2728
- lib/speakeasy_client_sdk/schemas.rb
29+
- lib/speakeasy_client_sdk/auth.rb
2830
- lib/speakeasy_client_sdk/requests.rb
29-
- lib/speakeasy_client_sdk/plugins.rb
3031
- lib/speakeasy_client_sdk/embeds.rb
32+
- lib/speakeasy_client_sdk/events.rb
3133
- lib/speakeasy_client_sdk/sdk.rb
3234
- .rubocop.yml
3335
- Gemfile
@@ -75,7 +77,6 @@ generatedFiles:
7577
- sorbet/tapioca/config.yml
7678
- sorbet/tapioca/require.rb
7779
- speakeasy_client_sdk_ruby.gemspec
78-
- lib/speakeasy_client_sdk/models/operations/validateapikey_response.rb
7980
- lib/speakeasy_client_sdk/models/operations/deleteapi_request.rb
8081
- lib/speakeasy_client_sdk/models/operations/deleteapi_response.rb
8182
- lib/speakeasy_client_sdk/models/operations/generateopenapispec_request.rb
@@ -130,21 +131,20 @@ generatedFiles:
130131
- lib/speakeasy_client_sdk/models/operations/registerschema_requestbody.rb
131132
- lib/speakeasy_client_sdk/models/operations/registerschema_request.rb
132133
- lib/speakeasy_client_sdk/models/operations/registerschema_response.rb
134+
- lib/speakeasy_client_sdk/models/operations/validateapikey_response.rb
133135
- lib/speakeasy_client_sdk/models/operations/generaterequestpostmancollection_request.rb
134136
- lib/speakeasy_client_sdk/models/operations/generaterequestpostmancollection_response.rb
135137
- lib/speakeasy_client_sdk/models/operations/getrequestfromeventlog_request.rb
136138
- lib/speakeasy_client_sdk/models/operations/getrequestfromeventlog_response.rb
137139
- lib/speakeasy_client_sdk/models/operations/queryeventlog_request.rb
138140
- lib/speakeasy_client_sdk/models/operations/queryeventlog_response.rb
139-
- lib/speakeasy_client_sdk/models/operations/getplugins_response.rb
140-
- lib/speakeasy_client_sdk/models/operations/runplugin_request.rb
141-
- lib/speakeasy_client_sdk/models/operations/runplugin_response.rb
142-
- lib/speakeasy_client_sdk/models/operations/upsertplugin_response.rb
143141
- lib/speakeasy_client_sdk/models/operations/getembedaccesstoken_request.rb
144142
- lib/speakeasy_client_sdk/models/operations/getembedaccesstoken_response.rb
145143
- lib/speakeasy_client_sdk/models/operations/getvalidembedaccesstokens_response.rb
146144
- lib/speakeasy_client_sdk/models/operations/revokeembedaccesstoken_request.rb
147145
- lib/speakeasy_client_sdk/models/operations/revokeembedaccesstoken_response.rb
146+
- lib/speakeasy_client_sdk/models/operations/postworkspaceevents_request.rb
147+
- lib/speakeasy_client_sdk/models/operations/postworkspaceevents_response.rb
148148
- lib/speakeasy_client_sdk/models/shared/error.rb
149149
- lib/speakeasy_client_sdk/models/shared/generateopenapispecdiff.rb
150150
- lib/speakeasy_client_sdk/models/shared/api.rb
@@ -156,19 +156,21 @@ generatedFiles:
156156
- lib/speakeasy_client_sdk/models/shared/schema.rb
157157
- lib/speakeasy_client_sdk/models/shared/valuechange.rb
158158
- lib/speakeasy_client_sdk/models/shared/schemadiff.rb
159+
- lib/speakeasy_client_sdk/models/shared/apikeydetails.rb
159160
- lib/speakeasy_client_sdk/models/shared/unboundedrequest.rb
160161
- lib/speakeasy_client_sdk/models/shared/boundedrequest.rb
161162
- lib/speakeasy_client_sdk/models/shared/requestmetadata.rb
162163
- lib/speakeasy_client_sdk/models/shared/filters.rb
163164
- lib/speakeasy_client_sdk/models/shared/filter.rb
164-
- lib/speakeasy_client_sdk/models/shared/plugin.rb
165165
- lib/speakeasy_client_sdk/models/shared/embedaccesstokenresponse.rb
166166
- lib/speakeasy_client_sdk/models/shared/embedtoken.rb
167+
- lib/speakeasy_client_sdk/models/shared/generate_bump_type.rb
168+
- lib/speakeasy_client_sdk/models/shared/interaction_type.rb
169+
- lib/speakeasy_client_sdk/models/shared/clievent.rb
167170
- lib/speakeasy_client_sdk/models/shared/security.rb
168171
- lib/speakeasy_client_sdk_ruby.rb
169172
- lib/speakeasy_client_sdk/models/operations.rb
170173
- lib/speakeasy_client_sdk/models/shared.rb
171-
- docs/models/operations/validateapikeyresponse.md
172174
- docs/models/operations/deleteapirequest.md
173175
- docs/models/operations/deleteapiresponse.md
174176
- docs/models/operations/generateopenapispecrequest.md
@@ -223,21 +225,20 @@ generatedFiles:
223225
- docs/models/operations/registerschemarequestbody.md
224226
- docs/models/operations/registerschemarequest.md
225227
- docs/models/operations/registerschemaresponse.md
228+
- docs/models/operations/validateapikeyresponse.md
226229
- docs/models/operations/generaterequestpostmancollectionrequest.md
227230
- docs/models/operations/generaterequestpostmancollectionresponse.md
228231
- docs/models/operations/getrequestfromeventlogrequest.md
229232
- docs/models/operations/getrequestfromeventlogresponse.md
230233
- docs/models/operations/queryeventlogrequest.md
231234
- docs/models/operations/queryeventlogresponse.md
232-
- docs/models/operations/getpluginsresponse.md
233-
- docs/models/operations/runpluginrequest.md
234-
- docs/models/operations/runpluginresponse.md
235-
- docs/models/operations/upsertpluginresponse.md
236235
- docs/models/operations/getembedaccesstokenrequest.md
237236
- docs/models/operations/getembedaccesstokenresponse.md
238237
- docs/models/operations/getvalidembedaccesstokensresponse.md
239238
- docs/models/operations/revokeembedaccesstokenrequest.md
240239
- docs/models/operations/revokeembedaccesstokenresponse.md
240+
- docs/models/operations/postworkspaceeventsrequest.md
241+
- docs/models/operations/postworkspaceeventsresponse.md
241242
- docs/models/shared/error.md
242243
- docs/models/shared/generateopenapispecdiff.md
243244
- docs/models/shared/api.md
@@ -249,22 +250,26 @@ generatedFiles:
249250
- docs/models/shared/schema.md
250251
- docs/models/shared/valuechange.md
251252
- docs/models/shared/schemadiff.md
253+
- docs/models/shared/apikeydetails.md
252254
- docs/models/shared/unboundedrequest.md
253255
- docs/models/shared/boundedrequest.md
254256
- docs/models/shared/requestmetadata.md
255257
- docs/models/shared/filters.md
256258
- docs/models/shared/filter.md
257-
- docs/models/shared/plugin.md
258259
- docs/models/shared/embedaccesstokenresponse.md
259260
- docs/models/shared/embedtoken.md
261+
- docs/models/shared/generatebumptype.md
262+
- docs/models/shared/interactiontype.md
263+
- docs/models/shared/clievent.md
260264
- docs/models/shared/security.md
261265
- docs/sdks/sdk/README.md
262266
- docs/sdks/apis/README.md
263267
- docs/sdks/apiendpoints/README.md
264268
- docs/sdks/metadata/README.md
265269
- docs/sdks/schemas/README.md
270+
- docs/sdks/auth/README.md
266271
- docs/sdks/requests/README.md
267-
- docs/sdks/plugins/README.md
268272
- docs/sdks/embeds/README.md
273+
- docs/sdks/events/README.md
269274
- USAGE.md
270275
- .gitattributes

‎README.md‎

Lines changed: 76 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,33 @@ gem install speakeasy_client_sdk_ruby
1212
### Example
1313

1414
```ruby
15-
require_relative speakeasy_client_sdk_ruby
15+
require 'speakeasy_client_sdk_ruby'
1616

1717

18-
s = ::SpeakeasyClientSDK::SDK.new
18+
s = ::SpeakeasyClientSDK::SDK.new(
19+
workspace_id: "string",
20+
)
1921
s.config_security(
20-
security=::SpeakeasyClientSDK::Shared::Security.new(
21-
api_key="<YOUR_API_KEY_HERE>",
22+
::SpeakeasyClientSDK::Shared::Security.new(
23+
api_key: "<YOUR_API_KEY_HERE>",
2224
)
2325
)
2426

2527

2628
req = ::SpeakeasyClientSDK::Operations::GetApisRequest.new(
27-
metadata={
29+
metadata: {
2830
"South": [
2931
"string",
3032
],
3133
},
32-
op=::SpeakeasyClientSDK::Operations::QueryParamOp.new(
33-
and_=false,
34+
op: ::SpeakeasyClientSDK::Operations::QueryParamOp.new(
35+
and_: false,
3436
),
3537
)
3638

3739
res = s.apis.get_apis(req)
3840

39-
if ! res.classes.nil?
41+
if ! res.apis.nil?
4042
# handle response
4143
end
4244

@@ -46,10 +48,6 @@ end
4648
<!-- Start Available Resources and Operations [operations] -->
4749
## Available Resources and Operations
4850

49-
### [SDK](docs/sdks/sdk/README.md)
50-
51-
* [validate_api_key](docs/sdks/sdk/README.md#validate_api_key) - Validate the current api key.
52-
5351
### [Apis](docs/sdks/apis/README.md)
5452

5553
* [delete_api](docs/sdks/apis/README.md#delete_api) - Delete an Api.
@@ -87,23 +85,25 @@ end
8785
* [get_schemas](docs/sdks/schemas/README.md#get_schemas) - Get information about all schemas associated with a particular apiID.
8886
* [register_schema](docs/sdks/schemas/README.md#register_schema) - Register a schema.
8987

88+
### [Auth](docs/sdks/auth/README.md)
89+
90+
* [validate_api_key](docs/sdks/auth/README.md#validate_api_key) - Validate the current api key.
91+
9092
### [Requests](docs/sdks/requests/README.md)
9193

9294
* [generate_request_postman_collection](docs/sdks/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
9395
* [get_request_from_event_log](docs/sdks/requests/README.md#get_request_from_event_log) - Get information about a particular request.
9496
* [query_event_log](docs/sdks/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.
9597

96-
### [Plugins](docs/sdks/plugins/README.md)
97-
98-
* [get_plugins](docs/sdks/plugins/README.md#get_plugins) - Get all plugins for the current workspace.
99-
* [run_plugin](docs/sdks/plugins/README.md#run_plugin) - Run a plugin
100-
* [upsert_plugin](docs/sdks/plugins/README.md#upsert_plugin) - Upsert a plugin
101-
10298
### [Embeds](docs/sdks/embeds/README.md)
10399

104100
* [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
105101
* [get_valid_embed_access_tokens](docs/sdks/embeds/README.md#get_valid_embed_access_tokens) - Get all valid embed access tokens for the current workspace.
106102
* [revoke_embed_access_token](docs/sdks/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.
103+
104+
### [Events](docs/sdks/events/README.md)
105+
106+
* [post_workspace_events](docs/sdks/events/README.md#post_workspace_events) - Post events for a specific workspace
107107
<!-- End Available Resources and Operations [operations] -->
108108

109109

@@ -128,6 +128,64 @@ You can override the default server globally by passing a server name to the `se
128128
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
129129
<!-- End Server Selection [server] -->
130130

131+
<!-- Start Global Parameters [global-parameters] -->
132+
## Global Parameters
133+
134+
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.
135+
136+
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 `post_workspace_events`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
137+
138+
139+
### Available Globals
140+
141+
The following global parameter is available.
142+
143+
| Name | Type | Required | Description |
144+
| ---- | ---- |:--------:| ----------- |
145+
| workspace_id | ::String | | The workspace_id parameter. |
146+
147+
148+
### Example
149+
150+
```ruby
151+
require 'speakeasy_client_sdk_ruby'
152+
153+
154+
s = ::SpeakeasyClientSDK::SDK.new(
155+
workspace_id: "string",
156+
)
157+
s.config_security(
158+
::SpeakeasyClientSDK::Shared::Security.new(
159+
api_key: "<YOUR_API_KEY_HERE>",
160+
)
161+
)
162+
163+
164+
req = ::SpeakeasyClientSDK::Operations::PostWorkspaceEventsRequest.new(
165+
request_body: [
166+
::SpeakeasyClientSDK::Shared::CliEvent.new(
167+
created_at: DateTime.iso8601('2024-11-21T06:58:42.120Z'),
168+
execution_id: "string",
169+
id: "<ID>",
170+
interaction_type: ::SpeakeasyClientSDK::Shared::InteractionType::CLI_EXEC,
171+
local_started_at: DateTime.iso8601('2024-05-07T12:35:47.182Z'),
172+
speakeasy_api_key_name: "string",
173+
speakeasy_version: "string",
174+
success: false,
175+
workspace_id: "string",
176+
),
177+
],
178+
)
179+
180+
res = s.events.post_workspace_events(req)
181+
182+
if res.status_code == 200
183+
# handle response
184+
end
185+
186+
```
187+
<!-- End Global Parameters [global-parameters] -->
188+
131189
<!-- Placeholder for Future Speakeasy SDK Sections -->
132190

133191

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,4 +548,14 @@ Based on:
548548
### Generated
549549
- [ruby v3.0.0] .
550550
### Releases
551-
- [Ruby Gems v3.0.0] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/3.0.0 - .
551+
- [Ruby Gems v3.0.0] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/3.0.0 - .
552+
553+
## 2024-02-08 00:03:04
554+
### Changes
555+
Based on:
556+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
557+
- Speakeasy CLI 1.173.0 (2.250.16) https://github.com/speakeasy-api/speakeasy
558+
### Generated
559+
- [ruby v4.0.0] .
560+
### Releases
561+
- [Ruby Gems v4.0.0] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.0.0 - .

‎USAGE.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
<!-- Start SDK Example Usage [usage] -->
22
```ruby
3-
require_relative speakeasy_client_sdk_ruby
3+
require 'speakeasy_client_sdk_ruby'
44

55

6-
s = ::SpeakeasyClientSDK::SDK.new
6+
s = ::SpeakeasyClientSDK::SDK.new(
7+
workspace_id: "string",
8+
)
79
s.config_security(
8-
security=::SpeakeasyClientSDK::Shared::Security.new(
9-
api_key="<YOUR_API_KEY_HERE>",
10+
::SpeakeasyClientSDK::Shared::Security.new(
11+
api_key: "<YOUR_API_KEY_HERE>",
1012
)
1113
)
1214

1315

1416
req = ::SpeakeasyClientSDK::Operations::GetApisRequest.new(
15-
metadata={
17+
metadata: {
1618
"South": [
1719
"string",
1820
],
1921
},
20-
op=::SpeakeasyClientSDK::Operations::QueryParamOp.new(
21-
and_=false,
22+
op: ::SpeakeasyClientSDK::Operations::QueryParamOp.new(
23+
and_: false,
2224
),
2325
)
2426

2527
res = s.apis.get_apis(req)
2628

27-
if ! res.classes.nil?
29+
if ! res.apis.nil?
2830
# handle response
2931
end
3032

‎docs/models/operations/getallapiendpointsresponse.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
| Field | Type | Required | Description |
77
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
8+
| `api_endpoints` | T::Array<[::SpeakeasyClientSDK::Shared::ApiEndpoint](../../models/shared/apiendpoint.md)> | :heavy_minus_sign: | OK |
89
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
910
| `error` | [T.nilable(::SpeakeasyClientSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
1011
| `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-
| `classes` | T::Array<[::SpeakeasyClientSDK::Shared::ApiEndpoint](../../models/shared/apiendpoint.md)> | :heavy_minus_sign: | OK |
12+
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

0 commit comments

Comments
 (0)