dub 0.45.0 → 0.45.2

package/src/models/operations/getcustomer.ts

@@ -0,0 +1,129 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type GetCustomerRequest = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+};
+
+/**
+ * The customer object.
+ */
+export type GetCustomerResponseBody = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+  /**
+   * Unique identifier for the customer in the client's app.
+   */
+  externalId: string;
+  /**
+   * Name of the customer.
+   */
+  name: string;
+  /**
+   * Email of the customer.
+   */
+  email?: string | null | undefined;
+  /**
+   * Avatar URL of the customer.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The date the customer was created.
+   */
+  createdAt: string;
+};
+
+/** @internal */
+export const GetCustomerRequest$inboundSchema: z.ZodType<
+  GetCustomerRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+});
+
+/** @internal */
+export type GetCustomerRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetCustomerRequest$outboundSchema: z.ZodType<
+  GetCustomerRequest$Outbound,
+  z.ZodTypeDef,
+  GetCustomerRequest
+> = z.object({
+  id: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetCustomerRequest$ {
+  /** @deprecated use `GetCustomerRequest$inboundSchema` instead. */
+  export const inboundSchema = GetCustomerRequest$inboundSchema;
+  /** @deprecated use `GetCustomerRequest$outboundSchema` instead. */
+  export const outboundSchema = GetCustomerRequest$outboundSchema;
+  /** @deprecated use `GetCustomerRequest$Outbound` instead. */
+  export type Outbound = GetCustomerRequest$Outbound;
+}
+
+/** @internal */
+export const GetCustomerResponseBody$inboundSchema: z.ZodType<
+  GetCustomerResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+});
+
+/** @internal */
+export type GetCustomerResponseBody$Outbound = {
+  id: string;
+  externalId: string;
+  name: string;
+  email?: string | null | undefined;
+  avatar?: string | null | undefined;
+  createdAt: string;
+};
+
+/** @internal */
+export const GetCustomerResponseBody$outboundSchema: z.ZodType<
+  GetCustomerResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetCustomerResponseBody
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetCustomerResponseBody$ {
+  /** @deprecated use `GetCustomerResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetCustomerResponseBody$inboundSchema;
+  /** @deprecated use `GetCustomerResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetCustomerResponseBody$outboundSchema;
+  /** @deprecated use `GetCustomerResponseBody$Outbound` instead. */
+  export type Outbound = GetCustomerResponseBody$Outbound;
+}

package/src/models/operations/getcustomers.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type ResponseBody = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+  /**
+   * Unique identifier for the customer in the client's app.
+   */
+  externalId: string;
+  /**
+   * Name of the customer.
+   */
+  name: string;
+  /**
+   * Email of the customer.
+   */
+  email?: string | null | undefined;
+  /**
+   * Avatar URL of the customer.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The date the customer was created.
+   */
+  createdAt: string;
+};
+
+/** @internal */
+export const ResponseBody$inboundSchema: z.ZodType<
+  ResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+});
+
+/** @internal */
+export type ResponseBody$Outbound = {
+  id: string;
+  externalId: string;
+  name: string;
+  email?: string | null | undefined;
+  avatar?: string | null | undefined;
+  createdAt: string;
+};
+
+/** @internal */
+export const ResponseBody$outboundSchema: z.ZodType<
+  ResponseBody$Outbound,
+  z.ZodTypeDef,
+  ResponseBody
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ResponseBody$ {
+  /** @deprecated use `ResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ResponseBody$inboundSchema;
+  /** @deprecated use `ResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ResponseBody$outboundSchema;
+  /** @deprecated use `ResponseBody$Outbound` instead. */
+  export type Outbound = ResponseBody$Outbound;
+}

package/src/models/operations/index.ts

@@ -5,12 +5,16 @@
 export * from "./bulkcreatelinks.js";
 export * from "./bulkdeletelinks.js";
 export * from "./bulkupdatelinks.js";
