ci: regenerated with OpenAPI Doc 0.4.0 ., Speakeasy CLI 1.296.1

speakeasybot · speakeasybot · commit 0ca3009f6a6b · 2024-05-25T00:03:18.000Z
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: f5719c92-1297-4aa0-bc5f-37116859d1e3
 management:
-  docChecksum: c1d828d0e8ecf8fac6bec9e95f0ca086
+  docChecksum: 8a861fbcf601580459816dcab1973d85
   docVersion: 0.4.0 .
-  speakeasyVersion: 1.295.2
-  generationVersion: 2.335.5
-  releaseVersion: 4.2.3
-  configChecksum: 5f53313e0596121963ad8c8594f9c900
+  speakeasyVersion: 1.296.1
+  generationVersion: 2.338.1
+  releaseVersion: 4.2.4
+  configChecksum: e95d53a24f2456ac0e4dfb78cd0afe62
   repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby.git
   repoSubDirectory: .
   installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby
@@ -33,6 +33,7 @@ generatedFiles:
   - lib/speakeasy_client_sdk/github.rb
   - lib/speakeasy_client_sdk/organizations.rb
   - lib/speakeasy_client_sdk/reports.rb
+  - lib/speakeasy_client_sdk/suggest.rb
   - lib/speakeasy_client_sdk/embeds.rb
   - lib/speakeasy_client_sdk/events.rb
   - lib/speakeasy_client_sdk/sdk.rb
@@ -179,6 +180,13 @@ generatedFiles:
   - lib/speakeasy_client_sdk/models/operations/uploadreport_requestbody.rb
   - lib/speakeasy_client_sdk/models/operations/uploadreport_uploadedreport.rb
   - lib/speakeasy_client_sdk/models/operations/uploadreport_response.rb
+  - lib/speakeasy_client_sdk/models/operations/depth_style.rb
+  - lib/speakeasy_client_sdk/models/operations/style.rb
+  - lib/speakeasy_client_sdk/models/operations/opts.rb
+  - lib/speakeasy_client_sdk/models/operations/schema.rb
+  - lib/speakeasy_client_sdk/models/operations/suggestoperationids_requestbody.rb
+  - lib/speakeasy_client_sdk/models/operations/suggestoperationids_suggestion.rb
+  - lib/speakeasy_client_sdk/models/operations/suggestoperationids_response.rb
   - lib/speakeasy_client_sdk/models/operations/getembedaccesstoken_request.rb
   - lib/speakeasy_client_sdk/models/operations/getembedaccesstoken_response.rb
   - lib/speakeasy_client_sdk/models/operations/getvalidembedaccesstokens_response.rb
@@ -345,6 +353,13 @@ generatedFiles:
   - docs/models/operations/uploadreportrequestbody.md
   - docs/models/operations/uploadreportuploadedreport.md
   - docs/models/operations/uploadreportresponse.md
+  - docs/models/operations/depthstyle.md
+  - docs/models/operations/style.md
+  - docs/models/operations/opts.md
+  - docs/models/operations/schema.md
+  - docs/models/operations/suggestoperationidsrequestbody.md
+  - docs/models/operations/suggestoperationidssuggestion.md
+  - docs/models/operations/suggestoperationidsresponse.md
   - docs/models/operations/getembedaccesstokenrequest.md
   - docs/models/operations/getembedaccesstokenresponse.md
   - docs/models/operations/getvalidembedaccesstokensresponse.md
@@ -424,6 +439,7 @@ generatedFiles:
   - docs/sdks/github/README.md
   - docs/sdks/organizations/README.md
   - docs/sdks/reports/README.md
+  - docs/sdks/suggest/README.md
   - docs/sdks/embeds/README.md
   - docs/sdks/events/README.md
   - USAGE.md
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    speakeasy_client_sdk_ruby (4.2.3)
+    speakeasy_client_sdk_ruby (4.2.4)
       faraday
       faraday-multipart
       rack
