dub 0.10.0 → 0.20.2

package/src/models/operations/createlink.ts

@@ -0,0 +1,255 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * The unique IDs of the tags assigned to the short link.
+ */
+export type TagIds = string | Array<string>;
+
+export type CreateLinkRequestBody = {
+    /**
+     * 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).
+     */
+    domain?: string | undefined;
+    /**
+     * The short link slug. If not provided, a random 7-character slug will be generated.
+     */
+    key?: string | 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.
+     */
+    archived?: boolean | undefined;
+    /**
+     * The date and time when the short link will expire at.
+     */
+    expiresAt?: string | null | undefined;
+    /**
+     * The URL to redirect to when the short link has expired.
+     */
+    expiredUrl?: string | null | undefined;
+    /**
+     * The password required to access the destination URL of the short link.
+     */
+    password?: string | null | undefined;
+    /**
+     * Whether the short link uses Custom Social Media Cards feature.
+     */
+    proxy?: boolean | undefined;
+    /**
+     * The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+     */
+    title?: string | null | undefined;
+    /**
+     * The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+     */
+    description?: string | null | undefined;
+    /**
+     * The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+     */
+    image?: string | null | undefined;
+    /**
+     * Whether the short link uses link cloaking.
+     */
+    rewrite?: boolean | undefined;
+    /**
+     * The iOS destination URL for the short link for iOS device targeting.
+     */
+    ios?: string | null | undefined;
+    /**
+     * The Android destination URL for the short link for Android device targeting.
+     */
+    android?: string | null | undefined;
+    /**
+     * Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
+     */
+    geo?: Record<string, string> | null | undefined;
+    /**
+     * Whether the short link's stats are publicly accessible.
+     */
+    publicStats?: boolean | undefined;
+    /**
+     * [DEPRECATED] (use tagIds instead): The unique ID of the tag assigned to the short link.
+     *
+     * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    tagId?: string | null | undefined;
+    /**
+     * The unique IDs of the tags assigned to the short link.
+     */
+    tagIds?: string | Array<string> | undefined;
+    /**
+     * The comments for the short link.
+     */
+    comments?: string | null | undefined;
+};
+
+/** @internal */
+export namespace TagIds$ {
+    export type Inbound = string | Array<string>;
+
+    export type Outbound = string | Array<string>;
+    export const inboundSchema: z.ZodType<TagIds, z.ZodTypeDef, Inbound> = z.union([
+        z.string(),
+        z.array(z.string()),
+    ]);
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, TagIds> = z.union([
+        z.string(),
+        z.array(z.string()),
+    ]);
+}
+
+/** @internal */
+export namespace CreateLinkRequestBody$ {
+    export type Inbound = {
+        domain?: string | undefined;
+        key?: string | undefined;
+        prefix?: string | undefined;
+        url: string;
+        archived?: boolean | undefined;
+        expiresAt?: string | null | undefined;
+        expiredUrl?: string | null | undefined;
+        password?: string | null | undefined;
+        proxy?: boolean | undefined;
+        title?: string | null | undefined;
+        description?: string | null | undefined;
+        image?: string | null | undefined;
+        rewrite?: boolean | undefined;
+        ios?: string | null | undefined;
+        android?: string | null | undefined;
+        geo?: Record<string, string> | null | undefined;
+        publicStats?: boolean | undefined;
+        tagId?: string | null | undefined;
+        tagIds?: string | Array<string> | undefined;
+        comments?: string | null | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<CreateLinkRequestBody, z.ZodTypeDef, Inbound> = z
+        .object({
+            domain: z.string().optional(),
+            key: z.string().optional(),
+            prefix: z.string().optional(),
+            url: z.string(),
+            archived: z.boolean().default(false),
+            expiresAt: z.nullable(z.string()).optional(),
+            expiredUrl: z.nullable(z.string()).optional(),
+            password: z.nullable(z.string()).optional(),
+            proxy: z.boolean().default(false),
+            title: z.nullable(z.string()).optional(),
+            description: z.nullable(z.string()).optional(),
+            image: z.nullable(z.string()).optional(),
+            rewrite: z.boolean().default(false),
+            ios: z.nullable(z.string()).optional(),
+            android: z.nullable(z.string()).optional(),
+            geo: z.nullable(z.record(z.string())).optional(),
+            publicStats: z.boolean().default(false),
+            tagId: z.nullable(z.string()).optional(),
+            tagIds: z.union([z.string(), z.array(z.string())]).optional(),
+            comments: z.nullable(z.string()).optional(),
+        })
+        .transform((v) => {
+            return {
+                ...(v.domain === undefined ? null : { domain: v.domain }),
+                ...(v.key === undefined ? null : { key: v.key }),
+                ...(v.prefix === undefined ? null : { prefix: v.prefix }),
+                url: v.url,
+                archived: v.archived,
+                ...(v.expiresAt === undefined ? null : { expiresAt: v.expiresAt }),
+                ...(v.expiredUrl === undefined ? null : { expiredUrl: v.expiredUrl }),
+                ...(v.password === undefined ? null : { password: v.password }),
+                proxy: v.proxy,
+                ...(v.title === undefined ? null : { title: v.title }),
+                ...(v.description === undefined ? null : { description: v.description }),
+                ...(v.image === undefined ? null : { image: v.image }),
+                rewrite: v.rewrite,
+                ...(v.ios === undefined ? null : { ios: v.ios }),
+                ...(v.android === undefined ? null : { android: v.android }),
+                ...(v.geo === undefined ? null : { geo: v.geo }),
+                publicStats: v.publicStats,
+                ...(v.tagId === undefined ? null : { tagId: v.tagId }),
+                ...(v.tagIds === undefined ? null : { tagIds: v.tagIds }),
+                ...(v.comments === undefined ? null : { comments: v.comments }),
+            };
+        });
+
+    export type Outbound = {
+        domain?: string | undefined;
+        key?: string | undefined;
+        prefix?: string | undefined;
+        url: string;
+        archived: boolean;
+        expiresAt?: string | null | undefined;
+        expiredUrl?: string | null | undefined;
+        password?: string | null | undefined;
+        proxy: boolean;
+        title?: string | null | undefined;
+        description?: string | null | undefined;
+        image?: string | null | undefined;
+        rewrite: boolean;
+        ios?: string | null | undefined;
+        android?: string | null | undefined;
+        geo?: Record<string, string> | null | undefined;
+        publicStats: boolean;
+        tagId?: string | null | undefined;
+        tagIds?: string | Array<string> | undefined;
+        comments?: string | null | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateLinkRequestBody> = z
+        .object({
+            domain: z.string().optional(),
+            key: z.string().optional(),
+            prefix: z.string().optional(),
+            url: z.string(),
+            archived: z.boolean().default(false),
+            expiresAt: z.nullable(z.string()).optional(),
+            expiredUrl: z.nullable(z.string()).optional(),
+            password: z.nullable(z.string()).optional(),
+            proxy: z.boolean().default(false),
+            title: z.nullable(z.string()).optional(),
+            description: z.nullable(z.string()).optional(),
+            image: z.nullable(z.string()).optional(),
+            rewrite: z.boolean().default(false),
+            ios: z.nullable(z.string()).optional(),
+            android: z.nullable(z.string()).optional(),
+            geo: z.nullable(z.record(z.string())).optional(),
+            publicStats: z.boolean().default(false),
+            tagId: z.nullable(z.string()).optional(),
+            tagIds: z.union([z.string(), z.array(z.string())]).optional(),
+            comments: z.nullable(z.string()).optional(),
+        })
+        .transform((v) => {
+            return {
+                ...(v.domain === undefined ? null : { domain: v.domain }),
+                ...(v.key === undefined ? null : { key: v.key }),
+                ...(v.prefix === undefined ? null : { prefix: v.prefix }),
+                url: v.url,
+                archived: v.archived,
+                ...(v.expiresAt === undefined ? null : { expiresAt: v.expiresAt }),
+                ...(v.expiredUrl === undefined ? null : { expiredUrl: v.expiredUrl }),
+                ...(v.password === undefined ? null : { password: v.password }),
+                proxy: v.proxy,
+                ...(v.title === undefined ? null : { title: v.title }),
+                ...(v.description === undefined ? null : { description: v.description }),
+                ...(v.image === undefined ? null : { image: v.image }),
+                rewrite: v.rewrite,
+                ...(v.ios === undefined ? null : { ios: v.ios }),
+                ...(v.android === undefined ? null : { android: v.android }),
+                ...(v.geo === undefined ? null : { geo: v.geo }),
+                publicStats: v.publicStats,
+                ...(v.tagId === undefined ? null : { tagId: v.tagId }),
+                ...(v.tagIds === undefined ? null : { tagIds: v.tagIds }),
+                ...(v.comments === undefined ? null : { comments: v.comments }),
+            };
+        });
+}

package/src/models/operations/createtag.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * The color of the tag. If not provided, a random color will be used from the list: red, yellow, green, blue, purple, pink, brown.
+ */
+export enum Color {
+    Red = "red",
+    Yellow = "yellow",
+    Green = "green",
+    Blue = "blue",
+    Purple = "purple",
+    Pink = "pink",
+    Brown = "brown",
+}
+
+export type CreateTagRequestBody = {
+    /**
+     * The name of the tag to create.
+     */
+    tag: string;
+    /**
+     * The color of the tag. If not provided, a random color will be used from the list: red, yellow, green, blue, purple, pink, brown.
+     */
+    color?: Color | undefined;
+};
+
+/** @internal */
+export const Color$ = z.nativeEnum(Color);
+
+/** @internal */
+export namespace CreateTagRequestBody$ {
+    export type Inbound = {
+        tag: string;
+        color?: Color | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<CreateTagRequestBody, z.ZodTypeDef, Inbound> = z
+        .object({
+            tag: z.string(),
+            color: Color$.optional(),
+        })
+        .transform((v) => {
+            return {
+                tag: v.tag,
+                ...(v.color === undefined ? null : { color: v.color }),
+            };
+        });
+
+    export type Outbound = {
+        tag: string;
+        color?: Color | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateTagRequestBody> = z
+        .object({
+            tag: z.string(),
+            color: Color$.optional(),
+        })
+        .transform((v) => {
+            return {
+                tag: v.tag,
+                ...(v.color === undefined ? null : { color: v.color }),
+            };
+        });
+}

package/src/models/operations/createworkspace.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CreateWorkspaceRequestBody = {
+    name: string;
+    slug: string;
+    domain?: string | undefined;
+};
+
+/** @internal */
+export namespace CreateWorkspaceRequestBody$ {
+    export type Inbound = {
+        name: string;
+        slug: string;
+        domain?: string | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<CreateWorkspaceRequestBody, z.ZodTypeDef, Inbound> = z
+        .object({
+            name: z.string(),
+            slug: z.string(),
+            domain: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                name: v.name,
+                slug: v.slug,
+                ...(v.domain === undefined ? null : { domain: v.domain }),
+            };
+        });
+
+    export type Outbound = {
+        name: string;
+        slug: string;
+        domain?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateWorkspaceRequestBody> = z
+        .object({
+            name: z.string(),
+            slug: z.string(),
+            domain: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                name: v.name,
+                slug: v.slug,
+                ...(v.domain === undefined ? null : { domain: v.domain }),
+            };
+        });
+}

package/src/models/operations/deletelink.ts

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type DeleteLinkRequest = {
+    /**
+     * The id of the link to delete. You can get this via the `getLinkInfo` endpoint.
+     */
+    linkId: string;
+};
+
+/**
+ * The deleted link
+ */
+export type DeleteLinkResponseBody = {
+    /**
+     * The ID of the link.
+     */
+    id: string;
+};
+
+/** @internal */
+export namespace DeleteLinkRequest$ {
+    export type Inbound = {
+        linkId: string;
+    };
+
+    export const inboundSchema: z.ZodType<DeleteLinkRequest, z.ZodTypeDef, Inbound> = z
+        .object({
+            linkId: z.string(),
+        })
+        .transform((v) => {
+            return {
+                linkId: v.linkId,
+            };
+        });
+
+    export type Outbound = {
+        linkId: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, DeleteLinkRequest> = z
+        .object({
+            linkId: z.string(),
+        })
+        .transform((v) => {
+            return {
+                linkId: v.linkId,
+            };
+        });
+}
+
+/** @internal */
+export namespace DeleteLinkResponseBody$ {
+    export type Inbound = {
+        id: string;
+    };
+
+    export const inboundSchema: z.ZodType<DeleteLinkResponseBody, z.ZodTypeDef, Inbound> = z
+        .object({
+            id: z.string(),
+        })
+        .transform((v) => {
+            return {
+                id: v.id,
+            };
+        });
+
+    export type Outbound = {
+        id: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, DeleteLinkResponseBody> = z
+        .object({
+            id: z.string(),
+        })
+        .transform((v) => {
+            return {
+                id: v.id,
+            };
+        });
+}