dub 0.44.0 → 0.45.1

package/src/models/operations/deletecustomer.ts

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type DeleteCustomerRequest = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+};
+
+/**
+ * The customer was deleted.
+ */
+export type DeleteCustomerResponseBody = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+};
+
+/** @internal */
+export const DeleteCustomerRequest$inboundSchema: z.ZodType<
+  DeleteCustomerRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+});
+
+/** @internal */
+export type DeleteCustomerRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DeleteCustomerRequest$outboundSchema: z.ZodType<
+  DeleteCustomerRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteCustomerRequest
+> = 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 DeleteCustomerRequest$ {
+  /** @deprecated use `DeleteCustomerRequest$inboundSchema` instead. */
+  export const inboundSchema = DeleteCustomerRequest$inboundSchema;
+  /** @deprecated use `DeleteCustomerRequest$outboundSchema` instead. */
+  export const outboundSchema = DeleteCustomerRequest$outboundSchema;
+  /** @deprecated use `DeleteCustomerRequest$Outbound` instead. */
+  export type Outbound = DeleteCustomerRequest$Outbound;
+}
+
+/** @internal */
+export const DeleteCustomerResponseBody$inboundSchema: z.ZodType<
+  DeleteCustomerResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+});
+
+/** @internal */
+export type DeleteCustomerResponseBody$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DeleteCustomerResponseBody$outboundSchema: z.ZodType<
+  DeleteCustomerResponseBody$Outbound,
+  z.ZodTypeDef,
+  DeleteCustomerResponseBody
+> = 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 DeleteCustomerResponseBody$ {
+  /** @deprecated use `DeleteCustomerResponseBody$inboundSchema` instead. */
+  export const inboundSchema = DeleteCustomerResponseBody$inboundSchema;
+  /** @deprecated use `DeleteCustomerResponseBody$outboundSchema` instead. */
+  export const outboundSchema = DeleteCustomerResponseBody$outboundSchema;
+  /** @deprecated use `DeleteCustomerResponseBody$Outbound` instead. */
+  export type Outbound = DeleteCustomerResponseBody$Outbound;
+}

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

