ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.257.1

speakeasybot · speakeasybot · commit 2c5ca09e5a33 · 2024-04-18T00:03:28.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: fb8d80dde775dc830ade2c3c3fe88d18
+  docChecksum: 2b280a7f12ab57c144a654766cc34af2
   docVersion: 0.4.0
-  speakeasyVersion: 1.253.3
-  generationVersion: 2.306.3
-  releaseVersion: 4.1.4
-  configChecksum: cbc56ab37fc60f5b655b73c0282f24cd
+  speakeasyVersion: 1.257.1
+  generationVersion: 2.308.2
+  releaseVersion: 4.1.5
+  configChecksum: 56dfa69493542cc63df4cafe7edf501a
   repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby.git
   repoSubDirectory: .
   installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby
@@ -159,6 +159,9 @@ generatedFiles:
   - lib/speakeasy_client_sdk/models/operations/queryeventlog_request.rb
   - lib/speakeasy_client_sdk/models/operations/queryeventlog_response.rb
   - lib/speakeasy_client_sdk/models/operations/getorganizations_response.rb
+  - lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_request.rb
+  - lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_signedaccess.rb
+  - lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_response.rb
   - lib/speakeasy_client_sdk/models/operations/getlintingreportsignedurl_request.rb
   - lib/speakeasy_client_sdk/models/operations/getlintingreportsignedurl_signedaccess.rb
   - lib/speakeasy_client_sdk/models/operations/getlintingreportsignedurl_response.rb
@@ -306,6 +309,9 @@ generatedFiles:
   - docs/models/operations/queryeventlogrequest.md
   - docs/models/operations/queryeventlogresponse.md
   - docs/models/operations/getorganizationsresponse.md
+  - docs/models/operations/getchangesreportsignedurlrequest.md
+  - docs/models/operations/getchangesreportsignedurlsignedaccess.md
+  - docs/models/operations/getchangesreportsignedurlresponse.md
   - docs/models/operations/getlintingreportsignedurlrequest.md
   - docs/models/operations/getlintingreportsignedurlsignedaccess.md
   - docs/models/operations/getlintingreportsignedurlresponse.md
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    speakeasy_client_sdk_ruby (4.1.4)
+    speakeasy_client_sdk_ruby (4.1.5)
       faraday
       faraday-multipart
       rack
diff --git a/README.md b/README.md
@@ -104,6 +104,7 @@ end
 
 ### [Reports](docs/sdks/reports/README.md)
 
