Merge pull request #82 from dubinc/speakeasy-sdk-regen-1736814307

chore: 🐝 Update SDK - Generate 0.17.1

.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: ab657d60-207e-43a4-8cc8-692a672950ed
 management:
-  docChecksum: a6a1e65c1a9ddd2d1b445252e12b8157
+  docChecksum: 0c06ef8b2bdec6b49e32f18c56e32ee4
   docVersion: 0.0.1
-  speakeasyVersion: 1.468.2
+  speakeasyVersion: 1.468.3
   generationVersion: 2.493.4
-  releaseVersion: 0.17.0
-  configChecksum: 75dfec61d027003a3ce1e1116270c7c3
+  releaseVersion: 0.17.1
+  configChecksum: 7fcbaa72393d2944a83cc89d01903309
   repoURL: https://github.com/dubinc/dub-python.git
   installationURL: https://github.com/dubinc/dub-python.git
   published: true

.speakeasy/gen.yaml

@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
 python:
-  version: 0.17.0
+  version: 0.17.1
   additionalDependencies:
     dev: {}
     main: {}

.speakeasy/workflow.lock

@@ -1,21 +1,21 @@
-speakeasyVersion: 1.468.2
+speakeasyVersion: 1.468.3
 sources:
     dub:
         sourceNamespace: dub
-        sourceRevisionDigest: sha256:7a2b159d27c13219bef8966c0cdcf7dde3ceb67d939ef01df74aeb2205b27687
-        sourceBlobDigest: sha256:ff6c0ba3377775725392d6a76f3ca03ad807ddcbbb65b02d4362177bf7811437
+        sourceRevisionDigest: sha256:27f5581cbbd79a3315f99f35519b4c7d2697e8e48e5c743b21482e594b050772
+        sourceBlobDigest: sha256:b8fe74e980b300ac1b7dc614a3cf9037d1f3ecd3cba7d3a18d1b23ab4b3edab4
         tags:
             - latest
-            - speakeasy-sdk-regen-1736555173
+            - speakeasy-sdk-regen-1736814307
             - 0.0.1
 targets:
     my-first-target:
         source: dub
         sourceNamespace: dub
-        sourceRevisionDigest: sha256:7a2b159d27c13219bef8966c0cdcf7dde3ceb67d939ef01df74aeb2205b27687
-        sourceBlobDigest: sha256:ff6c0ba3377775725392d6a76f3ca03ad807ddcbbb65b02d4362177bf7811437
+        sourceRevisionDigest: sha256:27f5581cbbd79a3315f99f35519b4c7d2697e8e48e5c743b21482e594b050772
+        sourceBlobDigest: sha256:b8fe74e980b300ac1b7dc614a3cf9037d1f3ecd3cba7d3a18d1b23ab4b3edab4
         codeSamplesNamespace: code-samples-python-my-first-target
-        codeSamplesRevisionDigest: sha256:9834ae9907840e8e030014f601e12aff790c168f367234b1cced9c099c9c554b
+        codeSamplesRevisionDigest: sha256:540354aee2ca3bfffbc9ad9585ab6c5b43a290ad3640b7ec68d497eddfe66cc6
 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

RELEASES.md

@@ -726,4 +726,14 @@ Based on:
 ### Generated
 - [python v0.17.0] .
 ### Releases
-- [PyPI v0.17.0] https://pypi.org/project/dub/0.17.0 - .
+- [PyPI v0.17.0] https://pypi.org/project/dub/0.17.0 - .
+
+## 2025-01-14 00:24:52
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.468.3 (2.493.4) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.17.1] .
+### Releases
+- [PyPI v0.17.1] https://pypi.org/project/dub/0.17.1 - .

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dub"
-version = "0.17.0"
+version = "0.17.1"
 description = "Python Client SDK Generated by Speakeasy"
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"

src/dub/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "dub"
-__version__: str = "0.17.0"
+__version__: str = "0.17.1"
 __openapi_doc_version__: str = "0.0.1"
 __gen_version__: str = "2.493.4"
