Merge pull request #71 from dubinc/speakeasy-sdk-regen-1736814342

chore: 🐝 Update SDK - Generate 0.2.2-alpha.52

.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 5a2dd83e-da98-455b-8ef9-0100a914efdf
 management:
-  docChecksum: a6a1e65c1a9ddd2d1b445252e12b8157
+  docChecksum: 0c06ef8b2bdec6b49e32f18c56e32ee4
   docVersion: 0.0.1
-  speakeasyVersion: 1.468.2
+  speakeasyVersion: 1.468.3
   generationVersion: 2.493.4
-  releaseVersion: 0.2.2-alpha.51
-  configChecksum: 4ce3ed94c2bea0e1baf4b9137eec4d22
+  releaseVersion: 0.2.2-alpha.52
+  configChecksum: 6591a59de86fade8e7f14c259362f7b7
   repoURL: https://github.com/dubinc/dub-ruby.git
   installationURL: https://github.com/dubinc/dub-ruby
   published: true

.speakeasy/gen.yaml

@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
 ruby:
-  version: 0.2.2-alpha.51
+  version: 0.2.2-alpha.52
   author: Dub
   description: Ruby Client SDK Generated by Speakeasy
   imports:

.speakeasy/workflow.lock

@@ -1,21 +1,21 @@
-speakeasyVersion: 1.468.2
+speakeasyVersion: 1.468.3
 sources:
     dub:
         sourceNamespace: dub
-        sourceRevisionDigest: sha256:2f72a7abb22d9640a09e012a491993dec2508bd0215e7b52996856ee9ab5989d
-        sourceBlobDigest: sha256:e455cd12338a6074213fe801f891abdf883b45dae8c4f90f6ac421ee4b3c4449
+        sourceRevisionDigest: sha256:bbb5a6eadb94915233f59a7e5d6d996a624d1418af697db63da5b83c88967d36
+        sourceBlobDigest: sha256:95e092e1faeefc534d84f8dc5a72fd5c0ddbda08a02ae70b6246d5fdc0e8fea6
         tags:
             - latest
-            - speakeasy-sdk-regen-1736296015
+            - speakeasy-sdk-regen-1736814342
             - 0.0.1
 targets:
     my-first-target:
         source: dub
         sourceNamespace: dub
-        sourceRevisionDigest: sha256:2f72a7abb22d9640a09e012a491993dec2508bd0215e7b52996856ee9ab5989d
-        sourceBlobDigest: sha256:e455cd12338a6074213fe801f891abdf883b45dae8c4f90f6ac421ee4b3c4449
+        sourceRevisionDigest: sha256:bbb5a6eadb94915233f59a7e5d6d996a624d1418af697db63da5b83c88967d36
+        sourceBlobDigest: sha256:95e092e1faeefc534d84f8dc5a72fd5c0ddbda08a02ae70b6246d5fdc0e8fea6
         codeSamplesNamespace: code-samples-ruby-my-first-target
-        codeSamplesRevisionDigest: sha256:82559bb84b975e8e6016fa4e9f6e0beecbb2c4ed4eaf14c84c9579866c53a74f
+        codeSamplesRevisionDigest: sha256:8e8e529d6c013885fff41e0fc9140b6a7501bee606fb9577d3ee2c7b246e435a
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to This Repository
+
+Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
+
+## How to Report Issues
+
+If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected and actual behavior
+- Any relevant logs, screenshots, or error messages
+- Information about your environment (e.g., operating system, software versions)
+    - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
+
+## Issue Triage and Upstream Fixes
+
+We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
+
+## Contact
+
+If you have any questions or need further assistance, please feel free to reach out by opening an issue.
+
+Thank you for your understanding and cooperation!
+
+The Maintainers

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dub (0.2.2.pre.alpha.51)
+    dub (0.2.2.pre.alpha.52)
       faraday
       faraday-multipart
       rack

RELEASES.md

@@ -658,4 +658,14 @@ Based on:
 ### Generated
 - [ruby v0.2.2-alpha.51] .
 ### Releases
-- [Ruby Gems v0.2.2-alpha.51] https://rubygems.org/gems/dub/versions/0.2.2-alpha.51 - .
+- [Ruby Gems v0.2.2-alpha.51] https://rubygems.org/gems/dub/versions/0.2.2-alpha.51 - .
+
+## 2025-01-14 00:25:27
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.468.3 (2.493.4) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [ruby v0.2.2-alpha.52] .
+### Releases
+- [Ruby Gems v0.2.2-alpha.52] https://rubygems.org/gems/dub/versions/0.2.2-alpha.52 - .