+* [get_changes_report_signed_url](docs/sdks/reports/README.md#get_changes_report_signed_url) - Get the signed access url for the change reports for a particular document.
 * [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.
 
diff --git a/RELEASES.md b/RELEASES.md
@@ -778,4 +778,14 @@ Based on:
 ### Generated
 - [ruby v4.1.4] .
 ### Releases
-- [Ruby Gems v4.1.4] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.1.4 - .
+- [Ruby Gems v4.1.4] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.1.4 - .
+
+## 2024-04-18 00:03:15
+### Changes
+Based on:
+- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.257.1 (2.308.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [ruby v4.1.5] .
+### Releases
+- [Ruby Gems v4.1.5] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.1.5 - .
diff --git a/docs/models/operations/getchangesreportsignedurlrequest.md b/docs/models/operations/getchangesreportsignedurlrequest.md
@@ -0,0 +1,8 @@
+# GetChangesReportSignedUrlRequest
+
+
+## Fields
+
+| Field                                                               | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `document_checksum`                                                 | *::String*                                                          | :heavy_check_mark:                                                  | The checksum of the document to retrieve the signed access url for. |
diff --git a/docs/models/operations/getchangesreportsignedurlresponse.md b/docs/models/operations/getchangesreportsignedurlresponse.md
@@ -0,0 +1,11 @@
+# GetChangesReportSignedUrlResponse
+
+
+## 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                                                                                                |
+| `signed_access`                                                                                                                                        | [T.nilable(::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlSignedAccess)](../../models/operations/getchangesreportsignedurlsignedaccess.md) | :heavy_minus_sign:                                                                                                                                     | OK                                                                                                                                                     |
diff --git a/docs/models/operations/getchangesreportsignedurlsignedaccess.md b/docs/models/operations/getchangesreportsignedurlsignedaccess.md
@@ -0,0 +1,10 @@
+# GetChangesReportSignedUrlSignedAccess
+
+OK
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `url`              | *::String*         | :heavy_check_mark: | N/A                |
diff --git a/docs/sdks/reports/README.md b/docs/sdks/reports/README.md
@@ -7,9 +7,54 @@ REST APIs for managing reports
 
 ### Available Operations
 
+* [get_changes_report_signed_url](#get_changes_report_signed_url) - Get the signed access url for the change reports for a particular document.
 * [get_linting_report_signed_url](#get_linting_report_signed_url) - Get the signed access url for the linting reports for a particular document.
 * [upload_report](#upload_report) - Upload a report.
 
+## get_changes_report_signed_url
+
+Get the signed access url for the change reports for a particular document.
+
+### Example Usage
+
+```ruby
+require 'speakeasy_client_sdk_ruby'
+
+
+s = ::SpeakeasyClientSDK::SDK.new(
+      workspace_id: "<value>",
+    )
+s.config_security(
+  ::SpeakeasyClientSDK::Shared::Security.new(
+    api_key: "<YOUR_API_KEY_HERE>",
+  )
+)
+
+
+req = ::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlRequest.new(
+  document_checksum: "<value>",
+)
+    
+res = s.reports.get_changes_report_signed_url(req)
+
+if ! res.signed_access.nil?
+  # handle response
+end
+
+```
+
+### Parameters
+
+| Parameter                                                                                                                         | Type                                                                                                                              | Required                                                                                                                          | Description                                                                                                                       |
+| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `request`                                                                                                                         | [::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlRequest](../../models/operations/getchangesreportsignedurlrequest.md) | :heavy_check_mark:                                                                                                                | The request object to use for the request.                                                                                        |
+
+
+### Response
+
+**[T.nilable(::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlResponse)](../../models/operations/getchangesreportsignedurlresponse.md)**
+
+
 ## get_linting_report_signed_url
 
 Get the signed access url for the linting reports for a particular document.
diff --git a/gen.yaml b/gen.yaml
@@ -10,7 +10,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 ruby:
-  version: 4.1.4
+  version: 4.1.5
   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
@@ -82,6 +82,9 @@ module Operations
     autoload :QueryEventLogRequest, 'speakeasy_client_sdk/models/operations/queryeventlog_request.rb'
     autoload :QueryEventLogResponse, 'speakeasy_client_sdk/models/operations/queryeventlog_response.rb'
     autoload :GetOrganizationsResponse, 'speakeasy_client_sdk/models/operations/getorganizations_response.rb'
+    autoload :GetChangesReportSignedUrlRequest, 'speakeasy_client_sdk/models/operations/getchangesreportsignedurl_request.rb'
+    autoload :GetChangesReportSignedUrlSignedAccess, 'speakeasy_client_sdk/models/operations/getchangesreportsignedurl_signedaccess.rb'
+    autoload :GetChangesReportSignedUrlResponse, 'speakeasy_client_sdk/models/operations/getchangesreportsignedurl_response.rb'
     autoload :GetLintingReportSignedUrlRequest, 'speakeasy_client_sdk/models/operations/getlintingreportsignedurl_request.rb'
     autoload :GetLintingReportSignedUrlSignedAccess, 'speakeasy_client_sdk/models/operations/getlintingreportsignedurl_signedaccess.rb'
     autoload :GetLintingReportSignedUrlResponse, 'speakeasy_client_sdk/models/operations/getlintingreportsignedurl_response.rb'
diff --git a/lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_request.rb b/lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_request.rb
@@ -0,0 +1,24 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module SpeakeasyClientSDK
+  module Operations
+  
+
+    class GetChangesReportSignedUrlRequest < ::SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The checksum of the document to retrieve the signed access url for.
+      field :document_checksum, ::String, { 'path_param': { 'field_name': 'documentChecksum', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(document_checksum: ::String).void }
+      def initialize(document_checksum: nil)
+        @document_checksum = document_checksum
+      end
+    end
+  end
+end
diff --git a/lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_response.rb b/lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_response.rb
@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module SpeakeasyClientSDK
+  module Operations
+  
+
+    class GetChangesReportSignedUrlResponse < ::SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # HTTP response content type for this operation
+      field :content_type, ::String
+      # Raw HTTP response; suitable for custom response parsing
+      field :raw_response, ::Faraday::Response
+      # HTTP response status code for this operation
+      field :status_code, ::Integer
+      # OK
+      field :signed_access, T.nilable(::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlSignedAccess)
+
+
+      sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, signed_access: T.nilable(::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlSignedAccess)).void }
+      def initialize(content_type: nil, raw_response: nil, status_code: nil, signed_access: nil)
+        @content_type = content_type
+        @raw_response = raw_response
+        @status_code = status_code
+        @signed_access = signed_access
+      end
+    end
+  end
+end
diff --git a/lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_signedaccess.rb b/lib/speakeasy_client_sdk/models/operations/getchangesreportsignedurl_signedaccess.rb
@@ -0,0 +1,24 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module SpeakeasyClientSDK
+  module Operations
+  
+    # OK
+    class GetChangesReportSignedUrlSignedAccess < ::SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :url, ::String, { 'format_json': { 'letter_case': ::SpeakeasyClientSDK::Utils.field_name('url') } }
+
+
+      sig { params(url: ::String).void }
+      def initialize(url: nil)
+        @url = url
+      end
+    end
+  end
+end
diff --git a/lib/speakeasy_client_sdk/reports.rb b/lib/speakeasy_client_sdk/reports.rb
@@ -19,6 +19,42 @@ def initialize(sdk_config)
     end
 
 
+    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlRequest)).returns(::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlResponse) }
+    def get_changes_report_signed_url(request)
+      # get_changes_report_signed_url - Get the signed access url for the change reports for a particular document.
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        ::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlRequest,
+        base_url,
+        '/v1/reports/changes/{documentChecksum}',
+        request,
+        @sdk_configuration.globals
+      )
+      headers = {}
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::SpeakeasyClientSDK::Operations::GetChangesReportSignedUrlSignedAccess)
+          res.signed_access = out
+        end
+      end
+      res
+    end
+
+
     sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetLintingReportSignedUrlRequest)).returns(::SpeakeasyClientSDK::Operations::GetLintingReportSignedUrlResponse) }
     def get_linting_report_signed_url(request)
       # get_linting_report_signed_url - Get the signed access url for the linting reports for a particular document.
diff --git a/lib/speakeasy_client_sdk/sdkconfiguration.rb b/lib/speakeasy_client_sdk/sdkconfiguration.rb
@@ -41,9 +41,9 @@ def initialize(client, security, server_url, server, globals)
       @globals = globals.nil? ? {} : globals
       @language = 'ruby'
       @openapi_doc_version = '0.4.0'
-      @sdk_version = '4.1.4'
-      @gen_version = '2.306.3'
-      @user_agent = 'speakeasy-sdk/ruby 4.1.4 2.306.3 0.4.0 speakeasy_client_sdk_ruby'
+      @sdk_version = '4.1.5'
+      @gen_version = '2.308.2'
+      @user_agent = 'speakeasy-sdk/ruby 4.1.5 2.308.2 0.4.0 speakeasy_client_sdk_ruby'
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }
diff --git a/speakeasy_client_sdk_ruby.gemspec b/speakeasy_client_sdk_ruby.gemspec
@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'speakeasy_client_sdk_ruby'
-  s.version     = '4.1.4'
+  s.version     = '4.1.5'
   s.platform    = Gem::Platform::RUBY
   s.licenses    = ['Apache-2.0']
   s.summary     = ''
