dub 0.62.3 → 0.63.0

package/src/models/components/linkschema.ts

@@ -329,23 +329,23 @@ export type LinkSchema = {
    */
   password: string | null;
   /**
-   * Whether the short link uses Custom Social Media Cards feature.
+   * Whether the short link uses Custom Link Previews feature.
    */
   proxy?: boolean | undefined;
   /**
-   * The title of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The title of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   title: string | null;
   /**
-   * The description of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The description of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   description: string | null;
   /**
-   * The image of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The image of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   image: string | null;
   /**
-   * The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   video: string | null;
   /**

package/src/models/components/linkwebhookevent.ts

@@ -333,19 +333,19 @@ export type LinkWebhookEventLink = {
   password: string | null;
   proxy: boolean;
   /**
-   * The title of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The title of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   title: string | null;
   /**
-   * The description of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The description of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   description: string | null;
   /**
-   * The image of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The image of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   image: string | null;
   /**
-   * The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   video: string | null;
   rewrite: boolean;

package/src/models/components/partnerenrolledevent.ts

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

package/src/models/components/salecreatedevent.ts

@@ -377,19 +377,19 @@ export type SaleCreatedEventLink = {
   password: string | null;
   proxy: boolean;
   /**
-   * The title of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The title of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   title: string | null;
   /**
-   * The description of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The description of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   description: string | null;
   /**
-   * The image of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The image of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   image: string | null;
   /**
-   * The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   video: string | null;
   rewrite: boolean;

package/src/models/components/saleevent.ts

@@ -321,19 +321,19 @@ export type SaleEventLink = {
   password: string | null;
   proxy: boolean;
   /**
-   * The title of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The title of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   title: string | null;
   /**
-   * The description of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The description of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   description: string | null;
   /**
-   * The image of the short link. Will be used for Custom Social Media Cards if `proxy` is true.
+   * The image of the short link. Will be used for Custom Link Previews if `proxy` is true.
    */
   image: string | null;
   /**
-   * The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   video: string | null;
   rewrite: boolean;

package/src/models/errors/badrequest.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 BadRequestData = {
 /**
  * The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
  */
-export class BadRequest extends Error {
+export class BadRequest extends DubError {
   error: ErrorT;
 
   /** The original data that was passed to this error instance. */
   data$: BadRequestData;
 
-  constructor(err: BadRequestData) {
+  constructor(
+    err: BadRequestData,
+    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 = "BadRequest";
@@ -150,9 +153,16 @@ export const BadRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => ErrorT$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new BadRequest(v);
+    return new BadRequest(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/conflict.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 ConflictData = {
 /**
  * This response is sent when a request conflicts with the current state of the server.
  */
-export class Conflict extends Error {
+export class Conflict extends DubError {
   error: ConflictError;
 
   /** The original data that was passed to this error instance. */
   data$: ConflictData;
 
-  constructor(err: ConflictData) {
+  constructor(
+    err: ConflictData,
+    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 = "Conflict";
@@ -152,9 +155,16 @@ export const Conflict$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => ConflictError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Conflict(v);
+    return new Conflict(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/duberror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class DubError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "DubError";
+  }
+}

package/src/models/errors/forbidden.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 ForbiddenData = {
 /**
  * The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
  */
-export class Forbidden extends Error {
+export class Forbidden extends DubError {
   error: ForbiddenError;
 
   /** The original data that was passed to this error instance. */
   data$: ForbiddenData;
 
-  constructor(err: ForbiddenData) {
+  constructor(
+    err: ForbiddenData,
+    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 = "Forbidden";
@@ -154,9 +157,16 @@ export const Forbidden$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => ForbiddenError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Forbidden(v);
+    return new Forbidden(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/index.ts

@@ -10,6 +10,7 @@ export * from "./internalservererror.js";
 export * from "./inviteexpired.js";
 export * from "./notfound.js";
 export * from "./ratelimitexceeded.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./unauthorized.js";

package/src/models/errors/internalservererror.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 InternalServerErrorData = {
 /**
  * The server has encountered a situation it does not know how to handle.
  */
-export class InternalServerError extends Error {
+export class InternalServerError extends DubError {
   error: InternalServerErrorError;
 
   /** The original data that was passed to this error instance. */
   data$: InternalServerErrorData;
 
-  constructor(err: InternalServerErrorData) {
+  constructor(
+    err: InternalServerErrorData,
+    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 = "InternalServerError";
@@ -160,9 +163,16 @@ export const InternalServerError$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => InternalServerErrorError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new InternalServerError(v);
+    return new InternalServerError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/inviteexpired.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 InviteExpiredData = {
 /**
  * This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
  */
-export class InviteExpired extends Error {
+export class InviteExpired extends DubError {
   error: InviteExpiredError;
 
   /** The original data that was passed to this error instance. */
   data$: InviteExpiredData;
 
-  constructor(err: InviteExpiredData) {
+  constructor(
+    err: InviteExpiredData,
+    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 = "InviteExpired";
@@ -158,9 +161,16 @@ export const InviteExpired$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => InviteExpiredError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new InviteExpired(v);
+    return new InviteExpired(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/notfound.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 NotFoundData = {
 /**
  * The server cannot find the requested resource.
  */
-export class NotFound extends Error {
+export class NotFound extends DubError {
   error: NotFoundError;
 
   /** The original data that was passed to this error instance. */
   data$: NotFoundData;
 
-  constructor(err: NotFoundData) {
+  constructor(
+    err: NotFoundData,
+    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 = "NotFound";
@@ -152,9 +155,16 @@ export const NotFound$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: z.lazy(() => NotFoundError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new NotFound(v);
+    return new NotFound(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

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";