dub 0.64.0 → 0.64.2

package/src/models/operations/retrieveanalytics.ts

@@ -80,6 +80,8 @@ export type Interval = ClosedEnum<typeof Interval>;
 export const Trigger = {
   Qr: "qr",
   Link: "link",
+  Pageview: "pageview",
+  Deeplink: "deeplink",
 } as const;
 /**
  * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
@@ -91,6 +93,18 @@ export type Trigger = ClosedEnum<typeof Trigger>;
  */
 export type RetrieveAnalyticsQueryParamTagIds = string | Array<string>;
 
+/**
+ * Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
+ */
+export const SaleType = {
+  New: "new",
+  Recurring: "recurring",
+} as const;
+/**
+ * Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
+ */
+export type SaleType = ClosedEnum<typeof SaleType>;
+
 export type RetrieveAnalyticsRequest = {
   /**
    * The type of event to retrieve analytics for. Defaults to `clicks`.
@@ -212,6 +226,10 @@ export type RetrieveAnalyticsRequest = {
    * Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
    */
   root?: boolean | undefined;
+  /**
+   * Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
+   */
+  saleType?: SaleType | undefined;
   /**
    * The UTM source of the short link.
    */
@@ -383,6 +401,25 @@ export function retrieveAnalyticsQueryParamTagIdsFromJSON(
   );
 }
 
+/** @internal */
+export const SaleType$inboundSchema: z.ZodNativeEnum<typeof SaleType> = z
+  .nativeEnum(SaleType);
+
+/** @internal */
+export const SaleType$outboundSchema: z.ZodNativeEnum<typeof SaleType> =
+  SaleType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SaleType$ {
+  /** @deprecated use `SaleType$inboundSchema` instead. */
+  export const inboundSchema = SaleType$inboundSchema;
+  /** @deprecated use `SaleType$outboundSchema` instead. */
+  export const outboundSchema = SaleType$outboundSchema;
+}
+
 /** @internal */
 export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   RetrieveAnalyticsRequest,
@@ -419,6 +456,7 @@ export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   folderId: z.string().optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
+  saleType: SaleType$inboundSchema.optional(),
   utm_source: z.nullable(z.string()).optional(),
   utm_medium: z.nullable(z.string()).optional(),
   utm_campaign: z.nullable(z.string()).optional(),
