dub 0.62.4 → 0.63.0

package/src/models/errors/ratelimitexceeded.ts

@@ -7,6 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { DubError } from "./duberror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
@@ -45,17 +46,19 @@ export type RateLimitExceededData = {
 /**
  * The user has sent too many requests in a given amount of time ("rate limiting")
  */
-export class RateLimitExceeded extends Error {
+export class RateLimitExceeded extends DubError {
   error: RateLimitExceededError;
 
   /** The original data that was passed to this error instance. */
   data$: RateLimitExceededData;
 
-  constructor(err: RateLimitExceededData) {
+  constructor(
+    err: RateLimitExceededData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.error?.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     this.error = err.error;
 
     this.name = "RateLimitExceeded";
@@ -158,9 +161,16 @@ export const RateLimitExceeded$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => RateLimitExceededError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new RateLimitExceeded(v);
+    return new RateLimitExceeded(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { DubError } from "./duberror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends DubError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * 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(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkerror.ts

@@ -2,41 +2,33 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class SDKError extends Error {
-  /**
-   * HTTP status code
-   */
-  public readonly statusCode: number;
-  /**
-   * HTTP content type
-   */
-  public readonly contentType: string;
-  /**
-   * HTTP body
-   */
-  public readonly body: string;
-  /**
-   * Raw response
-   */
-  public readonly rawResponse: Response;
+import { DubError } from "./duberror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class SDKError extends DubError {
   constructor(
     message: string,
-    rawResponse: Response,
-    body: string = "",
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
   ) {
-    const statusCode = rawResponse.status;
-    const contentType = rawResponse.headers.get("content-type") || "";
-    const bodyString = body.length > 0 ? `\n${body}` : "";
-    super(
-      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
-    );
-
-    this.body = body;
-    this.rawResponse = rawResponse;
-    this.statusCode = statusCode;
-    this.contentType = contentType;
-
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : " ";
+    message += `Body ${body}`;
+    message = message.trim();
+    super(message, httpMeta);
     this.name = "SDKError";
   }
 }

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/errors/unauthorized.ts

@@ -7,6 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { DubError } from "./duberror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
@@ -45,17 +46,19 @@ export type UnauthorizedData = {
 /**
  * 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 {
+export class Unauthorized extends DubError {
   error: UnauthorizedError;
 
   /** The original data that was passed to this error instance. */
   data$: UnauthorizedData;
 
-  constructor(err: UnauthorizedData) {
+  constructor(
+    err: UnauthorizedData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.error?.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     this.error = err.error;
 
     this.name = "Unauthorized";
@@ -158,9 +161,16 @@ export const Unauthorized$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => UnauthorizedError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Unauthorized(v);
+    return new Unauthorized(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/unprocessableentity.ts

@@ -7,6 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { DubError } from "./duberror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
@@ -47,17 +48,19 @@ export type UnprocessableEntityData = {
 /**
  * The request was well-formed but was unable to be followed due to semantic errors.
  */
-export class UnprocessableEntity extends Error {
+export class UnprocessableEntity extends DubError {
   error: UnprocessableEntityError;
 
   /** The original data that was passed to this error instance. */
   data$: UnprocessableEntityData;
 
-  constructor(err: UnprocessableEntityData) {
+  constructor(
+    err: UnprocessableEntityData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.error?.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     this.error = err.error;
 
     this.name = "UnprocessableEntity";
@@ -160,9 +163,16 @@ export const UnprocessableEntity$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => UnprocessableEntityError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new UnprocessableEntity(v);
+    return new UnprocessableEntity(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/operations/createpartner.ts

@@ -455,6 +455,7 @@ export const CreatePartnerStatus = {
   Invited: "invited",
   Declined: "declined",
   Banned: "banned",
+  Archived: "archived",
 } as const;
 /**
  * The status of the partner's enrollment in the program.

package/src/models/operations/listevents.ts

@@ -108,15 +108,15 @@ export type ListEventsRequest = {
    */
   domain?: string | undefined;
   /**
-   * The short link slug.
+   * The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.
    */
   key?: string | undefined;
   /**
-   * The unique ID of the short link on Dub.
+   * The unique ID of the short link on Dub to retrieve analytics for.
    */
   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.
+   * The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
    */
   externalId?: string | undefined;
   /**

package/src/models/operations/retrieveanalytics.ts

@@ -105,15 +105,15 @@ export type RetrieveAnalyticsRequest = {
    */
   domain?: string | undefined;
   /**
-   * The short link slug.
+   * The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.
    */
   key?: string | undefined;
   /**
-   * The unique ID of the short link on Dub.
+   * The unique ID of the short link on Dub to retrieve analytics for.
    */
   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.
+   * The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
    */
   externalId?: string | undefined;
   /**