Skip to content

Commit d6c5997

Browse files
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.424.0
1 parent 644c15f commit d6c5997

File tree

103 files changed

+1486
-271
lines changed

Some content is hidden

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

103 files changed

+1486
-271
lines changed

.speakeasy/gen.lock

+75-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: ee307ad3-8dfc-4d06-9c04-86e7d437810d
33
management:
4-
docChecksum: cf89a4fde0fbc1524296a333f75ea848
5-
docVersion: 0.4.0 .
6-
speakeasyVersion: 1.405.8
7-
generationVersion: 2.429.0
8-
releaseVersion: 4.2.24
9-
configChecksum: b44c4c6d10fc1cef416d8c5bd31c898a
4+
docChecksum: b2873be85397668bb69843763effd9b6
5+
docVersion: 0.4.0
6+
speakeasyVersion: 1.424.0
7+
generationVersion: 2.445.1
8+
releaseVersion: 4.2.25
9+
configChecksum: 11c18eddf633e1de5ddaba3f9e55e9c7
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby.git
1111
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby
1212
published: true
@@ -35,8 +35,11 @@ generatedFiles:
3535
- docs/models/operations/checkgithubaccessresponse.md
3636
- docs/models/operations/createfreetrialresponse.md
3737
- docs/models/operations/createorganizationresponse.md
38+
- docs/models/operations/createremotesourceresponse.md
3839
- docs/models/operations/createrequestbody.md
3940
- docs/models/operations/createresponse.md
41+
- docs/models/operations/createsubscriptionrequest.md
42+
- docs/models/operations/createsubscriptionresponse.md
4043
- docs/models/operations/createworkspaceresponse.md
4144
- docs/models/operations/createworkspacetokenrequest.md
4245
- docs/models/operations/createworkspacetokenresponse.md
@@ -149,6 +152,10 @@ generatedFiles:
149152
- docs/models/operations/grantuseraccesstoworkspaceresponse.md
150153
- docs/models/operations/insertversionmetadatarequest.md
151154
- docs/models/operations/insertversionmetadataresponse.md
155+
- docs/models/operations/listregistrysubscriptionsrequest.md
156+
- docs/models/operations/listregistrysubscriptionsresponse.md
157+
- docs/models/operations/listremotesourcesrequest.md
158+
- docs/models/operations/listremotesourcesresponse.md
152159
- docs/models/operations/op.md
153160
- docs/models/operations/posttagsrequest.md
154161
- docs/models/operations/posttagsresponse.md
@@ -168,6 +175,7 @@ generatedFiles:
168175
- docs/models/operations/schema.md
169176
- docs/models/operations/searchworkspaceeventsrequest.md
170177
- docs/models/operations/searchworkspaceeventsresponse.md
178+
- docs/models/operations/suggestitemsresponse.md
171179
- docs/models/operations/suggestopenapiregistryrequest.md
172180
- docs/models/operations/suggestopenapiregistryresponse.md
173181
- docs/models/operations/suggestopenapirequest.md
@@ -207,6 +215,7 @@ generatedFiles:
207215
- docs/models/shared/embedaccesstokenresponse.md
208216
- docs/models/shared/embedtoken.md
209217
- docs/models/shared/error.md
218+
- docs/models/shared/eventtype.md
210219
- docs/models/shared/featureflag.md
211220
- docs/models/shared/filter.md
212221
- docs/models/shared/filters.md
@@ -238,7 +247,10 @@ generatedFiles:
238247
- docs/models/shared/organizationusageresponse.md
239248
- docs/models/shared/preflightrequest.md
240249
- docs/models/shared/preflighttoken.md
250+
- docs/models/shared/registrysubscription.md
241251
- docs/models/shared/relationship.md
252+
- docs/models/shared/remotedocument.md
253+
- docs/models/shared/remotesource.md
242254
- docs/models/shared/report.md
243255
- docs/models/shared/requestmetadata.md
244256
- docs/models/shared/revision.md
@@ -247,7 +259,9 @@ generatedFiles:
247259
- docs/models/shared/security.md
248260
- docs/models/shared/shorturl.md
249261
- docs/models/shared/ssometadata.md
262+
- docs/models/shared/subscriptiontype.md
250263
- docs/models/shared/suggestiontype.md
264+
- docs/models/shared/suggestitemsrequestbody.md
251265
- docs/models/shared/suggestoptsold.md
252266
- docs/models/shared/suggestrequestbody.md
253267
- docs/models/shared/suggestrequestbodysuggestiontype.md
@@ -284,6 +298,7 @@ generatedFiles:
284298
- docs/sdks/shorturls/README.md
285299
- docs/sdks/speakeasyclientsdk/README.md
286300
- docs/sdks/speakeasyclientsdkapiendpoints/README.md
301+
- docs/sdks/subscriptions/README.md
287302
- docs/sdks/suggest/README.md
288303
- docs/sdks/workspaces/README.md
289304
- lib/open_api_sdk/apiendpoints.rb
@@ -301,6 +316,9 @@ generatedFiles:
301316
- lib/open_api_sdk/models/operations/create_response.rb
302317
- lib/open_api_sdk/models/operations/createfreetrial_response.rb
303318
- lib/open_api_sdk/models/operations/createorganization_response.rb
319+
- lib/open_api_sdk/models/operations/createremotesource_response.rb
320+
- lib/open_api_sdk/models/operations/createsubscription_request.rb
321+
- lib/open_api_sdk/models/operations/createsubscription_response.rb
304322
- lib/open_api_sdk/models/operations/createworkspace_response.rb
305323
- lib/open_api_sdk/models/operations/createworkspacetoken_request.rb
306324
- lib/open_api_sdk/models/operations/createworkspacetoken_response.rb
@@ -413,6 +431,10 @@ generatedFiles:
413431
- lib/open_api_sdk/models/operations/grantuseraccesstoworkspace_response.rb
414432
- lib/open_api_sdk/models/operations/insertversionmetadata_request.rb
415433
- lib/open_api_sdk/models/operations/insertversionmetadata_response.rb
434+
- lib/open_api_sdk/models/operations/listregistrysubscriptions_request.rb
435+
- lib/open_api_sdk/models/operations/listregistrysubscriptions_response.rb
436+
- lib/open_api_sdk/models/operations/listremotesources_request.rb
437+
- lib/open_api_sdk/models/operations/listremotesources_response.rb
416438
- lib/open_api_sdk/models/operations/op.rb
417439
- lib/open_api_sdk/models/operations/posttags_request.rb
418440
- lib/open_api_sdk/models/operations/posttags_response.rb
@@ -434,6 +456,7 @@ generatedFiles:
434456
- lib/open_api_sdk/models/operations/searchworkspaceevents_response.rb
435457
- lib/open_api_sdk/models/operations/suggest_request.rb
436458
- lib/open_api_sdk/models/operations/suggest_response.rb
459+
- lib/open_api_sdk/models/operations/suggestitems_response.rb
437460
- lib/open_api_sdk/models/operations/suggestopenapi_request.rb
438461
- lib/open_api_sdk/models/operations/suggestopenapi_requestbody.rb
439462
- lib/open_api_sdk/models/operations/suggestopenapi_response.rb
@@ -472,6 +495,7 @@ generatedFiles:
472495
- lib/open_api_sdk/models/shared/embedaccesstokenresponse.rb
473496
- lib/open_api_sdk/models/shared/embedtoken.rb
474497
- lib/open_api_sdk/models/shared/error.rb
498+
- lib/open_api_sdk/models/shared/eventtype.rb
475499
- lib/open_api_sdk/models/shared/featureflag.rb
476500
- lib/open_api_sdk/models/shared/filter.rb
477501
- lib/open_api_sdk/models/shared/filters.rb
@@ -503,7 +527,10 @@ generatedFiles:
503527
- lib/open_api_sdk/models/shared/organizationusageresponse.rb
504528
- lib/open_api_sdk/models/shared/preflightrequest.rb
505529
- lib/open_api_sdk/models/shared/preflighttoken.rb
530+
- lib/open_api_sdk/models/shared/registrysubscription.rb
506531
- lib/open_api_sdk/models/shared/relationship.rb
532+
- lib/open_api_sdk/models/shared/remotedocument.rb
533+
- lib/open_api_sdk/models/shared/remotesource.rb
507534
- lib/open_api_sdk/models/shared/report.rb
508535
- lib/open_api_sdk/models/shared/requestmetadata.rb
509536
- lib/open_api_sdk/models/shared/revision.rb
@@ -512,7 +539,9 @@ generatedFiles:
512539
- lib/open_api_sdk/models/shared/security.rb
513540
- lib/open_api_sdk/models/shared/shorturl.rb
514541
- lib/open_api_sdk/models/shared/ssometadata.rb
542+
- lib/open_api_sdk/models/shared/subscriptiontype.rb
515543
- lib/open_api_sdk/models/shared/suggestion_type.rb
544+
- lib/open_api_sdk/models/shared/suggestitemsrequestbody.rb
516545
- lib/open_api_sdk/models/shared/suggestoptsold.rb
517546
- lib/open_api_sdk/models/shared/suggestrequestbody.rb
518547
- lib/open_api_sdk/models/shared/suggestrequestbody_suggestion_type.rb
@@ -542,6 +571,7 @@ generatedFiles:
542571
- lib/open_api_sdk/shorturls.rb
543572
- lib/open_api_sdk/speakeasyclientsdk.rb
544573
- lib/open_api_sdk/speakeasyclientsdk_apiendpoints.rb
574+
- lib/open_api_sdk/subscriptions.rb
545575
- lib/open_api_sdk/suggest.rb
546576
- lib/open_api_sdk/utils/metadata_fields.rb
547577
- lib/open_api_sdk/utils/t.rb
@@ -876,7 +906,7 @@ examples:
876906
speakeasy-default-validate-api-key:
877907
responses:
878908
2XX:
879-
application/json: {"workspace_id": "<id>", "workspace_slug": "<value>", "org_slug": "<value>", "account_type_v2": "enterprise", "enabled_features": ["<value>", "<value>", "<value>"], "telemetry_disabled": true}
909+
application/json: {"workspace_id": "<id>", "workspace_slug": "<value>", "org_slug": "<value>", "account_type_v2": "enterprise", "enabled_features": ["<value>", "<value>", "<value>"], "telemetry_disabled": true, "workspace_created_at": "2024-04-24T00:30:38.626Z"}
880910
4XX:
881911
application/json: {"message": "<value>", "status_code": 365836}
882912
getUser:
@@ -1114,7 +1144,7 @@ examples:
11141144
workspace_id: "<id>"
11151145
responses:
11161146
2XX:
1117-
application/json: {"workspace_id": "<id>"}
1147+
application/json: {"workspace_id": "<id>", "webhook_url": "https://ideal-hospitalization.biz", "created_at": "2022-02-07T14:50:24.533Z", "updated_at": "2022-01-26T01:43:28.591Z"}
11181148
4XX:
11191149
application/json: {"message": "<value>", "status_code": 802866}
11201150
updateWorkspaceSettings:
@@ -1123,7 +1153,7 @@ examples:
11231153
path:
11241154
workspace_id: "<id>"
11251155
requestBody:
1126-
application/json: {"workspace_id": "<id>"}
1156+
application/json: {"workspace_id": "<id>", "webhook_url": "https://last-suspension.info/", "created_at": "2023-12-29T06:46:35.807Z", "updated_at": "2024-02-04T10:37:56.725Z"}
11271157
responses:
11281158
4XX:
11291159
application/json: {"message": "<value>", "status_code": 169241}
@@ -1164,7 +1194,7 @@ examples:
11641194
workspace_id: "<id>"
11651195
responses:
11661196
2XX:
1167-
application/json: [{"id": "<id>", "name": "<value>", "alg": "<value>", "key": "<key>", "created_at": "<value>"}, {"id": "<id>", "name": "<value>", "alg": "<value>", "key": "<key>", "created_at": "<value>"}, {"id": "<id>", "name": "<value>", "alg": "<value>", "key": "<key>", "created_at": "<value>"}]
1197+
application/json: [{"id": "<id>", "name": "<value>", "workspace_id": "<id>", "alg": "<value>", "key": "<key>", "created_at": "<value>"}, {"id": "<id>", "name": "<value>", "workspace_id": "<id>", "alg": "<value>", "key": "<key>", "created_at": "<value>"}, {"id": "<id>", "name": "<value>", "workspace_id": "<id>", "alg": "<value>", "key": "<key>", "created_at": "<value>"}]
11681198
4XX:
11691199
application/json: {"message": "<value>", "status_code": 498293}
11701200
createWorkspaceToken:
@@ -1173,7 +1203,7 @@ examples:
11731203
path:
11741204
workspace_id: "<id>"
11751205
requestBody:
1176-
application/json: {"id": "<id>", "name": "<value>", "alg": "<value>", "key": "<key>", "created_at": "<value>"}
1206+
application/json: {"id": "<id>", "name": "<value>", "workspace_id": "<id>", "alg": "<value>", "key": "<key>", "created_at": "<value>"}
11771207
responses:
11781208
4XX:
11791209
application/json: {"message": "<value>", "status_code": 207213}
@@ -1375,3 +1405,37 @@ examples:
13751405
responses:
13761406
2XX:
13771407
application/json: {"short_url": "https://standard-utilization.com/", "full_url": "https://brisk-seafood.net/"}
1408+
suggestItems:
1409+
speakeasy-default-suggest-items:
1410+
requestBody:
1411+
application/json: {"prompt": "<value>", "items": []}
1412+
responses:
1413+
2XX:
1414+
application/json: ["<value>", "<value>"]
1415+
listRemoteSources:
1416+
speakeasy-default-list-remote-sources:
1417+
parameters:
1418+
query:
1419+
namespace_name: "<value>"
1420+
responses:
1421+
2XX:
1422+
application/json: {"inputs": [{"registry_url": "https://well-lit-cap.net"}, {"registry_url": "https://vibrant-labourer.net"}], "output": {"registry_url": "https://unfit-minor.biz"}}
1423+
4XX:
1424+
application/json: {"message": "<value>", "status_code": 754391}
1425+
createRemoteSource:
1426+
speakeasy-default-create-remote-source:
1427+
responses:
1428+
4XX:
1429+
application/json: {"message": "<value>", "status_code": 580557}
1430+
listRegistrySubscriptions:
1431+
speakeasy-default-list-registry-subscriptions:
1432+
responses:
1433+
"200":
1434+
application/json: [{"id": "<id>", "workspace_id": "<id>", "event_type": "update", "namespace_name": "<value>", "subscription_type": "cli", "subscription_settings": "<value>", "created_at": "2022-12-26T20:06:41.993Z", "updated_at": "2023-10-12T18:58:27.338Z"}, {"id": "<id>", "workspace_id": "<id>", "event_type": "update", "namespace_name": "<value>", "subscription_type": "cli", "subscription_settings": "<value>", "created_at": "2022-07-07T11:51:20.859Z", "updated_at": "2022-03-26T04:16:26.649Z"}]
1435+
createSubscription:
1436+
speakeasy-default-create-subscription:
1437+
requestBody:
1438+
application/json: {"id": "<id>", "workspace_id": "<id>", "event_type": "update", "namespace_name": "<value>", "subscription_type": "cli", "subscription_settings": "<value>", "created_at": "2022-06-08T17:58:57.702Z", "updated_at": "2022-07-20T08:51:35.776Z"}
1439+
responses:
1440+
"200":
1441+
application/json: {"id": "<id>", "workspace_id": "<id>", "event_type": "update", "namespace_name": "<value>", "subscription_type": "cli", "subscription_settings": "<value>", "created_at": "2022-03-27T15:41:56.125Z", "updated_at": "2023-07-24T03:56:06.003Z"}

