dub 0.64.1 → 0.64.3

package/src/models/components/partnerenrolledevent.ts

@@ -58,19 +58,35 @@ export type PartnerEnrolledEventLink = {
    */
   clicks?: number | undefined;
   /**
-   * 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 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;
 };
 
+/**
+ * If the partner was banned from the program, this is the reason for the ban.
+ */
+export const BannedReason = {
+  TosViolation: "tos_violation",
+  InappropriateContent: "inappropriate_content",
+  FakeTraffic: "fake_traffic",
+  Fraud: "fraud",
+  Spam: "spam",
+  BrandAbuse: "brand_abuse",
+} as const;
+/**
+ * If the partner was banned from the program, this is the reason for the ban.
+ */
+export type BannedReason = ClosedEnum<typeof BannedReason>;
+
 export type PartnerEnrolledEventData = {
   /**
    * The partner's unique ID on Dub.
@@ -96,30 +112,6 @@ export type PartnerEnrolledEventData = {
    * The partner's country (required for tax purposes).
    */
   country: string | null;
-  /**
-   * The partner's website URL (including the https protocol).
-   */
-  website: string | null;
-  /**
-   * The partner's YouTube channel username (e.g. `johndoe`).
-   */
-  youtube: string | null;
-  /**
-   * The partner's Twitter username (e.g. `johndoe`).
-   */
-  twitter: string | null;
-  /**
-   * The partner's LinkedIn username (e.g. `johndoe`).
-   */
-  linkedin: string | null;
-  /**
-   * The partner's Instagram username (e.g. `johndoe`).
-   */
-  instagram: string | null;
-  /**
-   * The partner's TikTok username (e.g. `johndoe`).
-   */
-  tiktok: string | null;
   /**
    * The partner's PayPal email (for receiving payouts via PayPal).
    */
@@ -133,55 +125,99 @@ export type PartnerEnrolledEventData = {
    */
   payoutsEnabledAt: string | null;
   /**
-   * The date when the partner was created on Dub.
+   * The partner's unique ID on Dub.
    */
-  createdAt: string;
+  partnerId: string;
   /**
-   * The status of the partner's enrollment in the program.
+   * The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future.
    */
-  status: Status;
+  tenantId: string | null;
   /**
    * The program's unique ID on Dub.
    */
   programId: string;
+  createdAt: string;
   /**
-   * The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future.
+   * The status of the partner's enrollment in the program.
    */
-  tenantId: string | null;
+  status: Status;
   /**
    * The partner's referral links in this program.
    */
   links: Array<PartnerEnrolledEventLink> | null;
   /**
-   * The total number of clicks on the partner's links.
+   * The total commissions paid to the partner for their referrals. Defaults to 0 if `includeExpandedFields` is false.
+   */
+  totalCommissions?: number | undefined;
+  clickRewardId?: string | null | undefined;
+  leadRewardId?: string | null | undefined;
+  saleRewardId?: string | null | undefined;
+  discountId?: string | null | undefined;
+  /**
+   * If the partner submitted an application to join the program, this is the ID of the application.
+   */
+  applicationId?: string | null | undefined;
+  /**
+   * If the partner was banned from the program, this is the date of the ban.
+   */
+  bannedAt?: string | null | undefined;
+  /**
+   * If the partner was banned from the program, this is the reason for the ban.
+   */
+  bannedReason?: BannedReason | null | undefined;
+  /**
+   * The total number of clicks on the partner's links. Defaults to 0 if `includeExpandedFields` is false.
    */
   clicks?: number | undefined;
   /**
-   * The total number of leads generated by the partner's links.
+   * The total number of leads generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false.
    */
   leads?: number | undefined;
   /**
-   * The total number of sales generated by the partner's links.
+   * The total number of sales generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false.
    */
   sales?: number | undefined;
   /**
-   * The total amount of sales (in cents) generated by the partner's links.
+   * The total amount of sales (in cents) generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false.
    */
   saleAmount?: number | undefined;
   /**
-   * The total commissions paid to the partner for their referrals.
+   * The total net revenue generated by the partner. Defaults to 0 if `includeExpandedFields` is false.
    */
-  totalCommissions?: number | undefined;
+  netRevenue?: number | undefined;
   /**
-   * The total net revenue generated by the partner.
+   * The partner's website URL (including the https protocol).
    */
-  netRevenue?: number | undefined;
+  website?: string | null | undefined;
+  websiteTxtRecord?: string | null | undefined;
+  websiteVerifiedAt?: string | null | undefined;
+  /**
+   * The partner's YouTube channel username (e.g. `johndoe`).
+   */
+  youtube?: string | null | undefined;
+  youtubeVerifiedAt?: string | null | undefined;
+  youtubeSubscriberCount?: number | null | undefined;
+  youtubeViewCount?: number | null | undefined;
+  /**
+   * The partner's Twitter username (e.g. `johndoe`).
+   */
+  twitter?: string | null | undefined;
+  twitterVerifiedAt?: string | null | undefined;
+  /**
+   * The partner's LinkedIn username (e.g. `johndoe`).
+   */
+  linkedin?: string | null | undefined;
+  linkedinVerifiedAt?: string | null | undefined;
+  /**
+   * The partner's Instagram username (e.g. `johndoe`).
+   */
+  instagram?: string | null | undefined;
+  instagramVerifiedAt?: string | null | undefined;
   /**
-   * DEPRECATED: The total earnings/commissions accrued by the partner's links.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   * The partner's TikTok username (e.g. `johndoe`).
    */
-  earnings?: number | undefined;
+  tiktok?: string | null | undefined;
+  tiktokVerifiedAt?: string | null | undefined;
 };
 
 /**
@@ -312,6 +348,25 @@ 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,
@@ -324,29 +379,45 @@ export const PartnerEnrolledEventData$inboundSchema: z.ZodType<
   image: z.nullable(z.string()),
   description: z.nullable(z.string()).optional(),
   country: z.nullable(z.string()),
-  website: z.nullable(z.string()),
-  youtube: z.nullable(z.string()),
-  twitter: z.nullable(z.string()),
-  linkedin: z.nullable(z.string()),
-  instagram: z.nullable(z.string()),
-  tiktok: z.nullable(z.string()),
   paypalEmail: z.nullable(z.string()),
   stripeConnectId: z.nullable(z.string()),
   payoutsEnabledAt: z.nullable(z.string()),
+  partnerId: z.string(),
+  tenantId: z.nullable(z.string()),
+  programId: z.string(),
   createdAt: z.string(),
   status: Status$inboundSchema,
-  programId: z.string(),
-  tenantId: z.nullable(z.string()),
   links: z.nullable(
     z.array(z.lazy(() => PartnerEnrolledEventLink$inboundSchema)),
   ),
+  totalCommissions: z.number().default(0),
+  clickRewardId: z.nullable(z.string()).optional(),
+  leadRewardId: z.nullable(z.string()).optional(),
+  saleRewardId: z.nullable(z.string()).optional(),
+  discountId: z.nullable(z.string()).optional(),
+  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),
   sales: z.number().default(0),
   saleAmount: z.number().default(0),
-  totalCommissions: z.number().default(0),
   netRevenue: z.number().default(0),
-  earnings: z.number().default(0),
+  website: z.nullable(z.string()).optional(),
+  websiteTxtRecord: z.nullable(z.string()).optional(),
+  websiteVerifiedAt: z.nullable(z.string()).optional(),
+  youtube: z.nullable(z.string()).optional(),
+  youtubeVerifiedAt: z.nullable(z.string()).optional(),
+  youtubeSubscriberCount: z.nullable(z.number()).optional(),
+  youtubeViewCount: z.nullable(z.number()).optional(),
+  twitter: z.nullable(z.string()).optional(),
+  twitterVerifiedAt: z.nullable(z.string()).optional(),
+  linkedin: z.nullable(z.string()).optional(),
+  linkedinVerifiedAt: z.nullable(z.string()).optional(),
+  instagram: z.nullable(z.string()).optional(),
+  instagramVerifiedAt: z.nullable(z.string()).optional(),
+  tiktok: z.nullable(z.string()).optional(),
+  tiktokVerifiedAt: z.nullable(z.string()).optional(),
 });
 
 /** @internal */
@@ -357,27 +428,43 @@ export type PartnerEnrolledEventData$Outbound = {
   image: string | null;
   description?: string | null | undefined;
   country: string | null;
-  website: string | null;
-  youtube: string | null;
-  twitter: string | null;
-  linkedin: string | null;
-  instagram: string | null;
-  tiktok: string | null;
   paypalEmail: string | null;
   stripeConnectId: string | null;
   payoutsEnabledAt: string | null;
+  partnerId: string;
+  tenantId: string | null;
+  programId: string;
   createdAt: string;
   status: string;
-  programId: string;
-  tenantId: string | null;
   links: Array<PartnerEnrolledEventLink$Outbound> | null;
+  totalCommissions: number;
+  clickRewardId?: string | null | undefined;
+  leadRewardId?: string | null | undefined;
+  saleRewardId?: string | null | undefined;
+  discountId?: string | null | undefined;
+  applicationId?: string | null | undefined;
+  bannedAt?: string | null | undefined;
+  bannedReason?: string | null | undefined;
   clicks: number;
   leads: number;
   sales: number;
   saleAmount: number;
-  totalCommissions: number;
   netRevenue: number;
-  earnings: number;
+  website?: string | null | undefined;
+  websiteTxtRecord?: string | null | undefined;
+  websiteVerifiedAt?: string | null | undefined;
+  youtube?: string | null | undefined;
+  youtubeVerifiedAt?: string | null | undefined;
+  youtubeSubscriberCount?: number | null | undefined;
+  youtubeViewCount?: number | null | undefined;
+  twitter?: string | null | undefined;
+  twitterVerifiedAt?: string | null | undefined;
+  linkedin?: string | null | undefined;
+  linkedinVerifiedAt?: string | null | undefined;
+  instagram?: string | null | undefined;
+  instagramVerifiedAt?: string | null | undefined;
+  tiktok?: string | null | undefined;
+  tiktokVerifiedAt?: string | null | undefined;
 };
 
 /** @internal */
@@ -392,29 +479,45 @@ export const PartnerEnrolledEventData$outboundSchema: z.ZodType<
   image: z.nullable(z.string()),
   description: z.nullable(z.string()).optional(),
   country: z.nullable(z.string()),
-  website: z.nullable(z.string()),
-  youtube: z.nullable(z.string()),
-  twitter: z.nullable(z.string()),
-  linkedin: z.nullable(z.string()),
-  instagram: z.nullable(z.string()),
-  tiktok: z.nullable(z.string()),
   paypalEmail: z.nullable(z.string()),
   stripeConnectId: z.nullable(z.string()),
   payoutsEnabledAt: z.nullable(z.string()),
+  partnerId: z.string(),
+  tenantId: z.nullable(z.string()),
+  programId: z.string(),
   createdAt: z.string(),
   status: Status$outboundSchema,
-  programId: z.string(),
-  tenantId: z.nullable(z.string()),
   links: z.nullable(
     z.array(z.lazy(() => PartnerEnrolledEventLink$outboundSchema)),
   ),
+  totalCommissions: z.number().default(0),
+  clickRewardId: z.nullable(z.string()).optional(),
+  leadRewardId: z.nullable(z.string()).optional(),
+  saleRewardId: z.nullable(z.string()).optional(),
+  discountId: z.nullable(z.string()).optional(),
+  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),
   sales: z.number().default(0),
   saleAmount: z.number().default(0),
-  totalCommissions: z.number().default(0),
   netRevenue: z.number().default(0),
-  earnings: z.number().default(0),
+  website: z.nullable(z.string()).optional(),
+  websiteTxtRecord: z.nullable(z.string()).optional(),
+  websiteVerifiedAt: z.nullable(z.string()).optional(),
+  youtube: z.nullable(z.string()).optional(),
+  youtubeVerifiedAt: z.nullable(z.string()).optional(),
+  youtubeSubscriberCount: z.nullable(z.number()).optional(),
+  youtubeViewCount: z.nullable(z.number()).optional(),
+  twitter: z.nullable(z.string()).optional(),
+  twitterVerifiedAt: z.nullable(z.string()).optional(),
+  linkedin: z.nullable(z.string()).optional(),
+  linkedinVerifiedAt: z.nullable(z.string()).optional(),
+  instagram: z.nullable(z.string()).optional(),
+  instagramVerifiedAt: z.nullable(z.string()).optional(),
+  tiktok: z.nullable(z.string()).optional(),
+  tiktokVerifiedAt: z.nullable(z.string()).optional(),
 });
 
 /**

package/src/models/components/salecreatedevent.ts

@@ -70,6 +70,7 @@ export type SaleCreatedEventClick = {
   device: string;
   browser: string;
   os: string;
+  trigger?: string | null | undefined;
   referer: string;
   refererUrl: string;
   qr: boolean;
@@ -407,12 +408,6 @@ export type SaleCreatedEventLink = {
    */
   geo: SaleCreatedEventGeo | 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 SaleCreatedEventLink = {
    * 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.
    */
@@ -635,6 +640,7 @@ export const SaleCreatedEventClick$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(),
@@ -653,6 +659,7 @@ export type SaleCreatedEventClick$Outbound = {
   device: string;
   browser: string;
   os: string;
+  trigger?: string | null | undefined;
   referer: string;
   refererUrl: string;
   qr: boolean;
@@ -675,6 +682,7 @@ export const SaleCreatedEventClick$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(),
@@ -2108,7 +2116,6 @@ export const SaleCreatedEventLink$inboundSchema: z.ZodType<
   android: z.nullable(z.string()),
   geo: z.nullable(z.lazy(() => SaleCreatedEventGeo$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()),
@@ -2128,12 +2135,14 @@ export const SaleCreatedEventLink$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, {
@@ -2171,7 +2180,6 @@ export type SaleCreatedEventLink$Outbound = {
   android: string | null;
   geo: SaleCreatedEventGeo$Outbound | null;
   publicStats: boolean;
-  tagId: string | null;
   tags: Array<TagSchema$Outbound> | null;
   folderId: string | null;
   webhookIds: Array<string>;
@@ -2192,12 +2200,14 @@ export type SaleCreatedEventLink$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;
 };
 
@@ -2231,7 +2241,6 @@ export const SaleCreatedEventLink$outboundSchema: z.ZodType<
   android: z.nullable(z.string()),
   geo: z.nullable(z.lazy(() => SaleCreatedEventGeo$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()),
@@ -2251,12 +2260,14 @@ export const SaleCreatedEventLink$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, {