ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.183.3

Author: speakeasybot

.speakeasy/gen.lock

@@ -4,16 +4,16 @@ management:
   docChecksum: 90bb5b2f880d4a86868122f9a6b08d40
   docVersion: 0.4.0
   speakeasyVersion: internal
-  generationVersion: 2.262.2
-  releaseVersion: 4.0.4
-  configChecksum: b2da48935fb729a6d019f70445b6ef87
+  generationVersion: 2.263.3
+  releaseVersion: 4.0.5
+  configChecksum: 0ccfedb96f8bbae17a80e161e91e47a6
   repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby.git
   repoSubDirectory: .
   installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby
   published: true
 features:
   ruby:
-    core: 3.2.8
+    core: 3.2.9
     examples: 2.81.3
     globalSecurity: 2.81.3
     globalServerURLs: 2.82.1
@@ -36,6 +36,7 @@ generatedFiles:
   - Gemfile.lock
   - Rakefile
   - lib/speakeasy_client_sdk/utils/metadata_fields.rb
+  - lib/speakeasy_client_sdk/utils/t.rb
   - lib/speakeasy_client_sdk/utils/utils.rb
   - sorbet/config
   - sorbet/rbi/annotations/.gitattributes

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    speakeasy_client_sdk_ruby (4.0.4)
+    speakeasy_client_sdk_ruby (4.0.5)
       faraday
       faraday-multipart
       rack

RELEASES.md

@@ -608,4 +608,14 @@ Based on:
 ### Generated
 - [ruby v4.0.4] .
 ### Releases
-- [Ruby Gems v4.0.4] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.0.4 - .
+- [Ruby Gems v4.0.4] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.0.4 - .
+
+## 2024-02-20 00:02:39
+### Changes
+Based on:
+- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.183.3 (2.263.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [ruby v4.0.5] .
+### Releases
+- [Ruby Gems v4.0.5] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.0.5 - .

gen.yaml

@@ -8,7 +8,7 @@ generation:
     parameterOrderingFeb2024: false
     requestResponseComponentNamesFeb2024: false
 ruby:
-  version: 4.0.4
+  version: 4.0.5
   author: Speakeasy
   description: Ruby Client SDK Generated by Speakeasy
   imports:

lib/speakeasy_client_sdk/apiendpoints.rb

@@ -19,7 +19,7 @@ def initialize(sdk_config)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::DeleteApiEndpointRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::DeleteApiEndpointRequest)).returns(::SpeakeasyClientSDK::Operations::DeleteApiEndpointResponse) }
     def delete_api_endpoint(request)
       # delete_api_endpoint - Delete an ApiEndpoint.
       # Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).
@@ -58,7 +58,7 @@ def delete_api_endpoint(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::FindApiEndpointRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::FindApiEndpointRequest)).returns(::SpeakeasyClientSDK::Operations::FindApiEndpointResponse) }
     def find_api_endpoint(request)
       # find_api_endpoint - Find an ApiEndpoint via its displayName.
       # Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema).
@@ -102,7 +102,7 @@ def find_api_endpoint(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecForApiEndpointRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecForApiEndpointRequest)).returns(::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecForApiEndpointResponse) }
     def generate_open_api_spec_for_api_endpoint(request)
       # generate_open_api_spec_for_api_endpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
       # This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document.
@@ -146,7 +146,7 @@ def generate_open_api_spec_for_api_endpoint(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionForApiEndpointRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionForApiEndpointRequest)).returns(::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionForApiEndpointResponse) }
     def generate_postman_collection_for_api_endpoint(request)
       # generate_postman_collection_for_api_endpoint - Generate a Postman collection for a particular ApiEndpoint.
       # Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document.
@@ -187,7 +187,7 @@ def generate_postman_collection_for_api_endpoint(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetAllApiEndpointsRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetAllApiEndpointsRequest)).returns(::SpeakeasyClientSDK::Operations::GetAllApiEndpointsResponse) }
     def get_all_api_endpoints(request)
       # get_all_api_endpoints - Get all Api endpoints for a particular apiID.
       url, params = @sdk_configuration.get_server_details