.speakeasy/gen.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ generation:
1212
auth:
1313
oAuth2ClientCredentialsEnabled: true
1414
ruby:
15-
version: 4.2.24
15+
version: 4.2.25
1616
author: Speakeasy
1717
description: Ruby Client SDK Generated by Speakeasy
1818
imports:

.speakeasy/workflow.lock

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
speakeasyVersion: 1.405.8
1+
speakeasyVersion: 1.424.0
22
sources: {}
33
targets:
44
speakeasy-client-sdk:
@@ -21,3 +21,7 @@ workflow:
2121
publish:
2222
rubygems:
2323
token: $rubygems_auth_token
24+
codeSamples:
25+
registry:
26+
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/-oas-code-samples
27+
blocking: false

.speakeasy/workflow.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@ targets:
1515
publish:
1616
rubygems:
1717
token: $rubygems_auth_token
18+
codeSamples:
19+
registry:
20+
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/-oas-code-samples
21+
blocking: false

README.md

+45-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Developer-friendly & type-safe Ruby SDK specifically catered to leverage *speake
1717
<!-- Start Summary [summary] -->
1818
## Summary
1919

20-
Speakeasy API: The Speakeasy API allows teams to manage common operations with their APIs
20+
Speakeasy API: The Subscriptions API manages subscriptions for CLI and registry events
2121

