/*
 * 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 * as components from "../components/index.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";

/**
 * The type of event to retrieve analytics for. Defaults to 'clicks'.
 */
export const QueryParamEvent = {
  Clicks: "clicks",
  Leads: "leads",
  Sales: "sales",
} as const;
/**
 * The type of event to retrieve analytics for. Defaults to 'clicks'.
 */
export type QueryParamEvent = ClosedEnum<typeof QueryParamEvent>;

/**
 * The interval to retrieve analytics for. If undefined, defaults to 24h.
 */
export const QueryParamInterval = {
  TwentyFourh: "24h",
  Sevend: "7d",
  Thirtyd: "30d",
  Ninetyd: "90d",
  Oney: "1y",
  Mtd: "mtd",
  Qtd: "qtd",
  Ytd: "ytd",
  All: "all",
} as const;
/**
 * The interval to retrieve analytics for. If undefined, defaults to 24h.
 */
export type QueryParamInterval = ClosedEnum<typeof QueryParamInterval>;

/**
 * Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
 */
export const QueryParamSaleType = {
  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 QueryParamSaleType = ClosedEnum<typeof QueryParamSaleType>;

/**
 * The sort order. The default is `desc`.
 */
export const QueryParamSortOrder = {
  Asc: "asc",
  Desc: "desc",
} as const;
/**
 * The sort order. The default is `desc`.
 */
export type QueryParamSortOrder = ClosedEnum<typeof QueryParamSortOrder>;

/**
 * The field to sort the events by. The default is `timestamp`.
 */
export const QueryParamSortBy = {
  Timestamp: "timestamp",
} as const;
/**
 * The field to sort the events by. The default is `timestamp`.
 */
export type QueryParamSortBy = ClosedEnum<typeof QueryParamSortBy>;

/**
 * DEPRECATED. Use `sortOrder` instead.
 *
 * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
 */
export const Order = {
  Asc: "asc",
  Desc: "desc",
} as const;
/**
 * DEPRECATED. Use `sortOrder` instead.
 *
 * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
 */
export type Order = ClosedEnum<typeof Order>;

export type ListEventsRequest = {
  /**
   * The type of event to retrieve analytics for. Defaults to 'clicks'.
   */
  event?: QueryParamEvent | undefined;
  /**
   * The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.
   */
  domain?: string | undefined;
  /**
   * The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.
   */
  key?: string | undefined;
  /**
   * The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.
   */
  linkId?: string | undefined;
  /**
   * The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
   */
  externalId?: string | undefined;
  /**
   * The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.
   */
  tenantId?: string | undefined;
  /**
   * The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.
   */
  tagId?: string | undefined;
  /**
   * The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.
   */
  folderId?: string | undefined;
  /**
   * The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.
   */
  groupId?: string | undefined;
  /**
   * The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.
   */
  partnerId?: string | undefined;
  /**
   * The ID of the customer to retrieve analytics for.
   */
  customerId?: string | undefined;
  /**
   * The interval to retrieve analytics for. If undefined, defaults to 24h.
   */
  interval?: QueryParamInterval | undefined;
  /**
   * The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.
   */
  start?: string | undefined;
  /**
   * The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.
   */
  end?: string | undefined;
  /**
   * The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
   */
  timezone?: string | undefined;
  /**
   * The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.
   */
  country?: string | undefined;
  /**
   * The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.
   */
  city?: string | undefined;
  /**
   * The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.
   */
  region?: string | undefined;
  /**
   * The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.
   */
  continent?: string | undefined;
  /**
   * The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.
   */
  device?: string | undefined;
  /**
   * The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.
   */
  browser?: string | undefined;
  /**
   * The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.
   */
  os?: string | undefined;
  /**
   * The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.
   */
  trigger?: string | undefined;
  /**
   * The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.
   */
  referer?: string | undefined;
  /**
   * The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.
   */
  refererUrl?: string | undefined;
  /**
   * The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.
   */
  url?: string | undefined;
  /**
   * The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.
   */
  utmSource?: string | undefined;
  /**
   * The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.
   */
  utmMedium?: string | undefined;
  /**
   * The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.
   */
  utmCampaign?: string | undefined;
  /**
   * The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).
   */
  utmTerm?: string | undefined;
  /**
   * The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).
   */
  utmContent?: string | undefined;
  /**
   * 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?: QueryParamSaleType | undefined;
  /**
   * Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`
   */
  query?: string | undefined;
  /**
   * Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.
   */
  programId?: string | undefined;
  /**
   * Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.
   */
  tagIds?: string | undefined;
  /**
   * Deprecated: Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
   */
  qr?: boolean | undefined;
  page?: number | undefined;
  limit?: number | undefined;
  /**
   * The sort order. The default is `desc`.
   */
  sortOrder?: QueryParamSortOrder | undefined;
  /**
   * The field to sort the events by. The default is `timestamp`.
   */
  sortBy?: QueryParamSortBy | undefined;
  /**
   * DEPRECATED. Use `sortOrder` instead.
   */
  order?: Order | undefined;
};

/**
 * The payment processor via which the sale was made.
 */
export const ResponseBodyPaymentProcessor = {
  Stripe: "stripe",
  Shopify: "shopify",
  Polar: "polar",
  Paddle: "paddle",
  Revenuecat: "revenuecat",
  Custom: "custom",
} as const;
/**
 * The payment processor via which the sale was made.
 */
export type ResponseBodyPaymentProcessor = ClosedEnum<
  typeof ResponseBodyPaymentProcessor
>;

export type ResponseBodySale = {
  /**
   * 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. `1580` JPY). Learn more: https://d.to/currency
   */
  amount: number;
  /**
   * The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID.
   */
  invoiceId: string | null;
  /**
   * The payment processor via which the sale was made.
   */
  paymentProcessor: ResponseBodyPaymentProcessor;
};

export type ListEventsResponseBodyEventsTestVariants = {
  url: string;
  percentage: number;
};

export type ListEventsResponseBodyLink = {
  /**
   * 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<components.LinkTagSchemaOutput> | 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<ListEventsResponseBodyEventsTestVariants>
    | 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;
  /**
   * The number of leads the short link has generated.
   */
  leads: number;
  /**
   * The number of leads that converted to paying customers.
   */
  conversions: number;
  /**
   * The total number of sales (includes recurring sales) generated by the short link.
   */
  sales: number;
  /**
   * The total dollar value of sales (in cents) generated by the short link.
   */
  saleAmount: number;
  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 ListEventsResponseBodyClick = {
  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 ResponseBodyCustomer = {
  /**
   * 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 SaleEvent = {
  event: "sale";
  timestamp: string;
  eventId: string;
  eventName: string;
  sale: ResponseBodySale;
  metadata?: any | null | undefined;
  link: ListEventsResponseBodyLink;
  click: ListEventsResponseBodyClick;
  customer: ResponseBodyCustomer;
  /**
   * Deprecated: Use `sale.amount` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  saleAmount: number;
  /**
   * Deprecated: Use `sale.invoiceId` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  invoiceId: string;
  /**
   * Deprecated: Use `sale.paymentProcessor` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  paymentProcessor: string;
  /**
   * Deprecated: Use `click.id` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  clickId: string;
  /**
   * Deprecated: Use `link.id` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  linkId: string;
  /**
   * Deprecated: Use `link.domain` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  domain: string;
  /**
   * Deprecated: Use `link.key` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  key: string;
  /**
   * Deprecated: Use `click.url` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  url: string;
  /**
   * Deprecated: Use `click.continent` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  continent: string;
  /**
   * Deprecated: Use `click.country` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  country: string;
  /**
   * Deprecated: Use `click.city` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  city: string;
  /**
   * Deprecated: Use `click.device` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  device: string;
  /**
   * Deprecated: Use `click.browser` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  browser: string;
  /**
   * Deprecated: Use `click.os` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  os: string;
  /**
   * Deprecated: Use `click.qr` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  qr: number;
  /**
   * Deprecated: Use `click.ip` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  ip: string;
};

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

export type ResponseBodyLink = {
  /**
   * 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<components.LinkTagSchemaOutput> | 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<ListEventsResponseBodyTestVariants> | 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;
  /**
   * The number of leads the short link has generated.
   */
  leads: number;
  /**
   * The number of leads that converted to paying customers.
   */
  conversions: number;
  /**
   * The total number of sales (includes recurring sales) generated by the short link.
   */
  sales: number;
  /**
   * The total dollar value of sales (in cents) generated by the short link.
   */
  saleAmount: number;
  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 ListEventsResponseBodyCustomer = {
  /**
   * 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 LeadEvent = {
  event: "lead";
  timestamp: string;
  eventId: string;
  eventName: string;
  metadata?: any | null | undefined;
  click: ResponseBodyClick;
  link: ResponseBodyLink;
  customer: ListEventsResponseBodyCustomer;
  /**
   * Deprecated: Use `click.id` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  clickId: string;
  /**
   * Deprecated: Use `link.id` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  linkId: string;
  /**
   * Deprecated: Use `link.domain` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  domain: string;
  /**
   * Deprecated: Use `link.key` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  key: string;
  /**
   * Deprecated: Use `click.url` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  url: string;
  /**
   * Deprecated: Use `click.continent` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  continent: string;
  /**
   * Deprecated: Use `click.country` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  country: string;
  /**
   * Deprecated: Use `click.city` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  city: string;
  /**
   * Deprecated: Use `click.device` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  device: string;
  /**
   * Deprecated: Use `click.browser` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  browser: string;
  /**
   * Deprecated: Use `click.os` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  os: string;
  /**
   * Deprecated: Use `click.qr` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  qr: number;
  /**
   * Deprecated: Use `click.ip` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  ip: string;
};

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

export type ListEventsResponseBodyEventsLink = {
  /**
   * 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<components.LinkTagSchemaOutput> | 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<ResponseBodyTestVariants> | 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;
  /**
   * The number of leads the short link has generated.
   */
  leads: number;
  /**
   * The number of leads that converted to paying customers.
   */
  conversions: number;
  /**
   * The total number of sales (includes recurring sales) generated by the short link.
   */
  sales: number;
  /**
   * The total dollar value of sales (in cents) generated by the short link.
   */
  saleAmount: number;
  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 ClickEvent = {
  event: "click";
  timestamp: string;
  click: ListEventsResponseBodyEventsClick;
  link: ListEventsResponseBodyEventsLink;
  /**
   * Deprecated: Use `click.id` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  clickId: string;
  /**
   * Deprecated: Use `link.id` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  linkId: string;
  /**
   * Deprecated: Use `link.domain` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  domain: string;
  /**
   * Deprecated: Use `link.key` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  key: string;
  /**
   * Deprecated: Use `click.url` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  url: string;
  /**
   * Deprecated: Use `click.continent` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  continent: string;
  /**
   * Deprecated: Use `click.country` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  country: string;
  /**
   * Deprecated: Use `click.city` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  city: string;
  /**
   * Deprecated: Use `click.device` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  device: string;
  /**
   * Deprecated: Use `click.browser` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  browser: string;
  /**
   * Deprecated: Use `click.os` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  os: string;
  /**
   * Deprecated: Use `click.qr` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  qr: number;
  /**
   * Deprecated: Use `click.ip` instead.
   *
   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
   */
  ip: string;
};

export type ListEventsResponseBody = ClickEvent | LeadEvent | SaleEvent;

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

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

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

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

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

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

/** @internal */
export type ListEventsRequest$Outbound = {
  event: string;
  domain?: string | undefined;
  key?: string | undefined;
  linkId?: string | undefined;
  externalId?: string | undefined;
  tenantId?: string | undefined;
  tagId?: string | undefined;
  folderId?: string | undefined;
  groupId?: string | undefined;
  partnerId?: string | undefined;
  customerId?: string | undefined;
  interval?: string | undefined;
  start?: string | undefined;
  end?: string | undefined;
  timezone: string;
  country?: string | undefined;
  city?: string | undefined;
  region?: string | undefined;
  continent?: string | undefined;
  device?: string | undefined;
  browser?: string | undefined;
  os?: string | undefined;
  trigger?: string | undefined;
  referer?: string | undefined;
  refererUrl?: string | undefined;
  url?: string | undefined;
  utm_source?: string | undefined;
  utm_medium?: string | undefined;
  utm_campaign?: string | undefined;
  utm_term?: string | undefined;
  utm_content?: string | undefined;
  root?: boolean | undefined;
  saleType?: string | undefined;
  query?: string | undefined;
  programId?: string | undefined;
  tagIds?: string | undefined;
  qr?: boolean | undefined;
  page: number;
  limit: number;
  sortOrder: string;
  sortBy: string;
  order: string;
};

/** @internal */
export const ListEventsRequest$outboundSchema: z.ZodType<
  ListEventsRequest$Outbound,
  z.ZodTypeDef,
  ListEventsRequest
> = z.object({
  event: QueryParamEvent$outboundSchema.default("clicks"),
  domain: z.string().optional(),
  key: z.string().optional(),
  linkId: z.string().optional(),
  externalId: z.string().optional(),
  tenantId: z.string().optional(),
  tagId: z.string().optional(),
  folderId: z.string().optional(),
  groupId: z.string().optional(),
  partnerId: z.string().optional(),
  customerId: z.string().optional(),
  interval: QueryParamInterval$outboundSchema.optional(),
  start: z.string().optional(),
  end: z.string().optional(),
  timezone: z.string().default("UTC"),
  country: z.string().optional(),
  city: z.string().optional(),
  region: z.string().optional(),
  continent: z.string().optional(),
  device: z.string().optional(),
  browser: z.string().optional(),
  os: z.string().optional(),
  trigger: z.string().optional(),
  referer: z.string().optional(),
  refererUrl: z.string().optional(),
  url: z.string().optional(),
  utmSource: z.string().optional(),
  utmMedium: z.string().optional(),
  utmCampaign: z.string().optional(),
  utmTerm: z.string().optional(),
  utmContent: z.string().optional(),
  root: z.boolean().optional(),
  saleType: QueryParamSaleType$outboundSchema.optional(),
  query: z.string().optional(),
  programId: z.string().optional(),
  tagIds: z.string().optional(),
  qr: z.boolean().optional(),
  page: z.number().default(1),
  limit: z.number().default(100),
  sortOrder: QueryParamSortOrder$outboundSchema.default("desc"),
  sortBy: QueryParamSortBy$outboundSchema.default("timestamp"),
  order: Order$outboundSchema.default("desc"),
}).transform((v) => {
  return remap$(v, {
    utmSource: "utm_source",
    utmMedium: "utm_medium",
    utmCampaign: "utm_campaign",
    utmTerm: "utm_term",
    utmContent: "utm_content",
  });
});

export function listEventsRequestToJSON(
  listEventsRequest: ListEventsRequest,
): string {
  return JSON.stringify(
    ListEventsRequest$outboundSchema.parse(listEventsRequest),
  );
}

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

/** @internal */
export const ResponseBodySale$inboundSchema: z.ZodType<
  ResponseBodySale,
  z.ZodTypeDef,
  unknown
> = z.object({
  amount: z.number().int(),
  invoiceId: z.nullable(z.string()).default(null),
  paymentProcessor: ResponseBodyPaymentProcessor$inboundSchema.default(
    "custom",
  ),
});

export function responseBodySaleFromJSON(
  jsonString: string,
): SafeParseResult<ResponseBodySale, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ResponseBodySale$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ResponseBodySale' from JSON`,
  );
}

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

export function listEventsResponseBodyEventsTestVariantsFromJSON(
  jsonString: string,
): SafeParseResult<
  ListEventsResponseBodyEventsTestVariants,
  SDKValidationError
> {
  return safeParse(
    jsonString,
    (x) =>
      ListEventsResponseBodyEventsTestVariants$inboundSchema.parse(
        JSON.parse(x),
      ),
    `Failed to parse 'ListEventsResponseBodyEventsTestVariants' from JSON`,
  );
}

/** @internal */
export const ListEventsResponseBodyLink$inboundSchema: z.ZodType<
  ListEventsResponseBodyLink,
  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(components.LinkTagSchemaOutput$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(() => ListEventsResponseBodyEventsTestVariants$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",
  });
});

export function listEventsResponseBodyLinkFromJSON(
  jsonString: string,
): SafeParseResult<ListEventsResponseBodyLink, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ListEventsResponseBodyLink$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ListEventsResponseBodyLink' from JSON`,
  );
}