-__user_agent__: str = "speakeasy-sdk/python 0.17.0 2.493.4 0.0.1 dub"
+__user_agent__: str = "speakeasy-sdk/python 0.17.1 2.493.4 0.0.1 dub"
 
 try:
     if __package__ is not None:

src/dub/models/operations/bulkcreatelinks.py

@@ -49,11 +49,11 @@ class RequestBodyTypedDict(TypedDict):
     prefix: NotRequired[str]
     r"""The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided."""
     track_conversion: NotRequired[bool]
-    r"""Whether to track conversions for the short link."""
+    r"""Whether to track conversions for the short link. Defaults to `false` if not provided."""
     archived: NotRequired[bool]
-    r"""Whether the short link is archived."""
+    r"""Whether the short link is archived. Defaults to `false` if not provided."""
     public_stats: NotRequired[bool]
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible."""
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
     tag_id: NotRequired[Nullable[str]]
     r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead."""
     tag_ids: NotRequired[BulkCreateLinksTagIdsTypedDict]
@@ -69,7 +69,7 @@ class RequestBodyTypedDict(TypedDict):
     password: NotRequired[Nullable[str]]
     r"""The password required to access the destination URL of the short link."""
     proxy: NotRequired[bool]
-    r"""Whether the short link uses Custom Social Media Cards feature."""
+    r"""Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided."""
     title: NotRequired[Nullable[str]]
     r"""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"""
     description: NotRequired[Nullable[str]]
@@ -79,7 +79,7 @@ class RequestBodyTypedDict(TypedDict):
     video: NotRequired[Nullable[str]]
     r"""The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og"""
     rewrite: NotRequired[bool]
-    r"""Whether the short link uses link cloaking."""
+    r"""Whether the short link uses link cloaking. Defaults to `false` if not provided."""
     ios: NotRequired[Nullable[str]]
     r"""The iOS destination URL for the short link for iOS device targeting."""
     android: NotRequired[Nullable[str]]
@@ -131,20 +131,20 @@ class RequestBody(BaseModel):
 
     track_conversion: Annotated[
         Optional[bool], pydantic.Field(alias="trackConversion")
-    ] = False
-    r"""Whether to track conversions for the short link."""
+    ] = None
+    r"""Whether to track conversions for the short link. Defaults to `false` if not provided."""
 
-    archived: Optional[bool] = False
-    r"""Whether the short link is archived."""
+    archived: Optional[bool] = None
+    r"""Whether the short link is archived. Defaults to `false` if not provided."""
 
     public_stats: Annotated[
         Optional[bool],
         pydantic.Field(
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
             alias="publicStats",
         ),
-    ] = False
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible."""
+    ] = None
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
 
     tag_id: Annotated[
         OptionalNullable[str],
@@ -181,8 +181,8 @@ class RequestBody(BaseModel):
     password: OptionalNullable[str] = UNSET
     r"""The password required to access the destination URL of the short link."""
 
-    proxy: Optional[bool] = False
-    r"""Whether the short link uses Custom Social Media Cards feature."""
+    proxy: Optional[bool] = None
+    r"""Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided."""
 
     title: OptionalNullable[str] = UNSET
     r"""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"""
@@ -196,8 +196,8 @@ class RequestBody(BaseModel):
     video: OptionalNullable[str] = UNSET
     r"""The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og"""
 
-    rewrite: Optional[bool] = False
-    r"""Whether the short link uses link cloaking."""
+    rewrite: Optional[bool] = None
+    r"""Whether the short link uses link cloaking. Defaults to `false` if not provided."""
 
     ios: OptionalNullable[str] = UNSET
     r"""The iOS destination URL for the short link for iOS device targeting."""
@@ -208,7 +208,7 @@ class RequestBody(BaseModel):
     geo: OptionalNullable[components_linkgeotargeting.LinkGeoTargeting] = UNSET
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`."""
 
