@automate.ax/integration-contracts 0.90.0 → 0.91.0

package/src/jobnimbus/api.ts

@@ -0,0 +1,294 @@
+import { isEncodable, type Encodable } from "@automate.ax/codec"
+import * as z from "zod"
+
+const JOB_NIMBUS_API_ORIGINS = {
+  accountsReceivable: "https://api.jobnimbus.com/accounts-receivable/v1/",
+  activities: "https://api.jobnimbus.com/activities/v1/",
+  files: "https://api.jobnimbus.com/files/v1/",
+  identity: "https://api.jobnimbus.com/identity/v1/",
+  public: "https://app.jobnimbus.com/api1/",
+} as const
+
+const JOB_NIMBUS_SECRET_SCHEMA = z.object({
+  apiKey: z.string().trim().min(1),
+})
+
+export const JOB_NIMBUS_VALUE_SCHEMA = z.custom<Encodable>(isEncodable, {
+  message: "Expected a codec-safe JobNimbus value.",
+})
+
+export const JOB_NIMBUS_RESPONSE_SCHEMA = z.union([
+  JOB_NIMBUS_VALUE_SCHEMA,
+  z.undefined().transform(() => null),
+])
+
+export type JobNimbusApi = keyof typeof JOB_NIMBUS_API_ORIGINS
+
+interface JobNimbusRequestOptions<TSchema extends z.ZodType> {
+  body?: Encodable
+  contentType?: string
+  headers?: Record<string, string | undefined>
+  method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT"
+  query?: Record<
+    string,
+    | boolean
+    | number
+    | string
+    | readonly (boolean | number | string)[]
+    | null
+    | undefined
+  >
+  responseSchema: TSchema
+}
+
+/** Error returned by a rejected JobNimbus API request. */
+export class JobNimbusApiError extends Error {
+  readonly details: Encodable
+  readonly status: number
+
+  /**
+   * Creates an error from a rejected JobNimbus response.
+   *
+   * @param status - HTTP response status.
+   * @param details - Codec-safe response details.
+   */
+  constructor(status: number, details: Encodable) {
+    super(`JobNimbus API request failed (${status}).`)
+    this.name = "JobNimbusApiError"
+    this.details = details
+    this.status = status
+  }
+}
+
+/**
+ * Creates an authenticated client for one documented JobNimbus API root.
+ *
+ * @param secret - Stored JobNimbus API key.
+ * @param api - Public API or one current Platform service.
+ */
+export function getJobNimbusApi(secret: unknown, api: JobNimbusApi) {
+  const { apiKey } = JOB_NIMBUS_SECRET_SCHEMA.parse(secret)
+  const origin = JOB_NIMBUS_API_ORIGINS[api]
+  const root = new URL(origin)
+
+  return {
+    /**
+     * Sends one JSON request below the selected JobNimbus API root.
+     *
+     * @param path - Relative path below the selected root.
+     * @param options - Request method, query, body, headers, and response
+     *   schema.
+     */
+    async request<TSchema extends z.ZodType>(
+      path: string,
+      options: JobNimbusRequestOptions<TSchema>,
+    ): Promise<z.output<TSchema>> {
+      const normalizedPath = path.replace(/^\/+/, "")
+      if (
+        !normalizedPath ||
+        normalizedPath.includes("://") ||
+        normalizedPath.includes("\\")
+      ) {
+        throw new TypeError("JobNimbus API paths must be relative.")
+      }
+
+      const url = new URL(normalizedPath, origin)
+      if (
+        url.origin !== root.origin ||
+        !url.pathname.startsWith(root.pathname)
+      ) {
+        throw new TypeError(
+          "JobNimbus API paths must remain below the selected root.",
+        )
+      }
+      for (const [key, value] of Object.entries(options.query ?? {})) {
+        if (value == null) continue
+        if (Array.isArray(value)) {
+          for (const item of value) url.searchParams.append(key, String(item))
+        } else {
+          url.searchParams.set(key, String(value))
+        }
+      }
+
+      const headers = new Headers({
+        Accept: "application/json",
+        Authorization: `Bearer ${apiKey}`,
+      })
+      for (const [key, value] of Object.entries(options.headers ?? {})) {
+        if (value !== undefined) headers.set(key, value)
+      }
+      if (options.body !== undefined) {
+        headers.set("Content-Type", options.contentType ?? "application/json")
+      }
+
+      const response = await fetch(url, {
+        body:
+          options.body === undefined
+            ? undefined
+            : JSON.stringify(
+                api === "public" ? toJobNimbus(options.body) : options.body,
+              ),
+        headers,
+        method: options.method ?? "GET",
+      })
+      const text = await response.text()
+      const parsed = JOB_NIMBUS_RESPONSE_SCHEMA.safeParse(
+        fromJobNimbus(text ? parseJson(text) : null),
+      )
+      if (!response.ok || !parsed.success) {
+        throw new JobNimbusApiError(
+          response.status,
+          parsed.success ? parsed.data : { response: text },
+        )
+      }
+      return options.responseSchema.parse(parsed.data)
+    },
+  }
+}
+
+/**
+ * Downloads one JobNimbus attachment from its documented non-API route.
+ *
+ * @param secret - Stored JobNimbus API key.
+ * @param fileId - Attachment JNID.
+ */
+export async function downloadJobNimbusFile(secret: unknown, fileId: string) {
+  const { apiKey } = JOB_NIMBUS_SECRET_SCHEMA.parse(secret)
+  const response = await fetch(
+    new URL(
+      encodeURIComponent(z.string().trim().min(1).parse(fileId)),
+      "https://app.jobnimbus.com/files/",
+    ),
+    { headers: { Authorization: `Bearer ${apiKey}` } },
+  )
+  if (!response.ok) {
+    throw new JobNimbusApiError(response.status, {
+      response: await response.text(),
+    })
+  }
+  return response.blob()
+}
+
+/**
+ * Converts public camelCase JSON into JobNimbus's provider-native keys.
+ *
+ * @param value - Codec-safe public value.
+ */
+export function toJobNimbus(value: Encodable): Encodable {
+  if (value instanceof Date) return value.toISOString()
+  if (Array.isArray(value)) return value.map(toJobNimbus)
+  if (!isPlainObject(value)) return value
+
+  return Object.fromEntries(
+    Object.entries(value).flatMap(([key, item]) =>
+      key === "customFields" && isPlainObject(item)
+        ? Object.entries(item).map(([field, fieldValue]) => [
+            field,
+            toJobNimbus(fieldValue),
+          ])
+        : [[toSnakeCase(key), toJobNimbus(item)]],
+    ),
+  )
+}
+
+/**
+ * Converts JobNimbus JSON into public camelCase values.
+ *
+ * Documented legacy Unix date fields become Date instances. Unknown fields are
+ * preserved so account-defined CRM fields survive normalization.
+ *
+ * @param value - Raw provider value.
+ */
+export function fromJobNimbus(value: unknown): Encodable {
+  return normalizeJobNimbusValue(value)
+}
+
+/**
+ * Recursively normalizes one raw provider value and its original key.
+ *
+ * @param value - Raw provider value.
+ * @param providerKey - Original provider field name, when nested in an object.
+ */
+function normalizeJobNimbusValue(
+  value: unknown,
+  providerKey?: string,
+): Encodable {
+  if (typeof value === "number" && providerKey?.startsWith("date_")) {
+    return new Date(value * 1_000)
+  }
+  if (Array.isArray(value)) {
+    return value.map((item) => normalizeJobNimbusValue(item))
+  }
+  if (!isPlainObject(value)) return JOB_NIMBUS_VALUE_SCHEMA.parse(value)
+
+  const customFields: Record<string, Encodable> = {}
+  return Object.fromEntries([
+    ...Object.entries(value).flatMap(([key, item]) => {
+      if (/^cf_(?:boolean|date|double|long|string)_\d+$/.test(key)) {
+        customFields[key] = normalizeJobNimbusValue(item, key)
+        return []
+      }
+      return [
+        [
+          key === "extermal_id"
+            ? "externalId"
+            : key === "jnid"
+              ? "id"
+              : key === "recid"
+                ? "recordId"
+                : toCamelCase(key),
+          normalizeJobNimbusValue(item, key),
+        ] as const,
+      ]
+    }),
+    ...(Object.keys(customFields).length > 0
+      ? [["customFields", customFields] as const]
+      : []),
+  ])
+}
+
+/**
+ * Parses a response body while preserving non-JSON diagnostics.
+ *
+ * @param value - Raw response body.
+ */
+function parseJson(value: string): unknown {
+  try {
+    return JSON.parse(value)
+  } catch {
+    return { response: value }
+  }
+}
+
+/**
+ * Checks whether a value can be traversed as a JSON-style object.
+ *
+ * @param value - Candidate object value.
+ */
+function isPlainObject(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value)
+}
+
+/**
+ * Converts one provider snake-case key to camel case.
+ *
+ * @param value - Provider field name.
+ */
+function toCamelCase(value: string) {
+  return value
+    .replace(/_([a-z0-9])/g, (_match, character: string) =>
+      character.toUpperCase(),
+    )
+    .replace(/^[A-Z]/, (character) => character.toLowerCase())
+}
+
+/**
+ * Converts one public camel-case key to provider snake case.
+ *
+ * @param value - Public field name.
+ */
+function toSnakeCase(value: string) {
+  return value
+    .replace(/([a-zA-Z])([0-9])/g, "$1_$2")
+    .replace(/[A-Z]/g, (character) => `_${character.toLowerCase()}`)
+}

