dub 0.10.0 → 0.20.2

package/src/models/errors/sdkerror.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+export class SDKError extends Error {
+    public readonly statusCode: number;
+
+    constructor(
+        message: string,
+        public readonly rawResponse: Response,
+        public readonly body: string = ""
+    ) {
+        const statusCode = rawResponse.status;
+        const bodyString = body.length > 0 ? `\n${body}` : "";
+
+        super(`${message}: Status ${statusCode}${bodyString}`);
+
+        this.statusCode = statusCode;
+
+        this.name = "SDKError";
+    }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  constructor(message: string, cause: unknown, rawValue: unknown) {
+    super(message);
+    this.name = "SDKValidationError";
+    this.cause = cause;
+    this.rawValue = rawValue;
+  }
+
+  public override toString() {
+    return `${this.message}: ${this.cause}`;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty() {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.message}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}
+
+export function formatZodError(err: z.ZodError, level = 0): string {
+  let pre = "  ".repeat(level);
+  pre = level > 0 ? `│${pre}` : pre;
+  pre += " ".repeat(level);
+
+  let message = "";
+  const append = (str: string) => (message += `\n${pre}${str}`);
+
+  const len = err.issues.length;
+  const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
+
+  if (len) {
+    append(`┌ ${headline}:`);
+  }
+
+  for (const issue of err.issues) {
+    let path = issue.path.join(".");
+    path = path ? `<root>.${path}` : "<root>";
+    append(`│ • [${path}]: ${issue.message} (${issue.code})`);
+    switch (issue.code) {
+      case "invalid_literal":
+      case "invalid_type": {
+        append(`│     Want: ${issue.expected}`);
+        append(`│      Got: ${issue.received}`);
+        break;
+      }
+      case "unrecognized_keys": {
+        append(`│     Keys: ${issue.keys.join(", ")}`);
+        break;
+      }
+      case "invalid_enum_value": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        append(`│         Got: ${issue.received}`);
+        break;
+      }
+      case "invalid_union_discriminator": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        break;
+      }
+      case "invalid_union": {
+        const len = issue.unionErrors.length;
+        append(
+          `│   ✖︎ Attemped to deserialize into one of ${len} union members:`,
+        );
+        issue.unionErrors.forEach((err, i) => {
+          append(`│   ✖︎ Member ${i + 1} of ${len}`);
+          append(`${formatZodError(err, level + 1)}`);
+        });
+      }
+    }
+  }
+
+  if (err.issues.length) {
+    append(`└─*`);
+  }
+
+  return message.slice(1);
+}