-    do_index: Annotated[Optional[bool], pydantic.Field(alias="doIndex")] = False
+    do_index: Annotated[Optional[bool], pydantic.Field(alias="doIndex")] = None
     r"""Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex"""
 
     utm_source: OptionalNullable[str] = UNSET

src/dub/models/operations/bulkupdatelinks.py

@@ -37,11 +37,11 @@ class DataTypedDict(TypedDict):
     tenant_id: NotRequired[Nullable[str]]
     r"""The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant."""
     track_conversion: NotRequired[bool]
-    r"""Whether to track conversions for the short link."""
+    r"""Whether to track conversions for the short link. Defaults to `false` if not provided."""
     archived: NotRequired[bool]
-    r"""Whether the short link is archived."""
+    r"""Whether the short link is archived. Defaults to `false` if not provided."""
     public_stats: NotRequired[bool]
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible."""
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
     tag_id: NotRequired[Nullable[str]]
     r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead."""
     tag_ids: NotRequired[BulkUpdateLinksTagIdsTypedDict]
@@ -57,7 +57,7 @@ class DataTypedDict(TypedDict):
     password: NotRequired[Nullable[str]]
     r"""The password required to access the destination URL of the short link."""
     proxy: NotRequired[bool]
-    r"""Whether the short link uses Custom Social Media Cards feature."""
+    r"""Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided."""
     title: NotRequired[Nullable[str]]
     r"""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"""
     description: NotRequired[Nullable[str]]
@@ -67,7 +67,7 @@ class DataTypedDict(TypedDict):
     video: NotRequired[Nullable[str]]
     r"""The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og"""
     rewrite: NotRequired[bool]
-    r"""Whether the short link uses link cloaking."""
+    r"""Whether the short link uses link cloaking. Defaults to `false` if not provided."""
     ios: NotRequired[Nullable[str]]
     r"""The iOS destination URL for the short link for iOS device targeting."""
     android: NotRequired[Nullable[str]]
@@ -105,20 +105,20 @@ class Data(BaseModel):
 
     track_conversion: Annotated[
         Optional[bool], pydantic.Field(alias="trackConversion")
-    ] = False
-    r"""Whether to track conversions for the short link."""
+    ] = None
+    r"""Whether to track conversions for the short link. Defaults to `false` if not provided."""
 
-    archived: Optional[bool] = False
-    r"""Whether the short link is archived."""
+    archived: Optional[bool] = None
+    r"""Whether the short link is archived. Defaults to `false` if not provided."""
 
     public_stats: Annotated[
         Optional[bool],
         pydantic.Field(
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
             alias="publicStats",
         ),
-    ] = False
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible."""
+    ] = None
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
 
     tag_id: Annotated[
         OptionalNullable[str],
@@ -155,8 +155,8 @@ class Data(BaseModel):
     password: OptionalNullable[str] = UNSET
     r"""The password required to access the destination URL of the short link."""
 
-    proxy: Optional[bool] = False
-    r"""Whether the short link uses Custom Social Media Cards feature."""
+    proxy: Optional[bool] = None
+    r"""Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided."""
 
     title: OptionalNullable[str] = UNSET
     r"""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"""
@@ -170,8 +170,8 @@ class Data(BaseModel):
     video: OptionalNullable[str] = UNSET
     r"""The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og"""
 
-    rewrite: Optional[bool] = False
-    r"""Whether the short link uses link cloaking."""
+    rewrite: Optional[bool] = None
+    r"""Whether the short link uses link cloaking. Defaults to `false` if not provided."""
 
     ios: OptionalNullable[str] = UNSET
     r"""The iOS destination URL for the short link for iOS device targeting."""
@@ -182,7 +182,7 @@ class Data(BaseModel):
     geo: OptionalNullable[components_linkgeotargeting.LinkGeoTargeting] = UNSET
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`."""
 
-    do_index: Annotated[Optional[bool], pydantic.Field(alias="doIndex")] = False
+    do_index: Annotated[Optional[bool], pydantic.Field(alias="doIndex")] = None
     r"""Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex"""
 
     utm_source: OptionalNullable[str] = UNSET