/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import * as z from "zod/v3";
import { remap as remap$ } from "../../lib/primitives.js";
import { safeParse } from "../../lib/schemas.js";
import { ClosedEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import {
  LinkTagSchema,
  LinkTagSchema$inboundSchema,
  LinkTagSchema$Outbound,
  LinkTagSchema$outboundSchema,
} from "./linktagschema.js";

export const LinkClickedEventEvent = {
  LinkClicked: "link.clicked",
} as const;
export type LinkClickedEventEvent = ClosedEnum<typeof LinkClickedEventEvent>;

export type Click = {
  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 LinkClickedEventTestVariants = {
  url: string;
  percentage: number;
};

export type Link = {
  /**
   * 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<LinkTagSchema> | 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<string>;
  /**
   * 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<LinkClickedEventTestVariants> | 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 LinkClickedEventData = {
  click: Click;
  link: Link;
};

/**
 * Triggered when a link is clicked.
 */
export type LinkClickedEvent = {
  id: string;
  event: LinkClickedEventEvent;
  createdAt: string;
  data: LinkClickedEventData;
};

/** @internal */
export const LinkClickedEventEvent$inboundSchema: z.ZodNativeEnum<
  typeof LinkClickedEventEvent
> = z.nativeEnum(LinkClickedEventEvent);
/** @internal */
export const LinkClickedEventEvent$outboundSchema: z.ZodNativeEnum<
  typeof LinkClickedEventEvent
> = LinkClickedEventEvent$inboundSchema;

/** @internal */
export const Click$inboundSchema: z.ZodType<Click, z.ZodTypeDef, unknown> = z
  .object({
    id: z.string(),
    timestamp: z.string(),
    url: z.string(),
    country: z.string(),
    city: z.string(),
    region: z.string(),
    continent: z.string(),
    device: z.string(),
    browser: z.string(),
    os: z.string(),
    trigger: z.nullable(z.string()).optional(),
    referer: z.string(),
    refererUrl: z.string(),
    qr: z.boolean(),
    ip: z.string(),
  });
/** @internal */
export type Click$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 const Click$outboundSchema: z.ZodType<
  Click$Outbound,
  z.ZodTypeDef,
  Click
> = z.object({
  id: z.string(),
  timestamp: z.string(),
  url: z.string(),
  country: z.string(),
  city: z.string(),
  region: z.string(),
  continent: z.string(),
  device: z.string(),
  browser: z.string(),
  os: z.string(),
  trigger: z.nullable(z.string()).optional(),
  referer: z.string(),
  refererUrl: z.string(),
  qr: z.boolean(),
  ip: z.string(),
});

export function clickToJSON(click: Click): string {
  return JSON.stringify(Click$outboundSchema.parse(click));
}
export function clickFromJSON(
  jsonString: string,
): SafeParseResult<Click, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Click$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Click' from JSON`,
  );
}

/** @internal */
export const LinkClickedEventTestVariants$inboundSchema: z.ZodType<
  LinkClickedEventTestVariants,
  z.ZodTypeDef,
  unknown
> = z.object({
  url: z.string(),
  percentage: z.number(),
});
/** @internal */
export type LinkClickedEventTestVariants$Outbound = {
  url: string;
  percentage: number;
};

/** @internal */
export const LinkClickedEventTestVariants$outboundSchema: z.ZodType<
  LinkClickedEventTestVariants$Outbound,
  z.ZodTypeDef,
  LinkClickedEventTestVariants
> = z.object({
  url: z.string(),
  percentage: z.number(),
});

export function linkClickedEventTestVariantsToJSON(
  linkClickedEventTestVariants: LinkClickedEventTestVariants,
): string {
  return JSON.stringify(
    LinkClickedEventTestVariants$outboundSchema.parse(
      linkClickedEventTestVariants,
    ),
  );
}
export function linkClickedEventTestVariantsFromJSON(
  jsonString: string,
): SafeParseResult<LinkClickedEventTestVariants, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => LinkClickedEventTestVariants$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'LinkClickedEventTestVariants' from JSON`,
  );
}

/** @internal */
export const Link$inboundSchema: z.ZodType<Link, z.ZodTypeDef, unknown> = z
  .object({
    id: z.string(),
    domain: z.string(),
    key: z.string(),
    url: z.string(),
    trackConversion: z.boolean(),
    externalId: z.nullable(z.string()),
    tenantId: z.nullable(z.string()),
    programId: z.nullable(z.string()),
    partnerId: z.nullable(z.string()),
    archived: z.boolean(),
    expiresAt: z.string(),
    expiredUrl: z.nullable(z.string()),
    disabledAt: z.string(),
    password: z.nullable(z.string()),
    proxy: z.boolean(),
    title: z.nullable(z.string()),
    description: z.nullable(z.string()),
    image: z.nullable(z.string()),
    video: z.nullable(z.string()),
    rewrite: z.boolean(),
    doIndex: z.boolean(),
    ios: z.nullable(z.string()),
    android: z.nullable(z.string()),
    geo: z.nullable(z.record(z.string())),
    publicStats: z.boolean(),
    tags: z.nullable(z.array(LinkTagSchema$inboundSchema)),
    folderId: z.nullable(z.string()),
    webhookIds: z.array(z.string()),
    comments: z.nullable(z.string()),
    shortLink: z.string(),
    qrCode: z.string(),
    utm_source: z.nullable(z.string()),
    utm_medium: z.nullable(z.string()),
    utm_campaign: z.nullable(z.string()),
    utm_term: z.nullable(z.string()),
    utm_content: z.nullable(z.string()),
    testVariants: z.nullable(
      z.array(z.lazy(() => LinkClickedEventTestVariants$inboundSchema)),
    ).optional(),
    testStartedAt: z.string(),
    testCompletedAt: z.string(),
    userId: z.nullable(z.string()),
    workspaceId: z.string(),
    clicks: z.number().default(0),
    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, {
      "utm_source": "utmSource",
      "utm_medium": "utmMedium",
      "utm_campaign": "utmCampaign",
      "utm_term": "utmTerm",
      "utm_content": "utmContent",
    });
  });
/** @internal */
export type Link$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<LinkTagSchema$Outbound> | null;
  folderId: string | null;
  webhookIds: Array<string>;
  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<LinkClickedEventTestVariants$Outbound>
    | 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 const Link$outboundSchema: z.ZodType<Link$Outbound, z.ZodTypeDef, Link> =
  z.object({
    id: z.string(),
    domain: z.string(),
    key: z.string(),
    url: z.string(),
    trackConversion: z.boolean(),
    externalId: z.nullable(z.string()),
    tenantId: z.nullable(z.string()),
    programId: z.nullable(z.string()),
    partnerId: z.nullable(z.string()),
    archived: z.boolean(),
    expiresAt: z.string(),
    expiredUrl: z.nullable(z.string()),
    disabledAt: z.string(),
    password: z.nullable(z.string()),
    proxy: z.boolean(),
    title: z.nullable(z.string()),
    description: z.nullable(z.string()),
    image: z.nullable(z.string()),
    video: z.nullable(z.string()),
    rewrite: z.boolean(),
    doIndex: z.boolean(),
    ios: z.nullable(z.string()),
    android: z.nullable(z.string()),
    geo: z.nullable(z.record(z.string())),
    publicStats: z.boolean(),
    tags: z.nullable(z.array(LinkTagSchema$outboundSchema)),
    folderId: z.nullable(z.string()),
    webhookIds: z.array(z.string()),
    comments: z.nullable(z.string()),
    shortLink: z.string(),
    qrCode: z.string(),
    utmSource: z.nullable(z.string()),
    utmMedium: z.nullable(z.string()),
    utmCampaign: z.nullable(z.string()),
    utmTerm: z.nullable(z.string()),
    utmContent: z.nullable(z.string()),
    testVariants: z.nullable(
      z.array(z.lazy(() => LinkClickedEventTestVariants$outboundSchema)),
    ).optional(),
    testStartedAt: z.string(),
    testCompletedAt: z.string(),
    userId: z.nullable(z.string()),
    workspaceId: z.string(),
    clicks: z.number().default(0),
    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, {
      utmSource: "utm_source",
      utmMedium: "utm_medium",
      utmCampaign: "utm_campaign",
      utmTerm: "utm_term",
      utmContent: "utm_content",
    });
  });

export function linkToJSON(link: Link): string {
  return JSON.stringify(Link$outboundSchema.parse(link));
}
export function linkFromJSON(
  jsonString: string,
): SafeParseResult<Link, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Link$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Link' from JSON`,
  );
}