@@ -466,6 +504,7 @@ export type RetrieveAnalyticsRequest$Outbound = {
   folderId?: string | undefined;
   qr?: boolean | undefined;
   root?: boolean | undefined;
+  saleType?: string | undefined;
   utm_source?: string | null | undefined;
   utm_medium?: string | null | undefined;
   utm_campaign?: string | null | undefined;
@@ -509,6 +548,7 @@ export const RetrieveAnalyticsRequest$outboundSchema: z.ZodType<
   folderId: z.string().optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
+  saleType: SaleType$outboundSchema.optional(),
   utmSource: z.nullable(z.string()).optional(),
   utmMedium: z.nullable(z.string()).optional(),
   utmCampaign: z.nullable(z.string()).optional(),

package/src/models/operations/tracklead.ts

@@ -32,7 +32,7 @@ export type TrackLeadRequestBody = {
   /**
    * The unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer.
    */
-  externalId: string;
+  customerExternalId: string;
   /**
    * The name of the customer. If not passed, a random name will be generated (e.g. “Big Red Caribou”).
    */
@@ -106,7 +106,7 @@ export const TrackLeadRequestBody$inboundSchema: z.ZodType<
 > = z.object({
   clickId: z.string(),
   eventName: z.string(),
-  externalId: z.string(),
+  customerExternalId: z.string(),
   customerName: z.nullable(z.string()).default(null),
   customerEmail: z.nullable(z.string()).default(null),
   customerAvatar: z.nullable(z.string()).default(null),
@@ -119,7 +119,7 @@ export const TrackLeadRequestBody$inboundSchema: z.ZodType<
 export type TrackLeadRequestBody$Outbound = {
   clickId: string;
   eventName: string;
-  externalId: string;
+  customerExternalId: string;
   customerName: string | null;
   customerEmail: string | null;
   customerAvatar: string | null;
@@ -136,7 +136,7 @@ export const TrackLeadRequestBody$outboundSchema: z.ZodType<
 > = z.object({
   clickId: z.string(),
   eventName: z.string(),
-  externalId: z.string(),
+  customerExternalId: z.string(),
   customerName: z.nullable(z.string()).default(null),
   customerEmail: z.nullable(z.string()).default(null),
   customerAvatar: z.nullable(z.string()).default(null),

package/src/models/operations/tracksale.ts

@@ -16,6 +16,7 @@ export const PaymentProcessor = {
   Shopify: "shopify",
   Polar: "polar",
   Paddle: "paddle",
+  Revenuecat: "revenuecat",
   Custom: "custom",
 } as const;
 /**
@@ -27,7 +28,7 @@ export type TrackSaleRequestBody = {
   /**
    * The unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer.
    */
-  externalId: string;
+  customerExternalId: string;
   /**
    * The amount of the sale in cents (for all two-decimal currencies). If the sale is in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn more: https://d.to/currency
    */
@@ -110,7 +111,7 @@ export const TrackSaleRequestBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  externalId: z.string(),
+  customerExternalId: z.string(),
   amount: z.number().int(),
   currency: z.string().default("usd"),
   eventName: z.string().default("Purchase"),
@@ -122,7 +123,7 @@ export const TrackSaleRequestBody$inboundSchema: z.ZodType<
 
 /** @internal */
 export type TrackSaleRequestBody$Outbound = {
-  externalId: string;
+  customerExternalId: string;
   amount: number;
   currency: string;
   eventName: string;
@@ -138,7 +139,7 @@ export const TrackSaleRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TrackSaleRequestBody
 > = z.object({
-  externalId: z.string(),
+  customerExternalId: z.string(),
   amount: z.number().int(),
   currency: z.string().default("usd"),
   eventName: z.string().default("Purchase"),

package/src/models/operations/updatecommission.ts

@@ -69,6 +69,72 @@ export const UpdateCommissionStatus = {
 } as const;
 export type UpdateCommissionStatus = ClosedEnum<typeof UpdateCommissionStatus>;
 
+export type UpdateCommissionPartner = {
+  /**
+   * 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 UpdateCommissionCustomer = {
+  /**
+   * 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;
+};
+
 /**
  * The updated commission.
  */
@@ -82,10 +148,17 @@ export type UpdateCommissionResponseBody = {
   earnings: number;
   currency: string;
   status: UpdateCommissionStatus;
-  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: UpdateCommissionPartner;
+  customer?: UpdateCommissionCustomer | null | undefined;
 };
 
 /** @internal */
@@ -281,6 +354,153 @@ export namespace UpdateCommissionStatus$ {
   export const outboundSchema = UpdateCommissionStatus$outboundSchema;
 }
 
+/** @internal */
+export const UpdateCommissionPartner$inboundSchema: z.ZodType<
+  UpdateCommissionPartner,
+  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 UpdateCommissionPartner$Outbound = {
+  id: string;
+  name: string;
+  email: string | null;
+  image: string | null;
+  payoutsEnabledAt: string | null;
+  country: string | null;
+};
+
+/** @internal */
+export const UpdateCommissionPartner$outboundSchema: z.ZodType<
+  UpdateCommissionPartner$Outbound,
+  z.ZodTypeDef,
+  UpdateCommissionPartner
+> = 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 UpdateCommissionPartner$ {
+  /** @deprecated use `UpdateCommissionPartner$inboundSchema` instead. */
+  export const inboundSchema = UpdateCommissionPartner$inboundSchema;
+  /** @deprecated use `UpdateCommissionPartner$outboundSchema` instead. */
+  export const outboundSchema = UpdateCommissionPartner$outboundSchema;
+  /** @deprecated use `UpdateCommissionPartner$Outbound` instead. */
+  export type Outbound = UpdateCommissionPartner$Outbound;
+}
+
+export function updateCommissionPartnerToJSON(
+  updateCommissionPartner: UpdateCommissionPartner,
+): string {
+  return JSON.stringify(
+    UpdateCommissionPartner$outboundSchema.parse(updateCommissionPartner),
+  );
+}
+
+export function updateCommissionPartnerFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateCommissionPartner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateCommissionPartner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateCommissionPartner' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateCommissionCustomer$inboundSchema: z.ZodType<
+  UpdateCommissionCustomer,
+  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 UpdateCommissionCustomer$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 UpdateCommissionCustomer$outboundSchema: z.ZodType<
+  UpdateCommissionCustomer$Outbound,
+  z.ZodTypeDef,
+  UpdateCommissionCustomer
+> = 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 UpdateCommissionCustomer$ {
+  /** @deprecated use `UpdateCommissionCustomer$inboundSchema` instead. */
+  export const inboundSchema = UpdateCommissionCustomer$inboundSchema;
+  /** @deprecated use `UpdateCommissionCustomer$outboundSchema` instead. */
+  export const outboundSchema = UpdateCommissionCustomer$outboundSchema;
+  /** @deprecated use `UpdateCommissionCustomer$Outbound` instead. */
+  export type Outbound = UpdateCommissionCustomer$Outbound;
+}
+
+export function updateCommissionCustomerToJSON(
+  updateCommissionCustomer: UpdateCommissionCustomer,
+): string {
+  return JSON.stringify(
+    UpdateCommissionCustomer$outboundSchema.parse(updateCommissionCustomer),
+  );
+}
+
+export function updateCommissionCustomerFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateCommissionCustomer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateCommissionCustomer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateCommissionCustomer' from JSON`,
+  );
+}
+
 /** @internal */
 export const UpdateCommissionResponseBody$inboundSchema: z.ZodType<
   UpdateCommissionResponseBody,
@@ -293,10 +513,15 @@ export const UpdateCommissionResponseBody$inboundSchema: z.ZodType<
   earnings: z.number(),
   currency: z.string(),
   status: UpdateCommissionStatus$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(() => UpdateCommissionPartner$inboundSchema),
+  customer: z.nullable(z.lazy(() => UpdateCommissionCustomer$inboundSchema))
+    .optional(),
 });
 
 /** @internal */
@@ -307,10 +532,14 @@ export type UpdateCommissionResponseBody$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: UpdateCommissionPartner$Outbound;
+  customer?: UpdateCommissionCustomer$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -325,10 +554,15 @@ export const UpdateCommissionResponseBody$outboundSchema: z.ZodType<
   earnings: z.number(),
   currency: z.string(),
   status: UpdateCommissionStatus$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(() => UpdateCommissionPartner$outboundSchema),
+  customer: z.nullable(z.lazy(() => UpdateCommissionCustomer$outboundSchema))
+    .optional(),
 });
 
 /**

package/src/sdk/partners.ts

@@ -5,6 +5,7 @@
 import { partnersAnalytics } from "../funcs/partnersAnalytics.js";
 import { partnersCreate } from "../funcs/partnersCreate.js";
 import { partnersCreateLink } from "../funcs/partnersCreateLink.js";
+import { partnersList } from "../funcs/partnersList.js";
 import { partnersRetrieveLinks } from "../funcs/partnersRetrieveLinks.js";
 import { partnersUpsertLink } from "../funcs/partnersUpsertLink.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -30,6 +31,23 @@ export class Partners extends ClientSDK {
     ));
   }
 
+  /**
+   * List all partners
+   *
+   * @remarks
+   * List all partners for a partner program.
+   */
+  async list(
+    request?: operations.ListPartnersRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<Array<operations.ListPartnersResponseBody>> {
+    return unwrapAsync(partnersList(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create a link for a partner
    *