Skip to content

Commit 0ddaf51

Browse files
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.448.2
1 parent 644c15f commit 0ddaf51

File tree

167 files changed

+3219
-336
lines changed

Some content is hidden

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

167 files changed

+3219
-336
lines changed

.speakeasy/gen.lock

+180-18
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.2
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

+152-35
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,24 @@ 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] -->
2424

2525
<!-- Start Table of Contents [toc] -->
2626
## Table of Contents
27+
<!-- $toc-max-depth=2 -->
28+
* [speakeasy_client_sdk_ruby](#speakeasyclientsdkruby)
29+
* [SDK Installation](#sdk-installation)
30+
* [SDK Example Usage](#sdk-example-usage)
31+
* [Available Resources and Operations](#available-resources-and-operations)
32+
* [Global Parameters](#global-parameters)
33+
* [Server Selection](#server-selection)
34+
* [Development](#development)
35+
* [Maturity](#maturity)
36+
* [Contributions](#contributions)
2737

28-
* [SDK Installation](#sdk-installation)
29-
* [SDK Example Usage](#sdk-example-usage)
30-
* [Available Resources and Operations](#available-resources-and-operations)
31-
* [Server Selection](#server-selection)
3238
<!-- End Table of Contents [toc] -->
3339

3440
<!-- Start SDK Installation [installation] -->
@@ -79,11 +85,21 @@ end
7985
<details open>
8086
<summary>Available methods</summary>
8187

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

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

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

88104
* [get_all](docs/sdks/apis/README.md#get_all) - Get a list of Apis for a given workspace
89105
* [get_all_versions](docs/sdks/apis/README.md#get_all_versions) - Get all Api versions for a particular ApiEndpoint.
@@ -92,40 +108,45 @@ end
92108
* [generate_open_api](docs/sdks/apis/README.md#generate_open_api) - Generate an OpenAPI specification for a particular Api.
93109
* [generate_postman](docs/sdks/apis/README.md#generate_postman) - Generate a Postman collection for a particular Api.
94110

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

97113
* [preflight](docs/sdks/artifacts/README.md#preflight) - Get access token for communicating with OCI distribution endpoints
98114
* [get_namespaces](docs/sdks/artifacts/README.md#get_namespaces) - Each namespace contains many revisions.
99115
* [get_revisions](docs/sdks/artifacts/README.md#get_revisions)
100116
* [get_tags](docs/sdks/artifacts/README.md#get_tags)
101117
* [post_tags](docs/sdks/artifacts/README.md#post_tags) - Add tags to an existing revision
118+
* [set_visibility](docs/sdks/artifacts/README.md#set_visibility) - Set visibility of a namespace with an existing metadata entry
119+
* [list_remote_sources](docs/sdks/artifacts/README.md#list_remote_sources) - Get remote sources attached to a particular namespace
120+
* [create_remote_source](docs/sdks/artifacts/README.md#create_remote_source) - Configure a new remote source
102121
* [get_manifest](docs/sdks/artifacts/README.md#get_manifest) - Get manifest for a particular reference
103122
* [get_blob](docs/sdks/artifacts/README.md#get_blob) - Get blob for a particular digest
104123

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

107126
* [validate_api_key](docs/sdks/auth/README.md#validate_api_key) - Validate the current api key.
108127
* [get_user](docs/sdks/auth/README.md#get_user) - Get information about the current user.
109128
* [get_access_token](docs/sdks/auth/README.md#get_access_token) - Get or refresh an access token for the current workspace.
110129
* [get_allowances](docs/sdks/auth/README.md#get_allowances) - Get access allowances for a particular workspace
111130

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

114133
* [get_access_token](docs/sdks/embeds/README.md#get_access_token) - Get an embed access token for the current workspace.
115134
* [get_valid](docs/sdks/embeds/README.md#get_valid) - Get all valid embed access tokens for the current workspace.
116135
* [delete](docs/sdks/embeds/README.md#delete) - Revoke an embed access EmbedToken.
117136

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

120139
* [search](docs/sdks/events/README.md#search) - Search events for a particular workspace by any field
121140
* [post](docs/sdks/events/README.md#post) - Post events for a specific workspace
122141
* [get_by_target](docs/sdks/events/README.md#get_by_target) - Load recent events for a particular workspace
123142
* [get_targets](docs/sdks/events/README.md#get_targets) - Load targets for a particular workspace
124143
* [get_targets_deprecated](docs/sdks/events/README.md#get_targets_deprecated) - Load targets for a particular workspace
125144

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

147+
* [get_setup](docs/sdks/github/README.md#get_setup)
128148
* [check_access](docs/sdks/github/README.md#check_access)
149+
* [link_github](docs/sdks/github/README.md#link_github)
129150
* [check_publishing_p_rs](docs/sdks/github/README.md#check_publishing_p_rs)
130151
* [check_publishing_secrets](docs/sdks/github/README.md#check_publishing_secrets)
131152
* [store_publishing_secrets](docs/sdks/github/README.md#store_publishing_secrets)
@@ -135,33 +156,33 @@ end
135156
* [trigger_action](docs/sdks/github/README.md#trigger_action)
136157
* [get_action](docs/sdks/github/README.md#get_action)
137158

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

140161
* [get](docs/sdks/metadata/README.md#get) - Get all metadata for a particular apiID and versionID.
141162
* [insert_version](docs/sdks/metadata/README.md#insert_version) - Insert metadata for a particular apiID and versionID.
142163
* [delete_version](docs/sdks/metadata/README.md#delete_version) - Delete metadata for a particular apiID and versionID.
143164

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

146167
* [get_all](docs/sdks/organizations/README.md#get_all) - Get organizations for a user
147168
* [create](docs/sdks/organizations/README.md#create) - Create an organization
148169
* [get](docs/sdks/organizations/README.md#get) - Get organization
149170
* [create_free_trial](docs/sdks/organizations/README.md#create_free_trial) - Create a free trial for an organization
150171
* [get_usage](docs/sdks/organizations/README.md#get_usage) - Get billing usage summary for a particular organization
151172

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

154175
* [upload](docs/sdks/reports/README.md#upload) - Upload a report.
155176
* [get_signed_url](docs/sdks/reports/README.md#get_signed_url) - Get the signed access url for the linting reports for a particular document.
156177
* [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.
157178

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

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

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

166187
* [get_latest](docs/sdks/schemas/README.md#get_latest) - Get information about the latest schema.
167188
* [post](docs/sdks/schemas/README.md#post) - Register a schema.
@@ -172,28 +193,29 @@ end
172193
* [download_revision](docs/sdks/schemas/README.md#download_revision) - Download a particular schema revision for an Api.
173194
* [get](docs/sdks/schemas/README.md#get) - Get information about all schemas associated with a particular apiID.
174195

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

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

200+
### [SpeakeasyClientSDK](docs/sdks/speakeasyclientsdk/README.md)
179201

180-
### [SpeakeasyClientSDKApiEndpoints](docs/sdks/speakeasyclientsdkapiendpoints/README.md)
202+
* [generate_code_sample_preview](docs/sdks/speakeasyclientsdk/README.md#generate_code_sample_preview) - Generate Code Sample previews from a file and configuration parameters.
203+
* [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.
204+
* [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.
181205

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.
206+
### [subscriptions](docs/sdks/subscriptions/README.md)
189207

190-
### [Suggest](docs/sdks/suggest/README.md)
208+
* [list_registry_subscriptions](docs/sdks/subscriptions/README.md#list_registry_subscriptions) - List Subscriptions
209+
* [create_subscription](docs/sdks/subscriptions/README.md#create_subscription) - Create Subscription
210+
211+
### [suggest](docs/sdks/suggest/README.md)
191212

192213
* [openapi](docs/sdks/suggest/README.md#openapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
193214
* [generate](docs/sdks/suggest/README.md#generate) - Generate suggestions for improving an OpenAPI document.
215+
* [suggest_items](docs/sdks/suggest/README.md#suggest_items) - Generate generic suggestions for a list of items.
194216
* [openapi_registry](docs/sdks/suggest/README.md#openapi_registry) - Generate suggestions for improving an OpenAPI document stored in the registry.
195217

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

198220
* [get_all](docs/sdks/workspaces/README.md#get_all) - Get workspaces for a user
199221
* [get](docs/sdks/workspaces/README.md#get) - Get workspace by context
@@ -213,24 +235,119 @@ end
213235
</details>
214236
<!-- End Available Resources and Operations [operations] -->
215237

216-
<!-- Start Server Selection [server] -->
217-
## Server Selection
238+
<!-- Start Global Parameters [global-parameters] -->
239+
## Global Parameters
240+
241+
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.
242+
243+
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.
218244

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

221275
### Select Server by Name
222276

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:
277+
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:
224278

225-
| Name | Server | Variables |
226-
| ----- | ------ | --------- |
227-
| `prod` | `https://api.prod.speakeasyapi.dev` | None |
279+
| Name | Server |
280+
| ------ | ----------------------------------- |
281+
| `prod` | `https://api.prod.speakeasyapi.dev` |
228282

283+
#### Example
229284

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

231317
### Override Server URL Per-Client
232318

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:
319+
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:
320+
```ruby
321+
require 'speakeasy_client_sdk_ruby'
322+
323+
324+
s = ::OpenApiSDK::SpeakeasyClientSDK.new(
325+
server_url: "https://api.prod.speakeasyapi.dev",
326+
)
327+
s.config_security(
328+
::OpenApiSDK::Shared::Security.new(
329+
api_key: "<YOUR_API_KEY_HERE>",
330+
)
331+
)
332+
333+
334+
req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new(
335+
languages: [
336+
"<value>",
337+
],
338+
schema_file: ::OpenApiSDK::Shared::SchemaFile.new(
339+
file_name: "example.file",
340+
content: "0xc3dD8BfBef".encode(),
341+
),
342+
)
343+
344+
res = s.generate_code_sample_preview(req)
345+
346+
if ! res.two_hundred_application_x_yaml_bytes.nil?
347+
# handle response
348+
end
349+
350+
```
234351
<!-- End Server Selection [server] -->
235352

236353
<!-- 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-28 00:13:36
40+
### Changes
41+
Based on:
42+
- OpenAPI Doc
43+
- Speakeasy CLI 1.448.2 (2.467.4) 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)