dub 0.64.0 → 0.64.2

package/src/models/operations/createpartner.ts

@@ -501,6 +501,22 @@ export type CreatePartnerLink = {
   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/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";

package/src/models/operations/listcommissions.ts

@@ -153,6 +153,72 @@ export const ListCommissionsStatus = {
 } as const;
 export type ListCommissionsStatus = ClosedEnum<typeof ListCommissionsStatus>;
 
+export type ListCommissionsPartner = {
+  /**
+   * 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 ListCommissionsCustomer = {
+  /**
+   * 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 ListCommissionsResponseBody = {
   /**
    * The commission's unique ID on Dub.
@@ -163,10 +229,17 @@ export type ListCommissionsResponseBody = {
   earnings: number;
   currency: string;
   status: ListCommissionsStatus;
-  invoiceId?: string | null | undefined;
-  description?: string | null | undefined;
+  invoiceId: string | null;
+  description: string | null;
+  quantity: number;
+  /**
+   * The user who created the manual commission.
+   */
+  userId?: string | null | undefined;
   createdAt: string;
   updatedAt: string;
+  partner: ListCommissionsPartner;
+  customer?: ListCommissionsCustomer | null | undefined;
 };
 
 /** @internal */
@@ -407,6 +480,153 @@ export namespace ListCommissionsStatus$ {
   export const outboundSchema = ListCommissionsStatus$outboundSchema;
 }
 
+/** @internal */
+export const ListCommissionsPartner$inboundSchema: z.ZodType<
+  ListCommissionsPartner,
+  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 ListCommissionsPartner$Outbound = {
+  id: string;
+  name: string;
+  email: string | null;
+  image: string | null;
+  payoutsEnabledAt: string | null;
+  country: string | null;
+};
+
+/** @internal */
+export const ListCommissionsPartner$outboundSchema: z.ZodType<
+  ListCommissionsPartner$Outbound,
+  z.ZodTypeDef,
+  ListCommissionsPartner
+> = 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 ListCommissionsPartner$ {
+  /** @deprecated use `ListCommissionsPartner$inboundSchema` instead. */
+  export const inboundSchema = ListCommissionsPartner$inboundSchema;
+  /** @deprecated use `ListCommissionsPartner$outboundSchema` instead. */
+  export const outboundSchema = ListCommissionsPartner$outboundSchema;
+  /** @deprecated use `ListCommissionsPartner$Outbound` instead. */
+  export type Outbound = ListCommissionsPartner$Outbound;
+}
+
+export function listCommissionsPartnerToJSON(
+  listCommissionsPartner: ListCommissionsPartner,
+): string {
+  return JSON.stringify(
+    ListCommissionsPartner$outboundSchema.parse(listCommissionsPartner),
+  );
+}
+
+export function listCommissionsPartnerFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCommissionsPartner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCommissionsPartner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCommissionsPartner' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCommissionsCustomer$inboundSchema: z.ZodType<
+  ListCommissionsCustomer,
+  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 ListCommissionsCustomer$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 ListCommissionsCustomer$outboundSchema: z.ZodType<
+  ListCommissionsCustomer$Outbound,
+  z.ZodTypeDef,
+  ListCommissionsCustomer
+> = 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 ListCommissionsCustomer$ {
+  /** @deprecated use `ListCommissionsCustomer$inboundSchema` instead. */
+  export const inboundSchema = ListCommissionsCustomer$inboundSchema;
+  /** @deprecated use `ListCommissionsCustomer$outboundSchema` instead. */
+  export const outboundSchema = ListCommissionsCustomer$outboundSchema;
+  /** @deprecated use `ListCommissionsCustomer$Outbound` instead. */
+  export type Outbound = ListCommissionsCustomer$Outbound;
+}
+
+export function listCommissionsCustomerToJSON(
+  listCommissionsCustomer: ListCommissionsCustomer,
+): string {
+  return JSON.stringify(
+    ListCommissionsCustomer$outboundSchema.parse(listCommissionsCustomer),
+  );
+}
+
+export function listCommissionsCustomerFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCommissionsCustomer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCommissionsCustomer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCommissionsCustomer' from JSON`,
+  );
+}
+
 /** @internal */
 export const ListCommissionsResponseBody$inboundSchema: z.ZodType<
   ListCommissionsResponseBody,
@@ -419,10 +639,15 @@ export const ListCommissionsResponseBody$inboundSchema: z.ZodType<
   earnings: z.number(),
   currency: z.string(),
   status: ListCommissionsStatus$inboundSchema,
-  invoiceId: z.nullable(z.string()).optional(),
-  description: z.nullable(z.string()).optional(),
+  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(() => ListCommissionsPartner$inboundSchema),
+  customer: z.nullable(z.lazy(() => ListCommissionsCustomer$inboundSchema))
+    .optional(),
 });
 
 /** @internal */
@@ -433,10 +658,14 @@ export type ListCommissionsResponseBody$Outbound = {
   earnings: number;
   currency: string;
   status: string;
-  invoiceId?: string | null | undefined;
-  description?: string | null | undefined;
+  invoiceId: string | null;
+  description: string | null;
+  quantity: number;
+  userId?: string | null | undefined;
   createdAt: string;
   updatedAt: string;
+  partner: ListCommissionsPartner$Outbound;
+  customer?: ListCommissionsCustomer$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -451,10 +680,15 @@ export const ListCommissionsResponseBody$outboundSchema: z.ZodType<
   earnings: z.number(),
   currency: z.string(),
   status: ListCommissionsStatus$outboundSchema,
-  invoiceId: z.nullable(z.string()).optional(),
-  description: z.nullable(z.string()).optional(),
+  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(() => ListCommissionsPartner$outboundSchema),
+  customer: z.nullable(z.lazy(() => ListCommissionsCustomer$outboundSchema))
+    .optional(),
 });
 
 /**