dub 0.67.0 → 0.69.0

package/src/models/components/partnerenrolledevent.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
@@ -133,6 +133,10 @@ export type PartnerEnrolledEventData = {
    * The date when the partner enabled payouts.
    */
   payoutsEnabledAt: string | null;
+  /**
+   * The date when the partner received the trusted badge in the partner network.
+   */
+  trustedAt: string | null;
   /**
    * The program's unique ID on Dub.
    */
@@ -159,7 +163,7 @@ export type PartnerEnrolledEventData = {
    */
   links: Array<PartnerEnrolledEventLink> | null;
   /**
-   * The total commissions paid to the partner for their referrals. Defaults to 0 if `includeExpandedFields` is false.
+   * The total commissions paid to the partner for their referrals
    */
   totalCommissions?: number | undefined;
   clickRewardId?: string | null | undefined;
@@ -179,29 +183,53 @@ export type PartnerEnrolledEventData = {
    */
   bannedReason?: BannedReason | null | undefined;
   /**
-   * The total number of clicks on the partner's links. Defaults to 0 if `includeExpandedFields` is false.
+   * The total number of clicks on the partner's links
    */
-  clicks?: number | undefined;
+  totalClicks?: number | undefined;
   /**
-   * The total number of leads generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false.
+   * The total number of leads generated by the partner's links
    */
-  leads?: number | undefined;
+  totalLeads?: number | undefined;
   /**
-   * The total number of leads that converted to paying customers. Defaults to 0 if `includeExpandedFields` is false.
+   * The total number of leads that converted to paying customers
    */
-  conversions?: number | undefined;
+  totalConversions?: number | undefined;
   /**
-   * The total number of sales generated by the partner's links (includes recurring sales). Defaults to 0 if `includeExpandedFields` is false.
+   * The total number of sales generated by the partner's links (includes recurring sales)
    */
-  sales?: number | undefined;
+  totalSales?: number | undefined;
   /**
-   * The total amount of sales (in cents) generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false.
+   * Total revenue generated by the partner's links
    */
-  saleAmount?: number | undefined;
+  totalSaleAmount?: number | undefined;
   /**
-   * The total net revenue generated by the partner. Defaults to 0 if `includeExpandedFields` is false.
+   * Net revenue after commissions (`Total Revenue - Total Commissions`)
    */
   netRevenue?: number | undefined;
+  /**
+   * Earnings Per Click (EPC) (`Total Revenue ÷ Total Clicks`)
+   */
+  earningsPerClick?: number | null | undefined;
+  /**
+   * Average lifetime value for each paying customer (`Total Revenue ÷ Total Conversions`)
+   */
+  averageLifetimeValue?: number | null | undefined;
+  /**
+   * Percentage of clicks that become leads (`Total Leads ÷ Total Clicks`)
+   */
+  clickToLeadRate?: number | null | undefined;
+  /**
+   * Percentage of clicks that convert to paying customers (`Total Conversions ÷ Total Clicks`)
+   */
+  clickToConversionRate?: number | null | undefined;
+  /**
+   * Percentage of leads that convert to paying customers (`Total Conversions ÷ Total Leads`)
+   */
+  leadToConversionRate?: number | null | undefined;
+  /**
+   * Return On Ad Spend (ROAS) (`Total Revenue ÷ Total Commissions`)
+   */
+  returnOnAdSpend?: number | null | undefined;
   /**
    * The partner's website URL (including the https protocol).
    */
@@ -242,42 +270,18 @@ export type PartnerEnrolledEvent = {
 export const PartnerEnrolledEventEvent$inboundSchema: z.ZodNativeEnum<
   typeof PartnerEnrolledEventEvent
 > = z.nativeEnum(PartnerEnrolledEventEvent);
-
 /** @internal */
 export const PartnerEnrolledEventEvent$outboundSchema: z.ZodNativeEnum<
   typeof PartnerEnrolledEventEvent
 > = PartnerEnrolledEventEvent$inboundSchema;
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PartnerEnrolledEventEvent$ {
-  /** @deprecated use `PartnerEnrolledEventEvent$inboundSchema` instead. */
-  export const inboundSchema = PartnerEnrolledEventEvent$inboundSchema;
-  /** @deprecated use `PartnerEnrolledEventEvent$outboundSchema` instead. */
-  export const outboundSchema = PartnerEnrolledEventEvent$outboundSchema;
-}
-
 /** @internal */
 export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
   .nativeEnum(Status);
-
 /** @internal */
 export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
   Status$inboundSchema;
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Status$ {
-  /** @deprecated use `Status$inboundSchema` instead. */
-  export const inboundSchema = Status$inboundSchema;
-  /** @deprecated use `Status$outboundSchema` instead. */
-  export const outboundSchema = Status$outboundSchema;
-}
-
 /** @internal */
 export const PartnerEnrolledEventLink$inboundSchema: z.ZodType<
   PartnerEnrolledEventLink,
@@ -295,7 +299,6 @@ export const PartnerEnrolledEventLink$inboundSchema: z.ZodType<
   sales: z.number().default(0),
   saleAmount: z.number().default(0),
 });
-
 /** @internal */
 export type PartnerEnrolledEventLink$Outbound = {
   id: string;
@@ -328,19 +331,6 @@ export const PartnerEnrolledEventLink$outboundSchema: z.ZodType<
   saleAmount: z.number().default(0),
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PartnerEnrolledEventLink$ {
-  /** @deprecated use `PartnerEnrolledEventLink$inboundSchema` instead. */
-  export const inboundSchema = PartnerEnrolledEventLink$inboundSchema;
-  /** @deprecated use `PartnerEnrolledEventLink$outboundSchema` instead. */
-  export const outboundSchema = PartnerEnrolledEventLink$outboundSchema;
-  /** @deprecated use `PartnerEnrolledEventLink$Outbound` instead. */
-  export type Outbound = PartnerEnrolledEventLink$Outbound;
-}
-
 export function partnerEnrolledEventLinkToJSON(
   partnerEnrolledEventLink: PartnerEnrolledEventLink,
 ): string {
@@ -348,7 +338,6 @@ export function partnerEnrolledEventLinkToJSON(
     PartnerEnrolledEventLink$outboundSchema.parse(partnerEnrolledEventLink),
   );
 }
-
 export function partnerEnrolledEventLinkFromJSON(
   jsonString: string,
 ): SafeParseResult<PartnerEnrolledEventLink, SDKValidationError> {
@@ -362,22 +351,10 @@ export function partnerEnrolledEventLinkFromJSON(
 /** @internal */
 export const BannedReason$inboundSchema: z.ZodNativeEnum<typeof BannedReason> =
   z.nativeEnum(BannedReason);
-
 /** @internal */
 export const BannedReason$outboundSchema: z.ZodNativeEnum<typeof BannedReason> =
   BannedReason$inboundSchema;
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace BannedReason$ {
-  /** @deprecated use `BannedReason$inboundSchema` instead. */
-  export const inboundSchema = BannedReason$inboundSchema;
-  /** @deprecated use `BannedReason$outboundSchema` instead. */
-  export const outboundSchema = BannedReason$outboundSchema;
-}
-
 /** @internal */
 export const PartnerEnrolledEventData$inboundSchema: z.ZodType<
   PartnerEnrolledEventData,
@@ -394,6 +371,7 @@ export const PartnerEnrolledEventData$inboundSchema: z.ZodType<
   paypalEmail: z.nullable(z.string()),
   stripeConnectId: z.nullable(z.string()),
   payoutsEnabledAt: z.nullable(z.string()),
+  trustedAt: z.nullable(z.string()),
   programId: z.string(),
   groupId: z.nullable(z.string()).optional(),
   partnerId: z.string(),
@@ -411,12 +389,18 @@ export const PartnerEnrolledEventData$inboundSchema: z.ZodType<
   applicationId: z.nullable(z.string()).optional(),
   bannedAt: z.nullable(z.string()).optional(),
   bannedReason: z.nullable(BannedReason$inboundSchema).optional(),
-  clicks: z.number().default(0),
-  leads: z.number().default(0),
-  conversions: z.number().default(0),
-  sales: z.number().default(0),
-  saleAmount: z.number().default(0),
+  totalClicks: z.number().default(0),
+  totalLeads: z.number().default(0),
+  totalConversions: z.number().default(0),
+  totalSales: z.number().default(0),
+  totalSaleAmount: z.number().default(0),
   netRevenue: z.number().default(0),
+  earningsPerClick: z.nullable(z.number()).optional(),
+  averageLifetimeValue: z.nullable(z.number()).optional(),
+  clickToLeadRate: z.nullable(z.number()).optional(),
+  clickToConversionRate: z.nullable(z.number()).optional(),
+  leadToConversionRate: z.nullable(z.number()).optional(),
+  returnOnAdSpend: z.nullable(z.number()).optional(),
   website: z.nullable(z.string()).optional(),
   youtube: z.nullable(z.string()).optional(),
   twitter: z.nullable(z.string()).optional(),
@@ -424,7 +408,6 @@ export const PartnerEnrolledEventData$inboundSchema: z.ZodType<
   instagram: z.nullable(z.string()).optional(),
   tiktok: z.nullable(z.string()).optional(),
 });
-
 /** @internal */
 export type PartnerEnrolledEventData$Outbound = {
   id: string;
@@ -437,6 +420,7 @@ export type PartnerEnrolledEventData$Outbound = {
   paypalEmail: string | null;
   stripeConnectId: string | null;
   payoutsEnabledAt: string | null;
+  trustedAt: string | null;
   programId: string;
   groupId?: string | null | undefined;
   partnerId: string;
@@ -452,12 +436,18 @@ export type PartnerEnrolledEventData$Outbound = {
   applicationId?: string | null | undefined;
   bannedAt?: string | null | undefined;
   bannedReason?: string | null | undefined;
-  clicks: number;
-  leads: number;
-  conversions: number;
-  sales: number;
-  saleAmount: number;
+  totalClicks: number;
+  totalLeads: number;
+  totalConversions: number;
+  totalSales: number;
+  totalSaleAmount: number;
   netRevenue: number;
+  earningsPerClick?: number | null | undefined;
+  averageLifetimeValue?: number | null | undefined;
+  clickToLeadRate?: number | null | undefined;
+  clickToConversionRate?: number | null | undefined;
+  leadToConversionRate?: number | null | undefined;
+  returnOnAdSpend?: number | null | undefined;
   website?: string | null | undefined;
   youtube?: string | null | undefined;
   twitter?: string | null | undefined;
@@ -482,6 +472,7 @@ export const PartnerEnrolledEventData$outboundSchema: z.ZodType<
   paypalEmail: z.nullable(z.string()),
   stripeConnectId: z.nullable(z.string()),
   payoutsEnabledAt: z.nullable(z.string()),
+  trustedAt: z.nullable(z.string()),
   programId: z.string(),
   groupId: z.nullable(z.string()).optional(),
   partnerId: z.string(),
@@ -499,12 +490,18 @@ export const PartnerEnrolledEventData$outboundSchema: z.ZodType<
   applicationId: z.nullable(z.string()).optional(),
   bannedAt: z.nullable(z.string()).optional(),
   bannedReason: z.nullable(BannedReason$outboundSchema).optional(),
-  clicks: z.number().default(0),
-  leads: z.number().default(0),
-  conversions: z.number().default(0),
-  sales: z.number().default(0),
-  saleAmount: z.number().default(0),
+  totalClicks: z.number().default(0),
+  totalLeads: z.number().default(0),
+  totalConversions: z.number().default(0),
+  totalSales: z.number().default(0),
+  totalSaleAmount: z.number().default(0),
   netRevenue: z.number().default(0),
+  earningsPerClick: z.nullable(z.number()).optional(),
+  averageLifetimeValue: z.nullable(z.number()).optional(),
+  clickToLeadRate: z.nullable(z.number()).optional(),
+  clickToConversionRate: z.nullable(z.number()).optional(),
+  leadToConversionRate: z.nullable(z.number()).optional(),
+  returnOnAdSpend: z.nullable(z.number()).optional(),
   website: z.nullable(z.string()).optional(),
   youtube: z.nullable(z.string()).optional(),
   twitter: z.nullable(z.string()).optional(),
@@ -513,19 +510,6 @@ export const PartnerEnrolledEventData$outboundSchema: z.ZodType<
   tiktok: z.nullable(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 PartnerEnrolledEventData$ {
-  /** @deprecated use `PartnerEnrolledEventData$inboundSchema` instead. */
-  export const inboundSchema = PartnerEnrolledEventData$inboundSchema;
-  /** @deprecated use `PartnerEnrolledEventData$outboundSchema` instead. */
-  export const outboundSchema = PartnerEnrolledEventData$outboundSchema;
-  /** @deprecated use `PartnerEnrolledEventData$Outbound` instead. */
-  export type Outbound = PartnerEnrolledEventData$Outbound;
-}
-
 export function partnerEnrolledEventDataToJSON(
   partnerEnrolledEventData: PartnerEnrolledEventData,
 ): string {
@@ -533,7 +517,6 @@ export function partnerEnrolledEventDataToJSON(
     PartnerEnrolledEventData$outboundSchema.parse(partnerEnrolledEventData),
   );
 }
-
 export function partnerEnrolledEventDataFromJSON(
   jsonString: string,
 ): SafeParseResult<PartnerEnrolledEventData, SDKValidationError> {
@@ -555,7 +538,6 @@ export const PartnerEnrolledEvent$inboundSchema: z.ZodType<
   createdAt: z.string(),
   data: z.lazy(() => PartnerEnrolledEventData$inboundSchema),
 });
-
 /** @internal */
 export type PartnerEnrolledEvent$Outbound = {
   id: string;
@@ -576,19 +558,6 @@ export const PartnerEnrolledEvent$outboundSchema: z.ZodType<
   data: z.lazy(() => PartnerEnrolledEventData$outboundSchema),
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PartnerEnrolledEvent$ {
-  /** @deprecated use `PartnerEnrolledEvent$inboundSchema` instead. */
-  export const inboundSchema = PartnerEnrolledEvent$inboundSchema;
-  /** @deprecated use `PartnerEnrolledEvent$outboundSchema` instead. */
-  export const outboundSchema = PartnerEnrolledEvent$outboundSchema;
-  /** @deprecated use `PartnerEnrolledEvent$Outbound` instead. */
-  export type Outbound = PartnerEnrolledEvent$Outbound;
-}
-
 export function partnerEnrolledEventToJSON(
   partnerEnrolledEvent: PartnerEnrolledEvent,
 ): string {
@@ -596,7 +565,6 @@ export function partnerEnrolledEventToJSON(
     PartnerEnrolledEvent$outboundSchema.parse(partnerEnrolledEvent),
   );
 }
-
 export function partnerEnrolledEventFromJSON(
   jsonString: string,
 ): SafeParseResult<PartnerEnrolledEvent, SDKValidationError> {