/** @internal */
export const ListEventsResponseBodyClick$inboundSchema: z.ZodType<
  ListEventsResponseBodyClick,
  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(),
});

export function listEventsResponseBodyClickFromJSON(
  jsonString: string,
): SafeParseResult<ListEventsResponseBodyClick, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ListEventsResponseBodyClick$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ListEventsResponseBodyClick' from JSON`,
  );
}

/** @internal */
export const ResponseBodyCustomer$inboundSchema: z.ZodType<
  ResponseBodyCustomer,
  z.ZodTypeDef,
  unknown
> = z.object({
  id: z.string(),
  name: z.string(),
  email: z.nullable(z.string()).optional(),
  avatar: z.nullable(z.string()).optional(),
  externalId: z.string(),
  stripeCustomerId: 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(),
  firstSaleAt: z.nullable(z.string()).optional(),
  subscriptionCanceledAt: z.nullable(z.string()).optional(),
});

export function responseBodyCustomerFromJSON(
  jsonString: string,
): SafeParseResult<ResponseBodyCustomer, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ResponseBodyCustomer$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ResponseBodyCustomer' from JSON`,
  );
}

/** @internal */
export const SaleEvent$inboundSchema: z.ZodType<
  SaleEvent,
  z.ZodTypeDef,
  unknown