@@ -229,7 +229,7 @@ def get_all_api_endpoints(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetAllForVersionApiEndpointsRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetAllForVersionApiEndpointsRequest)).returns(::SpeakeasyClientSDK::Operations::GetAllForVersionApiEndpointsResponse) }
     def get_all_for_version_api_endpoints(request)
       # get_all_for_version_api_endpoints - Get all ApiEndpoints for a particular apiID and versionID.
       url, params = @sdk_configuration.get_server_details
@@ -271,7 +271,7 @@ def get_all_for_version_api_endpoints(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetApiEndpointRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetApiEndpointRequest)).returns(::SpeakeasyClientSDK::Operations::GetApiEndpointResponse) }
     def get_api_endpoint(request)
       # get_api_endpoint - Get an ApiEndpoint.
       url, params = @sdk_configuration.get_server_details
@@ -313,7 +313,7 @@ def get_api_endpoint(request)
     end
 
 
-    sig { params(request: ::SpeakeasyClientSDK::Operations::UpsertApiEndpointRequest).returns(Utils::FieldAugmented) }
+    sig { params(request: ::SpeakeasyClientSDK::Operations::UpsertApiEndpointRequest).returns(::SpeakeasyClientSDK::Operations::UpsertApiEndpointResponse) }
     def upsert_api_endpoint(request)
       # upsert_api_endpoint - Upsert an ApiEndpoint.
       # Upsert an ApiEndpoint. If the ApiEndpoint does not exist it will be created, otherwise it will be updated.

lib/speakeasy_client_sdk/apis.rb

@@ -19,7 +19,7 @@ def initialize(sdk_config)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::DeleteApiRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::DeleteApiRequest)).returns(::SpeakeasyClientSDK::Operations::DeleteApiResponse) }
     def delete_api(request)
       # delete_api - Delete an Api.
       # Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore).
@@ -58,7 +58,7 @@ def delete_api(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecRequest)).returns(::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecResponse) }
     def generate_open_api_spec(request)
       # generate_open_api_spec - Generate an OpenAPI specification for a particular Api.
       # This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document.
@@ -102,7 +102,7 @@ def generate_open_api_spec(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionRequest)).returns(::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionResponse) }
     def generate_postman_collection(request)
       # generate_postman_collection - Generate a Postman collection for a particular Api.
       # Generates a postman collection containing all endpoints for a particular API. Includes variables produced for any path/query/header parameters included in the OpenAPI document.
@@ -143,7 +143,7 @@ def generate_postman_collection(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetAllApiVersionsRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetAllApiVersionsRequest)).returns(::SpeakeasyClientSDK::Operations::GetAllApiVersionsResponse) }
     def get_all_api_versions(request)
       # get_all_api_versions - Get all Api versions for a particular ApiEndpoint.
       # Get all Api versions for a particular ApiEndpoint.
@@ -189,7 +189,7 @@ def get_all_api_versions(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetApisRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetApisRequest)).returns(::SpeakeasyClientSDK::Operations::GetApisResponse) }
     def get_apis(request)
       # get_apis - Get a list of Apis for a given workspace
       # Get a list of all Apis and their versions for a given workspace.
@@ -229,7 +229,7 @@ def get_apis(request)
     end
 
 
-    sig { params(request: ::SpeakeasyClientSDK::Operations::UpsertApiRequest).returns(Utils::FieldAugmented) }
+    sig { params(request: ::SpeakeasyClientSDK::Operations::UpsertApiRequest).returns(::SpeakeasyClientSDK::Operations::UpsertApiResponse) }
     def upsert_api(request)
       # upsert_api - Upsert an Api
       # Upsert an Api. If the Api does not exist, it will be created.

lib/speakeasy_client_sdk/auth.rb

@@ -19,7 +19,7 @@ def initialize(sdk_config)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetWorkspaceAccessRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetWorkspaceAccessRequest)).returns(::SpeakeasyClientSDK::Operations::GetWorkspaceAccessResponse) }
     def get_workspace_access(request)
       # get_workspace_access - Get access allowances for a particular workspace
       # Checks if generation is permitted for a particular run of the CLI