@@ -36,7 +36,7 @@ export type GetLinksRequest = {
    */
   domain?: string | undefined;
   /**
-   * The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
+   * Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
    */
   tagId?: string | undefined;
   /**

package/src/models/operations/getlinkscount.ts

@@ -41,7 +41,7 @@ export type GetLinksCountRequest = {
    */
   domain?: string | undefined;
   /**
-   * The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
+   * Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
    */
   tagId?: string | undefined;
   /**

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

@@ -48,6 +48,11 @@ export const QueryParamTrigger = {
  */
 export type QueryParamTrigger = ClosedEnum<typeof QueryParamTrigger>;
 
+/**
+ * The tag IDs to retrieve analytics for.
+ */
+export type ListEventsQueryParamTagIds = string | Array<string>;
+
 export const Order = {
   Asc: "asc",
   Desc: "desc",
@@ -137,9 +142,13 @@ export type ListEventsRequest = {
    */
   url?: string | undefined;
   /**
-   * The tag ID to retrieve analytics for.
+   * Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
    */
   tagId?: string | undefined;
+  /**
+   * The tag IDs to retrieve analytics for.
+   */
+  tagIds?: string | Array<string> | undefined;
   /**
    * Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
    */
@@ -225,6 +234,36 @@ export namespace QueryParamTrigger$ {
   export const outboundSchema = QueryParamTrigger$outboundSchema;
 }
 
+/** @internal */
+export const ListEventsQueryParamTagIds$inboundSchema: z.ZodType<
+  ListEventsQueryParamTagIds,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type ListEventsQueryParamTagIds$Outbound = string | Array<string>;
+
+/** @internal */
+export const ListEventsQueryParamTagIds$outboundSchema: z.ZodType<
+  ListEventsQueryParamTagIds$Outbound,
+  z.ZodTypeDef,
+  ListEventsQueryParamTagIds
+> = z.union([z.string(), z.array(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 ListEventsQueryParamTagIds$ {
+  /** @deprecated use `ListEventsQueryParamTagIds$inboundSchema` instead. */
+  export const inboundSchema = ListEventsQueryParamTagIds$inboundSchema;
+  /** @deprecated use `ListEventsQueryParamTagIds$outboundSchema` instead. */
+  export const outboundSchema = ListEventsQueryParamTagIds$outboundSchema;
+  /** @deprecated use `ListEventsQueryParamTagIds$Outbound` instead. */
+  export type Outbound = ListEventsQueryParamTagIds$Outbound;
+}
+
 /** @internal */
 export const Order$inboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(
   Order,
@@ -290,6 +329,7 @@ export const ListEventsRequest$inboundSchema: z.ZodType<
   refererUrl: z.string().optional(),
   url: z.string().optional(),
   tagId: z.string().optional(),
+  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
   page: z.number().default(1),
@@ -320,6 +360,7 @@ export type ListEventsRequest$Outbound = {
   refererUrl?: string | undefined;
   url?: string | undefined;
   tagId?: string | undefined;
+  tagIds?: string | Array<string> | undefined;
   qr?: boolean | undefined;
   root?: boolean | undefined;
   page: number;
@@ -354,6 +395,7 @@ export const ListEventsRequest$outboundSchema: z.ZodType<
   refererUrl: z.string().optional(),
   url: z.string().optional(),
   tagId: z.string().optional(),
+  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
   page: z.number().default(1),

package/src/models/operations/retrieveanalytics.ts

@@ -74,6 +74,11 @@ export const Trigger = {
  */
 export type Trigger = ClosedEnum<typeof Trigger>;
 
+/**
+ * The tag IDs to retrieve analytics for.
+ */
+export type RetrieveAnalyticsQueryParamTagIds = string | Array<string>;
+
 export type RetrieveAnalyticsRequest = {
   /**
    * The type of event to retrieve analytics for. Defaults to `clicks`.
@@ -156,9 +161,13 @@ export type RetrieveAnalyticsRequest = {
    */
   url?: string | undefined;
   /**
-   * The tag ID to retrieve analytics for.
+   * Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
    */
   tagId?: string | undefined;
+  /**
+   * The tag IDs to retrieve analytics for.
+   */
+  tagIds?: string | Array<string> | undefined;
   /**
    * Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
    */
@@ -266,6 +275,37 @@ export namespace Trigger$ {
   export const outboundSchema = Trigger$outboundSchema;
 }
 
+/** @internal */
+export const RetrieveAnalyticsQueryParamTagIds$inboundSchema: z.ZodType<
+  RetrieveAnalyticsQueryParamTagIds,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type RetrieveAnalyticsQueryParamTagIds$Outbound = string | Array<string>;
+
+/** @internal */
+export const RetrieveAnalyticsQueryParamTagIds$outboundSchema: z.ZodType<
+  RetrieveAnalyticsQueryParamTagIds$Outbound,
+  z.ZodTypeDef,
+  RetrieveAnalyticsQueryParamTagIds
+> = z.union([z.string(), z.array(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 RetrieveAnalyticsQueryParamTagIds$ {
+  /** @deprecated use `RetrieveAnalyticsQueryParamTagIds$inboundSchema` instead. */
+  export const inboundSchema = RetrieveAnalyticsQueryParamTagIds$inboundSchema;
+  /** @deprecated use `RetrieveAnalyticsQueryParamTagIds$outboundSchema` instead. */
+  export const outboundSchema =
+    RetrieveAnalyticsQueryParamTagIds$outboundSchema;
+  /** @deprecated use `RetrieveAnalyticsQueryParamTagIds$Outbound` instead. */
+  export type Outbound = RetrieveAnalyticsQueryParamTagIds$Outbound;
+}
+
 /** @internal */
 export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   RetrieveAnalyticsRequest,
@@ -293,6 +333,7 @@ export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   refererUrl: z.string().optional(),
   url: z.string().optional(),
   tagId: z.string().optional(),
+  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
 });
@@ -320,6 +361,7 @@ export type RetrieveAnalyticsRequest$Outbound = {
   refererUrl?: string | undefined;
   url?: string | undefined;
   tagId?: string | undefined;
+  tagIds?: string | Array<string> | undefined;
   qr?: boolean | undefined;
   root?: boolean | undefined;
 };
@@ -351,6 +393,7 @@ export const RetrieveAnalyticsRequest$outboundSchema: z.ZodType<
   refererUrl: z.string().optional(),
   url: z.string().optional(),
   tagId: z.string().optional(),
+  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
 });

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()),
 });
 
 /**