diff --git a/README.md b/README.md
@@ -115,6 +115,10 @@ end
 * [get_linting_report_signed_url](docs/sdks/reports/README.md#get_linting_report_signed_url) - Get the signed access url for the linting reports for a particular document.
 * [upload_report](docs/sdks/reports/README.md#upload_report) - Upload a report.
 
+### [Suggest](docs/sdks/suggest/README.md)
+
+* [suggest_operation_i_ds](docs/sdks/suggest/README.md#suggest_operation_i_ds) - Generate operation ID suggestions.
+
 ### [Embeds](docs/sdks/embeds/README.md)
 
 * [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
diff --git a/RELEASES.md b/RELEASES.md
@@ -908,4 +908,14 @@ Based on:
 ### Generated
 - [ruby v4.2.3] .
 ### Releases
-- [Ruby Gems v4.2.3] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.3 - .
+- [Ruby Gems v4.2.3] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.3 - .
+
+## 2024-05-25 00:03:04
+### Changes
+Based on:
+- OpenAPI Doc 0.4.0 . https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [ruby v4.2.4] .
+### Releases
+- [Ruby Gems v4.2.4] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.4 - .
diff --git a/docs/models/operations/depthstyle.md b/docs/models/operations/depthstyle.md
@@ -0,0 +1,11 @@
+# DepthStyle
+
+
+## Values
+
+| Name       | Value      |
+| ---------- | ---------- |
+| `ORIGINAL` | original   |
+| `FLAT`     | flat       |
+| `NESTED`   | nested     |
+| `DEEP`     | deep       |
diff --git a/docs/models/operations/opts.md b/docs/models/operations/opts.md
@@ -0,0 +1,9 @@
+# Opts
+
+
+## Fields
+
+| Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `depth_style`                                                                                    | [T.nilable(::SpeakeasyClientSDK::Operations::DepthStyle)](../../models/operations/depthstyle.md) | :heavy_minus_sign:                                                                               | N/A                                                                                              |
+| `style`                                                                                          | [T.nilable(::SpeakeasyClientSDK::Operations::Style)](../../models/operations/style.md)           | :heavy_minus_sign:                                                                               | N/A                                                                                              |
diff --git a/docs/models/operations/schema.md b/docs/models/operations/schema.md
@@ -0,0 +1,9 @@
+# Schema
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `content`          | *::String*         | :heavy_check_mark: | N/A                |
+| `file_name`        | *::String*         | :heavy_check_mark: | N/A                |
diff --git a/docs/models/operations/style.md b/docs/models/operations/style.md
@@ -0,0 +1,9 @@
+# Style
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `STANDARDIZE` | standardize   |
+| `RESOURCE`    | resource      |
diff --git a/docs/models/operations/suggestoperationidsrequestbody.md b/docs/models/operations/suggestoperationidsrequestbody.md
@@ -0,0 +1,11 @@
+# SuggestOperationIDsRequestBody
+
+The schema file to upload provided as a multipart/form-data file segment.
+
+
+## Fields
+
+| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `opts`                                                                               | [T.nilable(::SpeakeasyClientSDK::Operations::Opts)](../../models/operations/opts.md) | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `schema`                                                                             | [::SpeakeasyClientSDK::Operations::Schema](../../models/operations/schema.md)        | :heavy_check_mark:                                                                   | N/A                                                                                  |
diff --git a/docs/models/operations/suggestoperationidsresponse.md b/docs/models/operations/suggestoperationidsresponse.md
@@ -0,0 +1,11 @@
+# SuggestOperationIDsResponse
+
+
+## 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                                                                                |
+| `suggestion`                                                                                                                           | [T.nilable(::SpeakeasyClientSDK::Operations::SuggestOperationIDsSuggestion)](../../models/operations/suggestoperationidssuggestion.md) | :heavy_minus_sign:                                                                                                                     | OK                                                                                                                                     |
diff --git a/docs/models/operations/suggestoperationidssuggestion.md b/docs/models/operations/suggestoperationidssuggestion.md
@@ -0,0 +1,10 @@
+# SuggestOperationIDsSuggestion
+
+OK
+
+
+## Fields
+
+| Field                                 | Type                                  | Required                              | Description                           |
+| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
+| `operation_ids`                       | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark:                    | N/A                                   |
diff --git a/docs/sdks/reports/README.md b/docs/sdks/reports/README.md
@@ -117,7 +117,7 @@ req = ::SpeakeasyClientSDK::Operations::UploadReportRequestBody.new(
   data: ::SpeakeasyClientSDK::Shared::Report.new(),
   file: ::SpeakeasyClientSDK::Operations::File.new(
     content: "0xA329C0ad85".encode(),
-    file_name: "sausages.m3a",
+    file_name: "your_file_here",
   ),
 )
     
diff --git a/docs/sdks/schemas/README.md b/docs/sdks/schemas/README.md
@@ -348,7 +348,7 @@ req = ::SpeakeasyClientSDK::Operations::RegisterSchemaRequest.new(
   request_body: ::SpeakeasyClientSDK::Operations::RegisterSchemaRequestBody.new(
     file: ::SpeakeasyClientSDK::Operations::RegisterSchemaFile.new(
       content: "0xCAFCA03e0e".encode(),
-      file_name: "bronze_table_blues.m2a",
+      file_name: "your_file_here",
     ),
   ),
   api_id: "<value>",
diff --git a/docs/sdks/suggest/README.md b/docs/sdks/suggest/README.md
@@ -0,0 +1,55 @@
+# Suggest
+
+
+## Overview
+
+REST APIs for managing LLM OAS suggestions
+
+### Available Operations
+
+* [suggest_operation_i_ds](#suggest_operation_i_ds) - Generate operation ID suggestions.
+
+## suggest_operation_i_ds
+
+Get suggestions from an LLM model for improving the operationIDs in the provided schema.
+
+### Example Usage
+
+```ruby
+require 'speakeasy_client_sdk_ruby'
+
+
+s = ::SpeakeasyClientSDK::SDK.new
+s.config_security(
+  ::SpeakeasyClientSDK::Shared::Security.new(
+    api_key: "<YOUR_API_KEY_HERE>",
+  )
+)
+
+
+req = ::SpeakeasyClientSDK::Operations::SuggestOperationIDsRequestBody.new(
+  schema: ::SpeakeasyClientSDK::Operations::Schema.new(
+    content: "0xb2de88c98a".encode(),
+    file_name: "your_file_here",
+  ),
+)
+    
+res = s.suggest.suggest_operation_i_ds(req)
+
+if ! res.suggestion.nil?
+  # handle response
+end
+
+```
+
+### Parameters
+
+| Parameter                                                                                                                     | Type                                                                                                                          | Required                                                                                                                      | Description                                                                                                                   |
+| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `request`                                                                                                                     | [::SpeakeasyClientSDK::Operations::SuggestOperationIDsRequestBody](../../models/operations/suggestoperationidsrequestbody.md) | :heavy_check_mark:                                                                                                            | The request object to use for the request.                                                                                    |
+
+
+### Response
+
+**[T.nilable(::SpeakeasyClientSDK::Operations::SuggestOperationIDsResponse)](../../models/operations/suggestoperationidsresponse.md)**
+
diff --git a/gen.yaml b/gen.yaml
@@ -10,7 +10,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 ruby:
-  version: 4.2.3
+  version: 4.2.4
   author: Speakeasy
   description: Ruby Client SDK Generated by Speakeasy
   imports:
diff --git a/lib/speakeasy_client_sdk/models/operations.rb b/lib/speakeasy_client_sdk/models/operations.rb
@@ -100,6 +100,13 @@ module Operations
     autoload :UploadReportRequestBody, 'speakeasy_client_sdk/models/operations/uploadreport_requestbody.rb'
     autoload :UploadReportUploadedReport, 'speakeasy_client_sdk/models/operations/uploadreport_uploadedreport.rb'
     autoload :UploadReportResponse, 'speakeasy_client_sdk/models/operations/uploadreport_response.rb'
+    autoload :DepthStyle, 'speakeasy_client_sdk/models/operations/depth_style.rb'
+    autoload :Style, 'speakeasy_client_sdk/models/operations/style.rb'
+    autoload :Opts, 'speakeasy_client_sdk/models/operations/opts.rb'
+    autoload :Schema, 'speakeasy_client_sdk/models/operations/schema.rb'
+    autoload :SuggestOperationIDsRequestBody, 'speakeasy_client_sdk/models/operations/suggestoperationids_requestbody.rb'
+    autoload :SuggestOperationIDsSuggestion, 'speakeasy_client_sdk/models/operations/suggestoperationids_suggestion.rb'
+    autoload :SuggestOperationIDsResponse, 'speakeasy_client_sdk/models/operations/suggestoperationids_response.rb'
     autoload :GetEmbedAccessTokenRequest, 'speakeasy_client_sdk/models/operations/getembedaccesstoken_request.rb'
     autoload :GetEmbedAccessTokenResponse, 'speakeasy_client_sdk/models/operations/getembedaccesstoken_response.rb'
     autoload :GetValidEmbedAccessTokensResponse, 'speakeasy_client_sdk/models/operations/getvalidembedaccesstokens_response.rb'
diff --git a/lib/speakeasy_client_sdk/models/operations/depth_style.rb b/lib/speakeasy_client_sdk/models/operations/depth_style.rb
@@ -0,0 +1,21 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module SpeakeasyClientSDK
+  module Operations
+  
+
+    class DepthStyle < T::Enum
+      enums do
+        ORIGINAL = new('original')
+        FLAT = new('flat')
+        NESTED = new('nested')
+        DEEP = new('deep')
+      end
+    end
+
+  end
+end
diff --git a/lib/speakeasy_client_sdk/models/operations/opts.rb b/lib/speakeasy_client_sdk/models/operations/opts.rb
@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module SpeakeasyClientSDK
+  module Operations
+  
+
+    class Opts < ::SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :depth_style, T.nilable(::SpeakeasyClientSDK::Operations::DepthStyle), { 'format_json': { 'letter_case': ::SpeakeasyClientSDK::Utils.field_name('depth_style'), 'decoder': Utils.enum_from_string(::SpeakeasyClientSDK::Operations::DepthStyle, true) } }
+
+      field :style, T.nilable(::SpeakeasyClientSDK::Operations::Style), { 'format_json': { 'letter_case': ::SpeakeasyClientSDK::Utils.field_name('style'), 'decoder': Utils.enum_from_string(::SpeakeasyClientSDK::Operations::Style, true) } }
+
+
+      sig { params(depth_style: T.nilable(::SpeakeasyClientSDK::Operations::DepthStyle), style: T.nilable(::SpeakeasyClientSDK::Operations::Style)).void }
+      def initialize(depth_style: nil, style: nil)
+        @depth_style = depth_style
+        @style = style
+      end
+    end
+  end
+end
diff --git a/lib/speakeasy_client_sdk/models/operations/schema.rb b/lib/speakeasy_client_sdk/models/operations/schema.rb
@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module SpeakeasyClientSDK
+  module Operations
+  
+
+    class Schema < ::SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content, ::String, { 'multipart_form': { 'content': true } }
+
+      field :file_name, ::String, { 'multipart_form': { 'field_name': 'schema' } }
+
+
+      sig { params(content: ::String, file_name: ::String).void }
+      def initialize(content: nil, file_name: nil)
+        @content = content
+        @file_name = file_name
+      end
+    end
+  end
+end
diff --git a/lib/speakeasy_client_sdk/models/operations/style.rb b/lib/speakeasy_client_sdk/models/operations/style.rb
@@ -0,0 +1,19 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module SpeakeasyClientSDK
+  module Operations
+  
+
+    class Style < T::Enum
+      enums do
+        STANDARDIZE = new('standardize')
+        RESOURCE = new('resource')
+      end
+    end
+
+  end
+end
diff --git a/lib/speakeasy_client_sdk/models/operations/suggestoperationids_requestbody.rb b/lib/speakeasy_client_sdk/models/operations/suggestoperationids_requestbody.rb
diff --git a/lib/speakeasy_client_sdk/models/operations/suggestoperationids_response.rb b/lib/speakeasy_client_sdk/models/operations/suggestoperationids_response.rb
diff --git a/lib/speakeasy_client_sdk/models/operations/suggestoperationids_suggestion.rb b/lib/speakeasy_client_sdk/models/operations/suggestoperationids_suggestion.rb
diff --git a/lib/speakeasy_client_sdk/sdk.rb b/lib/speakeasy_client_sdk/sdk.rb
diff --git a/lib/speakeasy_client_sdk/sdkconfiguration.rb b/lib/speakeasy_client_sdk/sdkconfiguration.rb
diff --git a/lib/speakeasy_client_sdk/suggest.rb b/lib/speakeasy_client_sdk/suggest.rb
diff --git a/lib/speakeasy_client_sdk_ruby.rb b/lib/speakeasy_client_sdk_ruby.rb
diff --git a/speakeasy_client_sdk_ruby.gemspec b/speakeasy_client_sdk_ruby.gemspec
