dub 0.64.1 → 0.64.3

package/src/models/operations/bulkupdatelinks.ts

@@ -49,18 +49,6 @@ export type Data = {
    * Whether the short link is archived. Defaults to `false` if not provided.
    */
   archived?: boolean | undefined;
-  /**
-   * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  publicStats?: boolean | undefined;
-  /**
-   * The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  tagId?: string | null | undefined;
   /**
    * The unique IDs of the tags assigned to the short link.
    */
@@ -169,6 +157,18 @@ export type Data = {
    * The date and time when the tests were or will be completed.
    */
   testCompletedAt?: string | null | undefined;
+  /**
+   * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  publicStats?: boolean | undefined;
+  /**
+   * Deprecated: Use `tagIds` 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 | undefined;
 };
 
 export type BulkUpdateLinksRequestBody = {
@@ -347,8 +347,6 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
     partnerId: z.nullable(z.string()).optional(),
     trackConversion: z.boolean().optional(),
     archived: z.boolean().optional(),
-    publicStats: z.boolean().optional(),
-    tagId: z.nullable(z.string()).optional(),
     tagIds: z.union([z.string(), z.array(z.string())]).optional(),
     tagNames: z.union([z.string(), z.array(z.string())]).optional(),
     folderId: z.nullable(z.string()).optional(),
@@ -378,6 +376,8 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
     ).optional(),
     testStartedAt: z.nullable(z.string()).optional(),
     testCompletedAt: z.nullable(z.string()).optional(),
+    publicStats: z.boolean().optional(),
+    tagId: z.nullable(z.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "utm_source": "utmSource",
@@ -396,8 +396,6 @@ export type Data$Outbound = {
   partnerId?: string | null | undefined;
   trackConversion?: boolean | undefined;
   archived?: boolean | undefined;
-  publicStats?: boolean | undefined;
-  tagId?: string | null | undefined;
   tagIds?: string | Array<string> | undefined;
   tagNames?: string | Array<string> | undefined;
   folderId?: string | null | undefined;
@@ -425,6 +423,8 @@ export type Data$Outbound = {
   testVariants?: Array<BulkUpdateLinksTestVariants$Outbound> | null | undefined;
   testStartedAt?: string | null | undefined;
   testCompletedAt?: string | null | undefined;
+  publicStats?: boolean | undefined;
+  tagId?: string | null | undefined;
 };
 
 /** @internal */
@@ -436,8 +436,6 @@ export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
     partnerId: z.nullable(z.string()).optional(),
     trackConversion: z.boolean().optional(),
     archived: z.boolean().optional(),
-    publicStats: z.boolean().optional(),
-    tagId: z.nullable(z.string()).optional(),
     tagIds: z.union([z.string(), z.array(z.string())]).optional(),
     tagNames: z.union([z.string(), z.array(z.string())]).optional(),
     folderId: z.nullable(z.string()).optional(),
@@ -467,6 +465,8 @@ export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
     ).optional(),
     testStartedAt: z.nullable(z.string()).optional(),
     testCompletedAt: z.nullable(z.string()).optional(),
+    publicStats: z.boolean().optional(),
+    tagId: z.nullable(z.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       utmSource: "utm_source",

package/src/models/operations/createlink.ts

@@ -69,18 +69,6 @@ export type CreateLinkRequestBody = {
    * Whether the short link is archived. Defaults to `false` if not provided.
    */
   archived?: boolean | undefined;
-  /**
-   * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  publicStats?: boolean | undefined;
-  /**
-   * The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  tagId?: string | null | undefined;
   /**
    * The unique IDs of the tags assigned to the short link.
    */
@@ -189,6 +177,18 @@ export type CreateLinkRequestBody = {
    * The date and time when the tests were or will be completed.
    */
   testCompletedAt?: string | null | undefined;
+  /**
+   * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  publicStats?: boolean | undefined;
+  /**
+   * Deprecated: Use `tagIds` 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 | undefined;
 };
 
 /** @internal */
@@ -346,8 +346,6 @@ export const CreateLinkRequestBody$inboundSchema: z.ZodType<
   prefix: z.string().optional(),
   trackConversion: z.boolean().optional(),
   archived: z.boolean().optional(),
-  publicStats: z.boolean().optional(),
-  tagId: z.nullable(z.string()).optional(),
   tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   tagNames: z.union([z.string(), z.array(z.string())]).optional(),
   folderId: z.nullable(z.string()).optional(),
@@ -376,6 +374,8 @@ export const CreateLinkRequestBody$inboundSchema: z.ZodType<
     .optional(),
   testStartedAt: z.nullable(z.string()).optional(),
   testCompletedAt: z.nullable(z.string()).optional(),
+  publicStats: z.boolean().optional(),
+  tagId: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "utm_source": "utmSource",
@@ -399,8 +399,6 @@ export type CreateLinkRequestBody$Outbound = {
   prefix?: string | undefined;
   trackConversion?: boolean | undefined;
   archived?: boolean | undefined;
-  publicStats?: boolean | undefined;
-  tagId?: string | null | undefined;
   tagIds?: string | Array<string> | undefined;
   tagNames?: string | Array<string> | undefined;
   folderId?: string | null | undefined;
@@ -428,6 +426,8 @@ export type CreateLinkRequestBody$Outbound = {
   testVariants?: Array<TestVariants$Outbound> | null | undefined;
   testStartedAt?: string | null | undefined;
   testCompletedAt?: string | null | undefined;
+  publicStats?: boolean | undefined;
+  tagId?: string | null | undefined;
 };
 
 /** @internal */
@@ -447,8 +447,6 @@ export const CreateLinkRequestBody$outboundSchema: z.ZodType<
   prefix: z.string().optional(),
   trackConversion: z.boolean().optional(),
   archived: z.boolean().optional(),
-  publicStats: z.boolean().optional(),
-  tagId: z.nullable(z.string()).optional(),
   tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   tagNames: z.union([z.string(), z.array(z.string())]).optional(),
   folderId: z.nullable(z.string()).optional(),
@@ -477,6 +475,8 @@ export const CreateLinkRequestBody$outboundSchema: z.ZodType<
     .optional(),
   testStartedAt: z.nullable(z.string()).optional(),
   testCompletedAt: z.nullable(z.string()).optional(),
+  publicStats: z.boolean().optional(),
+  tagId: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     utmSource: "utm_source",

package/src/models/operations/createpartner.ts

@@ -488,19 +488,35 @@ export type CreatePartnerLink = {
    */
   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>;
+
 /**
  * The created partner
  */
@@ -529,30 +545,6 @@ export type CreatePartnerResponseBody = {
    * 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).
    */
@@ -566,55 +558,99 @@ export type CreatePartnerResponseBody = {
    */
   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: CreatePartnerStatus;
+  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: CreatePartnerStatus;
   /**
    * The partner's referral links in this program.
    */
   links: Array<CreatePartnerLink> | 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;
 };
 
 /** @internal */
@@ -1120,6 +1156,25 @@ export function createPartnerLinkFromJSON(
   );
 }
 
+/** @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 CreatePartnerResponseBody$inboundSchema: z.ZodType<
   CreatePartnerResponseBody,
@@ -1132,27 +1187,43 @@ export const CreatePartnerResponseBody$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: CreatePartnerStatus$inboundSchema,
-  programId: z.string(),
-  tenantId: z.nullable(z.string()),
   links: z.nullable(z.array(z.lazy(() => CreatePartnerLink$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 */
@@ -1163,27 +1234,43 @@ export type CreatePartnerResponseBody$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<CreatePartnerLink$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 */
@@ -1198,27 +1285,43 @@ export const CreatePartnerResponseBody$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: CreatePartnerStatus$outboundSchema,
-  programId: z.string(),
-  tenantId: z.nullable(z.string()),
   links: z.nullable(z.array(z.lazy(() => CreatePartnerLink$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/operations/getlinks.ts

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

package/src/models/operations/getlinkscount.ts

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

package/src/models/operations/index.ts

@@ -31,6 +31,7 @@ export * from "./listcommissions.js";
 export * from "./listdomains.js";
 export * from "./listevents.js";
 export * from "./listfolders.js";
+export * from "./listpartners.js";
 export * from "./registerdomain.js";
 export * from "./retrieveanalytics.js";
 export * from "./retrievelinks.js";