/** @internal */
export const LinkClickedEventData$inboundSchema: z.ZodType<
  LinkClickedEventData,
  z.ZodTypeDef,
  unknown
> = z.object({
  click: z.lazy(() => Click$inboundSchema),
  link: z.lazy(() => Link$inboundSchema),
});
/** @internal */
export type LinkClickedEventData$Outbound = {
  click: Click$Outbound;
  link: Link$Outbound;
};

/** @internal */
export const LinkClickedEventData$outboundSchema: z.ZodType<
  LinkClickedEventData$Outbound,
  z.ZodTypeDef,
  LinkClickedEventData
> = z.object({
  click: z.lazy(() => Click$outboundSchema),
  link: z.lazy(() => Link$outboundSchema),
});

export function linkClickedEventDataToJSON(
  linkClickedEventData: LinkClickedEventData,
): string {
  return JSON.stringify(
    LinkClickedEventData$outboundSchema.parse(linkClickedEventData),
  );
}
export function linkClickedEventDataFromJSON(
  jsonString: string,
): SafeParseResult<LinkClickedEventData, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => LinkClickedEventData$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'LinkClickedEventData' from JSON`,
  );
}

/** @internal */
export const LinkClickedEvent$inboundSchema: z.ZodType<
  LinkClickedEvent,
  z.ZodTypeDef,
  unknown
> = z.object({
  id: z.string(),
  event: LinkClickedEventEvent$inboundSchema,
  createdAt: z.string(),
  data: z.lazy(() => LinkClickedEventData$inboundSchema),
});
/** @internal */
export type LinkClickedEvent$Outbound = {
  id: string;
  event: string;
  createdAt: string;
  data: LinkClickedEventData$Outbound;
};

/** @internal */
export const LinkClickedEvent$outboundSchema: z.ZodType<
  LinkClickedEvent$Outbound,
  z.ZodTypeDef,
  LinkClickedEvent
> = z.object({
  id: z.string(),
  event: LinkClickedEventEvent$outboundSchema,
  createdAt: z.string(),
  data: z.lazy(() => LinkClickedEventData$outboundSchema),
});

export function linkClickedEventToJSON(
  linkClickedEvent: LinkClickedEvent,
): string {
  return JSON.stringify(
    LinkClickedEvent$outboundSchema.parse(linkClickedEvent),
  );
}
export function linkClickedEventFromJSON(
  jsonString: string,
): SafeParseResult<LinkClickedEvent, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => LinkClickedEvent$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'LinkClickedEvent' from JSON`,
  );
}