package/src/models/errors/unauthorized.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * A short code indicating the error code returned.
+ */
+export enum UnauthorizedCode {
+    Unauthorized = "unauthorized",
+}
+
+export type UnauthorizedError = {
+    /**
+     * A short code indicating the error code returned.
+     */
+    code: UnauthorizedCode;
+    /**
+     * A human readable explanation of what went wrong.
+     */
+    message: string;
+    /**
+     * A link to our documentation with more details about this error code
+     */
+    docUrl?: string | undefined;
+};
+
+/**
+ * Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
+ */
+export type UnauthorizedData = {
+    error: UnauthorizedError;
+};
+
+/**
+ * Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
+ */
+export class Unauthorized extends Error {
+    error: UnauthorizedError;
+
+    /** The original data that was passed to this error instance. */
+    data$: UnauthorizedData;
+
+    constructor(err: UnauthorizedData) {
+        super("");
+        this.data$ = err;
+
+        this.error = err.error;
+
+        this.message =
+            "message" in err && typeof err.message === "string"
+                ? err.message
+                : "API error occurred";
+
+        this.name = "Unauthorized";
+    }
+}
+
+/** @internal */
+export const UnauthorizedCode$ = z.nativeEnum(UnauthorizedCode);
+
+/** @internal */
+export namespace UnauthorizedError$ {
+    export type Inbound = {
+        code: UnauthorizedCode;
+        message: string;
+        doc_url?: string | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<UnauthorizedError, z.ZodTypeDef, Inbound> = z
+        .object({
+            code: UnauthorizedCode$,
+            message: z.string(),
+            doc_url: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                code: v.code,
+                message: v.message,
+                ...(v.doc_url === undefined ? null : { docUrl: v.doc_url }),
+            };
+        });
+
+    export type Outbound = {
+        code: UnauthorizedCode;
+        message: string;
+        doc_url?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UnauthorizedError> = z
+        .object({
+            code: UnauthorizedCode$,
+            message: z.string(),
+            docUrl: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                code: v.code,
+                message: v.message,
+                ...(v.docUrl === undefined ? null : { doc_url: v.docUrl }),
+            };
+        });
+}
+
+/** @internal */
+export namespace Unauthorized$ {
+    export type Inbound = {
+        error: UnauthorizedError$.Inbound;
+    };
+
+    export const inboundSchema: z.ZodType<Unauthorized, z.ZodTypeDef, Inbound> = z
+        .object({
+            error: z.lazy(() => UnauthorizedError$.inboundSchema),
+        })
+        .transform((v) => {
+            return new Unauthorized({
+                error: v.error,
+            });
+        });
+
+    export type Outbound = {
+        error: UnauthorizedError$.Outbound;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Unauthorized> = z
+        .instanceof(Unauthorized)
+        .transform((v) => v.data$)
+        .pipe(
+            z
+                .object({
+                    error: z.lazy(() => UnauthorizedError$.outboundSchema),
+                })
+                .transform((v) => {
+                    return {
+                        error: v.error,
+                    };
+                })
+        );
+}

package/src/models/errors/unprocessableentity.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * A short code indicating the error code returned.
+ */
+export enum UnprocessableEntityCode {
+    UnprocessableEntity = "unprocessable_entity",
+}
+
+export type UnprocessableEntityError = {
+    /**
+     * A short code indicating the error code returned.
+     */
+    code: UnprocessableEntityCode;
+    /**
+     * A human readable explanation of what went wrong.
+     */
+    message: string;
+    /**
+     * A link to our documentation with more details about this error code
+     */
+    docUrl?: string | undefined;
+};
+
+/**
+ * The request was well-formed but was unable to be followed due to semantic errors.
+ */
+export type UnprocessableEntityData = {
+    error: UnprocessableEntityError;
+};
+
+/**
+ * The request was well-formed but was unable to be followed due to semantic errors.
+ */
+export class UnprocessableEntity extends Error {
+    error: UnprocessableEntityError;
+
+    /** The original data that was passed to this error instance. */
+    data$: UnprocessableEntityData;
+
+    constructor(err: UnprocessableEntityData) {
+        super("");
+        this.data$ = err;
+
+        this.error = err.error;
+
+        this.message =
+            "message" in err && typeof err.message === "string"
+                ? err.message
+                : "API error occurred";
+
+        this.name = "UnprocessableEntity";
+    }
+}
+
+/** @internal */
+export const UnprocessableEntityCode$ = z.nativeEnum(UnprocessableEntityCode);
+
+/** @internal */
+export namespace UnprocessableEntityError$ {
+    export type Inbound = {
+        code: UnprocessableEntityCode;
+        message: string;
+        doc_url?: string | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<UnprocessableEntityError, z.ZodTypeDef, Inbound> = z
+        .object({
+            code: UnprocessableEntityCode$,
+            message: z.string(),
+            doc_url: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                code: v.code,
+                message: v.message,
+                ...(v.doc_url === undefined ? null : { docUrl: v.doc_url }),
+            };
+        });
+
+    export type Outbound = {
+        code: UnprocessableEntityCode;
+        message: string;
+        doc_url?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UnprocessableEntityError> = z
+        .object({
+            code: UnprocessableEntityCode$,
+            message: z.string(),
+            docUrl: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                code: v.code,
+                message: v.message,
+                ...(v.docUrl === undefined ? null : { doc_url: v.docUrl }),
+            };
+        });
+}
+
+/** @internal */
+export namespace UnprocessableEntity$ {
+    export type Inbound = {
+        error: UnprocessableEntityError$.Inbound;
+    };
+
+    export const inboundSchema: z.ZodType<UnprocessableEntity, z.ZodTypeDef, Inbound> = z
+        .object({
+            error: z.lazy(() => UnprocessableEntityError$.inboundSchema),
+        })
+        .transform((v) => {
+            return new UnprocessableEntity({
+                error: v.error,
+            });
+        });
+
+    export type Outbound = {
+        error: UnprocessableEntityError$.Outbound;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UnprocessableEntity> = z
+        .instanceof(UnprocessableEntity)
+        .transform((v) => v.data$)
+        .pipe(
+            z
+                .object({
+                    error: z.lazy(() => UnprocessableEntityError$.outboundSchema),
+                })
+                .transform((v) => {
+                    return {
+                        error: v.error,
+                    };
+                })
+        );
+}

package/src/models/operations/bulkcreatelinks.ts

@@ -0,0 +1,254 @@
+/*
+ * 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 BulkCreateLinksTagIds = string | Array<string>;
+
+export type RequestBody = {
+    /**
+     * 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 BulkCreateLinksTagIds$ {
+    export type Inbound = string | Array<string>;
+
+    export type Outbound = string | Array<string>;
+    export const inboundSchema: z.ZodType<BulkCreateLinksTagIds, z.ZodTypeDef, Inbound> = z.union([
+        z.string(),
+        z.array(z.string()),
+    ]);
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, BulkCreateLinksTagIds> = z.union(
+        [z.string(), z.array(z.string())]
+    );
+}
+
+/** @internal */
+export namespace RequestBody$ {
+    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<RequestBody, 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, RequestBody> = 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 }),
+            };
+        });
+}