dub 0.40.1 → 0.41.0

package/src/lib/sdks.ts

@@ -71,11 +71,11 @@ const isBrowserLike = webWorkerLike
   || (typeof window === "object" && typeof window.document !== "undefined");
 
 export class ClientSDK {
-  private readonly httpClient: HTTPClient;
-  protected readonly baseURL: URL | null;
-  protected readonly hooks$: SDKHooks;
-  protected readonly logger?: Logger | undefined;
-  public readonly options$: SDKOptions & { hooks?: SDKHooks };
+  readonly #httpClient: HTTPClient;
+  readonly #hooks: SDKHooks;
+  readonly #logger?: Logger | undefined;
+  protected readonly _baseURL: URL | null;
+  public readonly _options: SDKOptions & { hooks?: SDKHooks };
 
   constructor(options: SDKOptions = {}) {
     const opt = options as unknown;
@@ -85,33 +85,33 @@ export class ClientSDK {
       && "hooks" in opt
       && opt.hooks instanceof SDKHooks
     ) {
-      this.hooks$ = opt.hooks;
+      this.#hooks = opt.hooks;
     } else {
-      this.hooks$ = new SDKHooks();
+      this.#hooks = new SDKHooks();
     }
-    this.options$ = { ...options, hooks: this.hooks$ };
+    this._options = { ...options, hooks: this.#hooks };
 
     const url = serverURLFromOptions(options);
     if (url) {
       url.pathname = url.pathname.replace(/\/+$/, "") + "/";
     }
-    const { baseURL, client } = this.hooks$.sdkInit({
+    const { baseURL, client } = this.#hooks.sdkInit({
       baseURL: url,
       client: options.httpClient || new HTTPClient(),
     });
-    this.baseURL = baseURL;
-    this.httpClient = client;
-    this.logger = options.debugLogger;
+    this._baseURL = baseURL;
+    this.#httpClient = client;
+    this.#logger = options.debugLogger;
   }
 
-  public createRequest$(
+  public _createRequest(
     context: HookContext,
     conf: RequestConfig,
     options?: RequestOptions,
   ): Result<Request, InvalidRequestError | UnexpectedClientError> {
     const { method, path, query, headers: opHeaders, security } = conf;
 
-    const base = conf.baseURL ?? this.baseURL;
+    const base = conf.baseURL ?? this._baseURL;
     if (!base) {
       return ERR(new InvalidRequestError("No base URL provided for operation"));
     }
@@ -195,7 +195,7 @@ export class ClientSDK {
 
     let input;
     try {
-      input = this.hooks$.beforeCreateRequest(context, {
+      input = this.#hooks.beforeCreateRequest(context, {
         url: reqURL,
         options: {
           ...fetchOptions,
@@ -215,7 +215,7 @@ export class ClientSDK {
     return OK(new Request(input.url, input.options));
   }
 
-  public async do$(
+  public async _do(
     request: Request,
     options: {
       context: HookContext;
@@ -238,25 +238,25 @@ export class ClientSDK {
 
     return retry(
       async () => {
-        const req = await this.hooks$.beforeRequest(context, request.clone());
-        await logRequest(this.logger, req).catch((e) =>
-          this.logger?.log("Failed to log request:", e)
+        const req = await this.#hooks.beforeRequest(context, request.clone());
+        await logRequest(this.#logger, req).catch((e) =>
+          this.#logger?.log("Failed to log request:", e)
         );
 
-        let response = await this.httpClient.request(req);
+        let response = await this.#httpClient.request(req);
 
         if (matchStatusCode(response, errorCodes)) {
-          const result = await this.hooks$.afterError(context, response, null);
+          const result = await this.#hooks.afterError(context, response, null);
           if (result.error) {
             throw result.error;
           }
           response = result.response || response;
         } else {
-          response = await this.hooks$.afterSuccess(context, response);
+          response = await this.#hooks.afterSuccess(context, response);
         }
 
-        await logResponse(this.logger, response, req)
-          .catch(e => this.logger?.log("Failed to log response:", e));
+        await logResponse(this.#logger, response, req)
+          .catch(e => this.#logger?.log("Failed to log response:", e));
 
         return response;
       },

package/src/models/components/leadevent.ts

@@ -423,6 +423,7 @@ export type LeadEventLink = {
 };
 
 export type Customer = {
+  id: string;
   name: string;
   email: string;
   avatar: string;
@@ -436,24 +437,6 @@ export type LeadEvent = {
   click: LeadEventClick;
   link: LeadEventLink;
   customer: Customer;
-  /**
-   * Deprecated. Use `customer.name` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  customerName: string;
-  /**
-   * Deprecated. Use `customer.email` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  customerEmail: string;
-  /**
-   * Deprecated. Use `customer.avatar` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  customerAvatar: string;
   /**
    * Deprecated. Use `click.id` instead.
    *
@@ -2088,6 +2071,7 @@ export const Customer$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   name: z.string(),
   email: z.string(),
   avatar: z.string(),
@@ -2095,6 +2079,7 @@ export const Customer$inboundSchema: z.ZodType<
 
 /** @internal */
 export type Customer$Outbound = {
+  id: string;
   name: string;
   email: string;
   avatar: string;
@@ -2106,6 +2091,7 @@ export const Customer$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Customer
 > = z.object({
+  id: z.string(),
   name: z.string(),
   email: z.string(),
   avatar: z.string(),
@@ -2137,9 +2123,6 @@ export const LeadEvent$inboundSchema: z.ZodType<
   click: z.lazy(() => LeadEventClick$inboundSchema),
   link: z.lazy(() => LeadEventLink$inboundSchema),
   customer: z.lazy(() => Customer$inboundSchema),
-  customer_name: z.string(),
-  customer_email: z.string(),
-  customer_avatar: z.string(),
   click_id: z.string(),
   link_id: z.string(),
   domain: z.string(),
@@ -2155,9 +2138,6 @@ export const LeadEvent$inboundSchema: z.ZodType<
   ip: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    "customer_name": "customerName",
-    "customer_email": "customerEmail",
-    "customer_avatar": "customerAvatar",
     "click_id": "clickId",
     "link_id": "linkId",
   });
@@ -2172,9 +2152,6 @@ export type LeadEvent$Outbound = {
   click: LeadEventClick$Outbound;
   link: LeadEventLink$Outbound;
   customer: Customer$Outbound;
-  customer_name: string;
-  customer_email: string;
-  customer_avatar: string;
   click_id: string;
   link_id: string;
   domain: string;
@@ -2203,9 +2180,6 @@ export const LeadEvent$outboundSchema: z.ZodType<
   click: z.lazy(() => LeadEventClick$outboundSchema),
   link: z.lazy(() => LeadEventLink$outboundSchema),
   customer: z.lazy(() => Customer$outboundSchema),
-  customerName: z.string(),
-  customerEmail: z.string(),
-  customerAvatar: z.string(),
   clickId: z.string(),
   linkId: z.string(),
   domain: z.string(),
@@ -2221,9 +2195,6 @@ export const LeadEvent$outboundSchema: z.ZodType<
   ip: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    customerName: "customer_name",
-    customerEmail: "customer_email",
-    customerAvatar: "customer_avatar",
     clickId: "click_id",
     linkId: "link_id",
   });

package/src/models/components/saleevent.ts

@@ -423,6 +423,7 @@ export type SaleEventClick = {
 };
 
 export type SaleEventCustomer = {
+  id: string;
   name: string;
   email: string;
   avatar: string;
@@ -465,24 +466,6 @@ export type SaleEvent = {
   click: SaleEventClick;
   customer: SaleEventCustomer;
   sale: Sale;
-  /**
-   * Deprecated. Use `customer.name` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  customerName: string;
-  /**
-   * Deprecated. Use `customer.email` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  customerEmail: string;
-  /**
-   * Deprecated. Use `customer.avatar` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  customerAvatar: string;
   /**
    * Deprecated. Use `sale.amount` instead.
    *
@@ -2133,6 +2116,7 @@ export const SaleEventCustomer$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   name: z.string(),
   email: z.string(),
   avatar: z.string(),
@@ -2140,6 +2124,7 @@ export const SaleEventCustomer$inboundSchema: z.ZodType<
 
 /** @internal */
 export type SaleEventCustomer$Outbound = {
+  id: string;
   name: string;
   email: string;
   avatar: string;
@@ -2151,6 +2136,7 @@ export const SaleEventCustomer$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SaleEventCustomer
 > = z.object({
+  id: z.string(),
   name: z.string(),
   email: z.string(),
   avatar: z.string(),
@@ -2240,9 +2226,6 @@ export const SaleEvent$inboundSchema: z.ZodType<
   click: z.lazy(() => SaleEventClick$inboundSchema),
   customer: z.lazy(() => SaleEventCustomer$inboundSchema),
   sale: z.lazy(() => Sale$inboundSchema),
-  customer_name: z.string(),
-  customer_email: z.string(),
-  customer_avatar: z.string(),
   saleAmount: z.number(),
   invoice_id: z.string(),
   payment_processor: z.string(),
@@ -2261,9 +2244,6 @@ export const SaleEvent$inboundSchema: z.ZodType<
   ip: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    "customer_name": "customerName",
-    "customer_email": "customerEmail",
-    "customer_avatar": "customerAvatar",
     "invoice_id": "invoiceId",
     "payment_processor": "paymentProcessor",
     "click_id": "clickId",
@@ -2281,9 +2261,6 @@ export type SaleEvent$Outbound = {
   click: SaleEventClick$Outbound;
   customer: SaleEventCustomer$Outbound;
   sale: Sale$Outbound;
-  customer_name: string;
-  customer_email: string;
-  customer_avatar: string;
   saleAmount: number;
   invoice_id: string;
   payment_processor: string;
@@ -2316,9 +2293,6 @@ export const SaleEvent$outboundSchema: z.ZodType<
   click: z.lazy(() => SaleEventClick$outboundSchema),
   customer: z.lazy(() => SaleEventCustomer$outboundSchema),
   sale: z.lazy(() => Sale$outboundSchema),
-  customerName: z.string(),
-  customerEmail: z.string(),
-  customerAvatar: z.string(),
   saleAmount: z.number(),
   invoiceId: z.string(),
   paymentProcessor: z.string(),
@@ -2337,9 +2311,6 @@ export const SaleEvent$outboundSchema: z.ZodType<
   ip: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    customerName: "customer_name",
-    customerEmail: "customer_email",
-    customerAvatar: "customer_avatar",
     invoiceId: "invoice_id",
     paymentProcessor: "payment_processor",
     clickId: "click_id",

package/src/sdk/analytics.ts

@@ -15,7 +15,7 @@ export class Analytics extends ClientSDK {
    * Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the `event` and `type` query parameters.
    */
   async retrieve(
-    request: operations.RetrieveAnalyticsRequest,
+    request?: operations.RetrieveAnalyticsRequest | undefined,
     options?: RequestOptions,
   ): Promise<operations.RetrieveAnalyticsResponseBody> {
     return unwrapAsync(analyticsRetrieve(

package/src/sdk/domains.ts

@@ -13,23 +13,6 @@ import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Domains extends ClientSDK {
-  /**
-   * Retrieve a list of domains
-   *
-   * @remarks
-   * Retrieve a list of domains associated with the authenticated workspace.
-   */
-  async list(
-    request: operations.ListDomainsRequest,
-    options?: RequestOptions,
-  ): Promise<PageIterator<operations.ListDomainsResponse>> {
-    return unwrapResultIterator(domainsList(
-      this,
-      request,
-      options,
-    ));
-  }
-
   /**
    * Create a domain
    *
@@ -48,18 +31,18 @@ export class Domains extends ClientSDK {
   }
 
   /**
-   * Delete a domain
+   * Retrieve a list of domains
    *
    * @remarks
-   * Delete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.
+   * Retrieve a list of domains associated with the authenticated workspace.
    */
-  async delete(
-    slug: string,
+  async list(
+    request?: operations.ListDomainsRequest | undefined,
     options?: RequestOptions,
-  ): Promise<operations.DeleteDomainResponseBody> {
-    return unwrapAsync(domainsDelete(
+  ): Promise<PageIterator<operations.ListDomainsResponse>> {
+    return unwrapResultIterator(domainsList(
       this,
-      slug,
+      request,
       options,
     ));
   }
@@ -82,4 +65,21 @@ export class Domains extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Delete a domain
+   *
+   * @remarks
+   * Delete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.
+   */
+  async delete(
+    slug: string,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteDomainResponseBody> {
+    return unwrapAsync(domainsDelete(
+      this,
+      slug,
+      options,
+    ));
+  }
 }

package/src/sdk/events.ts

@@ -15,7 +15,7 @@ export class Events extends ClientSDK {
    * Retrieve a paginated list of events for the authenticated workspace.
    */
   async list(
-    request: operations.ListEventsRequest,
+    request?: operations.ListEventsRequest | undefined,
     options?: RequestOptions,
   ): Promise<operations.ListEventsResponseBody> {
     return unwrapAsync(eventsList(

package/src/sdk/links.ts

@@ -20,16 +20,16 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Links extends ClientSDK {
   /**
-   * Retrieve a list of links
+   * Create a new link
    *
    * @remarks
-   * Retrieve a paginated list of links for the authenticated workspace.
+   * Create a new link for the authenticated workspace.
    */
-  async list(
-    request: operations.GetLinksRequest,
+  async create(
+    request?: operations.CreateLinkRequestBody | undefined,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.GetLinksResponse>> {
-    return unwrapResultIterator(linksList(
+  ): Promise<components.LinkSchema> {
+    return unwrapAsync(linksCreate(
       this,
       request,
       options,
@@ -37,16 +37,16 @@ export class Links extends ClientSDK {
   }
 
   /**
-   * Create a new link
+   * Retrieve a list of links
    *
    * @remarks
-   * Create a new link for the authenticated workspace.
+   * Retrieve a paginated list of links for the authenticated workspace.
    */
-  async create(
-    request?: operations.CreateLinkRequestBody | undefined,
+  async list(
+    request?: operations.GetLinksRequest | undefined,
     options?: RequestOptions,
-  ): Promise<components.LinkSchema> {
-    return unwrapAsync(linksCreate(
+  ): Promise<PageIterator<operations.GetLinksResponse>> {
+    return unwrapResultIterator(linksList(
       this,
       request,
       options,
@@ -60,7 +60,7 @@ export class Links extends ClientSDK {
    * Retrieve the number of links for the authenticated workspace.
    */
   async count(
-    request: operations.GetLinksCountRequest,
+    request?: operations.GetLinksCountRequest | undefined,
     options?: RequestOptions,
   ): Promise<number> {
     return unwrapAsync(linksCount(
@@ -77,7 +77,7 @@ export class Links extends ClientSDK {
    * Retrieve the info for a link.
    */
   async get(
-    request: operations.GetLinkInfoRequest,
+    request?: operations.GetLinkInfoRequest | undefined,
     options?: RequestOptions,
   ): Promise<components.LinkSchema> {
     return unwrapAsync(linksGet(
@@ -88,37 +88,37 @@ export class Links extends ClientSDK {
   }
 
   /**
-   * Delete a link
+   * Update a link
    *
    * @remarks
-   * Delete a link for the authenticated workspace.
+   * Update a link for the authenticated workspace. If there's no change, returns it as it is.
    */
-  async delete(
+  async update(
     linkId: string,
+    requestBody?: operations.UpdateLinkRequestBody | undefined,
     options?: RequestOptions,
-  ): Promise<operations.DeleteLinkResponseBody> {
-    return unwrapAsync(linksDelete(
+  ): Promise<components.LinkSchema> {
+    return unwrapAsync(linksUpdate(
       this,
       linkId,
+      requestBody,
       options,
     ));
   }
 
   /**
-   * Update a link
+   * Delete a link
    *
    * @remarks
-   * Update a link for the authenticated workspace. If there's no change, returns it as it is.
+   * Delete a link for the authenticated workspace.
    */
-  async update(
+  async delete(
     linkId: string,
-    requestBody?: operations.UpdateLinkRequestBody | undefined,
     options?: RequestOptions,
-  ): Promise<components.LinkSchema> {
-    return unwrapAsync(linksUpdate(
+  ): Promise<operations.DeleteLinkResponseBody> {
+    return unwrapAsync(linksDelete(
       this,
       linkId,
-      requestBody,
       options,
     ));
   }
@@ -141,16 +141,16 @@ export class Links extends ClientSDK {
   }
 
   /**
-   * Bulk delete links
+   * Bulk update links
    *
    * @remarks
-   * Bulk delete up to 100 links for the authenticated workspace.
+   * Bulk update up to 100 links with the same data for the authenticated workspace.
    */
-  async deleteMany(
-    request: operations.BulkDeleteLinksRequest,
+  async updateMany(
+    request?: operations.BulkUpdateLinksRequestBody | undefined,
     options?: RequestOptions,
-  ): Promise<operations.BulkDeleteLinksResponseBody> {
-    return unwrapAsync(linksDeleteMany(
+  ): Promise<Array<components.LinkSchema>> {
+    return unwrapAsync(linksUpdateMany(
       this,
       request,
       options,
@@ -158,16 +158,16 @@ export class Links extends ClientSDK {
   }
 
   /**
-   * Bulk update links
+   * Bulk delete links
    *
    * @remarks
-   * Bulk update up to 100 links with the same data for the authenticated workspace.
+   * Bulk delete up to 100 links for the authenticated workspace.
    */
-  async updateMany(
-    request?: operations.BulkUpdateLinksRequestBody | undefined,
+  async deleteMany(
+    request: operations.BulkDeleteLinksRequest,
     options?: RequestOptions,
-  ): Promise<Array<components.LinkSchema>> {
-    return unwrapAsync(linksUpdateMany(
+  ): Promise<operations.BulkDeleteLinksResponseBody> {
+    return unwrapAsync(linksDeleteMany(
       this,
       request,
       options,

package/src/sdk/sdk.ts

@@ -16,46 +16,46 @@ import { Workspaces } from "./workspaces.js";
 export class Dub extends ClientSDK {
   private _links?: Links;
   get links(): Links {
-    return (this._links ??= new Links(this.options$));
+    return (this._links ??= new Links(this._options));
   }
 
   private _qrCodes?: QRCodes;
   get qrCodes(): QRCodes {
-    return (this._qrCodes ??= new QRCodes(this.options$));
+    return (this._qrCodes ??= new QRCodes(this._options));
   }
 
   private _analytics?: Analytics;
   get analytics(): Analytics {
-    return (this._analytics ??= new Analytics(this.options$));
+    return (this._analytics ??= new Analytics(this._options));
   }
 
   private _events?: Events;
   get events(): Events {
-    return (this._events ??= new Events(this.options$));
+    return (this._events ??= new Events(this._options));
   }
 
   private _workspaces?: Workspaces;
   get workspaces(): Workspaces {
-    return (this._workspaces ??= new Workspaces(this.options$));
+    return (this._workspaces ??= new Workspaces(this._options));
   }
 
   private _tags?: Tags;
   get tags(): Tags {
-    return (this._tags ??= new Tags(this.options$));
+    return (this._tags ??= new Tags(this._options));
   }
 
   private _domains?: Domains;
   get domains(): Domains {
-    return (this._domains ??= new Domains(this.options$));
+    return (this._domains ??= new Domains(this._options));
   }
 
   private _track?: Track;
   get track(): Track {
-    return (this._track ??= new Track(this.options$));
+    return (this._track ??= new Track(this._options));
   }
 
   private _metatags?: Metatags;
   get metatags(): Metatags {
-    return (this._metatags ??= new Metatags(this.options$));
+    return (this._metatags ??= new Metatags(this._options));
   }
 }