dub 0.64.1 → 0.64.3

package/src/models/components/commissioncreatedevent.ts

@@ -0,0 +1,503 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const CommissionCreatedEventEvent = {
+  CommissionCreated: "commission.created",
+} as const;
+export type CommissionCreatedEventEvent = ClosedEnum<
+  typeof CommissionCreatedEventEvent
+>;
+
+export const CommissionCreatedEventType = {
+  Click: "click",
+  Lead: "lead",
+  Sale: "sale",
+  Custom: "custom",
+} as const;
+export type CommissionCreatedEventType = ClosedEnum<
+  typeof CommissionCreatedEventType
+>;
+
+export const CommissionCreatedEventStatus = {
+  Pending: "pending",
+  Processed: "processed",
+  Paid: "paid",
+  Refunded: "refunded",
+  Duplicate: "duplicate",
+  Fraud: "fraud",
+  Canceled: "canceled",
+} as const;
+export type CommissionCreatedEventStatus = ClosedEnum<
+  typeof CommissionCreatedEventStatus
+>;
+
+export type Partner = {
+  /**
+   * The partner's unique ID on Dub.
+   */
+  id: string;
+  /**
+   * The partner's full legal name.
+   */
+  name: string;
+  /**
+   * The partner's email address. Should be a unique value across Dub.
+   */
+  email: string | null;
+  /**
+   * The partner's avatar image.
+   */
+  image: string | null;
+  /**
+   * The date when the partner enabled payouts.
+   */
+  payoutsEnabledAt: string | null;
+  /**
+   * The partner's country (required for tax purposes).
+   */
+  country: string | null;
+};
+
+export type CommissionCreatedEventCustomer = {
+  /**
+   * The unique ID of the customer. You may use either the customer's `id` on Dub (obtained via `/customers` endpoint) or their `externalId` (unique ID within your system, prefixed with `ext_`, e.g. `ext_123`).
+   */
+  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;
+  /**
+   * Country of the customer.
+   */
+  country?: string | null | undefined;
+  /**
+   * Total number of sales for the customer.
+   */
+  sales?: number | null | undefined;
+  /**
+   * Total amount of sales for the customer.
+   */
+  saleAmount?: number | null | undefined;
+  /**
+   * The date the customer was created.
+   */
+  createdAt: string;
+};
+
+export type CommissionCreatedEventData = {
+  /**
+   * The commission's unique ID on Dub.
+   */
+  id: string;
+  type?: CommissionCreatedEventType | undefined;
+  amount: number;
+  earnings: number;
+  currency: string;
+  status: CommissionCreatedEventStatus;
+  invoiceId: string | null;
+  description: string | null;
+  quantity: number;
+  /**
+   * The user who created the manual commission.
+   */
+  userId?: string | null | undefined;
+  createdAt: string;
+  updatedAt: string;
+  partner: Partner;
+  customer?: CommissionCreatedEventCustomer | null | undefined;
+};
+
+/**
+ * Triggered when a commission is created for a partner.
+ */
+export type CommissionCreatedEvent = {
+  id: string;
+  event: CommissionCreatedEventEvent;
+  createdAt: string;
+  data: CommissionCreatedEventData;
+};
+
+/** @internal */
+export const CommissionCreatedEventEvent$inboundSchema: z.ZodNativeEnum<
+  typeof CommissionCreatedEventEvent
+> = z.nativeEnum(CommissionCreatedEventEvent);
+
+/** @internal */
+export const CommissionCreatedEventEvent$outboundSchema: z.ZodNativeEnum<
+  typeof CommissionCreatedEventEvent
+> = CommissionCreatedEventEvent$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommissionCreatedEventEvent$ {
+  /** @deprecated use `CommissionCreatedEventEvent$inboundSchema` instead. */
+  export const inboundSchema = CommissionCreatedEventEvent$inboundSchema;
+  /** @deprecated use `CommissionCreatedEventEvent$outboundSchema` instead. */
+  export const outboundSchema = CommissionCreatedEventEvent$outboundSchema;
+}
+
+/** @internal */
+export const CommissionCreatedEventType$inboundSchema: z.ZodNativeEnum<
+  typeof CommissionCreatedEventType
+> = z.nativeEnum(CommissionCreatedEventType);
+
+/** @internal */
+export const CommissionCreatedEventType$outboundSchema: z.ZodNativeEnum<
+  typeof CommissionCreatedEventType
+> = CommissionCreatedEventType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommissionCreatedEventType$ {
+  /** @deprecated use `CommissionCreatedEventType$inboundSchema` instead. */
+  export const inboundSchema = CommissionCreatedEventType$inboundSchema;
+  /** @deprecated use `CommissionCreatedEventType$outboundSchema` instead. */
+  export const outboundSchema = CommissionCreatedEventType$outboundSchema;
+}
+
+/** @internal */
+export const CommissionCreatedEventStatus$inboundSchema: z.ZodNativeEnum<
+  typeof CommissionCreatedEventStatus
+> = z.nativeEnum(CommissionCreatedEventStatus);
+
+/** @internal */
+export const CommissionCreatedEventStatus$outboundSchema: z.ZodNativeEnum<
+  typeof CommissionCreatedEventStatus
+> = CommissionCreatedEventStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommissionCreatedEventStatus$ {
+  /** @deprecated use `CommissionCreatedEventStatus$inboundSchema` instead. */
+  export const inboundSchema = CommissionCreatedEventStatus$inboundSchema;
+  /** @deprecated use `CommissionCreatedEventStatus$outboundSchema` instead. */
+  export const outboundSchema = CommissionCreatedEventStatus$outboundSchema;
+}
+
+/** @internal */
+export const Partner$inboundSchema: z.ZodType<Partner, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string(),
+    name: z.string(),
+    email: z.nullable(z.string()),
+    image: z.nullable(z.string()),
+    payoutsEnabledAt: z.nullable(z.string()),
+    country: z.nullable(z.string()),
+  });
+
+/** @internal */
+export type Partner$Outbound = {
+  id: string;
+  name: string;
+  email: string | null;
+  image: string | null;
+  payoutsEnabledAt: string | null;
+  country: string | null;
+};
+
+/** @internal */
+export const Partner$outboundSchema: z.ZodType<
+  Partner$Outbound,
+  z.ZodTypeDef,
+  Partner
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()),
+  image: z.nullable(z.string()),
+  payoutsEnabledAt: z.nullable(z.string()),
+  country: z.nullable(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 Partner$ {
+  /** @deprecated use `Partner$inboundSchema` instead. */
+  export const inboundSchema = Partner$inboundSchema;
+  /** @deprecated use `Partner$outboundSchema` instead. */
+  export const outboundSchema = Partner$outboundSchema;
+  /** @deprecated use `Partner$Outbound` instead. */
+  export type Outbound = Partner$Outbound;
+}
+
+export function partnerToJSON(partner: Partner): string {
+  return JSON.stringify(Partner$outboundSchema.parse(partner));
+}
+
+export function partnerFromJSON(
+  jsonString: string,
+): SafeParseResult<Partner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Partner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Partner' from JSON`,
+  );
+}
+
+/** @internal */
+export const CommissionCreatedEventCustomer$inboundSchema: z.ZodType<
+  CommissionCreatedEventCustomer,
+  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(),
+  country: z.nullable(z.string()).optional(),
+  sales: z.nullable(z.number()).optional(),
+  saleAmount: z.nullable(z.number()).optional(),
+  createdAt: z.string(),
+});
+
+/** @internal */
+export type CommissionCreatedEventCustomer$Outbound = {
+  id: string;
+  externalId: string;
+  name: string;
+  email?: string | null | undefined;
+  avatar?: string | null | undefined;
+  country?: string | null | undefined;
+  sales?: number | null | undefined;
+  saleAmount?: number | null | undefined;
+  createdAt: string;
+};
+
+/** @internal */
+export const CommissionCreatedEventCustomer$outboundSchema: z.ZodType<
+  CommissionCreatedEventCustomer$Outbound,
+  z.ZodTypeDef,
+  CommissionCreatedEventCustomer
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()).optional(),
+  sales: z.nullable(z.number()).optional(),
+  saleAmount: z.nullable(z.number()).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 CommissionCreatedEventCustomer$ {
+  /** @deprecated use `CommissionCreatedEventCustomer$inboundSchema` instead. */
+  export const inboundSchema = CommissionCreatedEventCustomer$inboundSchema;
+  /** @deprecated use `CommissionCreatedEventCustomer$outboundSchema` instead. */
+  export const outboundSchema = CommissionCreatedEventCustomer$outboundSchema;
+  /** @deprecated use `CommissionCreatedEventCustomer$Outbound` instead. */
+  export type Outbound = CommissionCreatedEventCustomer$Outbound;
+}
+
+export function commissionCreatedEventCustomerToJSON(
+  commissionCreatedEventCustomer: CommissionCreatedEventCustomer,
+): string {
+  return JSON.stringify(
+    CommissionCreatedEventCustomer$outboundSchema.parse(
+      commissionCreatedEventCustomer,
+    ),
+  );
+}
+
+export function commissionCreatedEventCustomerFromJSON(
+  jsonString: string,
+): SafeParseResult<CommissionCreatedEventCustomer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommissionCreatedEventCustomer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommissionCreatedEventCustomer' from JSON`,
+  );
+}
+
+/** @internal */
+export const CommissionCreatedEventData$inboundSchema: z.ZodType<
+  CommissionCreatedEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  type: CommissionCreatedEventType$inboundSchema.optional(),
+  amount: z.number(),
+  earnings: z.number(),
+  currency: z.string(),
+  status: CommissionCreatedEventStatus$inboundSchema,
+  invoiceId: z.nullable(z.string()),
+  description: z.nullable(z.string()),
+  quantity: z.number(),
+  userId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  partner: z.lazy(() => Partner$inboundSchema),
+  customer: z.nullable(
+    z.lazy(() => CommissionCreatedEventCustomer$inboundSchema),
+  ).optional(),
+});
+
+/** @internal */
+export type CommissionCreatedEventData$Outbound = {
+  id: string;
+  type?: string | undefined;
+  amount: number;
+  earnings: number;
+  currency: string;
+  status: string;
+  invoiceId: string | null;
+  description: string | null;
+  quantity: number;
+  userId?: string | null | undefined;
+  createdAt: string;
+  updatedAt: string;
+  partner: Partner$Outbound;
+  customer?: CommissionCreatedEventCustomer$Outbound | null | undefined;
+};
+
+/** @internal */
+export const CommissionCreatedEventData$outboundSchema: z.ZodType<
+  CommissionCreatedEventData$Outbound,
+  z.ZodTypeDef,
+  CommissionCreatedEventData
+> = z.object({
+  id: z.string(),
+  type: CommissionCreatedEventType$outboundSchema.optional(),
+  amount: z.number(),
+  earnings: z.number(),
+  currency: z.string(),
+  status: CommissionCreatedEventStatus$outboundSchema,
+  invoiceId: z.nullable(z.string()),
+  description: z.nullable(z.string()),
+  quantity: z.number(),
+  userId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  partner: z.lazy(() => Partner$outboundSchema),
+  customer: z.nullable(
+    z.lazy(() => CommissionCreatedEventCustomer$outboundSchema),
+  ).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommissionCreatedEventData$ {
+  /** @deprecated use `CommissionCreatedEventData$inboundSchema` instead. */
+  export const inboundSchema = CommissionCreatedEventData$inboundSchema;
+  /** @deprecated use `CommissionCreatedEventData$outboundSchema` instead. */
+  export const outboundSchema = CommissionCreatedEventData$outboundSchema;
+  /** @deprecated use `CommissionCreatedEventData$Outbound` instead. */
+  export type Outbound = CommissionCreatedEventData$Outbound;
+}
+
+export function commissionCreatedEventDataToJSON(
+  commissionCreatedEventData: CommissionCreatedEventData,
+): string {
+  return JSON.stringify(
+    CommissionCreatedEventData$outboundSchema.parse(commissionCreatedEventData),
+  );
+}
+
+export function commissionCreatedEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<CommissionCreatedEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommissionCreatedEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommissionCreatedEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const CommissionCreatedEvent$inboundSchema: z.ZodType<
+  CommissionCreatedEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  event: CommissionCreatedEventEvent$inboundSchema,
+  createdAt: z.string(),
+  data: z.lazy(() => CommissionCreatedEventData$inboundSchema),
+});
+
+/** @internal */
+export type CommissionCreatedEvent$Outbound = {
+  id: string;
+  event: string;
+  createdAt: string;
+  data: CommissionCreatedEventData$Outbound;
+};
+
+/** @internal */
+export const CommissionCreatedEvent$outboundSchema: z.ZodType<
+  CommissionCreatedEvent$Outbound,
+  z.ZodTypeDef,
+  CommissionCreatedEvent
+> = z.object({
+  id: z.string(),
+  event: CommissionCreatedEventEvent$outboundSchema,
+  createdAt: z.string(),
+  data: z.lazy(() => CommissionCreatedEventData$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommissionCreatedEvent$ {
+  /** @deprecated use `CommissionCreatedEvent$inboundSchema` instead. */
+  export const inboundSchema = CommissionCreatedEvent$inboundSchema;
+  /** @deprecated use `CommissionCreatedEvent$outboundSchema` instead. */
+  export const outboundSchema = CommissionCreatedEvent$outboundSchema;
+  /** @deprecated use `CommissionCreatedEvent$Outbound` instead. */
+  export type Outbound = CommissionCreatedEvent$Outbound;
+}
+
+export function commissionCreatedEventToJSON(
+  commissionCreatedEvent: CommissionCreatedEvent,
+): string {
+  return JSON.stringify(
+    CommissionCreatedEvent$outboundSchema.parse(commissionCreatedEvent),
+  );
+}
+
+export function commissionCreatedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<CommissionCreatedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommissionCreatedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommissionCreatedEvent' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -17,6 +17,7 @@ export * from "./analyticstoplinks.js";
 export * from "./analyticstopurls.js";
 export * from "./analyticstriggers.js";
 export * from "./clickevent.js";
+export * from "./commissioncreatedevent.js";
 export * from "./continentcode.js";
 export * from "./countrycode.js";
 export * from "./domainschema.js";

package/src/models/components/leadcreatedevent.ts

@@ -70,6 +70,7 @@ export type LeadCreatedEventClick = {
   device: string;
   browser: string;
   os: string;
+  trigger?: string | null | undefined;
   referer: string;
   refererUrl: string;
   qr: boolean;
@@ -407,12 +408,6 @@ export type LeadCreatedEventLink = {
    */
   geo: LeadCreatedEventGeo | null;
   publicStats: boolean;
-  /**
-   * The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  tagId: string | null;
   /**
    * The tags assigned to the short link.
    */
@@ -472,23 +467,33 @@ export type LeadCreatedEventLink = {
    * The number of clicks on the short link.
    */
   clicks?: number | undefined;
-  lastClicked: string;
   /**
-   * The number of leads the short links has generated.
+   * The number of leads the short link has generated.
    */
   leads?: number | undefined;
   /**
-   * The number of sales the short links has generated.
+   * The number of leads that converted to paying customers.
+   */
+  conversions?: number | undefined;
+  /**
+   * The total number of sales (includes recurring sales) generated by the short link.
    */
   sales?: number | undefined;
   /**
-   * The total dollar amount of sales the short links has generated (in cents).
+   * The total dollar value of sales (in cents) generated by the short link.
    */
   saleAmount?: number | undefined;
+  lastClicked: string;
   createdAt: string;
   updatedAt: string;
   /**
-   * The project ID of the short link. This field is deprecated – use `workspaceId` instead.
+   * Deprecated: Use `tags` instead. The unique ID of the tag assigned to the short link.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  tagId: string | null;
+  /**
+   * Deprecated: Use `workspaceId` instead. The project ID of the short link.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -627,6 +632,7 @@ export const LeadCreatedEventClick$inboundSchema: z.ZodType<
   device: z.string(),
   browser: z.string(),
   os: z.string(),
+  trigger: z.nullable(z.string()).optional(),
   referer: z.string(),
   refererUrl: z.string(),
   qr: z.boolean(),
@@ -645,6 +651,7 @@ export type LeadCreatedEventClick$Outbound = {
   device: string;
   browser: string;
   os: string;
+  trigger?: string | null | undefined;
   referer: string;
   refererUrl: string;
   qr: boolean;
@@ -667,6 +674,7 @@ export const LeadCreatedEventClick$outboundSchema: z.ZodType<
   device: z.string(),
   browser: z.string(),
   os: z.string(),
+  trigger: z.nullable(z.string()).optional(),
   referer: z.string(),
   refererUrl: z.string(),
   qr: z.boolean(),
@@ -2100,7 +2108,6 @@ export const LeadCreatedEventLink$inboundSchema: z.ZodType<
   android: z.nullable(z.string()),
   geo: z.nullable(z.lazy(() => LeadCreatedEventGeo$inboundSchema)),
   publicStats: z.boolean(),
-  tagId: z.nullable(z.string()),
   tags: z.nullable(z.array(TagSchema$inboundSchema)),
   folderId: z.nullable(z.string()),
   webhookIds: z.array(z.string()),
@@ -2120,12 +2127,14 @@ export const LeadCreatedEventLink$inboundSchema: z.ZodType<
   userId: z.nullable(z.string()),
   workspaceId: z.string(),
   clicks: z.number().default(0),
-  lastClicked: z.string(),
   leads: z.number().default(0),
+  conversions: z.number().default(0),
   sales: z.number().default(0),
   saleAmount: z.number().default(0),
+  lastClicked: z.string(),
   createdAt: z.string(),
   updatedAt: z.string(),
+  tagId: z.nullable(z.string()),
   projectId: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -2163,7 +2172,6 @@ export type LeadCreatedEventLink$Outbound = {
   android: string | null;
   geo: LeadCreatedEventGeo$Outbound | null;
   publicStats: boolean;
-  tagId: string | null;
   tags: Array<TagSchema$Outbound> | null;
   folderId: string | null;
   webhookIds: Array<string>;
@@ -2184,12 +2192,14 @@ export type LeadCreatedEventLink$Outbound = {
   userId: string | null;
   workspaceId: string;
   clicks: number;
-  lastClicked: string;
   leads: number;
+  conversions: number;
   sales: number;
   saleAmount: number;
+  lastClicked: string;
   createdAt: string;
   updatedAt: string;
+  tagId: string | null;
   projectId: string;
 };
 
@@ -2223,7 +2233,6 @@ export const LeadCreatedEventLink$outboundSchema: z.ZodType<
   android: z.nullable(z.string()),
   geo: z.nullable(z.lazy(() => LeadCreatedEventGeo$outboundSchema)),
   publicStats: z.boolean(),
-  tagId: z.nullable(z.string()),
   tags: z.nullable(z.array(TagSchema$outboundSchema)),
   folderId: z.nullable(z.string()),
   webhookIds: z.array(z.string()),
@@ -2243,12 +2252,14 @@ export const LeadCreatedEventLink$outboundSchema: z.ZodType<
   userId: z.nullable(z.string()),
   workspaceId: z.string(),
   clicks: z.number().default(0),
-  lastClicked: z.string(),
   leads: z.number().default(0),
+  conversions: z.number().default(0),
   sales: z.number().default(0),
   saleAmount: z.number().default(0),
+  lastClicked: z.string(),
   createdAt: z.string(),
   updatedAt: z.string(),
+  tagId: z.nullable(z.string()),
   projectId: z.string(),
 }).transform((v) => {
   return remap$(v, {