ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.441.0

Author: speakeasybot

.speakeasy/gen.lock

@@ -11,8 +11,9 @@ generation:
     requestResponseComponentNamesFeb2024: true
   auth:
     oAuth2ClientCredentialsEnabled: true
+    oAuth2PasswordEnabled: false
 ruby:
-  version: 4.2.24
+  version: 4.3.0
   author: Speakeasy
   description: Ruby Client SDK Generated by Speakeasy
   imports:

.speakeasy/gen.yaml

@@ -1,4 +1,4 @@
-speakeasyVersion: 1.405.8
+speakeasyVersion: 1.441.0
 sources: {}
 targets:
     speakeasy-client-sdk:
@@ -21,3 +21,7 @@ workflow:
             publish:
                 rubygems:
                     token: $rubygems_auth_token
+            codeSamples:
+                registry:
+                    location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/-oas-code-samples
+                blocking: false

.speakeasy/workflow.lock

@@ -15,3 +15,7 @@ targets:
         publish:
             rubygems:
                 token: $rubygems_auth_token
+        codeSamples:
+            registry:
+                location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/-oas-code-samples
+            blocking: false

.speakeasy/workflow.yaml

@@ -17,7 +17,7 @@ Developer-friendly & type-safe Ruby SDK specifically catered to leverage *speake
 <!-- Start Summary [summary] -->
 ## Summary
 
-Speakeasy API: The Speakeasy API allows teams to manage common operations with their APIs
+Speakeasy API: The Subscriptions API manages subscriptions for CLI and registry events
 
 For more information about the API: [The Speakeasy Platform Documentation](/docs)
 <!-- End Summary [summary] -->
