import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import { LinkTagSchema, LinkTagSchema$Outbound } from "./linktagschema.js"; export declare const LeadCreatedEventEvent: { readonly LeadCreated: "lead.created"; }; export type LeadCreatedEventEvent = ClosedEnum; export type Customer = { /** * 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; /** * Name of the customer. */ name: string; /** * Email of the customer. */ email?: string | null | undefined; /** * Avatar URL of the customer. */ avatar?: string | null | undefined; /** * Unique identifier for the customer in the client's app. */ externalId: string; /** * The customer's Stripe customer ID. This is useful for attributing recurring sale events to the partner who referred the customer. */ stripeCustomerId?: 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 (usually the signup date or trial start date). */ createdAt: string; /** * The date the customer made their first sale. Useful for calculating the time to first sale and LTV. */ firstSaleAt?: string | null | undefined; /** * The date the customer canceled their subscription. Useful for calculating LTV and churn rate. */ subscriptionCanceledAt?: string | null | undefined; }; export type LeadCreatedEventClick = { id: string; timestamp: string; url: string; country: string; city: string; region: string; continent: string; device: string; browser: string; os: string; trigger?: string | null | undefined; referer: string; refererUrl: string; qr: boolean; ip: string; }; export type LeadCreatedEventTestVariants = { url: string; percentage: number; }; export type LeadCreatedEventLink = { /** * The unique ID of the short link. */ id: string; /** * The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). */ domain: string; /** * The short link slug. If not provided, a random 7-character slug will be generated. */ key: string; url: string; trackConversion: boolean; /** * The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. */ externalId: string | null; /** * The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant. */ tenantId: string | null; /** * The ID of the program the short link is associated with. */ programId: string | null; /** * The ID of the partner the short link is associated with. */ partnerId: string | null; archived: boolean; expiresAt: string; expiredUrl: string | null; disabledAt: string; /** * The password required to access the destination URL of the short link. */ password: string | null; proxy: boolean; /** * The title of the short link. Will be used for Custom Link Previews if `proxy` is true. */ title: string | null; /** * The description of the short link. Will be used for Custom Link Previews if `proxy` is true. */ description: string | null; /** * The image of the short link. Will be used for Custom Link Previews if `proxy` is true. */ image: string | null; /** * The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og */ video: string | null; rewrite: boolean; doIndex: boolean; /** * The iOS destination URL for the short link for iOS device targeting. */ ios: string | null; /** * The Android destination URL for the short link for Android device targeting. */ android: string | null; /** * Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. See https://d.to/geo for more information. */ geo: { [k: string]: string; } | null; publicStats: boolean; /** * The tags assigned to the short link. */ tags: Array | null; /** * The unique ID of the folder assigned to the short link. */ folderId: string | null; /** * The IDs of the webhooks that the short link is associated with. */ webhookIds: Array; /** * The comments for the short link. */ comments: string | null; /** * The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`). */ shortLink: string; /** * The full URL of the QR code for the short link (e.g. `https://api.dub.co/qr?url=https://dub.sh/try`). */ qrCode: string; /** * The UTM source of the short link. */ utmSource: string | null; /** * The UTM medium of the short link. */ utmMedium: string | null; /** * The UTM campaign of the short link. */ utmCampaign: string | null; /** * The UTM term of the short link. */ utmTerm: string | null; /** * The UTM content of the short link. */ utmContent: string | null; /** * An array of A/B test URLs and the percentage of traffic to send to each URL. */ testVariants?: Array | null | undefined; testStartedAt: string; testCompletedAt: string; userId: string | null; /** * The workspace ID of the short link. */ workspaceId: string; /** * The number of clicks on the short link. */ clicks?: number | undefined; /** * The number of leads the short link has generated. */ leads?: number | undefined; /** * 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 value of sales (in cents) generated by the short link. */ saleAmount?: number | undefined; lastClicked: string; createdAt: string; updatedAt: string; /** * 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. */ projectId: string; }; export type Partner = { /** * 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; groupId?: string | null | undefined; totalClicks: number; totalLeads: number; totalConversions: number; totalSales: number; totalSaleAmount: number; totalCommissions: number; }; export type LeadCreatedEventData = { eventName: string; customer: Customer; click: LeadCreatedEventClick; link: LeadCreatedEventLink; partner?: Partner | null | undefined; metadata: { [k: string]: any; } | null; }; /** * Triggered when a lead is created. */ export type LeadCreatedEvent = { id: string; event: LeadCreatedEventEvent; createdAt: string; data: LeadCreatedEventData; }; /** @internal */ export declare const LeadCreatedEventEvent$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const LeadCreatedEventEvent$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const Customer$inboundSchema: z.ZodType; /** @internal */ export type Customer$Outbound = { id: string; name: string; email?: string | null | undefined; avatar?: string | null | undefined; externalId: string; stripeCustomerId?: string | null | undefined; country?: string | null | undefined; sales?: number | null | undefined; saleAmount?: number | null | undefined; createdAt: string; firstSaleAt?: string | null | undefined; subscriptionCanceledAt?: string | null | undefined; }; /** @internal */ export declare const Customer$outboundSchema: z.ZodType; export declare function customerToJSON(customer: Customer): string; export declare function customerFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const LeadCreatedEventClick$inboundSchema: z.ZodType; /** @internal */ export type LeadCreatedEventClick$Outbound = { id: string; timestamp: string; url: string; country: string; city: string; region: string; continent: string; device: string; browser: string; os: string; trigger?: string | null | undefined; referer: string; refererUrl: string; qr: boolean; ip: string; }; /** @internal */ export declare const LeadCreatedEventClick$outboundSchema: z.ZodType; export declare function leadCreatedEventClickToJSON(leadCreatedEventClick: LeadCreatedEventClick): string; export declare function leadCreatedEventClickFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const LeadCreatedEventTestVariants$inboundSchema: z.ZodType; /** @internal */ export type LeadCreatedEventTestVariants$Outbound = { url: string; percentage: number; }; /** @internal */ export declare const LeadCreatedEventTestVariants$outboundSchema: z.ZodType; export declare function leadCreatedEventTestVariantsToJSON(leadCreatedEventTestVariants: LeadCreatedEventTestVariants): string; export declare function leadCreatedEventTestVariantsFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const LeadCreatedEventLink$inboundSchema: z.ZodType; /** @internal */ export type LeadCreatedEventLink$Outbound = { id: string; domain: string; key: string; url: string; trackConversion: boolean; externalId: string | null; tenantId: string | null; programId: string | null; partnerId: string | null; archived: boolean; expiresAt: string; expiredUrl: string | null; disabledAt: string; password: string | null; proxy: boolean; title: string | null; description: string | null; image: string | null; video: string | null; rewrite: boolean; doIndex: boolean; ios: string | null; android: string | null; geo: { [k: string]: string; } | null; publicStats: boolean; tags: Array | null; folderId: string | null; webhookIds: Array; comments: string | null; shortLink: string; qrCode: string; utm_source: string | null; utm_medium: string | null; utm_campaign: string | null; utm_term: string | null; utm_content: string | null; testVariants?: Array | null | undefined; testStartedAt: string; testCompletedAt: string; userId: string | null; workspaceId: string; clicks: number; leads: number; conversions: number; sales: number; saleAmount: number; lastClicked: string; createdAt: string; updatedAt: string; tagId: string | null; projectId: string; }; /** @internal */ export declare const LeadCreatedEventLink$outboundSchema: z.ZodType; export declare function leadCreatedEventLinkToJSON(leadCreatedEventLink: LeadCreatedEventLink): string; export declare function leadCreatedEventLinkFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const Partner$inboundSchema: z.ZodType; /** @internal */ export type Partner$Outbound = { id: string; name: string; email: string | null; image: string | null; payoutsEnabledAt: string | null; country: string | null; groupId?: string | null | undefined; totalClicks: number; totalLeads: number; totalConversions: number; totalSales: number; totalSaleAmount: number; totalCommissions: number; }; /** @internal */ export declare const Partner$outboundSchema: z.ZodType; export declare function partnerToJSON(partner: Partner): string; export declare function partnerFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const LeadCreatedEventData$inboundSchema: z.ZodType; /** @internal */ export type LeadCreatedEventData$Outbound = { eventName: string; customer: Customer$Outbound; click: LeadCreatedEventClick$Outbound; link: LeadCreatedEventLink$Outbound; partner?: Partner$Outbound | null | undefined; metadata: { [k: string]: any; } | null; }; /** @internal */ export declare const LeadCreatedEventData$outboundSchema: z.ZodType; export declare function leadCreatedEventDataToJSON(leadCreatedEventData: LeadCreatedEventData): string; export declare function leadCreatedEventDataFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const LeadCreatedEvent$inboundSchema: z.ZodType; /** @internal */ export type LeadCreatedEvent$Outbound = { id: string; event: string; createdAt: string; data: LeadCreatedEventData$Outbound; }; /** @internal */ export declare const LeadCreatedEvent$outboundSchema: z.ZodType; export declare function leadCreatedEventToJSON(leadCreatedEvent: LeadCreatedEvent): string; export declare function leadCreatedEventFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=leadcreatedevent.d.ts.map