From 6b1fb0423d27b4b333115a6926a5be1162637ff3 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 14 Jan 2025 04:33:45 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.468.4 --- .speakeasy/gen.lock | 10 +- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 14 +- CONTRIBUTING.md | 26 ++++ README.md | 47 +++++++ RELEASES.md | 12 +- .../Operations/CreateLinkRequestBody.md | 72 +++++----- docs/Models/Operations/Data.md | 64 ++++----- docs/Models/Operations/RequestBody.md | 72 +++++----- .../Operations/UpdateLinkRequestBody.md | 72 +++++----- .../Operations/UpsertLinkRequestBody.md | 72 +++++----- .../Operations/CreateLinkRequestBody.php | 124 +++++++++--------- src/Models/Operations/Data.php | 124 +++++++++--------- src/Models/Operations/RequestBody.php | 124 +++++++++--------- .../Operations/UpdateLinkRequestBody.php | 124 +++++++++--------- .../Operations/UpsertLinkRequestBody.php | 124 +++++++++--------- src/SDKConfiguration.php | 6 +- 17 files changed, 586 insertions(+), 503 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 70160b7..1983d80 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 43187d3e-7c3c-4c11-b5d4-4b2334fb6d96 management: - docChecksum: a6a1e65c1a9ddd2d1b445252e12b8157 + docChecksum: 0c06ef8b2bdec6b49e32f18c56e32ee4 docVersion: 0.0.1 - speakeasyVersion: 1.468.2 - generationVersion: 2.493.4 - releaseVersion: 0.11.13 - configChecksum: 481be501d2f37979cdf2544785028b08 + speakeasyVersion: 1.468.4 + generationVersion: 2.493.10 + releaseVersion: 0.11.14 + configChecksum: e772e6603a5d9076f2d1b1acd0157cc6 repoURL: https://github.com/dubinc/dub-php.git installationURL: https://github.com/dubinc/dub-php published: true diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 5d7f243..d705556 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -13,7 +13,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: false php: - version: 0.11.13 + version: 0.11.14 additionalDependencies: autoload: {} autoload-dev: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 7a91c3b..cedb60b 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.468.2 +speakeasyVersion: 1.468.4 sources: dub: sourceNamespace: dub - sourceRevisionDigest: sha256:43c54b15d5e3b8dbfdf06770fa74bdd295946eeddb65091ec1ad855898d1c450 - sourceBlobDigest: sha256:e455cd12338a6074213fe801f891abdf883b45dae8c4f90f6ac421ee4b3c4449 + sourceRevisionDigest: sha256:d48d5f07831570587e2a2d687a6ce335f00b19323a111ae7362cff54bc11f2a6 + sourceBlobDigest: sha256:95e092e1faeefc534d84f8dc5a72fd5c0ddbda08a02ae70b6246d5fdc0e8fea6 tags: - latest - - speakeasy-sdk-regen-1736295578 + - speakeasy-sdk-regen-1736829146 - 0.0.1 targets: my-first-target: source: dub sourceNamespace: dub - sourceRevisionDigest: sha256:43c54b15d5e3b8dbfdf06770fa74bdd295946eeddb65091ec1ad855898d1c450 - sourceBlobDigest: sha256:e455cd12338a6074213fe801f891abdf883b45dae8c4f90f6ac421ee4b3c4449 + sourceRevisionDigest: sha256:d48d5f07831570587e2a2d687a6ce335f00b19323a111ae7362cff54bc11f2a6 + sourceBlobDigest: sha256:95e092e1faeefc534d84f8dc5a72fd5c0ddbda08a02ae70b6246d5fdc0e8fea6 codeSamplesNamespace: code-samples-php-my-first-target - codeSamplesRevisionDigest: sha256:1adcfada46e7f4118ceb2849f172f61931d78065f3db63da652238f4566a8e13 + codeSamplesRevisionDigest: sha256:7ecc9e5d3c43e4a5ea1743ed096ebc2240ca561ac86f718416d0f652371730eb 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/README.md b/README.md index 735bc87..d88bd74 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Dub.co API: Dub is link management infrastructure for companies to create market * [dub/dub-php](#dubdub-php) * [SDK Installation](#sdk-installation) * [SDK Example Usage](#sdk-example-usage) + * [Authentication](#authentication) * [Available Resources and Operations](#available-resources-and-operations) * [Pagination](#pagination) * [Error Handling](#error-handling) @@ -110,6 +111,52 @@ if ($response->linkSchema !== null) { ``` + +## Authentication + +### Per-Client Security Schemes + +This SDK supports the following security scheme globally: + +| Name | Type | Scheme | +| ------- | ---- | ----------- | +| `token` | http | HTTP Bearer | + +To authenticate with the API the `token` parameter must be set when initializing the SDK. For example: +```php +declare(strict_types=1); + +require 'vendor/autoload.php'; + +use Dub; +use Dub\Models\Operations; + +$sdk = Dub\Dub::builder() + ->setSecurity( + 'DUB_API_KEY' + ) + ->build(); + +$request = [ + new Operations\RequestBody( + url: 'https://google.com', + tagIds: [ + 'clux0rgak00011...', + ], + externalId: '123456', + ), +]; + +$response = $sdk->links->createMany( + request: $request +); + +if ($response->responseBodies !== null) { + // handle response +} +``` + + ## Available Resources and Operations diff --git a/RELEASES.md b/RELEASES.md index 5d8f8ab..ab8e003 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -580,4 +580,14 @@ Based on: ### Generated - [php v0.11.13] . ### Releases -- [Composer v0.11.13] https://packagist.org/packages/dub/dub-php#v0.11.13 - . \ No newline at end of file +- [Composer v0.11.13] https://packagist.org/packages/dub/dub-php#v0.11.13 - . + +## 2025-01-14 04:32:11 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.468.4 (2.493.10) https://github.com/speakeasy-api/speakeasy +### Generated +- [php v0.11.14] . +### Releases +- [Composer v0.11.14] https://packagist.org/packages/dub/dub-php#v0.11.14 - . \ No newline at end of file diff --git a/docs/Models/Operations/CreateLinkRequestBody.md b/docs/Models/Operations/CreateLinkRequestBody.md index 2643bb0..3eb7815 100644 --- a/docs/Models/Operations/CreateLinkRequestBody.md +++ b/docs/Models/Operations/CreateLinkRequestBody.md @@ -3,39 +3,39 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | -| `domain` | *?string* | :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` | *?string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | -| `prefix` | *?string* | :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. | | -| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`publicStats`~~ | *?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. | | -| `tagIds` | [string\|array\|null](../../Models/Operations/TagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tagNames` | [string\|array\|null](../../Models/Operations/TagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `externalId` | *?string* | :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 | -| `tenantId` | *?string* | :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. | | -| ~~`tagId`~~ | *?string* | :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. | | -| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | -| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | -| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utmContent` | *?string* | :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` | *?string* | :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. | | -| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhookIds` | array<*string*> | :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` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | +| `domain` | *?string* | :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` | *?string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | +| `prefix` | *?string* | :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. | | +| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`publicStats`~~ | *?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. | | +| `tagIds` | [string\|array\|null](../../Models/Operations/TagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tagNames` | [string\|array\|null](../../Models/Operations/TagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `externalId` | *?string* | :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 | +| `tenantId` | *?string* | :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. | | +| ~~`tagId`~~ | *?string* | :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. | | +| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | +| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | +| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utmContent` | *?string* | :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` | *?string* | :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. | | +| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhookIds` | array<*string*> | :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 4ad0bfa..4855226 100644 --- a/docs/Models/Operations/Data.md +++ b/docs/Models/Operations/Data.md @@ -3,35 +3,35 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *?string* | :heavy_minus_sign: | The destination URL of the short link. | https://google.com | -| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`publicStats`~~ | *?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. | | -| `tagIds` | [string\|array\|null](../../Models/Operations/BulkUpdateLinksTagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tagNames` | [string\|array\|null](../../Models/Operations/BulkUpdateLinksTagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `tenantId` | *?string* | :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. | | -| ~~`tagId`~~ | *?string* | :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. | | -| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | -| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | -| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utmContent` | *?string* | :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` | *?string* | :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. | | -| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhookIds` | array<*string*> | :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` | *?string* | :heavy_minus_sign: | The destination URL of the short link. | https://google.com | +| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`publicStats`~~ | *?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. | | +| `tagIds` | [string\|array\|null](../../Models/Operations/BulkUpdateLinksTagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tagNames` | [string\|array\|null](../../Models/Operations/BulkUpdateLinksTagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `tenantId` | *?string* | :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. | | +| ~~`tagId`~~ | *?string* | :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. | | +| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | +| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | +| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utmContent` | *?string* | :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` | *?string* | :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. | | +| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhookIds` | array<*string*> | :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 7e3c217..9ce0c91 100644 --- a/docs/Models/Operations/RequestBody.md +++ b/docs/Models/Operations/RequestBody.md @@ -3,39 +3,39 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | -| `domain` | *?string* | :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` | *?string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | -| `prefix` | *?string* | :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. | | -| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`publicStats`~~ | *?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. | | -| `tagIds` | [string\|array\|null](../../Models/Operations/BulkCreateLinksTagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tagNames` | [string\|array\|null](../../Models/Operations/BulkCreateLinksTagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `externalId` | *?string* | :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 | -| `tenantId` | *?string* | :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. | | -| ~~`tagId`~~ | *?string* | :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. | | -| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | -| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | -| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utmContent` | *?string* | :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` | *?string* | :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. | | -| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhookIds` | array<*string*> | :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` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | +| `domain` | *?string* | :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` | *?string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | +| `prefix` | *?string* | :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. | | +| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`publicStats`~~ | *?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. | | +| `tagIds` | [string\|array\|null](../../Models/Operations/BulkCreateLinksTagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tagNames` | [string\|array\|null](../../Models/Operations/BulkCreateLinksTagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `externalId` | *?string* | :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 | +| `tenantId` | *?string* | :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. | | +| ~~`tagId`~~ | *?string* | :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. | | +| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | +| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | +| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utmContent` | *?string* | :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` | *?string* | :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. | | +| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhookIds` | array<*string*> | :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 9afd318..ca90480 100644 --- a/docs/Models/Operations/UpdateLinkRequestBody.md +++ b/docs/Models/Operations/UpdateLinkRequestBody.md @@ -3,39 +3,39 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *?string* | :heavy_minus_sign: | The destination URL of the short link. | https://google.com | -| `domain` | *?string* | :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` | *?string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | -| `prefix` | *?string* | :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. | | -| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`publicStats`~~ | *?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. | | -| `tagIds` | [string\|array\|null](../../Models/Operations/UpdateLinkTagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tagNames` | [string\|array\|null](../../Models/Operations/UpdateLinkTagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `externalId` | *?string* | :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 | -| `tenantId` | *?string* | :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. | | -| ~~`tagId`~~ | *?string* | :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. | | -| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | -| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | -| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utmContent` | *?string* | :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` | *?string* | :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. | | -| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhookIds` | array<*string*> | :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` | *?string* | :heavy_minus_sign: | The destination URL of the short link. | https://google.com | +| `domain` | *?string* | :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` | *?string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | +| `prefix` | *?string* | :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. | | +| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`publicStats`~~ | *?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. | | +| `tagIds` | [string\|array\|null](../../Models/Operations/UpdateLinkTagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tagNames` | [string\|array\|null](../../Models/Operations/UpdateLinkTagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `externalId` | *?string* | :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 | +| `tenantId` | *?string* | :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. | | +| ~~`tagId`~~ | *?string* | :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. | | +| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | +| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | +| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utmContent` | *?string* | :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` | *?string* | :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. | | +| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhookIds` | array<*string*> | :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 68001e8..2b4918e 100644 --- a/docs/Models/Operations/UpsertLinkRequestBody.md +++ b/docs/Models/Operations/UpsertLinkRequestBody.md @@ -3,39 +3,39 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | -| `domain` | *?string* | :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` | *?string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | -| `prefix` | *?string* | :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. | | -| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. | | -| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. | | -| ~~`publicStats`~~ | *?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. | | -| `tagIds` | [string\|array\|null](../../Models/Operations/UpsertLinkTagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | -| `tagNames` | [string\|array\|null](../../Models/Operations/UpsertLinkTagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | -| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. | | -| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. | | -| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | -| `externalId` | *?string* | :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 | -| `tenantId` | *?string* | :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. | | -| ~~`tagId`~~ | *?string* | :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. | | -| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | -| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | -| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | -| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | -| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | -| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | -| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | -| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | -| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | -| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | -| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | -| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | -| `utmContent` | *?string* | :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` | *?string* | :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. | | -| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | -| `webhookIds` | array<*string*> | :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` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google.com | +| `domain` | *?string* | :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` | *?string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. | | +| `prefix` | *?string* | :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. | | +| `trackConversion` | *?bool* | :heavy_minus_sign: | Whether to track conversions for the short link. Defaults to `false` if not provided. | | +| `archived` | *?bool* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| ~~`publicStats`~~ | *?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. | | +| `tagIds` | [string\|array\|null](../../Models/Operations/UpsertLinkTagIds.md) | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tagNames` | [string\|array\|null](../../Models/Operations/UpsertLinkTagNames.md) | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `proxy` | *?bool* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `rewrite` | *?bool* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `doIndex` | *?bool* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `externalId` | *?string* | :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 | +| `tenantId` | *?string* | :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. | | +| ~~`tagId`~~ | *?string* | :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. | | +| `comments` | *?string* | :heavy_minus_sign: | The comments for the short link. | | +| `expiresAt` | *?string* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expiredUrl` | *?string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *?string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `title` | *?string* | :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` | *?string* | :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` | *?string* | :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` | *?string* | :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 | | +| `ios` | *?string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *?string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `geo` | [?Components\LinkGeoTargeting](../../Models/Components/LinkGeoTargeting.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. | | +| `utmSource` | *?string* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utmMedium` | *?string* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utmCampaign` | *?string* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utmTerm` | *?string* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utmContent` | *?string* | :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` | *?string* | :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. | | +| `programId` | *?string* | :heavy_minus_sign: | The ID of the program the short link is associated with. | | +| `webhookIds` | array<*string*> | :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/src/Models/Operations/CreateLinkRequestBody.php b/src/Models/Operations/CreateLinkRequestBody.php index 4fffe3e..272abd4 100644 --- a/src/Models/Operations/CreateLinkRequestBody.php +++ b/src/Models/Operations/CreateLinkRequestBody.php @@ -46,6 +46,34 @@ class CreateLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?string $prefix = null; + /** + * Whether to track conversions for the short link. Defaults to `false` if not provided. + * + * @var ?bool $trackConversion + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $trackConversion = null; + + /** + * Whether the short link is archived. Defaults to `false` if not provided. + * + * @var ?bool $archived + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $archived = null; + + /** + * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. + * + * @var ?bool $publicStats + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $publicStats = null; + /** * The unique IDs of the tags assigned to the short link. * @@ -66,6 +94,33 @@ class CreateLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public string|array|null $tagNames = null; + /** + * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. + * + * @var ?bool $proxy + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $proxy = null; + + /** + * Whether the short link uses link cloaking. Defaults to `false` if not provided. + * + * @var ?bool $rewrite + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $rewrite = null; + + /** + * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex + * + * @var ?bool $doIndex + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $doIndex = null; + /** * 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. * @@ -267,61 +322,6 @@ class CreateLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?array $webhookIds = null; - /** - * Whether to track conversions for the short link. - * - * @var ?bool $trackConversion - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $trackConversion = null; - - /** - * Whether the short link is archived. - * - * @var ?bool $archived - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $archived = null; - - /** - * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. - * - * @var ?bool $publicStats - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $publicStats = null; - - /** - * Whether the short link uses Custom Social Media Cards feature. - * - * @var ?bool $proxy - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $proxy = null; - - /** - * Whether the short link uses link cloaking. - * - * @var ?bool $rewrite - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $rewrite = null; - - /** - * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex - * - * @var ?bool $doIndex - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $doIndex = null; - /** * @param string $url * @param ?string $domain @@ -358,14 +358,20 @@ class CreateLinkRequestBody * @param ?string $programId * @param ?array $webhookIds */ - public function __construct(string $url, ?string $domain = null, ?string $key = null, ?string $prefix = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?string $externalId = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null, ?bool $trackConversion = false, ?bool $archived = false, ?bool $publicStats = false, ?bool $proxy = false, ?bool $rewrite = false, ?bool $doIndex = false) + public function __construct(string $url, ?string $domain = null, ?string $key = null, ?string $prefix = null, ?bool $trackConversion = null, ?bool $archived = null, ?bool $publicStats = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?bool $proxy = null, ?bool $rewrite = null, ?bool $doIndex = null, ?string $externalId = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null) { $this->url = $url; $this->domain = $domain; $this->key = $key; $this->prefix = $prefix; + $this->trackConversion = $trackConversion; + $this->archived = $archived; + $this->publicStats = $publicStats; $this->tagIds = $tagIds; $this->tagNames = $tagNames; + $this->proxy = $proxy; + $this->rewrite = $rewrite; + $this->doIndex = $doIndex; $this->externalId = $externalId; $this->tenantId = $tenantId; $this->tagId = $tagId; @@ -388,11 +394,5 @@ public function __construct(string $url, ?string $domain = null, ?string $key = $this->ref = $ref; $this->programId = $programId; $this->webhookIds = $webhookIds; - $this->trackConversion = $trackConversion; - $this->archived = $archived; - $this->publicStats = $publicStats; - $this->proxy = $proxy; - $this->rewrite = $rewrite; - $this->doIndex = $doIndex; } } \ No newline at end of file diff --git a/src/Models/Operations/Data.php b/src/Models/Operations/Data.php index ad39ef9..1df9e02 100644 --- a/src/Models/Operations/Data.php +++ b/src/Models/Operations/Data.php @@ -20,6 +20,34 @@ class Data #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?string $url = null; + /** + * Whether to track conversions for the short link. Defaults to `false` if not provided. + * + * @var ?bool $trackConversion + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $trackConversion = null; + + /** + * Whether the short link is archived. Defaults to `false` if not provided. + * + * @var ?bool $archived + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $archived = null; + + /** + * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. + * + * @var ?bool $publicStats + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $publicStats = null; + /** * The unique IDs of the tags assigned to the short link. * @@ -40,6 +68,33 @@ class Data #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public string|array|null $tagNames = null; + /** + * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. + * + * @var ?bool $proxy + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $proxy = null; + + /** + * Whether the short link uses link cloaking. Defaults to `false` if not provided. + * + * @var ?bool $rewrite + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $rewrite = null; + + /** + * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex + * + * @var ?bool $doIndex + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $doIndex = null; + /** * 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. * @@ -232,61 +287,6 @@ class Data #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?array $webhookIds = null; - /** - * Whether to track conversions for the short link. - * - * @var ?bool $trackConversion - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $trackConversion = null; - - /** - * Whether the short link is archived. - * - * @var ?bool $archived - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $archived = null; - - /** - * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. - * - * @var ?bool $publicStats - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $publicStats = null; - - /** - * Whether the short link uses Custom Social Media Cards feature. - * - * @var ?bool $proxy - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $proxy = null; - - /** - * Whether the short link uses link cloaking. - * - * @var ?bool $rewrite - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $rewrite = null; - - /** - * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex - * - * @var ?bool $doIndex - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $doIndex = null; - /** * @param ?string $url * @param ?bool $trackConversion @@ -319,11 +319,17 @@ class Data * @param ?string $programId * @param ?array $webhookIds */ - public function __construct(?string $url = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null, ?bool $trackConversion = false, ?bool $archived = false, ?bool $publicStats = false, ?bool $proxy = false, ?bool $rewrite = false, ?bool $doIndex = false) + public function __construct(?string $url = null, ?bool $trackConversion = null, ?bool $archived = null, ?bool $publicStats = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?bool $proxy = null, ?bool $rewrite = null, ?bool $doIndex = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null) { $this->url = $url; + $this->trackConversion = $trackConversion; + $this->archived = $archived; + $this->publicStats = $publicStats; $this->tagIds = $tagIds; $this->tagNames = $tagNames; + $this->proxy = $proxy; + $this->rewrite = $rewrite; + $this->doIndex = $doIndex; $this->tenantId = $tenantId; $this->tagId = $tagId; $this->comments = $comments; @@ -345,11 +351,5 @@ public function __construct(?string $url = null, string|array|null $tagIds = nul $this->ref = $ref; $this->programId = $programId; $this->webhookIds = $webhookIds; - $this->trackConversion = $trackConversion; - $this->archived = $archived; - $this->publicStats = $publicStats; - $this->proxy = $proxy; - $this->rewrite = $rewrite; - $this->doIndex = $doIndex; } } \ No newline at end of file diff --git a/src/Models/Operations/RequestBody.php b/src/Models/Operations/RequestBody.php index b658773..852a28f 100644 --- a/src/Models/Operations/RequestBody.php +++ b/src/Models/Operations/RequestBody.php @@ -46,6 +46,34 @@ class RequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?string $prefix = null; + /** + * Whether to track conversions for the short link. Defaults to `false` if not provided. + * + * @var ?bool $trackConversion + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $trackConversion = null; + + /** + * Whether the short link is archived. Defaults to `false` if not provided. + * + * @var ?bool $archived + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $archived = null; + + /** + * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. + * + * @var ?bool $publicStats + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $publicStats = null; + /** * The unique IDs of the tags assigned to the short link. * @@ -66,6 +94,33 @@ class RequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public string|array|null $tagNames = null; + /** + * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. + * + * @var ?bool $proxy + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $proxy = null; + + /** + * Whether the short link uses link cloaking. Defaults to `false` if not provided. + * + * @var ?bool $rewrite + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $rewrite = null; + + /** + * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex + * + * @var ?bool $doIndex + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $doIndex = null; + /** * 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. * @@ -267,61 +322,6 @@ class RequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?array $webhookIds = null; - /** - * Whether to track conversions for the short link. - * - * @var ?bool $trackConversion - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $trackConversion = null; - - /** - * Whether the short link is archived. - * - * @var ?bool $archived - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $archived = null; - - /** - * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. - * - * @var ?bool $publicStats - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $publicStats = null; - - /** - * Whether the short link uses Custom Social Media Cards feature. - * - * @var ?bool $proxy - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $proxy = null; - - /** - * Whether the short link uses link cloaking. - * - * @var ?bool $rewrite - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $rewrite = null; - - /** - * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex - * - * @var ?bool $doIndex - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $doIndex = null; - /** * @param string $url * @param ?string $domain @@ -358,14 +358,20 @@ class RequestBody * @param ?string $programId * @param ?array $webhookIds */ - public function __construct(string $url, ?string $domain = null, ?string $key = null, ?string $prefix = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?string $externalId = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null, ?bool $trackConversion = false, ?bool $archived = false, ?bool $publicStats = false, ?bool $proxy = false, ?bool $rewrite = false, ?bool $doIndex = false) + public function __construct(string $url, ?string $domain = null, ?string $key = null, ?string $prefix = null, ?bool $trackConversion = null, ?bool $archived = null, ?bool $publicStats = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?bool $proxy = null, ?bool $rewrite = null, ?bool $doIndex = null, ?string $externalId = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null) { $this->url = $url; $this->domain = $domain; $this->key = $key; $this->prefix = $prefix; + $this->trackConversion = $trackConversion; + $this->archived = $archived; + $this->publicStats = $publicStats; $this->tagIds = $tagIds; $this->tagNames = $tagNames; + $this->proxy = $proxy; + $this->rewrite = $rewrite; + $this->doIndex = $doIndex; $this->externalId = $externalId; $this->tenantId = $tenantId; $this->tagId = $tagId; @@ -388,11 +394,5 @@ public function __construct(string $url, ?string $domain = null, ?string $key = $this->ref = $ref; $this->programId = $programId; $this->webhookIds = $webhookIds; - $this->trackConversion = $trackConversion; - $this->archived = $archived; - $this->publicStats = $publicStats; - $this->proxy = $proxy; - $this->rewrite = $rewrite; - $this->doIndex = $doIndex; } } \ No newline at end of file diff --git a/src/Models/Operations/UpdateLinkRequestBody.php b/src/Models/Operations/UpdateLinkRequestBody.php index cc7707e..4bf1fbe 100644 --- a/src/Models/Operations/UpdateLinkRequestBody.php +++ b/src/Models/Operations/UpdateLinkRequestBody.php @@ -47,6 +47,34 @@ class UpdateLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?string $prefix = null; + /** + * Whether to track conversions for the short link. Defaults to `false` if not provided. + * + * @var ?bool $trackConversion + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $trackConversion = null; + + /** + * Whether the short link is archived. Defaults to `false` if not provided. + * + * @var ?bool $archived + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $archived = null; + + /** + * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. + * + * @var ?bool $publicStats + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $publicStats = null; + /** * The unique IDs of the tags assigned to the short link. * @@ -67,6 +95,33 @@ class UpdateLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public string|array|null $tagNames = null; + /** + * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. + * + * @var ?bool $proxy + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $proxy = null; + + /** + * Whether the short link uses link cloaking. Defaults to `false` if not provided. + * + * @var ?bool $rewrite + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $rewrite = null; + + /** + * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex + * + * @var ?bool $doIndex + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $doIndex = null; + /** * 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. * @@ -268,61 +323,6 @@ class UpdateLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?array $webhookIds = null; - /** - * Whether to track conversions for the short link. - * - * @var ?bool $trackConversion - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $trackConversion = null; - - /** - * Whether the short link is archived. - * - * @var ?bool $archived - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $archived = null; - - /** - * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. - * - * @var ?bool $publicStats - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $publicStats = null; - - /** - * Whether the short link uses Custom Social Media Cards feature. - * - * @var ?bool $proxy - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $proxy = null; - - /** - * Whether the short link uses link cloaking. - * - * @var ?bool $rewrite - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $rewrite = null; - - /** - * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex - * - * @var ?bool $doIndex - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $doIndex = null; - /** * @param ?string $url * @param ?string $domain @@ -359,14 +359,20 @@ class UpdateLinkRequestBody * @param ?string $programId * @param ?array $webhookIds */ - public function __construct(?string $url = null, ?string $domain = null, ?string $key = null, ?string $prefix = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?string $externalId = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null, ?bool $trackConversion = false, ?bool $archived = false, ?bool $publicStats = false, ?bool $proxy = false, ?bool $rewrite = false, ?bool $doIndex = false) + public function __construct(?string $url = null, ?string $domain = null, ?string $key = null, ?string $prefix = null, ?bool $trackConversion = null, ?bool $archived = null, ?bool $publicStats = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?bool $proxy = null, ?bool $rewrite = null, ?bool $doIndex = null, ?string $externalId = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null) { $this->url = $url; $this->domain = $domain; $this->key = $key; $this->prefix = $prefix; + $this->trackConversion = $trackConversion; + $this->archived = $archived; + $this->publicStats = $publicStats; $this->tagIds = $tagIds; $this->tagNames = $tagNames; + $this->proxy = $proxy; + $this->rewrite = $rewrite; + $this->doIndex = $doIndex; $this->externalId = $externalId; $this->tenantId = $tenantId; $this->tagId = $tagId; @@ -389,11 +395,5 @@ public function __construct(?string $url = null, ?string $domain = null, ?string $this->ref = $ref; $this->programId = $programId; $this->webhookIds = $webhookIds; - $this->trackConversion = $trackConversion; - $this->archived = $archived; - $this->publicStats = $publicStats; - $this->proxy = $proxy; - $this->rewrite = $rewrite; - $this->doIndex = $doIndex; } } \ No newline at end of file diff --git a/src/Models/Operations/UpsertLinkRequestBody.php b/src/Models/Operations/UpsertLinkRequestBody.php index f79a3ae..cd44577 100644 --- a/src/Models/Operations/UpsertLinkRequestBody.php +++ b/src/Models/Operations/UpsertLinkRequestBody.php @@ -46,6 +46,34 @@ class UpsertLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?string $prefix = null; + /** + * Whether to track conversions for the short link. Defaults to `false` if not provided. + * + * @var ?bool $trackConversion + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $trackConversion = null; + + /** + * Whether the short link is archived. Defaults to `false` if not provided. + * + * @var ?bool $archived + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $archived = null; + + /** + * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided. + * + * @var ?bool $publicStats + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $publicStats = null; + /** * The unique IDs of the tags assigned to the short link. * @@ -66,6 +94,33 @@ class UpsertLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public string|array|null $tagNames = null; + /** + * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. + * + * @var ?bool $proxy + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $proxy = null; + + /** + * Whether the short link uses link cloaking. Defaults to `false` if not provided. + * + * @var ?bool $rewrite + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $rewrite = null; + + /** + * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex + * + * @var ?bool $doIndex + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?bool $doIndex = null; + /** * 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. * @@ -267,61 +322,6 @@ class UpsertLinkRequestBody #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?array $webhookIds = null; - /** - * Whether to track conversions for the short link. - * - * @var ?bool $trackConversion - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('trackConversion')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $trackConversion = null; - - /** - * Whether the short link is archived. - * - * @var ?bool $archived - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('archived')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $archived = null; - - /** - * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. - * - * @var ?bool $publicStats - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('publicStats')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $publicStats = null; - - /** - * Whether the short link uses Custom Social Media Cards feature. - * - * @var ?bool $proxy - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('proxy')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $proxy = null; - - /** - * Whether the short link uses link cloaking. - * - * @var ?bool $rewrite - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('rewrite')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $rewrite = null; - - /** - * Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex - * - * @var ?bool $doIndex - */ - #[\Speakeasy\Serializer\Annotation\SerializedName('doIndex')] - #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?bool $doIndex = null; - /** * @param string $url * @param ?string $domain @@ -358,14 +358,20 @@ class UpsertLinkRequestBody * @param ?string $programId * @param ?array $webhookIds */ - public function __construct(string $url, ?string $domain = null, ?string $key = null, ?string $prefix = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?string $externalId = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null, ?bool $trackConversion = false, ?bool $archived = false, ?bool $publicStats = false, ?bool $proxy = false, ?bool $rewrite = false, ?bool $doIndex = false) + public function __construct(string $url, ?string $domain = null, ?string $key = null, ?string $prefix = null, ?bool $trackConversion = null, ?bool $archived = null, ?bool $publicStats = null, string|array|null $tagIds = null, string|array|null $tagNames = null, ?bool $proxy = null, ?bool $rewrite = null, ?bool $doIndex = null, ?string $externalId = null, ?string $tenantId = null, ?string $tagId = null, ?string $comments = null, ?string $expiresAt = null, ?string $expiredUrl = null, ?string $password = null, ?string $title = null, ?string $description = null, ?string $image = null, ?string $video = null, ?string $ios = null, ?string $android = null, ?Components\LinkGeoTargeting $geo = null, ?string $utmSource = null, ?string $utmMedium = null, ?string $utmCampaign = null, ?string $utmTerm = null, ?string $utmContent = null, ?string $ref = null, ?string $programId = null, ?array $webhookIds = null) { $this->url = $url; $this->domain = $domain; $this->key = $key; $this->prefix = $prefix; + $this->trackConversion = $trackConversion; + $this->archived = $archived; + $this->publicStats = $publicStats; $this->tagIds = $tagIds; $this->tagNames = $tagNames; + $this->proxy = $proxy; + $this->rewrite = $rewrite; + $this->doIndex = $doIndex; $this->externalId = $externalId; $this->tenantId = $tenantId; $this->tagId = $tagId; @@ -388,11 +394,5 @@ public function __construct(string $url, ?string $domain = null, ?string $key = $this->ref = $ref; $this->programId = $programId; $this->webhookIds = $webhookIds; - $this->trackConversion = $trackConversion; - $this->archived = $archived; - $this->publicStats = $publicStats; - $this->proxy = $proxy; - $this->rewrite = $rewrite; - $this->doIndex = $doIndex; } } \ No newline at end of file diff --git a/src/SDKConfiguration.php b/src/SDKConfiguration.php index dc6892e..90236d5 100644 --- a/src/SDKConfiguration.php +++ b/src/SDKConfiguration.php @@ -26,11 +26,11 @@ class SDKConfiguration public string $openapiDocVersion = '0.0.1'; - public string $sdkVersion = '0.11.13'; + public string $sdkVersion = '0.11.14'; - public string $genVersion = '2.493.4'; + public string $genVersion = '2.493.10'; - public string $userAgent = 'speakeasy-sdk/php 0.11.13 2.493.4 0.0.1 dub/dub-php'; + public string $userAgent = 'speakeasy-sdk/php 0.11.14 2.493.10 0.0.1 dub/dub-php'; public ?RetryConfig $retryConfig = null;