@@ -57,7 +57,7 @@ def get_workspace_access(request)
     end
 
 
-    sig { returns(::SpeakeasyClientSDK::Utils::FieldAugmented) }
+    sig { returns(::SpeakeasyClientSDK::Operations::ValidateApiKeyResponse) }
     def validate_api_key
       # validate_api_key - Validate the current api key.
       url, params = @sdk_configuration.get_server_details

lib/speakeasy_client_sdk/embeds.rb

@@ -19,7 +19,7 @@ def initialize(sdk_config)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetEmbedAccessTokenRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetEmbedAccessTokenRequest)).returns(::SpeakeasyClientSDK::Operations::GetEmbedAccessTokenResponse) }
     def get_embed_access_token(request)
       # get_embed_access_token - Get an embed access token for the current workspace.
       # Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content.
@@ -59,7 +59,7 @@ def get_embed_access_token(request)
     end
 
 
-    sig { returns(::SpeakeasyClientSDK::Utils::FieldAugmented) }
+    sig { returns(::SpeakeasyClientSDK::Operations::GetValidEmbedAccessTokensResponse) }
     def get_valid_embed_access_tokens
       # get_valid_embed_access_tokens - Get all valid embed access tokens for the current workspace.
       url, params = @sdk_configuration.get_server_details
@@ -95,7 +95,7 @@ def get_valid_embed_access_tokens
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::RevokeEmbedAccessTokenRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::RevokeEmbedAccessTokenRequest)).returns(::SpeakeasyClientSDK::Operations::RevokeEmbedAccessTokenResponse) }
     def revoke_embed_access_token(request)
       # revoke_embed_access_token - Revoke an embed access EmbedToken.
       url, params = @sdk_configuration.get_server_details

lib/speakeasy_client_sdk/events.rb

@@ -19,7 +19,7 @@ def initialize(sdk_config)
     end
 
 
-    sig { params(request: ::SpeakeasyClientSDK::Operations::PostWorkspaceEventsRequest).returns(Utils::FieldAugmented) }
+    sig { params(request: ::SpeakeasyClientSDK::Operations::PostWorkspaceEventsRequest).returns(::SpeakeasyClientSDK::Operations::PostWorkspaceEventsResponse) }
     def post_workspace_events(request)
       # post_workspace_events - Post events for a specific workspace
       # Sends an array of events to be stored for a particular workspace.

lib/speakeasy_client_sdk/metadata.rb

@@ -19,7 +19,7 @@ def initialize(sdk_config)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::DeleteVersionMetadataRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::DeleteVersionMetadataRequest)).returns(::SpeakeasyClientSDK::Operations::DeleteVersionMetadataResponse) }
     def delete_version_metadata(request)
       # delete_version_metadata - Delete metadata for a particular apiID and versionID.
       url, params = @sdk_configuration.get_server_details
@@ -57,7 +57,7 @@ def delete_version_metadata(request)
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetVersionMetadataRequest)).returns(Utils::FieldAugmented) }
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetVersionMetadataRequest)).returns(::SpeakeasyClientSDK::Operations::GetVersionMetadataResponse) }
     def get_version_metadata(request)
       # get_version_metadata - Get all metadata for a particular apiID and versionID.
       url, params = @sdk_configuration.get_server_details
@@ -99,7 +99,7 @@ def get_version_metadata(request)
     end
 
 
-    sig { params(request: ::SpeakeasyClientSDK::Operations::InsertVersionMetadataRequest).returns(Utils::FieldAugmented) }
+    sig { params(request: ::SpeakeasyClientSDK::Operations::InsertVersionMetadataRequest).returns(::SpeakeasyClientSDK::Operations::InsertVersionMetadataResponse) }
     def insert_version_metadata(request)
       # insert_version_metadata - Insert metadata for a particular apiID and versionID.
       url, params = @sdk_configuration.get_server_details