diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 0b3f70a..1ff6b3d 100755 --- a/.speakeasy/gen.lock +++ b/.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 diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 8b62f1b..3be59c1 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -13,7 +13,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: false python: - version: 0.17.0 + version: 0.17.1 additionalDependencies: dev: {} main: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 0036478..dc15622 100644 --- a/.speakeasy/workflow.lock +++ b/.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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d585717 --- /dev/null +++ b/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 diff --git a/RELEASES.md b/RELEASES.md index f660fb3..03a4838 100644 --- a/RELEASES.md +++ b/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 - . \ No newline at end of file +- [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 - . \ No newline at end of file diff --git a/docs/models/operations/createlinkrequestbody.md b/docs/models/operations/createlinkrequestbody.md index a557bd4..2ba6ebc 100644 --- a/docs/models/operations/createlinkrequestbody.md +++ b/docs/models/operations/createlinkrequestbody.md @@ -3,39 +3,39 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *str* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | -| `domain` | *Optional[str]* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). | | -| `key` | *Optional[str]* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | -| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 | -| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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. | | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. | | -| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | -| `tag_ids` | [Optional[operations.TagIds]](../../models/operations/tagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tag_names` | [Optional[operations.TagNames]](../../models/operations/tagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | -| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | -| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | -| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | *str* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | +| `domain` | *Optional[str]* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). | | +| `key` | *Optional[str]* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 | +| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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. | | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. | | +| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | +| `tag_ids` | [Optional[operations.TagIds]](../../models/operations/tagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tag_names` | [Optional[operations.TagNames]](../../models/operations/tagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | +| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | +| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | +| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file diff --git a/docs/models/operations/data.md b/docs/models/operations/data.md index 901b24f..1ed8ea7 100644 --- a/docs/models/operations/data.md +++ b/docs/models/operations/data.md @@ -3,35 +3,35 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *Optional[str]* | :heavy_minus_sign: | The destination URL of the short link. | https://google.com | -| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. | | -| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | -| `tag_ids` | [Optional[operations.BulkUpdateLinksTagIds]](../../models/operations/bulkupdatelinkstagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tag_names` | [Optional[operations.BulkUpdateLinksTagNames]](../../models/operations/bulkupdatelinkstagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | -| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | -| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | -| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | *Optional[str]* | :heavy_minus_sign: | The destination URL of the short link. | https://google.com | +| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. | | +| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | +| `tag_ids` | [Optional[operations.BulkUpdateLinksTagIds]](../../models/operations/bulkupdatelinkstagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tag_names` | [Optional[operations.BulkUpdateLinksTagNames]](../../models/operations/bulkupdatelinkstagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | +| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | +| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | +| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file diff --git a/docs/models/operations/requestbody.md b/docs/models/operations/requestbody.md index 6b99087..8edc37f 100644 --- a/docs/models/operations/requestbody.md +++ b/docs/models/operations/requestbody.md @@ -3,39 +3,39 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *str* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | -| `domain` | *Optional[str]* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). | | -| `key` | *Optional[str]* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | -| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 | -| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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. | | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. | | -| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | -| `tag_ids` | [Optional[operations.BulkCreateLinksTagIds]](../../models/operations/bulkcreatelinkstagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tag_names` | [Optional[operations.BulkCreateLinksTagNames]](../../models/operations/bulkcreatelinkstagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | -| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | -| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | -| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | *str* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | +| `domain` | *Optional[str]* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). | | +| `key` | *Optional[str]* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 | +| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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. | | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. | | +| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | +| `tag_ids` | [Optional[operations.BulkCreateLinksTagIds]](../../models/operations/bulkcreatelinkstagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tag_names` | [Optional[operations.BulkCreateLinksTagNames]](../../models/operations/bulkcreatelinkstagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | +| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | +| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | +| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file diff --git a/docs/models/operations/updatelinkrequestbody.md b/docs/models/operations/updatelinkrequestbody.md index a92e457..5df11b9 100644 --- a/docs/models/operations/updatelinkrequestbody.md +++ b/docs/models/operations/updatelinkrequestbody.md @@ -3,39 +3,39 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *Optional[str]* | :heavy_minus_sign: | The destination URL of the short link. | https://google.com | -| `domain` | *Optional[str]* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). | | -| `key` | *Optional[str]* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | -| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 | -| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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. | | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. | | -| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | -| `tag_ids` | [Optional[operations.UpdateLinkTagIds]](../../models/operations/updatelinktagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tag_names` | [Optional[operations.UpdateLinkTagNames]](../../models/operations/updatelinktagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | -| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | -| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | -| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | *Optional[str]* | :heavy_minus_sign: | The destination URL of the short link. | https://google.com | +| `domain` | *Optional[str]* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). | | +| `key` | *Optional[str]* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 | +| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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. | | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. | | +| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | +| `tag_ids` | [Optional[operations.UpdateLinkTagIds]](../../models/operations/updatelinktagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tag_names` | [Optional[operations.UpdateLinkTagNames]](../../models/operations/updatelinktagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | +| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | +| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | +| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file diff --git a/docs/models/operations/upsertlinkrequestbody.md b/docs/models/operations/upsertlinkrequestbody.md index 4ffbfbc..b3d0817 100644 --- a/docs/models/operations/upsertlinkrequestbody.md +++ b/docs/models/operations/upsertlinkrequestbody.md @@ -3,39 +3,39 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *str* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | -| `domain` | *Optional[str]* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). | | -| `key` | *Optional[str]* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | -| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 | -| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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. | | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. | | -| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | -| `tag_ids` | [Optional[operations.UpsertLinkTagIds]](../../models/operations/upsertlinktagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tag_names` | [Optional[operations.UpsertLinkTagNames]](../../models/operations/upsertlinktagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | -| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | -| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | -| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | -| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | *str* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | +| `domain` | *Optional[str]* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). | | +| `key` | *Optional[str]* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 | +| `tenant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | 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. | | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | 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` | *Optional[bool]* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`public_stats`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. | | +| ~~`tag_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. | | +| `tag_ids` | [Optional[operations.UpsertLinkTagIds]](../../models/operations/upsertlinktagids.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tag_names` | [Optional[operations.UpsertLinkTagNames]](../../models/operations/upsertlinktagnames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `comments` | *OptionalNullable[str]* | :heavy_minus_sign: | The comments for the short link. | | +| `expires_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expired_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `proxy` | *Optional[bool]* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og | | +| `video` | *OptionalNullable[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `ios` | *OptionalNullable[str]* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *OptionalNullable[str]* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [OptionalNullable[components.LinkGeoTargeting]](../../models/components/linkgeotargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `do_index` | *Optional[bool]* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `utm_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utm_medium` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utm_campaign` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utm_term` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utm_content` | *OptionalNullable[str]* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | +| `ref` | *OptionalNullable[str]* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | +| `program_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhook_ids` | List[*str*] | :heavy_minus_sign: | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data. | | \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index ffd99e1..fde19be 100644 --- a/pyproject.toml +++ b/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" diff --git a/src/dub/_version.py b/src/dub/_version.py index 6b408d7..5c5a29b 100644 --- a/src/dub/_version.py +++ b/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: diff --git a/src/dub/models/operations/bulkcreatelinks.py b/src/dub/models/operations/bulkcreatelinks.py index 99e298b..228e198 100644 --- a/src/dub/models/operations/bulkcreatelinks.py +++ b/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,11 +131,11 @@ 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], @@ -143,8 +143,8 @@ class RequestBody(BaseModel): 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 diff --git a/src/dub/models/operations/bulkupdatelinks.py b/src/dub/models/operations/bulkupdatelinks.py index a98c3de..8c0b43f 100644 --- a/src/dub/models/operations/bulkupdatelinks.py +++ b/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,11 +105,11 @@ 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], @@ -117,8 +117,8 @@ class Data(BaseModel): 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 diff --git a/src/dub/models/operations/createlink.py b/src/dub/models/operations/createlink.py index adf73f7..a65b529 100644 --- a/src/dub/models/operations/createlink.py +++ b/src/dub/models/operations/createlink.py @@ -39,11 +39,11 @@ class CreateLinkRequestBodyTypedDict(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[TagIdsTypedDict] @@ -59,7 +59,7 @@ class CreateLinkRequestBodyTypedDict(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]] @@ -69,7 +69,7 @@ class CreateLinkRequestBodyTypedDict(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]] @@ -121,11 +121,11 @@ class CreateLinkRequestBody(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], @@ -133,8 +133,8 @@ class CreateLinkRequestBody(BaseModel): 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], @@ -167,8 +167,8 @@ class CreateLinkRequestBody(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""" @@ -182,8 +182,8 @@ class CreateLinkRequestBody(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.""" @@ -194,7 +194,7 @@ class CreateLinkRequestBody(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 diff --git a/src/dub/models/operations/updatelink.py b/src/dub/models/operations/updatelink.py index f1aaf84..2d9e623 100644 --- a/src/dub/models/operations/updatelink.py +++ b/src/dub/models/operations/updatelink.py @@ -44,11 +44,11 @@ class UpdateLinkRequestBodyTypedDict(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[UpdateLinkTagIdsTypedDict] @@ -64,7 +64,7 @@ class UpdateLinkRequestBodyTypedDict(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]] @@ -74,7 +74,7 @@ class UpdateLinkRequestBodyTypedDict(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]] @@ -126,11 +126,11 @@ class UpdateLinkRequestBody(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], @@ -138,8 +138,8 @@ class UpdateLinkRequestBody(BaseModel): 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], @@ -176,8 +176,8 @@ class UpdateLinkRequestBody(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""" @@ -191,8 +191,8 @@ class UpdateLinkRequestBody(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.""" @@ -203,7 +203,7 @@ class UpdateLinkRequestBody(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 diff --git a/src/dub/models/operations/upsertlink.py b/src/dub/models/operations/upsertlink.py index b66b663..5cd1983 100644 --- a/src/dub/models/operations/upsertlink.py +++ b/src/dub/models/operations/upsertlink.py @@ -43,11 +43,11 @@ class UpsertLinkRequestBodyTypedDict(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[UpsertLinkTagIdsTypedDict] @@ -63,7 +63,7 @@ class UpsertLinkRequestBodyTypedDict(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]] @@ -73,7 +73,7 @@ class UpsertLinkRequestBodyTypedDict(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]] @@ -125,11 +125,11 @@ class UpsertLinkRequestBody(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], @@ -137,8 +137,8 @@ class UpsertLinkRequestBody(BaseModel): 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], @@ -175,8 +175,8 @@ class UpsertLinkRequestBody(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""" @@ -190,8 +190,8 @@ class UpsertLinkRequestBody(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.""" @@ -202,7 +202,7 @@ class UpsertLinkRequestBody(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