2222
For more information about the API: [The Speakeasy Platform Documentation](/docs)
2323
<!-- End Summary [summary] -->
@@ -28,6 +28,7 @@ For more information about the API: [The Speakeasy Platform Documentation](/docs
2828
* [SDK Installation](#sdk-installation)
2929
* [SDK Example Usage](#sdk-example-usage)
3030
* [Available Resources and Operations](#available-resources-and-operations)
31+
* [Global Parameters](#global-parameters)
3132
* [Server Selection](#server-selection)
3233
<!-- End Table of Contents [toc] -->
3334

@@ -99,6 +100,8 @@ end
99100
* [get_revisions](docs/sdks/artifacts/README.md#get_revisions)
100101
* [get_tags](docs/sdks/artifacts/README.md#get_tags)
101102
* [post_tags](docs/sdks/artifacts/README.md#post_tags) - Add tags to an existing revision
103+
* [list_remote_sources](docs/sdks/artifacts/README.md#list_remote_sources) - Get remote sources attached to a particular namespace
104+
* [create_remote_source](docs/sdks/artifacts/README.md#create_remote_source) - Configure a new remote source
102105
* [get_manifest](docs/sdks/artifacts/README.md#get_manifest) - Get manifest for a particular reference
103106
* [get_blob](docs/sdks/artifacts/README.md#get_blob) - Get blob for a particular digest
104107

@@ -187,10 +190,16 @@ end
187190
* [generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint.
188191
* [generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint.
189192

193+
### [Subscriptions](docs/sdks/subscriptions/README.md)
194+
195+
* [list_registry_subscriptions](docs/sdks/subscriptions/README.md#list_registry_subscriptions) - List Subscriptions
196+
* [create_subscription](docs/sdks/subscriptions/README.md#create_subscription) - Create Subscription
197+
190198
### [Suggest](docs/sdks/suggest/README.md)
191199

192200
* [openapi](docs/sdks/suggest/README.md#openapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
193201
* [generate](docs/sdks/suggest/README.md#generate) - Generate suggestions for improving an OpenAPI document.
202+
* [suggest_items](docs/sdks/suggest/README.md#suggest_items) - Generate generic suggestions for a list of items.
194203
* [openapi_registry](docs/sdks/suggest/README.md#openapi_registry) - Generate suggestions for improving an OpenAPI document stored in the registry.
195204

196205
### [Workspaces](docs/sdks/workspaces/README.md)
@@ -213,6 +222,41 @@ end
213222
</details>
214223
<!-- End Available Resources and Operations [operations] -->
215224

225+
<!-- Start Global Parameters [global-parameters] -->
226+
## Global Parameters
227+
228+
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.
229+
230+
For example, you can set `workspace_id` to `"<id>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_access_token`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
231+
232+
233+
### Available Globals
234+
235+
The following global parameter is available.
236+
237+
| Name | Type | Required | Description |
238+
| ---- | ---- |:--------:| ----------- |
239+
| workspace_id | ::String | | The workspace_id parameter. |
240+
241+
242+
### Example
243+
244+
```ruby
245+
require 'speakeasy_client_sdk_ruby'
246+
247+
248+
s = ::OpenApiSDK::SpeakeasyClientSDK.new
249+
250+
251+
res = s.auth.get_access_token(workspace_id="<id>")
252+
253+
if ! res.access_token.nil?
254+
# handle response
255+
end
256+
257+
```
258+
<!-- End Global Parameters [global-parameters] -->
259+
216260
<!-- Start Server Selection [server] -->
217261
## Server Selection
218262

RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,14 @@ Based on:
3434
### Generated
3535
- [ruby v4.2.24] .
3636
### Releases
37-
- [Ruby Gems v4.2.24] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.24 - .
37+
- [Ruby Gems v4.2.24] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.24 - .
38+
39+
## 2024-11-04 00:13:18
40+
### Changes
41+
Based on:
42+
- OpenAPI Doc
43+
- Speakeasy CLI 1.424.0 (2.445.1) https://github.com/speakeasy-api/speakeasy
44+
### Generated
45+
- [ruby v4.2.25] .
46+
### Releases
47+
- [Ruby Gems v4.2.25] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.25 - .

0 commit comments

Comments
 (0)