Skip to content

Commit 6b6e860

Browse files
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.448.0
1 parent 644c15f commit 6b6e860

File tree

156 files changed

+3096
-313
lines changed

Some content is hidden

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

156 files changed

+3096
-313
lines changed

.speakeasy/gen.lock

+174-12
Large diffs are not rendered by default.

.speakeasy/gen.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ generation:
1111
requestResponseComponentNamesFeb2024: true
1212
auth:
1313
oAuth2ClientCredentialsEnabled: true
14+
oAuth2PasswordEnabled: false
1415
ruby:
15-
version: 4.2.24
16+
version: 4.3.0
1617
author: Speakeasy
1718
description: Ruby Client SDK Generated by Speakeasy
1819
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.448.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-ruby-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-ruby-code-samples
21+
blocking: false

README.md

+143-31
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

@@ -79,11 +80,21 @@ end
7980
<details open>
8081
<summary>Available methods</summary>
8182

82-
### [Apiendpoints](docs/sdks/apiendpoints/README.md)
83+
### [api_endpoints](docs/sdks/speakeasyclientsdkapiendpoints/README.md)
84+
85+
* [get_all](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get_all) - Get all ApiEndpoints for a particular apiID and versionID.
86+
* [find](docs/sdks/speakeasyclientsdkapiendpoints/README.md#find) - Find an ApiEndpoint via its displayName.
87+
* [delete](docs/sdks/speakeasyclientsdkapiendpoints/README.md#delete) - Delete an ApiEndpoint.
88+
* [get](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get) - Get an ApiEndpoint.
89+
* [upsert](docs/sdks/speakeasyclientsdkapiendpoints/README.md#upsert) - Upsert an ApiEndpoint.
90+
* [generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint.
91+
* [generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint.
92+
93+
### [apiendpoints](docs/sdks/apiendpoints/README.md)
8394

8495
* [list](docs/sdks/apiendpoints/README.md#list) - Get all Api endpoints for a particular apiID.
8596

86-
### [Apis](docs/sdks/apis/README.md)
97+
### [apis](docs/sdks/apis/README.md)
8798

8899
* [get_all](docs/sdks/apis/README.md#get_all) - Get a list of Apis for a given workspace
89100
* [get_all_versions](docs/sdks/apis/README.md#get_all_versions) - Get all Api versions for a particular ApiEndpoint.
@@ -92,40 +103,45 @@ end
92103
* [generate_open_api](docs/sdks/apis/README.md#generate_open_api) - Generate an OpenAPI specification for a particular Api.
93104
* [generate_postman](docs/sdks/apis/README.md#generate_postman) - Generate a Postman collection for a particular Api.
94105

95-
### [Artifacts](docs/sdks/artifacts/README.md)
106+
### [artifacts](docs/sdks/artifacts/README.md)
96107

97108
* [preflight](docs/sdks/artifacts/README.md#preflight) - Get access token for communicating with OCI distribution endpoints
98109
* [get_namespaces](docs/sdks/artifacts/README.md#get_namespaces) - Each namespace contains many revisions.
99110
* [get_revisions](docs/sdks/artifacts/README.md#get_revisions)
100111
* [get_tags](docs/sdks/artifacts/README.md#get_tags)
101112
* [post_tags](docs/sdks/artifacts/README.md#post_tags) - Add tags to an existing revision
113+
* [set_visibility](docs/sdks/artifacts/README.md#set_visibility) - Set visibility of a namespace with an existing metadata entry
114+
* [list_remote_sources](docs/sdks/artifacts/README.md#list_remote_sources) - Get remote sources attached to a particular namespace
115+
* [create_remote_source](docs/sdks/artifacts/README.md#create_remote_source) - Configure a new remote source
102116
* [get_manifest](docs/sdks/artifacts/README.md#get_manifest) - Get manifest for a particular reference
103117
* [get_blob](docs/sdks/artifacts/README.md#get_blob) - Get blob for a particular digest
104118

105-
### [Auth](docs/sdks/auth/README.md)
119+
### [auth](docs/sdks/auth/README.md)
106120

107121
* [validate_api_key](docs/sdks/auth/README.md#validate_api_key) - Validate the current api key.
108122
* [get_user](docs/sdks/auth/README.md#get_user) - Get information about the current user.
109123
* [get_access_token](docs/sdks/auth/README.md#get_access_token) - Get or refresh an access token for the current workspace.
110124
* [get_allowances](docs/sdks/auth/README.md#get_allowances) - Get access allowances for a particular workspace
111125

112-
### [Embeds](docs/sdks/embeds/README.md)
126+
### [embeds](docs/sdks/embeds/README.md)
113127

114128
* [get_access_token](docs/sdks/embeds/README.md#get_access_token) - Get an embed access token for the current workspace.
115129
* [get_valid](docs/sdks/embeds/README.md#get_valid) - Get all valid embed access tokens for the current workspace.
116130
* [delete](docs/sdks/embeds/README.md#delete) - Revoke an embed access EmbedToken.
117131

118-
### [Events](docs/sdks/events/README.md)
132+
### [events](docs/sdks/events/README.md)
119133

120134
* [search](docs/sdks/events/README.md#search) - Search events for a particular workspace by any field
121135
* [post](docs/sdks/events/README.md#post) - Post events for a specific workspace
122136
* [get_by_target](docs/sdks/events/README.md#get_by_target) - Load recent events for a particular workspace
123137
* [get_targets](docs/sdks/events/README.md#get_targets) - Load targets for a particular workspace
124138
* [get_targets_deprecated](docs/sdks/events/README.md#get_targets_deprecated) - Load targets for a particular workspace
125139

126-
### [Github](docs/sdks/github/README.md)
140+
### [github](docs/sdks/github/README.md)
127141

142+
* [get_setup](docs/sdks/github/README.md#get_setup)
128143
* [check_access](docs/sdks/github/README.md#check_access)
144+
* [link_github](docs/sdks/github/README.md#link_github)
129145
* [check_publishing_p_rs](docs/sdks/github/README.md#check_publishing_p_rs)
130146
* [check_publishing_secrets](docs/sdks/github/README.md#check_publishing_secrets)
131147
* [store_publishing_secrets](docs/sdks/github/README.md#store_publishing_secrets)
@@ -135,33 +151,33 @@ end
135151
* [trigger_action](docs/sdks/github/README.md#trigger_action)
136152
* [get_action](docs/sdks/github/README.md#get_action)
137153

138-
### [Metadata](docs/sdks/metadata/README.md)
154+
### [metadata](docs/sdks/metadata/README.md)
139155

140156
* [get](docs/sdks/metadata/README.md#get) - Get all metadata for a particular apiID and versionID.
141157
* [insert_version](docs/sdks/metadata/README.md#insert_version) - Insert metadata for a particular apiID and versionID.
142158
* [delete_version](docs/sdks/metadata/README.md#delete_version) - Delete metadata for a particular apiID and versionID.
143159

144-
### [Organizations](docs/sdks/organizations/README.md)
160+
### [organizations](docs/sdks/organizations/README.md)
145161

146162
* [get_all](docs/sdks/organizations/README.md#get_all) - Get organizations for a user
147163
* [create](docs/sdks/organizations/README.md#create) - Create an organization
148164
* [get](docs/sdks/organizations/README.md#get) - Get organization
149165
* [create_free_trial](docs/sdks/organizations/README.md#create_free_trial) - Create a free trial for an organization
150166
* [get_usage](docs/sdks/organizations/README.md#get_usage) - Get billing usage summary for a particular organization
151167

152-
### [Reports](docs/sdks/reports/README.md)
168+
### [reports](docs/sdks/reports/README.md)
153169

154170
* [upload](docs/sdks/reports/README.md#upload) - Upload a report.
155171
* [get_signed_url](docs/sdks/reports/README.md#get_signed_url) - Get the signed access url for the linting reports for a particular document.
156172
* [get_changes_signed_url](docs/sdks/reports/README.md#get_changes_signed_url) - Get the signed access url for the change reports for a particular document.
157173

158-
### [Requests](docs/sdks/requests/README.md)
174+
### [requests](docs/sdks/requests/README.md)
159175

160176
* [query](docs/sdks/requests/README.md#query) - Query the event log to retrieve a list of requests.
161177
* [get](docs/sdks/requests/README.md#get) - Get information about a particular request.
162178
* [generate_postman_collection](docs/sdks/requests/README.md#generate_postman_collection) - Generate a Postman collection for a particular request.
163179

164-
### [Schemas](docs/sdks/schemas/README.md)
180+
### [schemas](docs/sdks/schemas/README.md)
165181

166182
* [get_latest](docs/sdks/schemas/README.md#get_latest) - Get information about the latest schema.
167183
* [post](docs/sdks/schemas/README.md#post) - Register a schema.
@@ -172,28 +188,29 @@ end
172188
* [download_revision](docs/sdks/schemas/README.md#download_revision) - Download a particular schema revision for an Api.
173189
* [get](docs/sdks/schemas/README.md#get) - Get information about all schemas associated with a particular apiID.
174190

175-
### [ShortURLs](docs/sdks/shorturls/README.md)
191+
### [short_ur_ls](docs/sdks/shorturls/README.md)
176192

177193
* [create](docs/sdks/shorturls/README.md#create) - Shorten a URL.
178194

195+
### [SpeakeasyClientSDK](docs/sdks/speakeasyclientsdk/README.md)
179196

180-
### [SpeakeasyClientSDKApiEndpoints](docs/sdks/speakeasyclientsdkapiendpoints/README.md)
197+
* [generate_code_sample_preview](docs/sdks/speakeasyclientsdk/README.md#generate_code_sample_preview) - Generate Code Sample previews from a file and configuration parameters.
198+
* [generate_code_sample_preview_async](docs/sdks/speakeasyclientsdk/README.md#generate_code_sample_preview_async) - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling.
199+
* [get_code_sample_preview_async](docs/sdks/speakeasyclientsdk/README.md#get_code_sample_preview_async) - Poll for the result of an asynchronous Code Sample preview generation.
181200

182-
* [get_all](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get_all) - Get all ApiEndpoints for a particular apiID and versionID.
183-
* [find](docs/sdks/speakeasyclientsdkapiendpoints/README.md#find) - Find an ApiEndpoint via its displayName.
184-
* [delete](docs/sdks/speakeasyclientsdkapiendpoints/README.md#delete) - Delete an ApiEndpoint.
185-
* [get](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get) - Get an ApiEndpoint.
186-
* [upsert](docs/sdks/speakeasyclientsdkapiendpoints/README.md#upsert) - Upsert an ApiEndpoint.
187-
* [generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint.
188-
* [generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint.
201+
### [subscriptions](docs/sdks/subscriptions/README.md)
189202

190-
### [Suggest](docs/sdks/suggest/README.md)
203+
* [list_registry_subscriptions](docs/sdks/subscriptions/README.md#list_registry_subscriptions) - List Subscriptions
204+
* [create_subscription](docs/sdks/subscriptions/README.md#create_subscription) - Create Subscription
205+
206+
### [suggest](docs/sdks/suggest/README.md)
191207

192208
* [openapi](docs/sdks/suggest/README.md#openapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
193209
* [generate](docs/sdks/suggest/README.md#generate) - Generate suggestions for improving an OpenAPI document.
210+
* [suggest_items](docs/sdks/suggest/README.md#suggest_items) - Generate generic suggestions for a list of items.
194211
* [openapi_registry](docs/sdks/suggest/README.md#openapi_registry) - Generate suggestions for improving an OpenAPI document stored in the registry.
195212

196-
### [Workspaces](docs/sdks/workspaces/README.md)
213+
### [workspaces](docs/sdks/workspaces/README.md)
197214

198215
* [get_all](docs/sdks/workspaces/README.md#get_all) - Get workspaces for a user
199216
* [get](docs/sdks/workspaces/README.md#get) - Get workspace by context
@@ -213,24 +230,119 @@ end
213230
</details>
214231
<!-- End Available Resources and Operations [operations] -->
215232

216-
<!-- Start Server Selection [server] -->
217-
## Server Selection
233+
<!-- Start Global Parameters [global-parameters] -->
234+
## Global Parameters
235+
236+
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.
237+
238+
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.
218239

240+
241+
### Available Globals
242+
243+
The following global parameter is available.
244+
245+
| Name | Type | Description |
246+
| ------------ | -------- | --------------------------- |
247+
| workspace_id | ::String | The workspace_id parameter. |
248+
249+
### Example
250+
251+
```ruby
252+
require 'speakeasy_client_sdk_ruby'
253+
254+
255+
s = ::OpenApiSDK::SpeakeasyClientSDK.new
256+
257+
258+
res = s.auth.get_access_token(workspace_id="<id>")
259+
260+
if ! res.access_token.nil?
261+
# handle response
262+
end
263+
264+
```
265+
<!-- End Global Parameters [global-parameters] -->
266+
267+
<!-- Start Server Selection [server] -->
219268
## Server Selection
220269

221270
### Select Server by Name
222271

223-
You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
272+
You can override the default server globally by passing a server name to the `server (Symbol)` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
224273

225-
| Name | Server | Variables |
226-
| ----- | ------ | --------- |
227-
| `prod` | `https://api.prod.speakeasyapi.dev` | None |
274+
| Name | Server |
275+
| ------ | ----------------------------------- |
276+
| `prod` | `https://api.prod.speakeasyapi.dev` |
228277

278+
#### Example
229279

280+
```ruby
281+
require 'speakeasy_client_sdk_ruby'
282+
283+
284+
s = ::OpenApiSDK::SpeakeasyClientSDK.new(
285+
server: "prod",
286+
)
287+
s.config_security(
288+
::OpenApiSDK::Shared::Security.new(
289+
api_key: "<YOUR_API_KEY_HERE>",
290+
)
291+
)
292+
293+
294+
req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new(
295+
languages: [
296+
"<value>",
297+
],
298+
schema_file: ::OpenApiSDK::Shared::SchemaFile.new(
299+
file_name: "example.file",
300+
content: "0xc3dD8BfBef".encode(),
301+
),
302+
)
303+
304+
res = s.generate_code_sample_preview(req)
305+
306+
if ! res.two_hundred_application_x_yaml_bytes.nil?
307+
# handle response
308+
end
309+
310+
```
230311

231312
### Override Server URL Per-Client
232313

233-
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:
314+
The default server can also be overridden globally by passing a URL to the `server_url (String)` optional parameter when initializing the SDK client instance. For example:
315+
```ruby
316+
require 'speakeasy_client_sdk_ruby'
317+
318+
319+
s = ::OpenApiSDK::SpeakeasyClientSDK.new(
320+
server_url: "https://api.prod.speakeasyapi.dev",
321+
)
322+
s.config_security(
323+
::OpenApiSDK::Shared::Security.new(
324+
api_key: "<YOUR_API_KEY_HERE>",
325+
)
326+
)
327+
328+
329+
req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new(
330+
languages: [
331+
"<value>",
332+
],
333+
schema_file: ::OpenApiSDK::Shared::SchemaFile.new(
334+
file_name: "example.file",
335+
content: "0xc3dD8BfBef".encode(),
336+
),
337+
)
338+
339+
res = s.generate_code_sample_preview(req)
340+
341+
if ! res.two_hundred_application_x_yaml_bytes.nil?
342+
# handle response
343+
end
344+
345+
```
234346
<!-- End Server Selection [server] -->
235347

236348
<!-- Placeholder for Future Speakeasy SDK Sections -->

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-27 00:13:23
40+
### Changes
41+
Based on:
42+
- OpenAPI Doc
43+
- Speakeasy CLI 1.448.0 (2.466.0) https://github.com/speakeasy-api/speakeasy
44+
### Generated
45+
- [ruby v4.3.0] .
46+
### Releases
47+
- [Ruby Gems v4.3.0] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.3.0 - .
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CreateRemoteSourceResponse
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+
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
10+
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11+
| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |

0 commit comments

Comments
 (0)