@@ -28,6 +28,7 @@ For more information about the API: [The Speakeasy Platform Documentation](/docs
 * [SDK Installation](#sdk-installation)
 * [SDK Example Usage](#sdk-example-usage)
 * [Available Resources and Operations](#available-resources-and-operations)
+* [Global Parameters](#global-parameters)
 * [Server Selection](#server-selection)
 <!-- End Table of Contents [toc] -->
 
@@ -79,11 +80,21 @@ end
 <details open>
 <summary>Available methods</summary>
 
-### [Apiendpoints](docs/sdks/apiendpoints/README.md)
+### [api_endpoints](docs/sdks/speakeasyclientsdkapiendpoints/README.md)
+
+* [get_all](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get_all) - Get all ApiEndpoints for a particular apiID and versionID.
+* [find](docs/sdks/speakeasyclientsdkapiendpoints/README.md#find) - Find an ApiEndpoint via its displayName.
+* [delete](docs/sdks/speakeasyclientsdkapiendpoints/README.md#delete) - Delete an ApiEndpoint.
+* [get](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get) - Get an ApiEndpoint.
+* [upsert](docs/sdks/speakeasyclientsdkapiendpoints/README.md#upsert) - Upsert an ApiEndpoint.
+* [generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint.
+* [generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint.
+
+### [apiendpoints](docs/sdks/apiendpoints/README.md)
 
 * [list](docs/sdks/apiendpoints/README.md#list) - Get all Api endpoints for a particular apiID.
 
-### [Apis](docs/sdks/apis/README.md)
+### [apis](docs/sdks/apis/README.md)
 
 * [get_all](docs/sdks/apis/README.md#get_all) - Get a list of Apis for a given workspace
 * [get_all_versions](docs/sdks/apis/README.md#get_all_versions) - Get all Api versions for a particular ApiEndpoint.
@@ -92,40 +103,43 @@ end
 * [generate_open_api](docs/sdks/apis/README.md#generate_open_api) - Generate an OpenAPI specification for a particular Api.
 * [generate_postman](docs/sdks/apis/README.md#generate_postman) - Generate a Postman collection for a particular Api.
 
-### [Artifacts](docs/sdks/artifacts/README.md)
+### [artifacts](docs/sdks/artifacts/README.md)
 
 * [preflight](docs/sdks/artifacts/README.md#preflight) - Get access token for communicating with OCI distribution endpoints
 * [get_namespaces](docs/sdks/artifacts/README.md#get_namespaces) - Each namespace contains many revisions.
 * [get_revisions](docs/sdks/artifacts/README.md#get_revisions)
 * [get_tags](docs/sdks/artifacts/README.md#get_tags)
 * [post_tags](docs/sdks/artifacts/README.md#post_tags) - Add tags to an existing revision
+* [list_remote_sources](docs/sdks/artifacts/README.md#list_remote_sources) - Get remote sources attached to a particular namespace
+* [create_remote_source](docs/sdks/artifacts/README.md#create_remote_source) - Configure a new remote source
 * [get_manifest](docs/sdks/artifacts/README.md#get_manifest) - Get manifest for a particular reference
 * [get_blob](docs/sdks/artifacts/README.md#get_blob) - Get blob for a particular digest
 
-### [Auth](docs/sdks/auth/README.md)
+### [auth](docs/sdks/auth/README.md)
 
 * [validate_api_key](docs/sdks/auth/README.md#validate_api_key) - Validate the current api key.
 * [get_user](docs/sdks/auth/README.md#get_user) - Get information about the current user.
 * [get_access_token](docs/sdks/auth/README.md#get_access_token) - Get or refresh an access token for the current workspace.
 * [get_allowances](docs/sdks/auth/README.md#get_allowances) - Get access allowances for a particular workspace
 
-### [Embeds](docs/sdks/embeds/README.md)
+### [embeds](docs/sdks/embeds/README.md)
 
 * [get_access_token](docs/sdks/embeds/README.md#get_access_token) - Get an embed access token for the current workspace.
 * [get_valid](docs/sdks/embeds/README.md#get_valid) - Get all valid embed access tokens for the current workspace.
 * [delete](docs/sdks/embeds/README.md#delete) - Revoke an embed access EmbedToken.
 
-### [Events](docs/sdks/events/README.md)
+### [events](docs/sdks/events/README.md)
 
 * [search](docs/sdks/events/README.md#search) - Search events for a particular workspace by any field
 * [post](docs/sdks/events/README.md#post) - Post events for a specific workspace
 * [get_by_target](docs/sdks/events/README.md#get_by_target) - Load recent events for a particular workspace
 * [get_targets](docs/sdks/events/README.md#get_targets) - Load targets for a particular workspace
 * [get_targets_deprecated](docs/sdks/events/README.md#get_targets_deprecated) - Load targets for a particular workspace
 
-### [Github](docs/sdks/github/README.md)
+### [github](docs/sdks/github/README.md)
 
 * [check_access](docs/sdks/github/README.md#check_access)
+* [link_github](docs/sdks/github/README.md#link_github)
 * [check_publishing_p_rs](docs/sdks/github/README.md#check_publishing_p_rs)
 * [check_publishing_secrets](docs/sdks/github/README.md#check_publishing_secrets)
 * [store_publishing_secrets](docs/sdks/github/README.md#store_publishing_secrets)
@@ -135,33 +149,33 @@ end
 * [trigger_action](docs/sdks/github/README.md#trigger_action)
 * [get_action](docs/sdks/github/README.md#get_action)
 
-### [Metadata](docs/sdks/metadata/README.md)
+### [metadata](docs/sdks/metadata/README.md)
 
 * [get](docs/sdks/metadata/README.md#get) - Get all metadata for a particular apiID and versionID.
 * [insert_version](docs/sdks/metadata/README.md#insert_version) - Insert metadata for a particular apiID and versionID.
 * [delete_version](docs/sdks/metadata/README.md#delete_version) - Delete metadata for a particular apiID and versionID.
 
-### [Organizations](docs/sdks/organizations/README.md)
+### [organizations](docs/sdks/organizations/README.md)
 
 * [get_all](docs/sdks/organizations/README.md#get_all) - Get organizations for a user
 * [create](docs/sdks/organizations/README.md#create) - Create an organization
 * [get](docs/sdks/organizations/README.md#get) - Get organization
 * [create_free_trial](docs/sdks/organizations/README.md#create_free_trial) - Create a free trial for an organization
 * [get_usage](docs/sdks/organizations/README.md#get_usage) - Get billing usage summary for a particular organization
 
-### [Reports](docs/sdks/reports/README.md)
+### [reports](docs/sdks/reports/README.md)
 
 * [upload](docs/sdks/reports/README.md#upload) - Upload a report.
 * [get_signed_url](docs/sdks/reports/README.md#get_signed_url) - Get the signed access url for the linting reports for a particular document.
 * [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.
 
-### [Requests](docs/sdks/requests/README.md)
+### [requests](docs/sdks/requests/README.md)
 
 * [query](docs/sdks/requests/README.md#query) - Query the event log to retrieve a list of requests.
 * [get](docs/sdks/requests/README.md#get) - Get information about a particular request.
 * [generate_postman_collection](docs/sdks/requests/README.md#generate_postman_collection) - Generate a Postman collection for a particular request.
 
-### [Schemas](docs/sdks/schemas/README.md)
+### [schemas](docs/sdks/schemas/README.md)
 
 * [get_latest](docs/sdks/schemas/README.md#get_latest) - Get information about the latest schema.
 * [post](docs/sdks/schemas/README.md#post) - Register a schema.
@@ -172,28 +186,29 @@ end
 * [download_revision](docs/sdks/schemas/README.md#download_revision) - Download a particular schema revision for an Api.
 * [get](docs/sdks/schemas/README.md#get) - Get information about all schemas associated with a particular apiID.
 
-### [ShortURLs](docs/sdks/shorturls/README.md)
+### [short_ur_ls](docs/sdks/shorturls/README.md)
 
 * [create](docs/sdks/shorturls/README.md#create) - Shorten a URL.
 
+### [SpeakeasyClientSDK](docs/sdks/speakeasyclientsdk/README.md)
 
-### [SpeakeasyClientSDKApiEndpoints](docs/sdks/speakeasyclientsdkapiendpoints/README.md)
+* [generate_code_sample_preview](docs/sdks/speakeasyclientsdk/README.md#generate_code_sample_preview) - Generate Code Sample previews from a file and configuration parameters.
+* [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.
+* [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.
 
-* [get_all](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get_all) - Get all ApiEndpoints for a particular apiID and versionID.
-* [find](docs/sdks/speakeasyclientsdkapiendpoints/README.md#find) - Find an ApiEndpoint via its displayName.
-* [delete](docs/sdks/speakeasyclientsdkapiendpoints/README.md#delete) - Delete an ApiEndpoint.
-* [get](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get) - Get an ApiEndpoint.
-* [upsert](docs/sdks/speakeasyclientsdkapiendpoints/README.md#upsert) - Upsert an ApiEndpoint.
-* [generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint.
-* [generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint.
+### [subscriptions](docs/sdks/subscriptions/README.md)
 
-### [Suggest](docs/sdks/suggest/README.md)
+* [list_registry_subscriptions](docs/sdks/subscriptions/README.md#list_registry_subscriptions) - List Subscriptions
+* [create_subscription](docs/sdks/subscriptions/README.md#create_subscription) - Create Subscription
+
+### [suggest](docs/sdks/suggest/README.md)
 
 * [openapi](docs/sdks/suggest/README.md#openapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
 * [generate](docs/sdks/suggest/README.md#generate) - Generate suggestions for improving an OpenAPI document.
+* [suggest_items](docs/sdks/suggest/README.md#suggest_items) - Generate generic suggestions for a list of items.
 * [openapi_registry](docs/sdks/suggest/README.md#openapi_registry) - Generate suggestions for improving an OpenAPI document stored in the registry.
 
-### [Workspaces](docs/sdks/workspaces/README.md)
+### [workspaces](docs/sdks/workspaces/README.md)
 
 * [get_all](docs/sdks/workspaces/README.md#get_all) - Get workspaces for a user
 * [get](docs/sdks/workspaces/README.md#get) - Get workspace by context
@@ -213,24 +228,119 @@ end
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
-<!-- Start Server Selection [server] -->
-## Server Selection
+<!-- Start Global Parameters [global-parameters] -->
+## Global Parameters
+
+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.
+
+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.
 
+
+### Available Globals
+
+The following global parameter is available.
+
+| Name         | Type     | Description                 |
+| ------------ | -------- | --------------------------- |
+| workspace_id | ::String | The workspace_id parameter. |
+
+### Example
+
+```ruby
+require 'speakeasy_client_sdk_ruby'
+
+
+s = ::OpenApiSDK::SpeakeasyClientSDK.new
+
+    
+res = s.auth.get_access_token(workspace_id="<id>")
+
+if ! res.access_token.nil?
+  # handle response
+end
+
+```
+<!-- End Global Parameters [global-parameters] -->
+
+<!-- Start Server Selection [server] -->
 ## Server Selection
 
 ### Select Server by Name
 
-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:
+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:
 
-| Name | Server | Variables |
-| ----- | ------ | --------- |
-| `prod` | `https://api.prod.speakeasyapi.dev` | None |
+| Name   | Server                              |
+| ------ | ----------------------------------- |
+| `prod` | `https://api.prod.speakeasyapi.dev` |
 
+#### Example
 
+```ruby
+require 'speakeasy_client_sdk_ruby'
+
+
+s = ::OpenApiSDK::SpeakeasyClientSDK.new(
+      server: "prod",
+    )
+s.config_security(
+  ::OpenApiSDK::Shared::Security.new(
+    api_key: "<YOUR_API_KEY_HERE>",
+  )
+)
+
+
+req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new(
+  languages: [
+    "<value>",
+  ],
+  schema_file: ::OpenApiSDK::Shared::SchemaFile.new(
+    file_name: "example.file",
+    content: "0xc3dD8BfBef".encode(),
+  ),
+)
+    
+res = s.generate_code_sample_preview(req)
+
+if ! res.two_hundred_application_x_yaml_bytes.nil?
+  # handle response
+end
+
+```
 
 ### Override Server URL Per-Client
 
-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:
+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:
+```ruby
+require 'speakeasy_client_sdk_ruby'
+
+
+s = ::OpenApiSDK::SpeakeasyClientSDK.new(
+      server_url: "https://api.prod.speakeasyapi.dev",
+    )
+s.config_security(
+  ::OpenApiSDK::Shared::Security.new(
+    api_key: "<YOUR_API_KEY_HERE>",
+  )
+)
+
+
+req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new(
+  languages: [
+    "<value>",
+  ],
+  schema_file: ::OpenApiSDK::Shared::SchemaFile.new(
+    file_name: "example.file",
+    content: "0xc3dD8BfBef".encode(),
+  ),
+)
+    
+res = s.generate_code_sample_preview(req)
+
+if ! res.two_hundred_application_x_yaml_bytes.nil?
+  # handle response
+end
+
+```
 <!-- End Server Selection [server] -->
 
 <!-- Placeholder for Future Speakeasy SDK Sections -->

README.md

@@ -34,4 +34,14 @@ Based on:
 ### Generated
 - [ruby v4.2.24] .
 ### Releases
-- [Ruby Gems v4.2.24] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.24 - .
+- [Ruby Gems v4.2.24] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.24 - .
+
+## 2024-11-20 00:12:52
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.441.0 (2.460.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [ruby v4.3.0] .
+### Releases
+- [Ruby Gems v4.3.0] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.3.0 - .

RELEASES.md

@@ -0,0 +1,11 @@
+# CreateRemoteSourceResponse
+
+
+## Fields
+
+| Field                                                                       | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `content_type`                                                              | *::String*                                                                  | :heavy_check_mark:                                                          | HTTP response content type for this operation                               |
+| `status_code`                                                               | *::Integer*                                                                 | :heavy_check_mark:                                                          | HTTP response status code for this operation                                |
+| `raw_response`                                                              | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark:                                                          | Raw HTTP response; suitable for custom response parsing                     |
+| `error`                                                                     | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md)      | :heavy_minus_sign:                                                          | Default error response                                                      |

docs/models/operations/createremotesourceresponse.md

@@ -0,0 +1,9 @@
+# CreateSubscriptionRequest
+
+
+## Fields
+
+| Field                                                                                     | Type                                                                                      | Required                                                                                  | Description                                                                               |
+| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `registry_subscription`                                                                   | [::OpenApiSDK::Shared::RegistrySubscription](../../models/shared/registrysubscription.md) | :heavy_check_mark:                                                                        | The subscription to create                                                                |
+| `workspace_id`                                                                            | *T.nilable(::String)*                                                                     | :heavy_minus_sign:                                                                        | The workspace ID                                                                          |