+export * from "./createcustomer.js";
 export * from "./createdomain.js";
 export * from "./createlink.js";
 export * from "./createtag.js";
+export * from "./deletecustomer.js";
 export * from "./deletedomain.js";
 export * from "./deletelink.js";
 export * from "./deletetag.js";
+export * from "./getcustomer.js";
+export * from "./getcustomers.js";
 export * from "./getlinkinfo.js";
 export * from "./getlinks.js";
 export * from "./getlinkscount.js";
@@ -23,6 +27,7 @@ export * from "./retrieveanalytics.js";
 export * from "./trackcustomer.js";
 export * from "./tracklead.js";
 export * from "./tracksale.js";
+export * from "./updatecustomer.js";
 export * from "./updatedomain.js";
 export * from "./updatelink.js";
 export * from "./updatetag.js";

package/src/models/operations/tracklead.ts

@@ -16,7 +16,13 @@ export type TrackLeadRequestBody = {
   /**
    * This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
    */
-  customerId: string;
+  externalId?: string | undefined;
+  /**
+   * This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  customerId?: string | null | undefined;
   /**
    * Name of the customer in the client's app.
    */
@@ -40,10 +46,10 @@ export type Click = {
 };
 
 export type Customer = {
-  id: string;
   name: string | null;
   email: string | null;
   avatar: string | null;
+  externalId: string | null;
 };
 
 /**
@@ -62,7 +68,8 @@ export const TrackLeadRequestBody$inboundSchema: z.ZodType<
 > = z.object({
   clickId: z.string(),
   eventName: z.string(),
-  customerId: z.string(),
+  externalId: z.string().default(""),
+  customerId: z.nullable(z.string()).default(null),
   customerName: z.nullable(z.string()).default(null),
   customerEmail: z.nullable(z.string()).default(null),
   customerAvatar: z.nullable(z.string()).default(null),
@@ -73,7 +80,8 @@ export const TrackLeadRequestBody$inboundSchema: z.ZodType<
 export type TrackLeadRequestBody$Outbound = {
   clickId: string;
   eventName: string;
-  customerId: string;
+  externalId: string;
+  customerId: string | null;
   customerName: string | null;
   customerEmail: string | null;
   customerAvatar: string | null;
@@ -88,7 +96,8 @@ export const TrackLeadRequestBody$outboundSchema: z.ZodType<
 > = z.object({
   clickId: z.string(),
   eventName: z.string(),
-  customerId: z.string(),
+  externalId: z.string().default(""),
+  customerId: z.nullable(z.string()).default(null),
   customerName: z.nullable(z.string()).default(null),
   customerEmail: z.nullable(z.string()).default(null),
   customerAvatar: z.nullable(z.string()).default(null),
@@ -147,18 +156,18 @@ export const Customer$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string(),
   name: z.nullable(z.string()),
   email: z.nullable(z.string()),
   avatar: z.nullable(z.string()),
+  externalId: z.nullable(z.string()),
 });
 
 /** @internal */
 export type Customer$Outbound = {
-  id: string;
   name: string | null;
   email: string | null;
   avatar: string | null;
+  externalId: string | null;
 };
 
 /** @internal */
@@ -167,10 +176,10 @@ export const Customer$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Customer
 > = z.object({
-  id: z.string(),
   name: z.nullable(z.string()),
   email: z.nullable(z.string()),
   avatar: z.nullable(z.string()),
+  externalId: z.nullable(z.string()),
 });
 
 /**

package/src/models/operations/tracksale.ts

@@ -22,7 +22,13 @@ export type TrackSaleRequestBody = {
   /**
    * This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
    */
-  customerId: string;
+  externalId?: string | undefined;
+  /**
+   * This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  customerId?: string | null | undefined;
   /**
    * The amount of the sale. Should be passed in cents.
    */
@@ -54,6 +60,7 @@ export type TrackSaleCustomer = {
   name: string | null;
   email: string | null;
   avatar: string | null;
+  externalId: string | null;
 };
 
 export type Sale = {
@@ -100,7 +107,8 @@ export const TrackSaleRequestBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  customerId: z.string(),
+  externalId: z.string().default(""),
+  customerId: z.nullable(z.string()).default(null),
   amount: z.number().int(),
   paymentProcessor: PaymentProcessor$inboundSchema,
   eventName: z.string().default("Purchase"),
@@ -111,7 +119,8 @@ export const TrackSaleRequestBody$inboundSchema: z.ZodType<
 
 /** @internal */
 export type TrackSaleRequestBody$Outbound = {
-  customerId: string;
+  externalId: string;
+  customerId: string | null;
   amount: number;
   paymentProcessor: string;
   eventName: string;
@@ -126,7 +135,8 @@ export const TrackSaleRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TrackSaleRequestBody
 > = z.object({
-  customerId: z.string(),
+  externalId: z.string().default(""),
+  customerId: z.nullable(z.string()).default(null),
   amount: z.number().int(),
   paymentProcessor: PaymentProcessor$outboundSchema,
   eventName: z.string().default("Purchase"),
@@ -158,6 +168,7 @@ export const TrackSaleCustomer$inboundSchema: z.ZodType<
   name: z.nullable(z.string()),
   email: z.nullable(z.string()),
   avatar: z.nullable(z.string()),
+  externalId: z.nullable(z.string()),
 });
 
 /** @internal */
@@ -166,6 +177,7 @@ export type TrackSaleCustomer$Outbound = {
   name: string | null;
   email: string | null;
   avatar: string | null;
+  externalId: string | null;
 };
 
 /** @internal */
@@ -178,6 +190,7 @@ export const TrackSaleCustomer$outboundSchema: z.ZodType<
   name: z.nullable(z.string()),
   email: z.nullable(z.string()),
   avatar: z.nullable(z.string()),
+  externalId: z.nullable(z.string()),
 });
 
 /**

package/src/models/operations/updatecustomer.ts

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type UpdateCustomerRequestBody = {
+  /**
+   * Email of the customer in the client's app.
+   */
+  email?: string | null | undefined;
+  /**
+   * Name of the customer in the client's app. If not provided, a random name will be generated.
+   */
+  name?: string | null | undefined;
+  /**
+   * Avatar URL of the customer in the client's app.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * Unique identifier for the customer in the client's app.
+   */
+  externalId?: string | undefined;
+};
+
+export type UpdateCustomerRequest = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+  requestBody?: UpdateCustomerRequestBody | undefined;
+};
+
+/**
+ * The customer was updated.
+ */
+export type UpdateCustomerResponseBody = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+  /**
+   * Unique identifier for the customer in the client's app.
+   */
+  externalId: string;
+  /**
+   * Name of the customer.
+   */
+  name: string;
+  /**
+   * Email of the customer.
+   */
+  email?: string | null | undefined;
+  /**
+   * Avatar URL of the customer.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The date the customer was created.
+   */
+  createdAt: string;
+};
+
+/** @internal */
+export const UpdateCustomerRequestBody$inboundSchema: z.ZodType<
+  UpdateCustomerRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  externalId: z.string().optional(),
+});
+
+/** @internal */
+export type UpdateCustomerRequestBody$Outbound = {
+  email?: string | null | undefined;
+  name?: string | null | undefined;
+  avatar?: string | null | undefined;
+  externalId?: string | undefined;
+};
+
+/** @internal */
+export const UpdateCustomerRequestBody$outboundSchema: z.ZodType<
+  UpdateCustomerRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateCustomerRequestBody
+> = z.object({
+  email: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  externalId: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateCustomerRequestBody$ {
+  /** @deprecated use `UpdateCustomerRequestBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateCustomerRequestBody$inboundSchema;
+  /** @deprecated use `UpdateCustomerRequestBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateCustomerRequestBody$outboundSchema;
+  /** @deprecated use `UpdateCustomerRequestBody$Outbound` instead. */
+  export type Outbound = UpdateCustomerRequestBody$Outbound;
+}
+
+/** @internal */
+export const UpdateCustomerRequest$inboundSchema: z.ZodType<
+  UpdateCustomerRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  RequestBody: z.lazy(() => UpdateCustomerRequestBody$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "RequestBody": "requestBody",
+  });
+});
+
+/** @internal */
+export type UpdateCustomerRequest$Outbound = {
+  id: string;
+  RequestBody?: UpdateCustomerRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateCustomerRequest$outboundSchema: z.ZodType<
+  UpdateCustomerRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateCustomerRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateCustomerRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateCustomerRequest$ {
+  /** @deprecated use `UpdateCustomerRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateCustomerRequest$inboundSchema;
+  /** @deprecated use `UpdateCustomerRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateCustomerRequest$outboundSchema;
+  /** @deprecated use `UpdateCustomerRequest$Outbound` instead. */
+  export type Outbound = UpdateCustomerRequest$Outbound;
+}
+
+/** @internal */
+export const UpdateCustomerResponseBody$inboundSchema: z.ZodType<
+  UpdateCustomerResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+});
+
+/** @internal */
+export type UpdateCustomerResponseBody$Outbound = {
+  id: string;
+  externalId: string;
+  name: string;
+  email?: string | null | undefined;
+  avatar?: string | null | undefined;
+  createdAt: string;
+};
+
+/** @internal */
+export const UpdateCustomerResponseBody$outboundSchema: z.ZodType<
+  UpdateCustomerResponseBody$Outbound,
+  z.ZodTypeDef,
+  UpdateCustomerResponseBody
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateCustomerResponseBody$ {
+  /** @deprecated use `UpdateCustomerResponseBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateCustomerResponseBody$inboundSchema;
+  /** @deprecated use `UpdateCustomerResponseBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateCustomerResponseBody$outboundSchema;
+  /** @deprecated use `UpdateCustomerResponseBody$Outbound` instead. */
+  export type Outbound = UpdateCustomerResponseBody$Outbound;
+}