package/src/jobnimbus/index.ts

@@ -0,0 +1,2 @@
+export * from "./api"
+export * from "./schemas"

package/src/jobnimbus/schemas.ts

@@ -0,0 +1,351 @@
+import * as z from "zod"
+
+import { JOB_NIMBUS_VALUE_SCHEMA } from "./api"
+
+export const JOB_NIMBUS_ID_SCHEMA = z.string().trim().min(1)
+
+const NULLABLE_STRING_SCHEMA = z.string().nullable().optional()
+const NULLABLE_NUMBER_SCHEMA = z.number().nullable().optional()
+const DATE_SCHEMA = z.date().nullable().optional()
+
+export const JOB_NIMBUS_CUSTOM_FIELDS_SCHEMA = z.record(
+  z.string().min(1),
+  z.union([z.boolean(), z.number(), z.string(), z.null()]),
+)
+
+export const JOB_NIMBUS_REFERENCE_SCHEMA = z
+  .object({
+    id: JOB_NIMBUS_ID_SCHEMA,
+    name: NULLABLE_STRING_SCHEMA,
+    number: NULLABLE_STRING_SCHEMA,
+    type: NULLABLE_STRING_SCHEMA,
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_OWNER_SCHEMA = z
+  .object({
+    id: JOB_NIMBUS_ID_SCHEMA,
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_LOCATION_SCHEMA = z
+  .object({
+    id: z.number(),
+    name: NULLABLE_STRING_SCHEMA,
+    parentId: z.number().nullable().optional(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_GEO_SCHEMA = z.object({
+  lat: z.number(),
+  lon: z.number(),
+})
+
+const CRM_BASE_FIELDS = {
+  dateCreated: DATE_SCHEMA,
+  createdBy: NULLABLE_STRING_SCHEMA,
+  createdByName: NULLABLE_STRING_SCHEMA,
+  customer: NULLABLE_STRING_SCHEMA,
+  customFields: JOB_NIMBUS_CUSTOM_FIELDS_SCHEMA.optional(),
+  id: JOB_NIMBUS_ID_SCHEMA,
+  isActive: z.boolean().optional(),
+  isArchived: z.boolean().optional(),
+  location: JOB_NIMBUS_LOCATION_SCHEMA.nullable().optional(),
+  owners: JOB_NIMBUS_OWNER_SCHEMA.array().optional(),
+  recordId: z.number().optional(),
+  recordType: NULLABLE_NUMBER_SCHEMA,
+  recordTypeName: NULLABLE_STRING_SCHEMA,
+  related: JOB_NIMBUS_REFERENCE_SCHEMA.array().optional(),
+  tags: z.string().array().optional(),
+  type: NULLABLE_STRING_SCHEMA,
+  dateUpdated: DATE_SCHEMA,
+}
+
+const ADDRESS_FIELDS = {
+  addressLine1: NULLABLE_STRING_SCHEMA,
+  addressLine2: NULLABLE_STRING_SCHEMA,
+  city: NULLABLE_STRING_SCHEMA,
+  countryName: NULLABLE_STRING_SCHEMA,
+  stateText: NULLABLE_STRING_SCHEMA,
+  zip: NULLABLE_STRING_SCHEMA,
+}
+
+const WORKFLOW_FIELDS = {
+  isClosed: z.boolean().optional(),
+  isLead: z.boolean().optional(),
+  salesRep: NULLABLE_STRING_SCHEMA,
+  salesRepName: NULLABLE_STRING_SCHEMA,
+  source: NULLABLE_NUMBER_SCHEMA,
+  sourceName: NULLABLE_STRING_SCHEMA,
+  status: NULLABLE_NUMBER_SCHEMA,
+  statusName: NULLABLE_STRING_SCHEMA,
+}
+
+export const JOB_NIMBUS_CONTACT_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    ...ADDRESS_FIELDS,
+    ...WORKFLOW_FIELDS,
+    company: NULLABLE_STRING_SCHEMA,
+    description: NULLABLE_STRING_SCHEMA,
+    displayName: NULLABLE_STRING_SCHEMA,
+    email: NULLABLE_STRING_SCHEMA,
+    faxNumber: NULLABLE_STRING_SCHEMA,
+    firstName: NULLABLE_STRING_SCHEMA,
+    geo: JOB_NIMBUS_GEO_SCHEMA.nullable().optional(),
+    homePhone: NULLABLE_STRING_SCHEMA,
+    lastName: NULLABLE_STRING_SCHEMA,
+    mobilePhone: NULLABLE_STRING_SCHEMA,
+    website: NULLABLE_STRING_SCHEMA,
+    workPhone: NULLABLE_STRING_SCHEMA,
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_JOB_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    ...ADDRESS_FIELDS,
+    ...WORKFLOW_FIELDS,
+    description: NULLABLE_STRING_SCHEMA,
+    geo: JOB_NIMBUS_GEO_SCHEMA.nullable().optional(),
+    name: z.string(),
+    number: NULLABLE_STRING_SCHEMA,
+    primary: JOB_NIMBUS_REFERENCE_SCHEMA.nullable().optional(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_TASK_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    actualTime: NULLABLE_NUMBER_SCHEMA,
+    dateEnd: DATE_SCHEMA,
+    dateStart: DATE_SCHEMA,
+    description: NULLABLE_STRING_SCHEMA,
+    estimatedTime: NULLABLE_NUMBER_SCHEMA,
+    isCompleted: z.boolean().optional(),
+    number: NULLABLE_STRING_SCHEMA,
+    priority: NULLABLE_NUMBER_SCHEMA,
+    primary: JOB_NIMBUS_REFERENCE_SCHEMA.nullable().optional(),
+    title: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_PRODUCT_UOM_SCHEMA = z
+  .object({
+    labor: z
+      .object({ cost: z.number().optional(), price: z.number().optional() })
+      .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+      .optional(),
+    material: z
+      .object({ cost: z.number().optional(), price: z.number().optional() })
+      .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+      .optional(),
+    uom: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_PRODUCT_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    description: NULLABLE_STRING_SCHEMA,
+    externalId: NULLABLE_STRING_SCHEMA,
+    itemType: z.enum(["labor", "labor+material", "material"]).optional(),
+    locationId: z.number().nullable().optional(),
+    name: z.string(),
+    suppliers: z.array(JOB_NIMBUS_VALUE_SCHEMA).optional(),
+    taxExempt: z.boolean().optional(),
+    uoms: JOB_NIMBUS_PRODUCT_UOM_SCHEMA.array().optional(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_FILE_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    description: NULLABLE_STRING_SCHEMA,
+    filename: NULLABLE_STRING_SCHEMA,
+    isPrivate: z.boolean().optional(),
+    name: NULLABLE_STRING_SCHEMA,
+    size: NULLABLE_NUMBER_SCHEMA,
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+/**
+ * Wraps a legacy item schema in JobNimbus's offset-page response.
+ *
+ * @param itemSchema - Schema for one legacy result.
+ */
+export function jobNimbusPageSchema<TSchema extends z.ZodType>(
+  itemSchema: TSchema,
+) {
+  return z
+    .object({
+      count: z.number().int().nonnegative(),
+      results: itemSchema.array(),
+    })
+    .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+}
+
+export const JOB_NIMBUS_ACTIVITY_RECORD_INPUT_SCHEMA = z.object({
+  id: JOB_NIMBUS_ID_SCHEMA,
+  type: z.string().trim().min(1),
+})
+
+export const JOB_NIMBUS_ACTIVITY_RECORD_SCHEMA = z.object({
+  ...JOB_NIMBUS_ACTIVITY_RECORD_INPUT_SCHEMA.shape,
+  name: z.string().nullable().optional(),
+})
+
+export const JOB_NIMBUS_ACTIVITY_ACTOR_SCHEMA = z
+  .object({
+    id: JOB_NIMBUS_ID_SCHEMA,
+    name: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_ACTIVITY_SCHEMA = z
+  .object({
+    activityAction: z.string(),
+    activityTypeId: z.number().int(),
+    content: z.string(),
+    createdAt: z
+      .union([z.date(), z.iso.datetime({ offset: true })])
+      .transform((value) => (value instanceof Date ? value : new Date(value))),
+    createdBy: JOB_NIMBUS_ACTIVITY_ACTOR_SCHEMA,
+    hasFiles: z.boolean(),
+    id: JOB_NIMBUS_ID_SCHEMA,
+    isEditable: z.boolean(),
+    isPrivate: z.boolean(),
+    primaryRecord: JOB_NIMBUS_ACTIVITY_RECORD_SCHEMA,
+    relatedRecords: JOB_NIMBUS_ACTIVITY_RECORD_SCHEMA.array(),
+    updatedAt: z
+      .union([z.date(), z.iso.datetime({ offset: true })])
+      .transform((value) => (value instanceof Date ? value : new Date(value))),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_ACTIVITY_TYPE_SCHEMA = z.object({
+  displayName: z.string(),
+  id: z.number().int(),
+  isArchived: z.boolean(),
+  isSystem: z.boolean(),
+})
+
+/**
+ * Wraps a Platform response schema in JobNimbus's data envelope.
+ *
+ * @param dataSchema - Schema for the enveloped data value.
+ */
+export function jobNimbusDataSchema<TSchema extends z.ZodType>(
+  dataSchema: TSchema,
+) {
+  return z.object({ data: dataSchema }).catchall(JOB_NIMBUS_VALUE_SCHEMA)
+}
+
+export const JOB_NIMBUS_ACTIVITY_PAGE_SCHEMA = z
+  .object({
+    data: JOB_NIMBUS_ACTIVITY_SCHEMA.array(),
+    pagination: z.object({
+      nextCursor: z.string().nullable(),
+      pageSize: z.number().int().positive(),
+    }),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_WORKFLOW_STATUS_SCHEMA = z
+  .object({
+    id: z.number().int(),
+    isActive: z.boolean(),
+    isArchived: z.boolean(),
+    isClosed: z.boolean(),
+    isLead: z.boolean(),
+    name: z.string(),
+    order: z.number().int(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_WORKFLOW_SCHEMA = z
+  .object({
+    id: z.number().int(),
+    isActive: z.boolean(),
+    name: z.string(),
+    objectType: z.enum(["contact", "job", "workorder"]),
+    order: z.number().int(),
+    status: JOB_NIMBUS_WORKFLOW_STATUS_SCHEMA.array(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_FILE_TYPE_SCHEMA = z.object({
+  fileTypeId: z.number().int(),
+  isActive: z.boolean(),
+  typeName: z.string(),
+})
+
+export const JOB_NIMBUS_TASK_TYPE_SCHEMA = z.object({
+  defaultName: z.string(),
+  hideFromCalendarView: z.boolean(),
+  hideFromTaskList: z.boolean(),
+  icon: z.string(),
+  isActive: z.boolean(),
+  taskTypeId: z.number().int(),
+  typeName: z.string(),
+})
+
+export const JOB_NIMBUS_LEGACY_ACTIVITY_TYPE_SCHEMA = z.object({
+  activityTypeId: z.number().int(),
+  isActive: z.boolean(),
+  showInJobShare: z.boolean(),
+  typeName: z.string(),
+})
+
+export const JOB_NIMBUS_SOURCE_SCHEMA = z.object({
+  isActive: z.boolean(),
+  jobSourceId: z.number().int(),
+  sourceName: z.string(),
+})
+
+export const JOB_NIMBUS_ACCOUNT_SETTINGS_SCHEMA = z
+  .object({
+    activityTypes: JOB_NIMBUS_LEGACY_ACTIVITY_TYPE_SCHEMA.array().optional(),
+    fileTypes: JOB_NIMBUS_FILE_TYPE_SCHEMA.array().optional(),
+    sources: JOB_NIMBUS_SOURCE_SCHEMA.array().optional(),
+    taskTypes: JOB_NIMBUS_TASK_TYPE_SCHEMA.array().optional(),
+    workflows: JOB_NIMBUS_WORKFLOW_SCHEMA.array().optional(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_GROUP_SCHEMA = z
+  .object({
+    managers: JOB_NIMBUS_ID_SCHEMA.array(),
+    members: JOB_NIMBUS_ID_SCHEMA.array(),
+    name: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_USER_SCHEMA = z
+  .object({
+    calendarColor: NULLABLE_STRING_SCHEMA,
+    email: z.email(),
+    firstName: z.string(),
+    id: JOB_NIMBUS_ID_SCHEMA,
+    imageUrl: NULLABLE_STRING_SCHEMA,
+    isActive: z.boolean(),
+    lastName: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_USERS_RESPONSE_SCHEMA = z
+  .object({
+    dateUpdated: z.date().optional(),
+    users: JOB_NIMBUS_USER_SCHEMA.array(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_COMPANY_SCHEMA = z.object({
+  companyId: JOB_NIMBUS_ID_SCHEMA,
+  companyLogoUrl: z.string().nullable(),
+  companyName: z.string(),
+  isCurrent: z.boolean(),
+  isPrimary: z.boolean(),
+  lastAccessedAt: z.iso.datetime({ offset: true }).nullable(),
+  userAvatarUrl: z.string().nullable(),
+})