/* generated using openapi-typescript-codegen -- do not edit */ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ import type { LifecycleStageEnum } from './LifecycleStageEnum'; /** * Adds a read-only ``tags`` field to a host serializer. * * Emits ``[{id, name, color}]``. Cheap when the host queryset uses * ``prefetch_related("tag_assignments__tag")`` — without that prefetch * every record triggers two extra queries. */ export type Person = { /** * Server-assigned UUID. Stable across renames and merges. */ readonly id: string; /** * Platform the person belongs to. Set automatically from your credentials; you cannot pass another Platform's id. */ readonly platform: number; /** * Display name (e.g. 'Alice Chen'). */ name: string; /** * Canonical email address. When a platform user is created with a matching email in your Platform, this person is automatically linked to them (case-insensitive). */ primary_email?: string; /** * Additional email addresses associated with this person. */ emails?: any; /** * Phone/contact numbers in any free-form shape. */ contact_numbers?: any; /** * Role / job title — display only, not validated. */ job_title?: string; /** * UUID of an organization in your Platform. References to organizations in other Platforms are rejected. */ organization?: string | null; /** * Id of the platform user who owns / manages this person (internal account manager). Optional. */ owner?: number | null; /** * Read-only. Populated once this person is bound to a platform user — either automatically on user creation when emails match, or explicitly via `POST /persons/{id}/link-user/`. */ readonly platform_user: number | null; /** * Sales pipeline stage. One of: `lead`, `qualified`, `opportunity`, `customer`, `churned`. * * * `lead` - Lead * * `qualified` - Qualified * * `opportunity` - Opportunity * * `customer` - Customer * * `churned` - Churned */ lifecycle_stage?: LifecycleStageEnum; /** * Optional external system id (e.g. import key from another CRM). When non-blank, must be unique within your Platform. */ unique_id?: string; /** * Read-only. Set to `false` when the person is linked to a platform user or merged into another person. */ readonly active: boolean; readonly tags: Array<{ id: number; name: string; color: string; }>; /** * Free-form JSON for Platform-defined attributes. */ metadata?: any; /** * Creation timestamp. */ readonly created_at: string; /** * Last-modified timestamp. */ readonly updated_at: string; };