package/src/sdk/customers.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { customersCreate } from "../funcs/customersCreate.js";
+import { customersDelete } from "../funcs/customersDelete.js";
+import { customersGet } from "../funcs/customersGet.js";
+import { customersList } from "../funcs/customersList.js";
+import { customersUpdate } from "../funcs/customersUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Customers extends ClientSDK {
+  /**
+   * Retrieve a list of customers
+   *
+   * @remarks
+   * Retrieve a list of customers for the authenticated workspace.
+   */
+  async list(
+    options?: RequestOptions,
+  ): Promise<Array<operations.ResponseBody>> {
+    return unwrapAsync(customersList(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Create a customer
+   *
+   * @remarks
+   * Create a customer for the authenticated workspace.
+   */
+  async create(
+    request?: operations.CreateCustomerRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateCustomerResponseBody> {
+    return unwrapAsync(customersCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a customer
+   *
+   * @remarks
+   * Retrieve a customer by ID for the authenticated workspace.
+   */
+  async get(
+    request: operations.GetCustomerRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCustomerResponseBody> {
+    return unwrapAsync(customersGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a customer
+   *
+   * @remarks
+   * Update a customer for the authenticated workspace.
+   */
+  async update(
+    id: string,
+    requestBody?: operations.UpdateCustomerRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateCustomerResponseBody> {
+    return unwrapAsync(customersUpdate(
+      this,
+      id,
+      requestBody,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a customer
+   *
+   * @remarks
+   * Delete a customer from a workspace.
+   */
+  async delete(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteCustomerResponseBody> {
+    return unwrapAsync(customersDelete(
+      this,
+      id,
+      options,
+    ));
+  }
+}