Merge pull request #87 from dubinc/speakeasy-sdk-regen-1713872275

chore: 🐝 Update SDK - Generate
This commit is contained in:
Steven Tey
2024-04-23 14:42:15 +03:00
committed by GitHub
39 changed files with 373 additions and 44 deletions

View File

@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: f28179cc-ef59-426d-9e85-60cec22fc642
management:
docChecksum: 03500a0abdb72263de22a886b05ac471
docChecksum: d13f5102cda97c578071c17197996172
docVersion: 0.0.1
speakeasyVersion: 1.269.1
generationVersion: 2.312.1
releaseVersion: 0.24.3
configChecksum: 3de5167144ac68b4c6110a2db8d72494
releaseVersion: 0.24.4
configChecksum: e898c52661b3e0d1837c6c2d8b801d02
repoURL: https://github.com/dubinc/dub-node.git
installationURL: https://github.com/dubinc/dub-node
published: true

View File

@@ -12,7 +12,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
typescript:
version: 0.24.3
version: 0.24.4
additionalDependencies:
dependencies: {}
devDependencies:

View File

@@ -47,6 +47,7 @@ const dub = new Dub({
async function run() {
const result = await dub.links.create({
url: "https://google/com",
externalId: "123456",
tagIds: ["clux0rgak00011..."],
tagNames: "<value>",
geo: {},

View File

@@ -147,3 +147,13 @@ Based on:
- [typescript v0.24.3] .
### Releases
- [NPM v0.24.3] https://www.npmjs.com/package/dub/v/0.24.3 - .
## 2024-04-23 11:37:53
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.269.1 (2.312.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.24.4] .
### Releases
- [NPM v0.24.4] https://www.npmjs.com/package/dub/v/0.24.4 - .

View File

@@ -10,6 +10,7 @@ const dub = new Dub({
async function run() {
const result = await dub.links.create({
url: "https://google/com",
externalId: "123456",
tagIds: ["clux0rgak00011..."],
tagNames: "<value>",
geo: {},

View File

@@ -8,6 +8,7 @@
| `id` | *string* | :heavy_check_mark: | The unique ID of the short link. |
| `domain` | *string* | :heavy_check_mark: | 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_check_mark: | The short link slug. If not provided, a random 7-character slug will be generated. |
| `externalId` | *string* | :heavy_check_mark: | This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter. |
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. |
| `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. |
| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time when the short link will expire in ISO-8601 format. |

View File

@@ -5,10 +5,11 @@
| 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. | |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter. | 123456 |
| `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. | |
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google/com |
| `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. | |
| `publicStats` | *boolean* | :heavy_minus_sign: | Whether the short link's stats are publicly accessible. | |
| ~~`tagId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the tag assigned to the short link. This field is deprecated use `tagIds` instead. | |

View File

@@ -5,10 +5,11 @@
| 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. | |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter. | 123456 |
| `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. | |
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google/com |
| `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. | |
| `publicStats` | *boolean* | :heavy_minus_sign: | Whether the short link's stats are publicly accessible. | |
| ~~`tagId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the tag assigned to the short link. This field is deprecated use `tagIds` instead. | |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetBrowserAnalyticsQueryParamInterval](../../models/operations/getbrowseranalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.GetBrowserAnalyticsQueryParamCountry](../../models/operations/getbrowseranalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetCityAnalyticsQueryParamInterval](../../models/operations/getcityanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.GetCityAnalyticsQueryParamCountry](../../models/operations/getcityanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.Interval](../../models/operations/interval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.Country](../../models/operations/country.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetCountryAnalyticsQueryParamInterval](../../models/operations/getcountryanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.GetCountryAnalyticsQueryParamCountry](../../models/operations/getcountryanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetDeviceAnalyticsQueryParamInterval](../../models/operations/getdeviceanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.GetDeviceAnalyticsQueryParamCountry](../../models/operations/getdeviceanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetOSAnalyticsQueryParamInterval](../../models/operations/getosanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.GetOSAnalyticsQueryParamCountry](../../models/operations/getosanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetRefererAnalyticsQueryParamInterval](../../models/operations/getrefereranalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.GetRefererAnalyticsQueryParamCountry](../../models/operations/getrefereranalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.QueryParamInterval](../../models/operations/queryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.QueryParamCountry](../../models/operations/queryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetTopLinksQueryParamInterval](../../models/operations/gettoplinksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.GetTopLinksQueryParamCountry](../../models/operations/gettoplinksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -7,6 +7,8 @@
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetTopURLsQueryParamInterval](../../models/operations/gettopurlsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
| `country` | [operations.GetTopURLsQueryParamCountry](../../models/operations/gettopurlsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |

View File

@@ -5,10 +5,11 @@
| 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. | |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter. | 123456 |
| `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. | |
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. | https://google/com |
| `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. | |
| `publicStats` | *boolean* | :heavy_minus_sign: | Whether the short link's stats are publicly accessible. | |
| ~~`tagId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the tag assigned to the short link. This field is deprecated use `tagIds` instead. | |

View File

@@ -84,6 +84,7 @@ const dub = new Dub({
async function run() {
const result = await dub.links.create({
url: "https://google/com",
externalId: "123456",
tagIds: [
"clux0rgak00011...",
],
@@ -253,6 +254,7 @@ async function run() {
const linkId = "<value>";
const requestBody = {
url: "https://google/com",
externalId: "123456",
tagIds: [
"clux0rgak00011...",
],
@@ -370,6 +372,7 @@ async function run() {
const result = await dub.links.createMany([
{
url: "https://google/com",
externalId: "123456",
tagIds: [
"clux0rgak00011...",
],

View File

@@ -2,7 +2,7 @@
{
"name": "dub",
"version": "0.24.3",
"version": "0.24.4",
"exports": {
".": "./src/index.ts",
"./models/errors": "./src/models/errors/index.ts",

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "dub",
"version": "0.24.3",
"version": "0.24.4",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "dub",
"version": "0.24.3",
"version": "0.24.4",
"devDependencies": {
"@types/jsonpath": "^0.2.4",
"@types/node": "^20.12.7",

View File

@@ -1,6 +1,6 @@
{
"name": "dub",
"version": "0.24.3",
"version": "0.24.4",
"author": "Dub",
"main": "./index.js",
"sideEffects": false,

View File

@@ -64,7 +64,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
export const SDK_METADATA = {
language: "typescript",
openapiDocVersion: "0.0.1",
sdkVersion: "0.24.3",
sdkVersion: "0.24.4",
genVersion: "2.312.1",
userAgent: "speakeasy-sdk/typescript 0.24.3 2.312.1 0.0.1 dub",
userAgent: "speakeasy-sdk/typescript 0.24.4 2.312.1 0.0.1 dub",
} as const;

View File

@@ -274,6 +274,10 @@ export type LinkSchema = {
* The short link slug. If not provided, a random 7-character slug will be generated.
*/
key: string;
/**
* This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId: string | null;
/**
* The destination URL of the short link.
*/
@@ -1935,6 +1939,7 @@ export namespace LinkSchema$ {
id: string;
domain: string;
key: string;
externalId: string | null;
url: string;
archived?: boolean | undefined;
expiresAt: string | null;
@@ -1973,6 +1978,7 @@ export namespace LinkSchema$ {
id: z.string(),
domain: z.string(),
key: z.string(),
externalId: z.nullable(z.string()),
url: z.string(),
archived: z.boolean().default(false),
expiresAt: z.nullable(
@@ -2015,6 +2021,7 @@ export namespace LinkSchema$ {
id: v.id,
domain: v.domain,
key: v.key,
externalId: v.externalId,
url: v.url,
archived: v.archived,
expiresAt: v.expiresAt,
@@ -2053,6 +2060,7 @@ export namespace LinkSchema$ {
id: string;
domain: string;
key: string;
externalId: string | null;
url: string;
archived: boolean;
expiresAt: string | null;
@@ -2091,6 +2099,7 @@ export namespace LinkSchema$ {
id: z.string(),
domain: z.string(),
key: z.string(),
externalId: z.nullable(z.string()),
url: z.string(),
archived: z.boolean().default(false),
expiresAt: z.nullable(z.date().transform((v) => v.toISOString())),
@@ -2128,6 +2137,7 @@ export namespace LinkSchema$ {
id: v.id,
domain: v.domain,
key: v.key,
externalId: v.externalId,
url: v.url,
archived: v.archived,
expiresAt: v.expiresAt,

View File

@@ -271,6 +271,10 @@ export type BulkCreateLinksGeo = {
};
export type RequestBody = {
/**
* The destination URL of the short link.
*/
url: string;
/**
* 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).
*/
@@ -279,14 +283,14 @@ export type RequestBody = {
* The short link slug. If not provided, a random 7-character slug will be generated.
*/
key?: string | undefined;
/**
* This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | null | undefined;
/**
* 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.
*/
prefix?: string | undefined;
/**
* The destination URL of the short link.
*/
url: string;
/**
* Whether the short link is archived.
*/
@@ -1913,10 +1917,11 @@ export namespace BulkCreateLinksGeo$ {
/** @internal */
export namespace RequestBody$ {
export type Inbound = {
url: string;
domain?: string | undefined;
key?: string | undefined;
externalId?: string | null | undefined;
prefix?: string | undefined;
url: string;
archived?: boolean | undefined;
publicStats?: boolean | undefined;
tagId?: string | null | undefined;
@@ -1938,10 +1943,11 @@ export namespace RequestBody$ {
export const inboundSchema: z.ZodType<RequestBody, z.ZodTypeDef, Inbound> = z
.object({
url: z.string(),
domain: z.string().optional(),
key: z.string().optional(),
externalId: z.nullable(z.string()).optional(),
prefix: z.string().optional(),
url: z.string(),
archived: z.boolean().default(false),
publicStats: z.boolean().default(false),
tagId: z.nullable(z.string()).optional(),
@@ -1962,10 +1968,11 @@ export namespace RequestBody$ {
})
.transform((v) => {
return {
url: v.url,
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.prefix === undefined ? null : { prefix: v.prefix }),
url: v.url,
archived: v.archived,
publicStats: v.publicStats,
...(v.tagId === undefined ? null : { tagId: v.tagId }),
@@ -1987,10 +1994,11 @@ export namespace RequestBody$ {
});
export type Outbound = {
url: string;
domain?: string | undefined;
key?: string | undefined;
externalId?: string | null | undefined;
prefix?: string | undefined;
url: string;
archived: boolean;
publicStats: boolean;
tagId?: string | null | undefined;
@@ -2012,10 +2020,11 @@ export namespace RequestBody$ {
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, RequestBody> = z
.object({
url: z.string(),
domain: z.string().optional(),
key: z.string().optional(),
externalId: z.nullable(z.string()).optional(),
prefix: z.string().optional(),
url: z.string(),
archived: z.boolean().default(false),
publicStats: z.boolean().default(false),
tagId: z.nullable(z.string()).optional(),
@@ -2036,10 +2045,11 @@ export namespace RequestBody$ {
})
.transform((v) => {
return {
url: v.url,
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.prefix === undefined ? null : { prefix: v.prefix }),
url: v.url,
archived: v.archived,
publicStats: v.publicStats,
...(v.tagId === undefined ? null : { tagId: v.tagId }),

View File

@@ -271,6 +271,10 @@ export type Geo = {
};
export type CreateLinkRequestBody = {
/**
* The destination URL of the short link.
*/
url: string;
/**
* 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).
*/
@@ -279,14 +283,14 @@ export type CreateLinkRequestBody = {
* The short link slug. If not provided, a random 7-character slug will be generated.
*/
key?: string | undefined;
/**
* This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | null | undefined;
/**
* 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.
*/
prefix?: string | undefined;
/**
* The destination URL of the short link.
*/
url: string;
/**
* Whether the short link is archived.
*/
@@ -1917,10 +1921,11 @@ export namespace Geo$ {
/** @internal */
export namespace CreateLinkRequestBody$ {
export type Inbound = {
url: string;
domain?: string | undefined;
key?: string | undefined;
externalId?: string | null | undefined;
prefix?: string | undefined;
url: string;
archived?: boolean | undefined;
publicStats?: boolean | undefined;
tagId?: string | null | undefined;
@@ -1942,10 +1947,11 @@ export namespace CreateLinkRequestBody$ {
export const inboundSchema: z.ZodType<CreateLinkRequestBody, z.ZodTypeDef, Inbound> = z
.object({
url: z.string(),
domain: z.string().optional(),
key: z.string().optional(),
externalId: z.nullable(z.string()).optional(),
prefix: z.string().optional(),
url: z.string(),
archived: z.boolean().default(false),
publicStats: z.boolean().default(false),
tagId: z.nullable(z.string()).optional(),
@@ -1966,10 +1972,11 @@ export namespace CreateLinkRequestBody$ {
})
.transform((v) => {
return {
url: v.url,
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.prefix === undefined ? null : { prefix: v.prefix }),
url: v.url,
archived: v.archived,
publicStats: v.publicStats,
...(v.tagId === undefined ? null : { tagId: v.tagId }),
@@ -1991,10 +1998,11 @@ export namespace CreateLinkRequestBody$ {
});
export type Outbound = {
url: string;
domain?: string | undefined;
key?: string | undefined;
externalId?: string | null | undefined;
prefix?: string | undefined;
url: string;
archived: boolean;
publicStats: boolean;
tagId?: string | null | undefined;
@@ -2016,10 +2024,11 @@ export namespace CreateLinkRequestBody$ {
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateLinkRequestBody> = z
.object({
url: z.string(),
domain: z.string().optional(),
key: z.string().optional(),
externalId: z.nullable(z.string()).optional(),
prefix: z.string().optional(),
url: z.string(),
archived: z.boolean().default(false),
publicStats: z.boolean().default(false),
tagId: z.nullable(z.string()).optional(),
@@ -2040,10 +2049,11 @@ export namespace CreateLinkRequestBody$ {
})
.transform((v) => {
return {
url: v.url,
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.prefix === undefined ? null : { prefix: v.prefix }),
url: v.url,
archived: v.archived,
publicStats: v.publicStats,
...(v.tagId === undefined ? null : { tagId: v.tagId }),

View File

@@ -271,6 +271,10 @@ export type EditLinkGeo = {
};
export type EditLinkRequestBody = {
/**
* The destination URL of the short link.
*/
url: string;
/**
* 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).
*/
@@ -279,14 +283,14 @@ export type EditLinkRequestBody = {
* The short link slug. If not provided, a random 7-character slug will be generated.
*/
key?: string | undefined;
/**
* This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | null | undefined;
/**
* 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.
*/
prefix?: string | undefined;
/**
* The destination URL of the short link.
*/
url: string;
/**
* Whether the short link is archived.
*/
@@ -1925,10 +1929,11 @@ export namespace EditLinkGeo$ {
/** @internal */
export namespace EditLinkRequestBody$ {
export type Inbound = {
url: string;
domain?: string | undefined;
key?: string | undefined;
externalId?: string | null | undefined;
prefix?: string | undefined;
url: string;
archived?: boolean | undefined;
publicStats?: boolean | undefined;
tagId?: string | null | undefined;
@@ -1950,10 +1955,11 @@ export namespace EditLinkRequestBody$ {
export const inboundSchema: z.ZodType<EditLinkRequestBody, z.ZodTypeDef, Inbound> = z
.object({
url: z.string(),
domain: z.string().optional(),
key: z.string().optional(),
externalId: z.nullable(z.string()).optional(),
prefix: z.string().optional(),
url: z.string(),
archived: z.boolean().default(false),
publicStats: z.boolean().default(false),
tagId: z.nullable(z.string()).optional(),
@@ -1974,10 +1980,11 @@ export namespace EditLinkRequestBody$ {
})
.transform((v) => {
return {
url: v.url,
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.prefix === undefined ? null : { prefix: v.prefix }),
url: v.url,
archived: v.archived,
publicStats: v.publicStats,
...(v.tagId === undefined ? null : { tagId: v.tagId }),
@@ -1999,10 +2006,11 @@ export namespace EditLinkRequestBody$ {
});
export type Outbound = {
url: string;
domain?: string | undefined;
key?: string | undefined;
externalId?: string | null | undefined;
prefix?: string | undefined;
url: string;
archived: boolean;
publicStats: boolean;
tagId?: string | null | undefined;
@@ -2024,10 +2032,11 @@ export namespace EditLinkRequestBody$ {
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, EditLinkRequestBody> = z
.object({
url: z.string(),
domain: z.string().optional(),
key: z.string().optional(),
externalId: z.nullable(z.string()).optional(),
prefix: z.string().optional(),
url: z.string(),
archived: z.boolean().default(false),
publicStats: z.boolean().default(false),
tagId: z.nullable(z.string()).optional(),
@@ -2048,10 +2057,11 @@ export namespace EditLinkRequestBody$ {
})
.transform((v) => {
return {
url: v.url,
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.prefix === undefined ? null : { prefix: v.prefix }),
url: v.url,
archived: v.archived,
publicStats: v.publicStats,
...(v.tagId === undefined ? null : { tagId: v.tagId }),

View File

@@ -291,6 +291,14 @@ export type GetBrowserAnalyticsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -363,6 +371,8 @@ export namespace GetBrowserAnalyticsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetBrowserAnalyticsQueryParamInterval | undefined;
country?: GetBrowserAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -380,6 +390,8 @@ export namespace GetBrowserAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetBrowserAnalyticsQueryParamInterval$.optional(),
country: GetBrowserAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -396,6 +408,8 @@ export namespace GetBrowserAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -413,6 +427,8 @@ export namespace GetBrowserAnalyticsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetBrowserAnalyticsQueryParamInterval | undefined;
country?: GetBrowserAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -430,6 +446,8 @@ export namespace GetBrowserAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetBrowserAnalyticsQueryParamInterval$.optional(),
country: GetBrowserAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -446,6 +464,8 @@ export namespace GetBrowserAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -291,6 +291,14 @@ export type GetCityAnalyticsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -628,6 +636,8 @@ export namespace GetCityAnalyticsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetCityAnalyticsQueryParamInterval | undefined;
country?: GetCityAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -645,6 +655,8 @@ export namespace GetCityAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetCityAnalyticsQueryParamInterval$.optional(),
country: GetCityAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -661,6 +673,8 @@ export namespace GetCityAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -678,6 +692,8 @@ export namespace GetCityAnalyticsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetCityAnalyticsQueryParamInterval | undefined;
country?: GetCityAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -695,6 +711,8 @@ export namespace GetCityAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetCityAnalyticsQueryParamInterval$.optional(),
country: GetCityAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -711,6 +729,8 @@ export namespace GetCityAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -289,6 +289,14 @@ export type GetClicksAnalyticsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -346,6 +354,8 @@ export namespace GetClicksAnalyticsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: Interval | undefined;
country?: Country | undefined;
city?: string | undefined;
@@ -363,6 +373,8 @@ export namespace GetClicksAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: Interval$.optional(),
country: Country$.optional(),
city: z.string().optional(),
@@ -379,6 +391,8 @@ export namespace GetClicksAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -396,6 +410,8 @@ export namespace GetClicksAnalyticsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: Interval | undefined;
country?: Country | undefined;
city?: string | undefined;
@@ -413,6 +429,8 @@ export namespace GetClicksAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: Interval$.optional(),
country: Country$.optional(),
city: z.string().optional(),
@@ -429,6 +447,8 @@ export namespace GetClicksAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -291,6 +291,14 @@ export type GetCountryAnalyticsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -624,6 +632,8 @@ export namespace GetCountryAnalyticsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetCountryAnalyticsQueryParamInterval | undefined;
country?: GetCountryAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -641,6 +651,8 @@ export namespace GetCountryAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetCountryAnalyticsQueryParamInterval$.optional(),
country: GetCountryAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -657,6 +669,8 @@ export namespace GetCountryAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -674,6 +688,8 @@ export namespace GetCountryAnalyticsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetCountryAnalyticsQueryParamInterval | undefined;
country?: GetCountryAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -691,6 +707,8 @@ export namespace GetCountryAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetCountryAnalyticsQueryParamInterval$.optional(),
country: GetCountryAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -707,6 +725,8 @@ export namespace GetCountryAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -291,6 +291,14 @@ export type GetDeviceAnalyticsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -363,6 +371,8 @@ export namespace GetDeviceAnalyticsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetDeviceAnalyticsQueryParamInterval | undefined;
country?: GetDeviceAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -380,6 +390,8 @@ export namespace GetDeviceAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetDeviceAnalyticsQueryParamInterval$.optional(),
country: GetDeviceAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -396,6 +408,8 @@ export namespace GetDeviceAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -413,6 +427,8 @@ export namespace GetDeviceAnalyticsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetDeviceAnalyticsQueryParamInterval | undefined;
country?: GetDeviceAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -430,6 +446,8 @@ export namespace GetDeviceAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetDeviceAnalyticsQueryParamInterval$.optional(),
country: GetDeviceAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -446,6 +464,8 @@ export namespace GetDeviceAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -291,6 +291,14 @@ export type GetOSAnalyticsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -363,6 +371,8 @@ export namespace GetOSAnalyticsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetOSAnalyticsQueryParamInterval | undefined;
country?: GetOSAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -380,6 +390,8 @@ export namespace GetOSAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetOSAnalyticsQueryParamInterval$.optional(),
country: GetOSAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -396,6 +408,8 @@ export namespace GetOSAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -413,6 +427,8 @@ export namespace GetOSAnalyticsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetOSAnalyticsQueryParamInterval | undefined;
country?: GetOSAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -430,6 +446,8 @@ export namespace GetOSAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetOSAnalyticsQueryParamInterval$.optional(),
country: GetOSAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -446,6 +464,8 @@ export namespace GetOSAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -291,6 +291,14 @@ export type GetRefererAnalyticsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -363,6 +371,8 @@ export namespace GetRefererAnalyticsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetRefererAnalyticsQueryParamInterval | undefined;
country?: GetRefererAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -380,6 +390,8 @@ export namespace GetRefererAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetRefererAnalyticsQueryParamInterval$.optional(),
country: GetRefererAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -396,6 +408,8 @@ export namespace GetRefererAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -413,6 +427,8 @@ export namespace GetRefererAnalyticsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetRefererAnalyticsQueryParamInterval | undefined;
country?: GetRefererAnalyticsQueryParamCountry | undefined;
city?: string | undefined;
@@ -430,6 +446,8 @@ export namespace GetRefererAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetRefererAnalyticsQueryParamInterval$.optional(),
country: GetRefererAnalyticsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -446,6 +464,8 @@ export namespace GetRefererAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -289,6 +289,14 @@ export type GetTimeseriesAnalyticsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -359,6 +367,8 @@ export namespace GetTimeseriesAnalyticsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: QueryParamInterval | undefined;
country?: QueryParamCountry | undefined;
city?: string | undefined;
@@ -376,6 +386,8 @@ export namespace GetTimeseriesAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: QueryParamInterval$.optional(),
country: QueryParamCountry$.optional(),
city: z.string().optional(),
@@ -392,6 +404,8 @@ export namespace GetTimeseriesAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -409,6 +423,8 @@ export namespace GetTimeseriesAnalyticsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: QueryParamInterval | undefined;
country?: QueryParamCountry | undefined;
city?: string | undefined;
@@ -427,6 +443,8 @@ export namespace GetTimeseriesAnalyticsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: QueryParamInterval$.optional(),
country: QueryParamCountry$.optional(),
city: z.string().optional(),
@@ -443,6 +461,8 @@ export namespace GetTimeseriesAnalyticsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -291,6 +291,14 @@ export type GetTopLinksRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -361,6 +369,8 @@ export namespace GetTopLinksRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetTopLinksQueryParamInterval | undefined;
country?: GetTopLinksQueryParamCountry | undefined;
city?: string | undefined;
@@ -378,6 +388,8 @@ export namespace GetTopLinksRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetTopLinksQueryParamInterval$.optional(),
country: GetTopLinksQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -394,6 +406,8 @@ export namespace GetTopLinksRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -411,6 +425,8 @@ export namespace GetTopLinksRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetTopLinksQueryParamInterval | undefined;
country?: GetTopLinksQueryParamCountry | undefined;
city?: string | undefined;
@@ -428,6 +444,8 @@ export namespace GetTopLinksRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetTopLinksQueryParamInterval$.optional(),
country: GetTopLinksQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -444,6 +462,8 @@ export namespace GetTopLinksRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -291,6 +291,14 @@ export type GetTopURLsRequest = {
* The short link slug.
*/
key?: string | undefined;
/**
* The unique ID of the short link on Dub.
*/
linkId?: string | undefined;
/**
* This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
*/
externalId?: string | undefined;
/**
* The interval to retrieve analytics for.
*/
@@ -361,6 +369,8 @@ export namespace GetTopURLsRequest$ {
export type Inbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetTopURLsQueryParamInterval | undefined;
country?: GetTopURLsQueryParamCountry | undefined;
city?: string | undefined;
@@ -378,6 +388,8 @@ export namespace GetTopURLsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetTopURLsQueryParamInterval$.optional(),
country: GetTopURLsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -394,6 +406,8 @@ export namespace GetTopURLsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),
@@ -411,6 +425,8 @@ export namespace GetTopURLsRequest$ {
export type Outbound = {
domain?: string | undefined;
key?: string | undefined;
linkId?: string | undefined;
externalId?: string | undefined;
interval?: GetTopURLsQueryParamInterval | undefined;
country?: GetTopURLsQueryParamCountry | undefined;
city?: string | undefined;
@@ -428,6 +444,8 @@ export namespace GetTopURLsRequest$ {
.object({
domain: z.string().optional(),
key: z.string().optional(),
linkId: z.string().optional(),
externalId: z.string().optional(),
interval: GetTopURLsQueryParamInterval$.optional(),
country: GetTopURLsQueryParamCountry$.optional(),
city: z.string().optional(),
@@ -444,6 +462,8 @@ export namespace GetTopURLsRequest$ {
return {
...(v.domain === undefined ? null : { domain: v.domain }),
...(v.key === undefined ? null : { key: v.key }),
...(v.linkId === undefined ? null : { linkId: v.linkId }),
...(v.externalId === undefined ? null : { externalId: v.externalId }),
...(v.interval === undefined ? null : { interval: v.interval }),
...(v.country === undefined ? null : { country: v.country }),
...(v.city === undefined ? null : { city: v.city }),

View File

@@ -74,11 +74,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -320,11 +325,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -566,11 +576,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -814,11 +829,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -1062,11 +1082,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -1310,11 +1335,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -1558,11 +1588,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -1806,11 +1841,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -2054,11 +2094,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,
@@ -2300,11 +2345,16 @@ export class Analytics extends ClientSDK {
}),
enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("externalId", payload$.externalId, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("interval", payload$.interval, {
explode: true,
charEncoding: "percent",
}),
enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
enc$.encodeForm("projectSlug", this.options$.projectSlug, {
explode: true,