dub 0.62.3 → 0.63.0

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/bulkcreatelinks.ts

@@ -106,23 +106,23 @@ export type RequestBody = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   /**
-   * The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**

package/src/models/operations/bulkupdatelinks.ts

@@ -90,23 +90,23 @@ export type Data = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   /**
-   * The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**

package/src/models/operations/createlink.ts

@@ -106,23 +106,23 @@ export type CreateLinkRequestBody = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   /**
-   * The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**

package/src/models/operations/createpartner.ts

@@ -333,23 +333,23 @@ export type LinkProps = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   /**
-   * The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**
@@ -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/createpartnerlink.ts

@@ -72,23 +72,23 @@ export type CreatePartnerLinkLinkProps = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   /**
-   * The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**

package/src/models/operations/createreferralsembedtoken.ts

@@ -335,23 +335,23 @@ export type CreateReferralsEmbedTokenLinkProps = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   /**
-   * The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**

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;
   /**

package/src/models/operations/updatelink.ts

@@ -106,20 +106,20 @@ export type UpdateLinkRequestBody = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**

package/src/models/operations/upsertlink.ts

@@ -106,23 +106,23 @@ export type UpsertLinkRequestBody = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   /**
-   * The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**

package/src/models/operations/upsertpartnerlink.ts

@@ -72,23 +72,23 @@ export type UpsertPartnerLinkLinkProps = {
    */
   password?: string | null | undefined;
   /**
-   * Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
+   * Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
    */
   proxy?: boolean | undefined;
   /**
-   * The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   title?: string | null | undefined;
   /**
-   * The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   description?: string | null | undefined;
   /**
-   * The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
+   * The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
    */
   image?: string | null | undefined;
   /**
-   * 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 | undefined;
   /**