@automate.ax/integration-contracts 0.87.7 → 0.88.0

package/src/close/schemas.ts

@@ -0,0 +1,995 @@
+import * as z from "zod"
+import { CLOSE_OBJECT_SCHEMA, CLOSE_VALUE_SCHEMA } from "./api"
+
+export const CLOSE_DATE_SCHEMA = z
+  .union([
+    z.date(),
+    z.string().refine((value) => !Number.isNaN(Date.parse(value)), {
+      message: "Expected a Close date or datetime.",
+    }),
+  ])
+  .transform((value) => (value instanceof Date ? value : new Date(value)))
+const DATE_SCHEMA = CLOSE_DATE_SCHEMA
+const NULLABLE_DATE_SCHEMA = DATE_SCHEMA.nullable()
+
+export const CLOSE_ADDRESS_SCHEMA = z.object({
+  address1: z.string().nullable(),
+  address2: z.string().nullable(),
+  city: z.string().nullable(),
+  country: z.string().nullable(),
+  label: z.string().nullable(),
+  state: z.string().nullable(),
+  tzIds: z.string().array().optional(),
+  zipcode: z.string().nullable(),
+})
+
+export const CLOSE_CONTACT_EMAIL_SCHEMA = z.object({
+  email: z.email(),
+  isUnsubscribed: z.boolean().prefault(false),
+  type: z.string(),
+})
+
+export const CLOSE_CONTACT_PHONE_SCHEMA = z.object({
+  country: z.string().nullable().optional(),
+  outboundSmsBlocked: z.boolean().optional(),
+  phone: z.string(),
+  phoneFormatted: z.string().optional(),
+  tzIds: z.string().array().optional(),
+  type: z.string(),
+})
+
+export const CLOSE_CONTACT_URL_SCHEMA = z.object({
+  type: z.string(),
+  url: z.string(),
+})
+
+export const CLOSE_LEAD_SCHEMA = z.object({
+  addresses: CLOSE_ADDRESS_SCHEMA.array().prefault([]),
+  contactIds: z.string().array(),
+  createdAt: DATE_SCHEMA,
+  createdBy: z.string().nullable(),
+  customFields: z.record(z.string(), z.json()).prefault({}),
+  description: z.string().nullable(),
+  displayName: z.string().optional(),
+  htmlUrl: z.url(),
+  id: z.string(),
+  name: z.string().nullable(),
+  organizationId: z.string(),
+  source: z.string().nullable().optional(),
+  statusId: z.string(),
+  statusLabel: z.string().optional(),
+  updatedAt: DATE_SCHEMA,
+  updatedBy: z.string().nullable(),
+  url: z.string().nullable(),
+})
+
+export const CLOSE_CONTACT_SCHEMA = z.object({
+  createdAt: DATE_SCHEMA,
+  createdBy: z.string().nullable(),
+  customFields: z.record(z.string(), z.json()).prefault({}),
+  displayName: z.string(),
+  emails: CLOSE_CONTACT_EMAIL_SCHEMA.array().prefault([]),
+  id: z.string(),
+  leadId: z.string().nullable(),
+  name: z.string().nullable(),
+  organizationId: z.string(),
+  phones: CLOSE_CONTACT_PHONE_SCHEMA.array().prefault([]),
+  title: z.string().nullable(),
+  updatedAt: DATE_SCHEMA,
+  updatedBy: z.string().nullable(),
+  urls: CLOSE_CONTACT_URL_SCHEMA.array().prefault([]),
+})
+
+export const CLOSE_OPPORTUNITY_STATUS_TYPE_SCHEMA = z.enum([
+  "active",
+  "lost",
+  "won",
+])
+
+export const CLOSE_ATTACHMENT_SCHEMA = z.object({
+  contentType: z.string().nullable(),
+  filename: z.string().nullable(),
+  size: z.number().int().nullable(),
+  thumbnailUrl: z.url().nullable().optional(),
+  url: z.url(),
+})
+
+const CLOSE_OPPORTUNITY_SUGGESTED_ACTION_SCHEMA = z.discriminatedUnion(
+  "action",
+  [
+    z.object({
+      action: z.literal("change_status"),
+      details: z.object({ statusId: z.string() }).nullable(),
+      justification: z.string(),
+    }),
+    z.object({
+      action: z.literal("adjust_close_date"),
+      details: z.object({ closeDate: DATE_SCHEMA }).nullable(),
+      justification: z.string(),
+    }),
+    z.object({
+      action: z.literal("follow_up_email"),
+      details: z
+        .object({
+          contactId: z.string(),
+          messageDraft: z.string(),
+          subjectDraft: z.string(),
+        })
+        .nullable(),
+      justification: z.string(),
+    }),
+    z.object({
+      action: z.literal("follow_up_sms"),
+      details: z
+        .object({ contactId: z.string(), messageDraft: z.string() })
+        .nullable(),
+      justification: z.string(),
+    }),
+    z.object({
+      action: z.literal("follow_up_call"),
+      details: z
+        .object({ callPlan: z.string(), contactId: z.string() })
+        .nullable(),
+      justification: z.string(),
+    }),
+  ],
+)
+
+export const CLOSE_OPPORTUNITY_SCHEMA = z.object({
+  annualizedExpectedValue: z.number().int().nullable(),
+  annualizedValue: z.number().int().nullable(),
+  attachments: CLOSE_ATTACHMENT_SCHEMA.array().optional(),
+  commentSummary: z
+    .object({ commentCount: z.number().int(), threadId: z.string() })
+    .nullable()
+    .optional(),
+  confidence: z.number().int().min(0).max(100),
+  contactId: z.string().nullable(),
+  contactName: z.string().nullable().optional(),
+  createdAt: DATE_SCHEMA,
+  createdBy: z.string().nullable(),
+  createdByName: z.string().nullable().optional(),
+  customFields: z.record(z.string(), z.json()).prefault({}),
+  dateLost: NULLABLE_DATE_SCHEMA,
+  dateWon: NULLABLE_DATE_SCHEMA,
+  expectedValue: z.number().int().nullable(),
+  id: z.string(),
+  integrationLinks: z
+    .object({ name: z.string(), url: z.url() })
+    .array()
+    .optional(),
+  isStalled: z.boolean().optional(),
+  leadId: z.string(),
+  leadName: z.string().nullable().optional(),
+  leadPrimaryEmail: CLOSE_CONTACT_EMAIL_SCHEMA.nullable().optional(),
+  leadPrimaryPhone: CLOSE_CONTACT_PHONE_SCHEMA.array().nullable().optional(),
+  note: z.string().nullable(),
+  noteHtml: z.string().nullable(),
+  organizationId: z.string(),
+  pipelineId: z.string().nullable().optional(),
+  pipelineName: z.string().nullable().optional(),
+  stallStatus: z
+    .object({
+      communicationIssue: z.enum([
+        "no_issue",
+        "cant_get_in_touch",
+        "no_communication_attempts",
+      ]),
+      nextAction: z.object({
+        action: z.enum([
+          "mark_as_lost",
+          "change_status",
+          "follow_up",
+          "adjust_close_date",
+          "ask_someone_else_to_reach_out",
+          "change_communication_method",
+        ]),
+        justification: z.string(),
+      }),
+    })
+    .nullable()
+    .optional(),
+  statusId: z.string(),
+  statusDisplayName: z.string().optional(),
+  statusLabel: z.string().optional(),
+  statusType: CLOSE_OPPORTUNITY_STATUS_TYPE_SCHEMA.optional(),
+  suggestedAction:
+    CLOSE_OPPORTUNITY_SUGGESTED_ACTION_SCHEMA.nullable().optional(),
+  updatedAt: DATE_SCHEMA,
+  updatedBy: z.string().nullable(),
+  updatedByName: z.string().nullable().optional(),
+  userId: z.string(),
+  userName: z.string().nullable().optional(),
+  value: z.number().int().nullable(),
+  valueCurrency: z.string().nullable().optional(),
+  valueFormatted: z.string().nullable().optional(),
+  valuePeriod: z.enum(["annual", "monthly", "one_time"]),
+})
+
+export const CLOSE_OPPORTUNITY_PAGE_SCHEMA = z.object({
+  countByValuePeriod: z.record(z.string(), z.number().int().nonnegative()),
+  data: CLOSE_OPPORTUNITY_SCHEMA.array(),
+  expectedValueAnnual: z.number().int(),
+  expectedValueAnnualFormatted: z.string(),
+  expectedValueAnnualized: z.number().int(),
+  expectedValueAnnualizedFormatted: z.string(),
+  expectedValueMonthly: z.number().int(),
+  expectedValueMonthlyFormatted: z.string(),
+  expectedValueOneTime: z.number().int(),
+  expectedValueOneTimeFormatted: z.string(),
+  hasMore: z.boolean(),
+  totalResults: z.number().int().nonnegative(),
+  totalValueAnnual: z.number().int(),
+  totalValueAnnualFormatted: z.string(),
+  totalValueAnnualized: z.number().int(),
+  totalValueAnnualizedFormatted: z.string(),
+  totalValueMonthly: z.number().int(),
+  totalValueMonthlyFormatted: z.string(),
+  totalValueOneTime: z.number().int(),
+  totalValueOneTimeFormatted: z.string(),
+})
+
+const CLOSE_TASK_FIELDS = {
+  assignedTo: z.string().nullable(),
+  assignedToName: z.string().nullable().optional(),
+  contactId: z.string().nullable(),
+  contactName: z.string().nullable().optional(),
+  createdAt: DATE_SCHEMA,
+  createdBy: z.string().nullable(),
+  createdByName: z.string().nullable().optional(),
+  date: NULLABLE_DATE_SCHEMA,
+  dueDate: NULLABLE_DATE_SCHEMA.optional(),
+  id: z.string(),
+  isComplete: z.boolean(),
+  isDateless: z.boolean().optional(),
+  leadId: z.string().nullable(),
+  leadName: z.string().nullable().optional(),
+  objectId: z.string().nullable().optional(),
+  objectType: z.string().nullable().optional(),
+  organizationId: z.string(),
+  priority: z.enum(["high", "medium"]).nullable().optional(),
+  text: z.string().nullable().optional(),
+  updatedAt: DATE_SCHEMA,
+  updatedBy: z.string().nullable(),
+  updatedByName: z.string().nullable().optional(),
+  view: z.enum(["archive", "future", "inbox"]).optional(),
+}
+
+const CLOSE_TASK_PHONE_FIELDS = {
+  localPhone: z.string().nullable().optional(),
+  phone: z.string().nullable().optional(),
+  phoneFormatted: z.string().nullable().optional(),
+  phoneNumberDescription: z.string().nullable().optional(),
+}
+
+export const CLOSE_TASK_SCHEMA = z.discriminatedUnion("type", [
+  z.object({ ...CLOSE_TASK_FIELDS, type: z.literal("lead") }),
+  z.object({
+    ...CLOSE_TASK_FIELDS,
+    ...CLOSE_TASK_PHONE_FIELDS,
+    type: z.literal("missed_call"),
+  }),
+  z.object({
+    ...CLOSE_TASK_FIELDS,
+    ...CLOSE_TASK_PHONE_FIELDS,
+    type: z.literal("voicemail"),
+    voicemailDuration: z.number().int().nonnegative().optional(),
+    voicemailUrl: z.url().optional(),
+  }),
+  z.object({
+    ...CLOSE_TASK_FIELDS,
+    bodyPreview: z.string().nullable().optional(),
+    emails: z.string().array().optional(),
+    subject: z.string().nullable().optional(),
+    type: z.literal("incoming_email"),
+  }),
+  z.object({
+    ...CLOSE_TASK_FIELDS,
+    bodyPreview: z.string().nullable().optional(),
+    emailId: z.string().optional(),
+    subject: z.string().nullable().optional(),
+    type: z.literal("email_followup"),
+  }),
+  z.object({
+    ...CLOSE_TASK_FIELDS,
+    ...CLOSE_TASK_PHONE_FIELDS,
+    recordingUrl: z.url().nullable().optional(),
+    type: z.literal("answered_detached_call"),
+  }),
+  z.object({
+    ...CLOSE_TASK_FIELDS,
+    opportunityNote: z.string().nullable().optional(),
+    opportunityValue: z.number().int().nullable().optional(),
+    opportunityValueCurrency: z.string().nullable().optional(),
+    opportunityValueFormatted: z.string().nullable().optional(),
+    opportunityValuePeriod: z
+      .enum(["annual", "monthly", "one_time"])
+      .nullable()
+      .optional(),
+    type: z.literal("opportunity_due"),
+  }),
+  z.object({
+    ...CLOSE_TASK_FIELDS,
+    attachments: z
+      .object({
+        contentType: z.string(),
+        filename: z.string(),
+        mediaId: z.string(),
+        size: z.number().int().nonnegative(),
+        thumbnailUrl: z.url().nullable().optional(),
+        url: z.url(),
+      })
+      .array()
+      .optional(),
+    localPhone: z.string().nullable().optional(),
+    remotePhone: z.string().nullable().optional(),
+    remotePhoneDescription: z.string().nullable().optional(),
+    remotePhoneFormatted: z.string().nullable().optional(),
+    type: z.literal("incoming_sms"),
+  }),
+  z.object({
+    ...CLOSE_TASK_FIELDS,
+    agentConfigId: z.string().nullable().optional(),
+    deduplicationKey: z.string().nullable().optional(),
+    isPrimaryLeadNotification: z.boolean().optional(),
+    resolution: z.string().nullable().optional(),
+    sequenceId: z.string().nullable().optional(),
+    sequenceSubscriptionId: z.string().nullable().optional(),
+    stepId: z.string().nullable().optional(),
+    type: z.literal("outgoing_call"),
+  }),
+])
+
+const CLOSE_CREATION_SOURCE_SCHEMA = z.enum([
+  "ui",
+  "api",
+  "import",
+  "clipper",
+  "email",
+  "suggestion",
+  "segment-integration",
+  "customerio-integration",
+  "calendly-integration",
+  "ai",
+  "whatsapp",
+  "webform",
+])
+
+export const CLOSE_NOTE_SCHEMA = z.object({
+  activityAt: NULLABLE_DATE_SCHEMA,
+  attachments: CLOSE_ATTACHMENT_SCHEMA.array(),
+  contactId: z.string().nullable(),
+  createdAt: DATE_SCHEMA,
+  createdBy: z.string().nullable(),
+  id: z.string(),
+  leadId: z.string().nullable(),
+  note: z.string(),
+  noteHtml: z.string(),
+  noteMentions: z.string().array(),
+  organizationId: z.string(),
+  pinned: z.boolean(),
+  pinnedAt: NULLABLE_DATE_SCHEMA,
+  source: CLOSE_CREATION_SOURCE_SCHEMA.nullable(),
+  title: z.string().nullable(),
+  type: z.literal("Note"),
+  updatedAt: DATE_SCHEMA,
+  updatedBy: z.string().nullable(),
+  userId: z.string().nullable(),
+  users: z.string().array(),
+})
+
+const CLOSE_ACTIVITY_FIELDS = {
+  activityAt: NULLABLE_DATE_SCHEMA.optional(),
+  contactId: z.string().nullable().optional(),
+  createdAt: DATE_SCHEMA,
+  createdBy: z.string().nullable(),
+  createdByName: z.string().nullable().optional(),
+  id: z.string(),
+  leadId: z.string().nullable(),
+  organizationId: z.string(),
+  source: z.string().nullable().optional(),
+  updatedAt: DATE_SCHEMA,
+  updatedBy: z.string().nullable(),
+  updatedByName: z.string().nullable().optional(),
+  userId: z.string().nullable().optional(),
+  userName: z.string().nullable().optional(),
+  users: z.string().array().prefault([]),
+}
+const CLOSE_EXACT_ACTIVITY_FIELDS = {
+  ...CLOSE_ACTIVITY_FIELDS,
+  activityAt: NULLABLE_DATE_SCHEMA,
+  contactId: z.string().nullable(),
+  userId: z.string().nullable(),
+}
+const CLOSE_TASK_COMPLETED_ACTIVITY_FIELDS = {
+  ...CLOSE_ACTIVITY_FIELDS,
+  activityAt: NULLABLE_DATE_SCHEMA,
+  userId: z.string().nullable(),
+}
+
+export const CLOSE_CALL_SCHEMA = z
+  .object({
+    ...CLOSE_ACTIVITY_FIELDS,
+    activityAt: NULLABLE_DATE_SCHEMA,
+    callMethod: z.string().nullable().optional(),
+    contactId: z.string().nullable(),
+    cost: z.string().nullable().optional(),
+    dialerId: z.string().nullable().optional(),
+    dialerSavedSearchId: z.string().nullable().optional(),
+    direction: z.enum(["inbound", "outbound"]),
+    disposition: z.string().nullable().optional(),
+    duration: z.number().int().nonnegative().nullable(),
+    localCountryIso: z.string().nullable().optional(),
+    localPhone: z.string().nullable().optional(),
+    localPhoneFormatted: z.string().nullable().optional(),
+    note: z.string().nullable(),
+    noteHtml: z.string().nullable(),
+    outcomeId: z.string().nullable(),
+    phone: z.string().nullable(),
+    recordingUrl: z.url().nullable(),
+    remoteCountryIso: z.string().nullable().optional(),
+    remotePhone: z.string().nullable().optional(),
+    remotePhoneFormatted: z.string().nullable().optional(),
+    source: z.enum(["Close.io", "External"]),
+    status: z.enum([
+      "busy",
+      "cancel",
+      "completed",
+      "created",
+      "failed",
+      "in-progress",
+      "no-answer",
+      "timeout",
+    ]),
+    type: z.literal("Call"),
+    userId: z.string().nullable(),
+    voicemailDuration: z.number().int().nonnegative().nullable().optional(),
+    voicemailUrl: z.url().nullable().optional(),
+  })
+  .catchall(CLOSE_VALUE_SCHEMA)
+
+export const CLOSE_EMAIL_SCHEMA = z
+  .object({
+    ...CLOSE_ACTIVITY_FIELDS,
+    activityAt: NULLABLE_DATE_SCHEMA,
+    attachments: CLOSE_ATTACHMENT_SCHEMA.array().nullable().optional(),
+    bcc: z.string().array().prefault([]),
+    bodyHtml: z.string().nullable(),
+    bodyText: z.string().nullable(),
+    bulkEmailActionId: z.string().nullable(),
+    cc: z.string().array().prefault([]),
+    contactId: z.string().nullable(),
+    dateScheduled: NULLABLE_DATE_SCHEMA,
+    dateSent: NULLABLE_DATE_SCHEMA,
+    direction: z.enum(["incoming", "outgoing"]).nullable(),
+    emailAccountId: z.string().nullable().optional(),
+    followupSequenceAddCcBcc: z.boolean(),
+    followupSequenceDelay: z.number().int().nullable(),
+    hasReply: z.boolean(),
+    inReplyToId: z.string().nullable(),
+    messageIds: z.string().array().prefault([]),
+    needSmtpCredentials: z.boolean(),
+    opens: z
+      .object({
+        ipAddress: z.string().nullable(),
+        openedAt: DATE_SCHEMA,
+        openedBy: z.string().nullable(),
+        userAgent: z.string().nullable(),
+      })
+      .array()
+      .nullable()
+      .optional(),
+    opensSummary: z.string().nullable(),
+    references: z.string().array().prefault([]),
+    sendAsId: z.string().nullable(),
+    sendAttempts: z
+      .record(z.string(), z.string())
+      .array()
+      .nullable()
+      .optional(),
+    sender: z.string().nullable(),
+    sequenceId: z.string().nullable().optional(),
+    sequenceName: z.string().nullable().optional(),
+    sequenceSubscriptionId: z.string().nullable().optional(),
+    status: z.enum(["draft", "error", "inbox", "outbox", "scheduled", "sent"]),
+    subject: z.string().nullable(),
+    templateId: z.string().nullable(),
+    threadId: z.string().nullable(),
+    to: z.string().array().prefault([]),
+    type: z.literal("Email"),
+    userId: z.string().nullable(),
+  })
+  .catchall(CLOSE_VALUE_SCHEMA)
+
+export const CLOSE_SMS_SCHEMA = z
+  .object({
+    ...CLOSE_ACTIVITY_FIELDS,
+    activityAt: NULLABLE_DATE_SCHEMA,
+    attachments: CLOSE_ATTACHMENT_SCHEMA.array().nullable().optional(),
+    contactId: z.string().nullable(),
+    cost: z.string().nullable(),
+    dateScheduled: NULLABLE_DATE_SCHEMA,
+    dateSent: NULLABLE_DATE_SCHEMA,
+    direction: z.enum(["inbound", "outbound"]),
+    errorMessage: z.string().nullable(),
+    localCountryIso: z.string().nullable(),
+    localPhone: z.string().nullable(),
+    localPhoneFormatted: z.string().nullable(),
+    remoteCountryIso: z.string().nullable(),
+    remotePhone: z.string().nullable(),
+    remotePhoneFormatted: z.string().nullable(),
+    source: z.enum(["Close.io", "External"]),
+    status: z.enum(["draft", "error", "inbox", "outbox", "scheduled", "sent"]),
+    templateId: z.string().nullable(),
+    text: z.string().nullable(),
+    type: z.literal("SMS"),
+    userId: z.string().nullable(),
+  })
+  .catchall(CLOSE_VALUE_SCHEMA)
+
+export const CLOSE_MEETING_SCHEMA = z
+  .object({
+    ...CLOSE_ACTIVITY_FIELDS,
+    actualDuration: z.number().int().nonnegative().nullable(),
+    attachedCallIds: z.string().array().prefault([]),
+    attendees: CLOSE_OBJECT_SCHEMA.array().prefault([]),
+    calendarEventLink: z.url().nullable(),
+    calendarEventUids: z.string().array().prefault([]),
+    conferenceLinks: CLOSE_OBJECT_SCHEMA.array().prefault([]),
+    connectedAccountId: z.string().nullable(),
+    duration: z.number().int().nonnegative(),
+    endsAt: DATE_SCHEMA,
+    integrations: CLOSE_OBJECT_SCHEMA.array().prefault([]),
+    isRecurring: z.boolean(),
+    location: z.string().nullable(),
+    note: z.string().nullable(),
+    outcomeId: z.string().nullable(),
+    providerCalendarEventId: z.string().nullable(),
+    providerCalendarIds: z.string().array().prefault([]),
+    providerCalendarType: z.enum(["google", "microsoft"]).nullable(),
+    source: z.enum(["calendar", "manual"]),
+    startsAt: DATE_SCHEMA,
+    status: z
+      .enum([
+        "upcoming",
+        "in-progress",
+        "completed",
+        "canceled",
+        "declined-by-org",
+        "declined-by-lead",
+      ])
+      .nullable(),
+    summary: z.object({ html: z.string(), text: z.string() }).nullable(),
+    title: z.string().nullable(),
+    type: z.literal("Meeting"),
+  })
+  .catchall(CLOSE_VALUE_SCHEMA)
+
+const CLOSE_COMMENT_SUMMARY_SCHEMA = z.object({
+  commentCount: z.number().int(),
+  threadId: z.string(),
+})
+const CLOSE_CREATED_ACTIVITY_SCHEMA = z.object({
+  ...CLOSE_EXACT_ACTIVITY_FIELDS,
+  importId: z.string().nullable(),
+  source: CLOSE_CREATION_SOURCE_SCHEMA.nullable(),
+  type: z.literal("Created"),
+})
+const CLOSE_CUSTOM_ACTIVITY_SCHEMA = z
+  .object({
+    ...CLOSE_EXACT_ACTIVITY_FIELDS,
+    commentSummary: CLOSE_COMMENT_SUMMARY_SCHEMA.nullable().optional(),
+    customActivityTypeId: z.string(),
+    customFields: z.record(z.string(), z.json()).prefault({}),
+    lastPublishedAt: NULLABLE_DATE_SCHEMA,
+    mentions: z.string().array(),
+    mentionsUpdatedAt: NULLABLE_DATE_SCHEMA,
+    pinned: z.boolean(),
+    pinnedAt: NULLABLE_DATE_SCHEMA,
+    source: CLOSE_CREATION_SOURCE_SCHEMA.nullable(),
+    status: z.enum(["draft", "published"]),
+    type: z.literal("CustomActivity"),
+  })
+  .catchall(CLOSE_VALUE_SCHEMA)
+const CLOSE_EMAIL_IDENTITY_SCHEMA = z.object({
+  email: z.string(),
+  name: z.string(),
+})
+const CLOSE_EMAIL_ENVELOPE_SCHEMA = z.object({
+  bcc: CLOSE_EMAIL_IDENTITY_SCHEMA.array(),
+  cc: CLOSE_EMAIL_IDENTITY_SCHEMA.array(),
+  date: z.string().nullable(),
+  from: CLOSE_EMAIL_IDENTITY_SCHEMA.array(),
+  inReplyTo: z.string().nullable(),
+  isAutoreply: z.boolean(),
+  messageId: z.string().nullable(),
+  replyTo: CLOSE_EMAIL_IDENTITY_SCHEMA.array(),
+  sender: CLOSE_EMAIL_IDENTITY_SCHEMA.array(),
+  subject: z.string().nullable(),
+  to: CLOSE_EMAIL_IDENTITY_SCHEMA.array(),
+})
+const CLOSE_EMAIL_PREVIEW_SCHEMA = z.object({
+  bcc: z.string().array(),
+  bodyPreview: z.string().nullable(),
+  cc: z.string().array(),
+  createdAt: DATE_SCHEMA,
+  dateSent: NULLABLE_DATE_SCHEMA,
+  direction: z.enum(["incoming", "outgoing"]),
+  envelope: CLOSE_EMAIL_ENVELOPE_SCHEMA.nullable(),
+  hasAttachments: z.boolean().nullable(),
+  id: z.string().nullable(),
+  opensSummary: z.string().nullable(),
+  sendAsId: z.string().nullable(),
+  sender: z.string().nullable(),
+  status: z.enum(["draft", "error", "inbox", "outbox", "scheduled", "sent"]),
+  subject: z.string().nullable(),
+  to: z.string().array(),
+  updatedAt: DATE_SCHEMA,
+  userId: z.string().nullable(),
+})
+const CLOSE_EMAIL_IN_THREAD_SCHEMA = CLOSE_EMAIL_SCHEMA.extend({
+  bodyHtml: z.string().nullable().optional(),
+  bodyText: z.string().nullable().optional(),
+})
+const CLOSE_EMAIL_THREAD_SCHEMA = z.object({
+  ...CLOSE_EXACT_ACTIVITY_FIELDS,
+  emails: CLOSE_EMAIL_IN_THREAD_SCHEMA.array().optional(),
+  importance: z
+    .discriminatedUnion("type", [
+      z.object({
+        reason: z.enum([
+          "manual",
+          "contains-manual-message",
+          "most-recent-communication",
+          "has-response",
+          "whitelisted",
+          "by-default",
+          "unset-initial-default",
+        ]),
+        type: z.literal("important"),
+      }),
+      z.object({
+        reason: z.enum([
+          "manual",
+          "scheduling-emails",
+          "automated-outbound",
+          "marketing-or-transactional",
+          "by-default",
+        ]),
+        type: z.literal("not_important"),
+      }),
+    ])
+    .optional(),
+  latestEmails: CLOSE_EMAIL_PREVIEW_SCHEMA.array().optional(),
+  latestNormalizedSubject: z.string().nullable(),
+  nEmails: z.number().int().nullable(),
+  participants: CLOSE_EMAIL_IDENTITY_SCHEMA.array().optional(),
+  summary: z
+    .object({
+      expiredAt: NULLABLE_DATE_SCHEMA,
+      feedback: z
+        .object({
+          detail: z.string().nullable(),
+          givenAt: DATE_SCHEMA,
+          rating: z.enum(["positive", "negative"]),
+        })
+        .optional(),
+      generatedAt: NULLABLE_DATE_SCHEMA,
+      status: z.enum(["pending", "success", "failure", "expired"]),
+      summaryHtml: z.string().nullable(),
+      summaryText: z.string().nullable(),
+      updatedAt: DATE_SCHEMA,
+    })
+    .nullable()
+    .optional(),
+  type: z.literal("EmailThread"),
+})
+const CLOSE_FORM_SUBMISSION_SCHEMA = z.object({
+  ...CLOSE_EXACT_ACTIVITY_FIELDS,
+  formConfigurationId: z.string(),
+  formId: z.string(),
+  formName: z.string().nullable().optional(),
+  ipAddress: z.string().nullable(),
+  origin: z.string().nullable(),
+  sourceUrl: z.string().nullable(),
+  sourceUrlNormalized: z.string().nullable(),
+  type: z.literal("FormSubmission"),
+  values: z.record(z.string(), z.union([z.string(), z.boolean(), z.null()])),
+  valuesByName: z.record(
+    z.string(),
+    z.union([z.string(), z.boolean(), z.null()]),
+  ),
+})
+const CLOSE_IMPORT_UPDATE_SCHEMA = z.object({
+  ...CLOSE_EXACT_ACTIVITY_FIELDS,
+  importId: z.string().nullable(),
+  reverted: z.boolean(),
+  type: z.literal("ImportUpdate"),
+})
+const CLOSE_LEAD_MERGE_SCHEMA = z.object({
+  ...CLOSE_EXACT_ACTIVITY_FIELDS,
+  destinationDisplayName: z.string().nullable(),
+  destinationLeadId: z.string(),
+  errorMessage: z.string().nullable(),
+  mergeStatus: z.enum(["pending", "in_progress", "completed", "errored"]),
+  sourceDisplayName: z.string().nullable(),
+  sourceLeadId: z.string(),
+  type: z.literal("LeadMerge"),
+})
+const CLOSE_LEAD_STATUS_CHANGE_SCHEMA = z.object({
+  ...CLOSE_EXACT_ACTIVITY_FIELDS,
+  newStatusId: z.string(),
+  newStatusLabel: z.string().optional(),
+  oldStatusId: z.string(),
+  oldStatusLabel: z.string().optional(),
+  pausedSubscriptions: z
+    .object({
+      contactId: z.string().nullable(),
+      contactName: z.string().nullable(),
+      id: z.string(),
+      sequenceId: z.string(),
+      sequenceName: z.string(),
+      sequenceStatus: z.string(),
+    })
+    .array()
+    .optional(),
+  type: z.literal("LeadStatusChange"),
+})
+const CLOSE_OPPORTUNITY_STATUS_CHANGE_SCHEMA = z.object({
+  ...CLOSE_EXACT_ACTIVITY_FIELDS,
+  newPipelineId: z.string().optional(),
+  newPipelineName: z.string().optional(),
+  newStatusId: z.string(),
+  newStatusLabel: z.string().optional(),
+  newStatusType: CLOSE_OPPORTUNITY_STATUS_TYPE_SCHEMA.optional(),
+  oldPipelineId: z.string().optional(),
+  oldPipelineName: z.string().optional(),
+  oldStatusId: z.string(),
+  oldStatusLabel: z.string().optional(),
+  oldStatusType: CLOSE_OPPORTUNITY_STATUS_TYPE_SCHEMA.optional(),
+  opportunityConfidence: z.number().int().nullable().optional(),
+  opportunityDateWon: NULLABLE_DATE_SCHEMA.optional(),
+  opportunityId: z.string().nullable(),
+  opportunityValue: z.number().int().nullable().optional(),
+  opportunityValueCurrency: z.string().nullable().optional(),
+  opportunityValueFormatted: z.string().nullable().optional(),
+  opportunityValuePeriod: z
+    .enum(["annual", "monthly", "one_time"])
+    .nullable()
+    .optional(),
+  type: z.literal("OpportunityStatusChange"),
+})
+const CLOSE_TASK_COMPLETED_ACTIVITY_SCHEMA = z.object({
+  ...CLOSE_TASK_COMPLETED_ACTIVITY_FIELDS,
+  commentSummary: CLOSE_COMMENT_SUMMARY_SCHEMA.nullable().optional(),
+  sequenceId: z.string().nullable().optional(),
+  sequenceName: z.string().nullable().optional(),
+  sequenceSubscriptionId: z.string().nullable().optional(),
+  taskAssignedTo: z.string().nullable().optional(),
+  taskAssignedToName: z.string().nullable().optional(),
+  taskId: z.string().nullable(),
+  taskText: z.string().nullable(),
+  type: z.literal("TaskCompleted"),
+})
+const CLOSE_WHATSAPP_MESSAGE_SCHEMA = z.object({
+  ...CLOSE_EXACT_ACTIVITY_FIELDS,
+  attachments: CLOSE_ATTACHMENT_SCHEMA.array().optional(),
+  direction: z.enum(["incoming", "outgoing"]),
+  externalWhatsappMessageId: z.string(),
+  integrationLink: z.string().nullable(),
+  integrationName: z.string().nullable(),
+  localPhone: z.string(),
+  localPhoneFormatted: z.string(),
+  messageHtml: z.string(),
+  messageMarkdown: z.string(),
+  remotePhone: z.string(),
+  remotePhoneFormatted: z.string(),
+  responseToId: z.string().nullable(),
+  sequenceId: z.string().nullable().optional(),
+  sequenceName: z.string().nullable().optional(),
+  sequenceSubscriptionId: z.string().nullable().optional(),
+  source: CLOSE_CREATION_SOURCE_SCHEMA,
+  text: z.string(),
+  type: z.literal("WhatsAppMessage"),
+})
+const CLOSE_ACTIVITY_LIST_CREATED_SCHEMA = CLOSE_CREATED_ACTIVITY_SCHEMA.extend(
+  {
+    importId: z.string().nullable().optional(),
+  },
+)
+const CLOSE_ACTIVITY_LIST_EMAIL_SCHEMA = CLOSE_EMAIL_SCHEMA.extend({
+  bulkEmailActionId: z.string().nullable().optional(),
+  dateSent: NULLABLE_DATE_SCHEMA.optional(),
+  hasReply: z.boolean().optional(),
+  inReplyToId: z.string().nullable().optional(),
+  needSmtpCredentials: z.boolean().optional(),
+  opensSummary: z.string().nullable().optional(),
+  sendAsId: z.string().nullable().optional(),
+  threadId: z.string().nullable().optional(),
+})
+const CLOSE_ACTIVITY_LIST_NOTE_SCHEMA = CLOSE_NOTE_SCHEMA.extend({
+  attachments: CLOSE_ATTACHMENT_SCHEMA.array().optional(),
+  noteHtml: z.string().optional(),
+  pinned: z.boolean().optional(),
+  pinnedAt: NULLABLE_DATE_SCHEMA.optional(),
+  source: z.string().nullable().optional(),
+  title: z.string().nullable().optional(),
+})
+
+export const CLOSE_ACTIVITY_SCHEMA = z.discriminatedUnion("type", [
+  CLOSE_CALL_SCHEMA,
+  CLOSE_ACTIVITY_LIST_EMAIL_SCHEMA,
+  CLOSE_MEETING_SCHEMA,
+  CLOSE_ACTIVITY_LIST_NOTE_SCHEMA,
+  CLOSE_SMS_SCHEMA,
+  CLOSE_ACTIVITY_LIST_CREATED_SCHEMA,
+  CLOSE_CUSTOM_ACTIVITY_SCHEMA,
+  CLOSE_EMAIL_THREAD_SCHEMA,
+  CLOSE_FORM_SUBMISSION_SCHEMA,
+  CLOSE_IMPORT_UPDATE_SCHEMA,
+  CLOSE_LEAD_MERGE_SCHEMA,
+  CLOSE_LEAD_STATUS_CHANGE_SCHEMA,
+  CLOSE_OPPORTUNITY_STATUS_CHANGE_SCHEMA,
+  CLOSE_TASK_COMPLETED_ACTIVITY_SCHEMA,
+  CLOSE_WHATSAPP_MESSAGE_SCHEMA,
+])
+
+export const CLOSE_COMMENT_SCHEMA = z.object({
+  body: z.string(),
+  createdAt: DATE_SCHEMA,
+  createdBy: z.string(),
+  id: z.string(),
+  leadId: z.string(),
+  mentions: z.string().array().prefault([]),
+  organizationId: z.string(),
+  removedAt: NULLABLE_DATE_SCHEMA,
+  removedBy: z.string().nullable(),
+  threadId: z.string(),
+  updatedAt: DATE_SCHEMA,
+  updatedBy: z.string(),
+})
+
+const CLOSE_SEQUENCE_SCHEDULE_SCHEMA = z.object({
+  ranges: z
+    .object({
+      end: z.string(),
+      start: z.string(),
+      weekday: z.number().int(),
+    })
+    .array(),
+})
+const CLOSE_SEQUENCE_STEP_SCHEMA = z.object({
+  createdAt: DATE_SCHEMA,
+  createdById: z.string(),
+  delay: z.number().int().nonnegative(),
+  emailTemplateId: z.string().nullable().optional(),
+  id: z.string(),
+  required: z.boolean(),
+  stepAllowedDelay: z.number().int().nonnegative().nullable().optional(),
+  stepType: z.enum(["call", "email"]).optional(),
+  threading: z.literal("old_thread").nullable().optional(),
+  updatedAt: DATE_SCHEMA,
+  updatedById: z.string(),
+})
+
+export const CLOSE_SEQUENCE_SCHEMA = z.object({
+  createdAt: DATE_SCHEMA,
+  createdById: z.string(),
+  id: z.string(),
+  name: z.string(),
+  organizationId: z.string(),
+  schedule: CLOSE_SEQUENCE_SCHEDULE_SCHEMA.nullable(),
+  status: z.string(),
+  steps: CLOSE_SEQUENCE_STEP_SCHEMA.array(),
+  subscriptionCountsByStatus: z
+    .object({
+      active: z.number().int().nonnegative(),
+      error: z.number().int().nonnegative(),
+      finished: z.number().int().nonnegative(),
+      goal: z.number().int().nonnegative(),
+      paused: z.number().int().nonnegative(),
+    })
+    .optional(),
+  timezone: z.string(),
+  updatedAt: DATE_SCHEMA,
+  updatedById: z.string(),
+})
+
+export const CLOSE_SEQUENCE_SUBSCRIPTION_SCHEMA = z.object({
+  callsAssignedTo: z.string().array().prefault([]),
+  contactEmail: z.email().nullable(),
+  contactId: z.string().nullable(),
+  createdAt: DATE_SCHEMA,
+  createdById: z.string(),
+  id: z.string(),
+  leadId: z.string(),
+  organizationId: z.string(),
+  senderAccountId: z.string().nullable(),
+  senderEmail: z.email().nullable(),
+  senderName: z.string().nullable(),
+  sequenceId: z.string(),
+  startDate: NULLABLE_DATE_SCHEMA,
+  status: z.enum(["active", "error", "finished", "goal", "paused"]),
+  statusReason: z.string().nullable(),
+  updatedAt: DATE_SCHEMA,
+  updatedById: z.string(),
+})
+
+export const CLOSE_USER_SCHEMA = z
+  .object({
+    createdAt: DATE_SCHEMA,
+    email: z.email(),
+    firstName: z.string(),
+    id: z.string(),
+    image: z.url().nullable().optional(),
+    lastName: z.string(),
+    organizationIds: z.string().array().optional(),
+    organizations: z
+      .union([z.string(), z.object({ id: z.string() })])
+      .array()
+      .prefault([]),
+    updatedAt: DATE_SCHEMA,
+  })
+  .transform(({ organizationIds, organizations, ...user }) => ({
+    ...user,
+    organizationIds:
+      organizationIds ??
+      organizations.map((organization) =>
+        typeof organization === "string" ? organization : organization.id,
+      ),
+  }))
+
+export const CLOSE_LEAD_STATUS_SCHEMA = z.object({
+  color: z
+    .enum([
+      "blue",
+      "gray",
+      "green",
+      "magenta",
+      "orange",
+      "purple",
+      "teal",
+      "yellow",
+    ])
+    .nullable(),
+  id: z.string(),
+  label: z.string(),
+  organizationId: z.string(),
+})
+
+export const CLOSE_OPPORTUNITY_STATUS_SCHEMA = z.object({
+  id: z.string(),
+  label: z.string(),
+  organizationId: z.string(),
+  pipelineId: z.string().optional(),
+  type: CLOSE_OPPORTUNITY_STATUS_TYPE_SCHEMA,
+})
+
+export const CLOSE_PIPELINE_SCHEMA = z.object({
+  createdAt: DATE_SCHEMA,
+  createdBy: z.string().nullable(),
+  id: z.string(),
+  name: z.string(),
+  organizationId: z.string(),
+  statuses: z
+    .object({
+      id: z.string(),
+      label: z.string(),
+      type: CLOSE_OPPORTUNITY_STATUS_TYPE_SCHEMA,
+    })
+    .array(),
+  updatedAt: DATE_SCHEMA,
+  updatedBy: z.string().nullable(),
+})
+
+/**
+ * Creates a schema for a paginated Close collection response.
+ *
+ * @param schema - Schema for one collection item.
+ */
+export function closePageSchema<TSchema extends z.ZodType>(schema: TSchema) {
+  return z.object({
+    data: schema.array(),
+    hasMore: z.boolean().prefault(false),
+  })
+}