> = z.object({
  event: z.literal("sale"),
  timestamp: z.string(),
  eventId: z.string(),
  eventName: z.string(),
  sale: z.lazy(() => ResponseBodySale$inboundSchema),
  metadata: z.nullable(z.any()).optional(),
  link: z.lazy(() => ListEventsResponseBodyLink$inboundSchema),
  click: z.lazy(() => ListEventsResponseBodyClick$inboundSchema),
  customer: z.lazy(() => ResponseBodyCustomer$inboundSchema),
  saleAmount: z.number(),
  invoice_id: z.string(),
  payment_processor: z.string(),
  click_id: z.string(),
  link_id: z.string(),
  domain: z.string(),
  key: z.string(),
  url: z.string(),
  continent: z.string(),
  country: z.string(),
  city: z.string(),
  device: z.string(),
  browser: z.string(),
  os: z.string(),
  qr: z.number(),
  ip: z.string(),
}).transform((v) => {
  return remap$(v, {
    "invoice_id": "invoiceId",
    "payment_processor": "paymentProcessor",
    "click_id": "clickId",
    "link_id": "linkId",
  });
});

export function saleEventFromJSON(
  jsonString: string,
): SafeParseResult<SaleEvent, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => SaleEvent$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'SaleEvent' from JSON`,
  );
}

/** @internal */
export const ResponseBodyClick$inboundSchema: z.ZodType<
  ResponseBodyClick,
  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(),
});

export function responseBodyClickFromJSON(
  jsonString: string,
): SafeParseResult<ResponseBodyClick, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ResponseBodyClick$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ResponseBodyClick' from JSON`,
  );
}

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

export function listEventsResponseBodyTestVariantsFromJSON(
  jsonString: string,
): SafeParseResult<ListEventsResponseBodyTestVariants, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) =>
      ListEventsResponseBodyTestVariants$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ListEventsResponseBodyTestVariants' from JSON`,
  );
}

/** @internal */
export const ResponseBodyLink$inboundSchema: z.ZodType<
  ResponseBodyLink,
  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(components.LinkTagSchemaOutput$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(() => ListEventsResponseBodyTestVariants$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",
  });
});

export function responseBodyLinkFromJSON(
  jsonString: string,
): SafeParseResult<ResponseBodyLink, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ResponseBodyLink$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ResponseBodyLink' from JSON`,
  );
}

/** @internal */
export const ListEventsResponseBodyCustomer$inboundSchema: z.ZodType<
  ListEventsResponseBodyCustomer,
  z.ZodTypeDef,
  unknown
> = z.object({
  id: z.string(),
  name: z.string(),
  email: z.nullable(z.string()).optional(),
  avatar: z.nullable(z.string()).optional(),
  externalId: z.string(),
  stripeCustomerId: 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(),
  firstSaleAt: z.nullable(z.string()).optional(),
  subscriptionCanceledAt: z.nullable(z.string()).optional(),
});

export function listEventsResponseBodyCustomerFromJSON(
  jsonString: string,
): SafeParseResult<ListEventsResponseBodyCustomer, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ListEventsResponseBodyCustomer$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ListEventsResponseBodyCustomer' from JSON`,
  );
}

/** @internal */
export const LeadEvent$inboundSchema: z.ZodType<
  LeadEvent,
  z.ZodTypeDef,
  unknown
> = z.object({
  event: z.literal("lead"),
  timestamp: z.string(),
  eventId: z.string(),
  eventName: z.string(),
  metadata: z.nullable(z.any()).optional(),
  click: z.lazy(() => ResponseBodyClick$inboundSchema),
  link: z.lazy(() => ResponseBodyLink$inboundSchema),
  customer: z.lazy(() => ListEventsResponseBodyCustomer$inboundSchema),
  click_id: z.string(),
  link_id: z.string(),
  domain: z.string(),
  key: z.string(),
  url: z.string(),
  continent: z.string(),
  country: z.string(),
  city: z.string(),
  device: z.string(),
  browser: z.string(),
  os: z.string(),
  qr: z.number(),
  ip: z.string(),
}).transform((v) => {
  return remap$(v, {
    "click_id": "clickId",
    "link_id": "linkId",
  });
});

export function leadEventFromJSON(
  jsonString: string,
): SafeParseResult<LeadEvent, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => LeadEvent$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'LeadEvent' from JSON`,
  );
}

/** @internal */
export const ListEventsResponseBodyEventsClick$inboundSchema: z.ZodType<
  ListEventsResponseBodyEventsClick,
  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(),
});

export function listEventsResponseBodyEventsClickFromJSON(
  jsonString: string,
): SafeParseResult<ListEventsResponseBodyEventsClick, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ListEventsResponseBodyEventsClick$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ListEventsResponseBodyEventsClick' from JSON`,
  );
}

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

export function responseBodyTestVariantsFromJSON(
  jsonString: string,
): SafeParseResult<ResponseBodyTestVariants, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ResponseBodyTestVariants$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ResponseBodyTestVariants' from JSON`,
  );
}

/** @internal */
export const ListEventsResponseBodyEventsLink$inboundSchema: z.ZodType<
  ListEventsResponseBodyEventsLink,
  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(components.LinkTagSchemaOutput$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(() => ResponseBodyTestVariants$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",
  });
});

export function listEventsResponseBodyEventsLinkFromJSON(
  jsonString: string,
): SafeParseResult<ListEventsResponseBodyEventsLink, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ListEventsResponseBodyEventsLink$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ListEventsResponseBodyEventsLink' from JSON`,
  );
}

/** @internal */
export const ClickEvent$inboundSchema: z.ZodType<
  ClickEvent,
  z.ZodTypeDef,
  unknown
> = z.object({
  event: z.literal("click"),
  timestamp: z.string(),
  click: z.lazy(() => ListEventsResponseBodyEventsClick$inboundSchema),
  link: z.lazy(() => ListEventsResponseBodyEventsLink$inboundSchema),
  click_id: z.string(),
  link_id: z.string(),
  domain: z.string(),
  key: z.string(),
  url: z.string(),
  continent: z.string(),
  country: z.string(),
  city: z.string(),
  device: z.string(),
  browser: z.string(),
  os: z.string(),
  qr: z.number(),
  ip: z.string(),
}).transform((v) => {
  return remap$(v, {
    "click_id": "clickId",
    "link_id": "linkId",
  });
});

export function clickEventFromJSON(
  jsonString: string,
): SafeParseResult<ClickEvent, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ClickEvent$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ClickEvent' from JSON`,
  );
}

/** @internal */
export const ListEventsResponseBody$inboundSchema: z.ZodType<
  ListEventsResponseBody,
  z.ZodTypeDef,
  unknown
> = z.union([
  z.lazy(() => ClickEvent$inboundSchema),
  z.lazy(() => LeadEvent$inboundSchema),
  z.lazy(() => SaleEvent$inboundSchema),
]);

export function listEventsResponseBodyFromJSON(
  jsonString: string,
): SafeParseResult<ListEventsResponseBody, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ListEventsResponseBody$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ListEventsResponseBody' from JSON`,
  );
}