dub.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'dub'
-  s.version     = '0.2.2-alpha.51'
+  s.version     = '0.2.2-alpha.52'
   s.platform    = Gem::Platform::RUBY
   s.licenses    = ['Apache-2.0']
   s.summary     = ''

lib/open_api_sdk/models/operations/createlink_requestbody.rb

@@ -15,7 +15,7 @@ class CreateLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
       field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
       # The Android destination URL for the short link for Android device targeting.
       field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
-      # Whether the short link is archived.
+      # Whether the short link is archived. Defaults to `false` if not provided.
       field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
       # The comments for the short link.
       field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
@@ -45,15 +45,15 @@ class CreateLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
       field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
       # The ID of the program the short link is associated with.
       field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
-      # Whether the short link uses Custom Social Media Cards feature.
+      # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
       field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
-      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
+      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
       # 
       # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
       # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
       field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
-      # Whether the short link uses link cloaking.
+      # Whether the short link uses link cloaking. Defaults to `false` if not provided.
       field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
       # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
       # 
@@ -67,7 +67,7 @@ class CreateLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
       field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
       # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
       field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
-      # Whether to track conversions for the short link.
+      # Whether to track conversions for the short link. Defaults to `false` if not provided.
       field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
       # The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
       field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }

lib/open_api_sdk/models/operations/data.rb

@@ -13,7 +13,7 @@ class Data < ::OpenApiSDK::Utils::FieldAugmented
 
       # The Android destination URL for the short link for Android device targeting.
       field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
-      # Whether the short link is archived.
+      # Whether the short link is archived. Defaults to `false` if not provided.
       field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
       # The comments for the short link.
       field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
@@ -35,15 +35,15 @@ class Data < ::OpenApiSDK::Utils::FieldAugmented
       field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
       # The ID of the program the short link is associated with.
       field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
-      # Whether the short link uses Custom Social Media Cards feature.
+      # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
       field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
-      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
+      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
       # 
       # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
       # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
       field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
-      # Whether the short link uses link cloaking.
+      # Whether the short link uses link cloaking. Defaults to `false` if not provided.
       field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
       # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
       # 
@@ -57,7 +57,7 @@ class Data < ::OpenApiSDK::Utils::FieldAugmented
       field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
       # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
       field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
-      # Whether to track conversions for the short link.
+      # Whether to track conversions for the short link. Defaults to `false` if not provided.
       field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
       # The destination URL of the short link.
       field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }

lib/open_api_sdk/models/operations/requestbody.rb

@@ -15,7 +15,7 @@ class RequestBody < ::OpenApiSDK::Utils::FieldAugmented
       field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
       # The Android destination URL for the short link for Android device targeting.
       field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
-      # Whether the short link is archived.
+      # Whether the short link is archived. Defaults to `false` if not provided.
       field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
       # The comments for the short link.
       field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
@@ -45,15 +45,15 @@ class RequestBody < ::OpenApiSDK::Utils::FieldAugmented
       field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
       # The ID of the program the short link is associated with.
       field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
-      # Whether the short link uses Custom Social Media Cards feature.
+      # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
       field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
-      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
+      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
       # 
       # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
       # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
       field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
-      # Whether the short link uses link cloaking.
+      # Whether the short link uses link cloaking. Defaults to `false` if not provided.
       field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
       # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
       # 
@@ -67,7 +67,7 @@ class RequestBody < ::OpenApiSDK::Utils::FieldAugmented
       field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
       # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
       field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
-      # Whether to track conversions for the short link.
+      # Whether to track conversions for the short link. Defaults to `false` if not provided.
       field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
       # The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
       field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }

lib/open_api_sdk/models/operations/updatelink_requestbody.rb

@@ -13,7 +13,7 @@ class UpdateLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
 
       # The Android destination URL for the short link for Android device targeting.
       field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
-      # Whether the short link is archived.
+      # Whether the short link is archived. Defaults to `false` if not provided.
       field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
       # The comments for the short link.
       field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
@@ -43,15 +43,15 @@ class UpdateLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
       field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
       # The ID of the program the short link is associated with.
       field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
-      # Whether the short link uses Custom Social Media Cards feature.
+      # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
       field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
-      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
+      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
       # 
       # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
       # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
       field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
-      # Whether the short link uses link cloaking.
+      # Whether the short link uses link cloaking. Defaults to `false` if not provided.
       field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
       # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
       # 
@@ -65,7 +65,7 @@ class UpdateLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
       field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
       # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
       field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
-      # Whether to track conversions for the short link.
+      # Whether to track conversions for the short link. Defaults to `false` if not provided.
       field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
       # The destination URL of the short link.
       field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }