@rapidmx/crm-plugin 0.1.0

package/dist/apps/shared/crmApi.d.ts

@@ -0,0 +1,909 @@
+export type WorkspaceRole = "owner" | "admin" | "editor" | "viewer";
+export type CrmObjectType = "contact" | "company";
+/** What notes, tasks and timelines can be about. */
+export type SubjectType = CrmObjectType | "deal";
+interface Stored {
+    uid: string;
+    version: number;
+    dateCreated: string;
+    dateModified: string;
+}
+export interface Workspace extends Stored {
+    name: string;
+    description?: string;
+    timezone: string;
+    postalAddress?: string;
+    website?: string;
+    createdByUserUid: string;
+    /** The caller's own role. */
+    role: WorkspaceRole;
+}
+export interface WorkspaceMember extends Stored {
+    workspaceUid: string;
+    userUid: string;
+    role: WorkspaceRole;
+    address?: string;
+    displayName?: string;
+}
+export interface WorkspaceSender extends Stored {
+    workspaceUid: string;
+    mailboxUid: string;
+    fromAddress: string;
+    fromName: string;
+    replyToAddress?: string;
+    /** Mail its mailbox exchanges with contacts goes on their timelines. */
+    logEmail?: boolean;
+}
+export type PropertyViewValue = string | number | boolean | string[];
+export interface Contact extends Stored {
+    workspaceUid: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    jobTitle?: string;
+    companyUid?: string;
+    ownerUserUid?: string;
+    lifecycleStage: string;
+    leadStatus?: string;
+    score: number;
+    tags: string[];
+    source?: string;
+    emailStatus: string;
+    lastEngagedAt?: string;
+    properties: Record<string, PropertyViewValue>;
+}
+export interface Company extends Stored {
+    workspaceUid: string;
+    name: string;
+    domain?: string;
+    industry?: string;
+    employeeCount?: number;
+    phone?: string;
+    website?: string;
+    city?: string;
+    country?: string;
+    ownerUserUid?: string;
+    tags: string[];
+    properties: Record<string, PropertyViewValue>;
+}
+export type CrmRecord = Contact | Company;
+export type PropertyType = "text" | "number" | "date" | "boolean" | "select" | "multi_select";
+export interface PropertyDefinition extends Stored {
+    workspaceUid: string;
+    objectType: CrmObjectType;
+    key: string;
+    label: string;
+    type: PropertyType;
+    options: {
+        value: string;
+        label: string;
+    }[];
+    group?: string;
+    description?: string;
+}
+export interface Note extends Stored {
+    subjectType: SubjectType;
+    subjectUid: string;
+    body: string;
+    authorUserUid: string;
+    pinned: boolean;
+}
+export type TaskStatus = "open" | "done";
+export type TaskPriority = "low" | "normal" | "high";
+export interface Task extends Stored {
+    title: string;
+    notes?: string;
+    status: TaskStatus;
+    priority: TaskPriority;
+    dueAt?: string;
+    assigneeUserUid?: string;
+    subjectType?: SubjectType;
+    subjectUid?: string;
+    completedAt?: string;
+}
+export interface TimelineEvent extends Stored {
+    kind: string;
+    occurredAt: string;
+    actorUserUid?: string;
+    summary: string;
+    data: Record<string, unknown>;
+}
+export interface ImportColumnMapping {
+    column: string;
+    target?: string;
+}
+export interface CrmImport extends Stored {
+    objectType: CrmObjectType;
+    fileName: string;
+    columns: string[];
+    mapping: ImportColumnMapping[];
+    updateExisting: boolean;
+    tags: string[];
+    status: "uploaded" | "queued" | "running" | "done" | "failed";
+    totalRows: number;
+    processedRows: number;
+    createdCount: number;
+    updatedCount: number;
+    skippedCount: number;
+    errors: {
+        row: number;
+        message: string;
+    }[];
+}
+export interface ImportUpload {
+    import: CrmImport;
+    targets: string[];
+    preview: string[][];
+}
+/** A filter condition or group, as `POST .../search` takes it. */
+export interface FilterCondition {
+    field: string;
+    op: string;
+    value?: unknown;
+}
+export interface FilterGroup {
+    and?: FilterNode[];
+    or?: FilterNode[];
+}
+export type FilterNode = FilterCondition | FilterGroup;
+export interface SearchRequest {
+    filter?: FilterNode;
+    q?: string;
+    sort?: {
+        field: string;
+        direction: "asc" | "desc";
+    };
+    limit?: number;
+    page?: number;
+}
+export interface SearchResult<T> {
+    items: T[];
+    total: number;
+}
+/** The API path of one kind of record: `contacts` or `companies`. */
+export declare function recordPath(objectType: CrmObjectType): string;
+export declare const listWorkspaces: () => Promise<Workspace[]>;
+export declare const getWorkspace: (uid: string) => Promise<Workspace>;
+export declare const createWorkspace: (input: Partial<Workspace>) => Promise<Workspace>;
+export declare const updateWorkspace: (uid: string, input: Partial<Workspace>) => Promise<Workspace>;
+export declare const deleteWorkspace: (uid: string) => Promise<void>;
+export declare const listMembers: (uid: string) => Promise<WorkspaceMember[]>;
+export declare const addMember: (uid: string, input: {
+    address?: string;
+    userUid?: string;
+    role: WorkspaceRole;
+}) => Promise<WorkspaceMember>;
+export declare const updateMember: (uid: string, userUid: string, role: WorkspaceRole) => Promise<WorkspaceMember>;
+export declare const removeMember: (uid: string, userUid: string) => Promise<void>;
+export declare const listSenders: (uid: string) => Promise<WorkspaceSender[]>;
+export declare const updateSender: (uid: string, senderUid: string, input: {
+    fromName?: string;
+    replyToAddress?: string | null;
+    logEmail?: boolean;
+}) => Promise<WorkspaceSender>;
+export declare const addSender: (uid: string, input: {
+    fromAddress: string;
+    fromName?: string;
+    replyToAddress?: string;
+    logEmail?: boolean;
+}) => Promise<WorkspaceSender>;
+export declare const removeSender: (uid: string, senderUid: string) => Promise<void>;
+export declare function searchRecords<T extends CrmRecord>(objectType: CrmObjectType, workspaceUid: string, request: SearchRequest): Promise<SearchResult<T>>;
+export declare function getRecord<T extends CrmRecord>(objectType: CrmObjectType, workspaceUid: string, uid: string): Promise<T>;
+export declare function createRecord<T extends CrmRecord>(objectType: CrmObjectType, workspaceUid: string, input: Record<string, unknown>): Promise<T>;
+export declare function updateRecord<T extends CrmRecord>(objectType: CrmObjectType, workspaceUid: string, uid: string, input: Record<string, unknown>): Promise<T>;
+export declare function deleteRecord(objectType: CrmObjectType, workspaceUid: string, uid: string): Promise<void>;
+export declare function bulkRecords(objectType: CrmObjectType, workspaceUid: string, input: {
+    uids: string[];
+    action: "delete" | "addTags" | "removeTags" | "setOwner";
+    tags?: string[];
+    ownerUserUid?: string | null;
+}): Promise<{
+    changed: number;
+}>;
+/** Downloads the records matching `request` as a CSV file. Browser only. */
+export declare function exportRecords(objectType: CrmObjectType, workspaceUid: string, request: SearchRequest): Promise<void>;
+export declare const listProperties: (workspaceUid: string, objectType?: CrmObjectType) => Promise<PropertyDefinition[]>;
+export declare const createProperty: (workspaceUid: string, input: Omit<Partial<PropertyDefinition>, "options"> & {
+    options?: (string | {
+        value: string;
+        label?: string;
+    })[];
+}) => Promise<PropertyDefinition>;
+export declare const deleteProperty: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const listNotes: (workspaceUid: string, subjectUid: string) => Promise<Note[]>;
+export declare const createNote: (workspaceUid: string, input: {
+    subjectType: SubjectType;
+    subjectUid: string;
+    body: string;
+}) => Promise<Note>;
+export declare const deleteNote: (workspaceUid: string, uid: string) => Promise<void>;
+export declare function listTasks(workspaceUid: string, query?: {
+    status?: TaskStatus;
+    assigneeUserUid?: string;
+    subjectUid?: string;
+}): Promise<Task[]>;
+export declare const createTask: (workspaceUid: string, input: Partial<Task>) => Promise<Task>;
+export declare const updateTask: (workspaceUid: string, uid: string, input: Partial<Task>) => Promise<Task>;
+export declare const deleteTask: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const listTimeline: (workspaceUid: string, subjectType: SubjectType, subjectUid: string) => Promise<TimelineEvent[]>;
+export interface MailingList extends Stored {
+    name: string;
+    description?: string;
+    publicName: string;
+    publicDescription?: string;
+    doubleOptIn: boolean;
+    visible: boolean;
+    senderUid?: string;
+    subscribedCount: number;
+    pendingCount: number;
+}
+export type SubscriptionStatus = "pending" | "subscribed" | "unsubscribed";
+export interface Subscription extends Stored {
+    listUid: string;
+    contactUid: string;
+    status: SubscriptionStatus;
+    source: string;
+    consentAt?: string;
+    unsubscribedAt?: string;
+}
+export interface Suppression extends Stored {
+    email: string;
+    reason: "hard_bounce" | "complaint" | "manual";
+    note?: string;
+}
+export interface FormField {
+    target: string;
+    label: string;
+    required: boolean;
+}
+export interface CrmForm extends Stored {
+    name: string;
+    title: string;
+    description?: string;
+    fields: FormField[];
+    listUids: string[];
+    doubleOptIn: boolean;
+    senderUid?: string;
+    successMessage: string;
+    redirectUrl?: string;
+    tags: string[];
+    enabled: boolean;
+    submissionCount: number;
+}
+export declare const listLists: (workspaceUid: string) => Promise<MailingList[]>;
+export declare const createList: (workspaceUid: string, input: Partial<MailingList>) => Promise<MailingList>;
+export declare const updateList: (workspaceUid: string, uid: string, input: Partial<MailingList>) => Promise<MailingList>;
+export declare const deleteList: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const listSubscriptions: (workspaceUid: string, contactUid: string) => Promise<Subscription[]>;
+export declare const setSubscriptions: (workspaceUid: string, input: {
+    listUid: string;
+    contactUids: string[];
+    status: "subscribed" | "unsubscribed";
+}) => Promise<{
+    changed: number;
+}>;
+export declare const listSuppressions: (workspaceUid: string) => Promise<Suppression[]>;
+export declare const createSuppression: (workspaceUid: string, input: {
+    email: string;
+    note?: string;
+}) => Promise<Suppression>;
+export declare const deleteSuppression: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const listForms: (workspaceUid: string) => Promise<CrmForm[]>;
+export declare const createForm: (workspaceUid: string, input: Partial<CrmForm>) => Promise<CrmForm>;
+export declare const updateForm: (workspaceUid: string, uid: string, input: Partial<CrmForm>) => Promise<CrmForm>;
+export declare const deleteForm: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const listImports: (workspaceUid: string) => Promise<CrmImport[]>;
+export declare const getImport: (workspaceUid: string, uid: string) => Promise<CrmImport>;
+export declare const startImport: (workspaceUid: string, uid: string, input: {
+    mapping: ImportColumnMapping[];
+    updateExisting: boolean;
+    tags: string[];
+    listUid?: string;
+}) => Promise<CrmImport>;
+export declare const deleteImport: (workspaceUid: string, uid: string) => Promise<void>;
+/** Uploads a CSV file for import. */
+export declare function uploadImport(workspaceUid: string, objectType: CrmObjectType, file: File): Promise<ImportUpload>;
+/** A readable message for a failed call. */
+export declare function errorMessage(err: unknown, fallback: string): string;
+export type Align = "left" | "center" | "right";
+export type SocialNetwork = "facebook" | "x" | "linkedin" | "instagram" | "youtube" | "github" | "web";
+interface BlockBase {
+    id: string;
+    align?: Align;
+    padding?: number;
+}
+export interface TextBlock extends BlockBase {
+    type: "text";
+    html: string;
+    color?: string;
+    fontSize?: number;
+}
+export interface HeadingBlock extends BlockBase {
+    type: "heading";
+    text: string;
+    level: 1 | 2 | 3;
+    color?: string;
+}
+export interface ImageBlock extends BlockBase {
+    type: "image";
+    src: string;
+    alt: string;
+    href?: string;
+    width?: number;
+}
+export interface ButtonBlock extends BlockBase {
+    type: "button";
+    text: string;
+    href: string;
+    color?: string;
+    backgroundColor?: string;
+    borderRadius?: number;
+}
+export interface DividerBlock extends BlockBase {
+    type: "divider";
+    color?: string;
+    thickness?: number;
+}
+export interface SpacerBlock extends BlockBase {
+    type: "spacer";
+    height: number;
+}
+export interface SocialBlock extends BlockBase {
+    type: "social";
+    links: {
+        network: SocialNetwork;
+        href: string;
+    }[];
+}
+export interface HtmlBlock extends BlockBase {
+    type: "html";
+    html: string;
+}
+export interface FooterBlock extends BlockBase {
+    type: "footer";
+    note?: string;
+    color?: string;
+}
+export type DesignBlock = TextBlock | HeadingBlock | ImageBlock | ButtonBlock | DividerBlock | SpacerBlock | SocialBlock | HtmlBlock | FooterBlock;
+export type BlockType = DesignBlock["type"];
+export interface DesignColumn {
+    id: string;
+    blocks: DesignBlock[];
+}
+export interface DesignSection {
+    id: string;
+    columns: DesignColumn[];
+    backgroundColor?: string;
+    padding?: number;
+}
+export interface DesignTheme {
+    width: number;
+    backgroundColor: string;
+    contentBackgroundColor: string;
+    textColor: string;
+    linkColor: string;
+    buttonColor: string;
+    buttonTextColor: string;
+    fontFamily: string;
+}
+export interface TemplateDesign {
+    version?: number;
+    theme: DesignTheme;
+    sections: DesignSection[];
+}
+export interface EmailTemplate extends Stored {
+    workspaceUid: string;
+    name: string;
+    category?: string | null;
+    subject: string;
+    preheader?: string | null;
+    design: TemplateDesign;
+    /** The design has an unsubscribe link (a footer block, or a `{{ links.unsubscribe }}` link); campaigns require one. */
+    hasUnsubscribeLink: boolean;
+}
+export interface SavedBlock extends Stored {
+    workspaceUid: string;
+    name: string;
+    blocks: DesignBlock[];
+}
+export interface RenderedEmail {
+    subject: string;
+    html: string;
+    text: string;
+}
+export interface MergeTag {
+    tag: string;
+    label: string;
+}
+/** A template's changes; `version` refuses the change when the template was saved elsewhere since. */
+export type TemplateInput = Partial<Pick<EmailTemplate, "name" | "category" | "subject" | "preheader" | "design" | "version">>;
+/** A page of the workspace's templates, by name. */
+export declare const searchTemplates: (workspaceUid: string, page: number, limit?: number) => Promise<SearchResult<EmailTemplate>>;
+export declare const getTemplate: (workspaceUid: string, uid: string) => Promise<EmailTemplate>;
+export declare const createTemplate: (workspaceUid: string, input: TemplateInput) => Promise<EmailTemplate>;
+export declare const updateTemplate: (workspaceUid: string, uid: string, input: TemplateInput) => Promise<EmailTemplate>;
+export declare const deleteTemplate: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const duplicateTemplate: (workspaceUid: string, uid: string) => Promise<EmailTemplate>;
+export declare const renderTemplate: (workspaceUid: string, input: {
+    design: TemplateDesign;
+    subject: string;
+    preheader?: string;
+    contactUid?: string;
+}) => Promise<RenderedEmail>;
+export declare const sendTestTemplate: (workspaceUid: string, uid: string, input: {
+    to: string;
+    senderUid: string;
+    contactUid?: string;
+}) => Promise<{
+    sent: string;
+}>;
+export declare const listMergeTags: (workspaceUid: string) => Promise<MergeTag[]>;
+export declare const listSavedBlocks: (workspaceUid: string) => Promise<SavedBlock[]>;
+export declare const createSavedBlock: (workspaceUid: string, input: {
+    name: string;
+    blocks: DesignBlock[];
+}) => Promise<SavedBlock>;
+export declare const deleteSavedBlock: (workspaceUid: string, uid: string) => Promise<void>;
+export type CampaignStatus = "draft" | "scheduled" | "preparing" | "sending" | "paused" | "sent" | "cancelled" | "failed";
+export type AbMetric = "open" | "click" | "reply";
+export interface CampaignVariant {
+    id: string;
+    subject?: string;
+    templateUid?: string;
+}
+export interface AbTest {
+    variants: CampaignVariant[];
+    testPercent: number;
+    metric: AbMetric;
+    testHours: number;
+    winnerId?: string;
+    decidedAt?: string;
+}
+export interface CampaignCounts {
+    recipients: number;
+    sent: number;
+    failed: number;
+    suppressed: number;
+    bounced: number;
+    opened: number;
+    clicked: number;
+    replied: number;
+    unsubscribed: number;
+    complained: number;
+}
+export interface CampaignStats extends CampaignCounts {
+    variants?: Record<string, CampaignCounts>;
+}
+export interface Campaign extends Stored {
+    workspaceUid: string;
+    name: string;
+    status: CampaignStatus;
+    templateUid?: string | null;
+    senderUid?: string | null;
+    listUids: string[];
+    excludeListUids: string[];
+    segmentUids: string[];
+    excludeSegmentUids: string[];
+    trackOpens: boolean;
+    trackClicks: boolean;
+    abTest?: AbTest | null;
+    scheduledAt?: string | null;
+    startedAt?: string | null;
+    finishedAt?: string | null;
+    recipientCount: number;
+    stats: CampaignStats;
+    error?: string | null;
+}
+export interface CampaignProblem {
+    field: string;
+    message: string;
+}
+export type SendStatus = "queued" | "held" | "sent" | "failed" | "suppressed" | "cancelled";
+/** One message of a campaign, as its recipients list shows it. */
+export interface CampaignRecipient extends Stored {
+    contactUid: string;
+    email: string;
+    variantId: string;
+    status: SendStatus;
+    sentAt?: string;
+    error?: string;
+    firstOpenedAt?: string;
+    openCount: number;
+    firstClickedAt?: string;
+    clickCount: number;
+    repliedAt?: string;
+    bouncedAt?: string;
+    bounceType?: string;
+    complainedAt?: string;
+    unsubscribedAt?: string;
+}
+export interface LinkClicks {
+    url: string;
+    clicks: number;
+    uniqueClicks: number;
+}
+export interface CampaignReport {
+    campaign: Campaign;
+    stats: CampaignStats;
+    links: LinkClicks[];
+}
+export type CampaignInput = Partial<Pick<Campaign, "name" | "templateUid" | "senderUid" | "listUids" | "excludeListUids" | "segmentUids" | "excludeSegmentUids" | "trackOpens" | "trackClicks" | "abTest" | "version">>;
+/** A page of the workspace's campaigns, newest first. */
+export declare const searchCampaigns: (workspaceUid: string, page: number, limit?: number) => Promise<SearchResult<Campaign>>;
+export declare const getCampaign: (workspaceUid: string, uid: string) => Promise<Campaign>;
+export declare const createCampaign: (workspaceUid: string, input: CampaignInput) => Promise<Campaign>;
+export declare const updateCampaign: (workspaceUid: string, uid: string, input: CampaignInput) => Promise<Campaign>;
+export declare const deleteCampaign: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const duplicateCampaign: (workspaceUid: string, uid: string) => Promise<Campaign>;
+export declare const campaignChecklist: (workspaceUid: string, uid: string) => Promise<CampaignProblem[]>;
+export declare const scheduleCampaign: (workspaceUid: string, uid: string, sendAt?: string) => Promise<Campaign>;
+/** Moves a campaign along: back to a draft, paused, resumed or cancelled. */
+export declare const changeCampaign: (workspaceUid: string, uid: string, action: "unschedule" | "pause" | "resume" | "cancel") => Promise<Campaign>;
+export declare const campaignAudience: (workspaceUid: string, input: {
+    listUids: string[];
+    excludeListUids: string[];
+    segmentUids?: string[];
+    excludeSegmentUids?: string[];
+}) => Promise<{
+    count: number;
+    capped: boolean;
+}>;
+export declare const campaignReport: (workspaceUid: string, uid: string) => Promise<CampaignReport>;
+export declare const campaignRecipients: (workspaceUid: string, uid: string, query: {
+    status?: SendStatus;
+    engagement?: string;
+    q?: string;
+    page: number;
+    limit?: number;
+}) => Promise<SearchResult<CampaignRecipient>>;
+export type SegmentKind = "dynamic" | "static";
+export interface Segment extends Stored {
+    workspaceUid: string;
+    name: string;
+    description?: string | null;
+    kind: SegmentKind;
+    filter: FilterNode;
+    memberCount: number;
+    capped: boolean;
+    refreshedAt?: string | null;
+}
+export interface SegmentPreview {
+    count: number;
+    capped: boolean;
+    contacts: Pick<Contact, "uid" | "email" | "firstName" | "lastName">[];
+}
+export type ScoringKind = "property" | "activity";
+export type ScoringActivity = "opened" | "clicked" | "replied" | "form_submitted" | "subscribed" | "unsubscribed" | "bounced";
+export interface ScoringRule extends Stored {
+    workspaceUid: string;
+    name: string;
+    enabled: boolean;
+    kind: ScoringKind;
+    filter?: FilterNode | null;
+    activity?: ScoringActivity | null;
+    points: number;
+    maxPoints?: number | null;
+    withinDays?: number | null;
+}
+export type SegmentInput = Partial<Pick<Segment, "name" | "description" | "kind" | "filter">>;
+export type ScoringRuleInput = Partial<Pick<ScoringRule, "name" | "enabled" | "kind" | "filter" | "activity" | "points" | "maxPoints" | "withinDays">>;
+export declare const listSegments: (workspaceUid: string) => Promise<Segment[]>;
+export declare const createSegment: (workspaceUid: string, input: SegmentInput) => Promise<Segment>;
+export declare const updateSegment: (workspaceUid: string, uid: string, input: SegmentInput) => Promise<Segment>;
+export declare const deleteSegment: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const refreshSegment: (workspaceUid: string, uid: string) => Promise<Segment>;
+export declare const previewSegment: (workspaceUid: string, filter: FilterNode) => Promise<SegmentPreview>;
+export declare const listScoringRules: (workspaceUid: string) => Promise<ScoringRule[]>;
+export declare const createScoringRule: (workspaceUid: string, input: ScoringRuleInput) => Promise<ScoringRule>;
+export declare const updateScoringRule: (workspaceUid: string, uid: string, input: ScoringRuleInput) => Promise<ScoringRule>;
+export declare const deleteScoringRule: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const recalculateScores: (workspaceUid: string) => Promise<{
+    changed: number;
+}>;
+export type NodeType = "trigger" | "delay" | "wait" | "condition" | "split" | "send_email" | "set_field" | "add_tag" | "remove_tag" | "subscribe" | "unsubscribe" | "create_task" | "notify" | "enroll" | "webhook" | "exit";
+export interface AutomationNode {
+    id: string;
+    type: NodeType;
+    config: Record<string, any>;
+}
+export interface AutomationEdge {
+    from: string;
+    to: string;
+    port: string;
+}
+export interface AutomationGraph {
+    nodes: AutomationNode[];
+    edges: AutomationEdge[];
+}
+export type AutomationStatus = "draft" | "active" | "paused";
+export type AutomationReentry = "never" | "after_exit";
+export type EnrollmentState = "active" | "waiting" | "completed" | "exited" | "failed";
+export interface Automation extends Stored {
+    workspaceUid: string;
+    name: string;
+    description?: string | null;
+    status: AutomationStatus;
+    graph: AutomationGraph;
+    reentry: AutomationReentry;
+    goalFilter?: FilterNode | null;
+    publishedVersionUid?: string | null;
+    publishedAt?: string | null;
+}
+export interface AutomationReport {
+    states: Record<EnrollmentState, number>;
+    nodes: Record<string, {
+        current: number;
+        sent?: number;
+        opened?: number;
+        clicked?: number;
+        replied?: number;
+    }>;
+}
+export interface Enrollment extends Stored {
+    automationUid: string;
+    contactUid: string;
+    email?: string;
+    state: EnrollmentState;
+    currentNodeId: string;
+    nextRunAt: string;
+    enteredAt: string;
+    finishedAt?: string | null;
+    error?: string | null;
+    history: {
+        nodeId: string;
+        at: string;
+        outcome: string;
+    }[];
+}
+export type AutomationInput = Partial<Pick<Automation, "name" | "description" | "graph" | "reentry" | "goalFilter" | "version">>;
+export declare const listAutomations: (workspaceUid: string) => Promise<Automation[]>;
+export declare const getAutomation: (workspaceUid: string, uid: string) => Promise<Automation>;
+export declare const createAutomation: (workspaceUid: string, input: AutomationInput) => Promise<Automation>;
+export declare const updateAutomation: (workspaceUid: string, uid: string, input: AutomationInput) => Promise<Automation>;
+export declare const deleteAutomation: (workspaceUid: string, uid: string) => Promise<void>;
+/** Publishes, pauses or resumes an automation. */
+export declare const changeAutomation: (workspaceUid: string, uid: string, action: "publish" | "pause" | "resume") => Promise<Automation>;
+export declare const enrollInAutomation: (workspaceUid: string, uid: string, contactUids: string[]) => Promise<{
+    enrolled: number;
+}>;
+export declare const automationReport: (workspaceUid: string, uid: string) => Promise<AutomationReport>;
+export declare const listEnrollments: (workspaceUid: string, uid: string, query: {
+    state?: EnrollmentState;
+    contactUid?: string;
+    page: number;
+    limit?: number;
+}) => Promise<SearchResult<Enrollment>>;
+export declare const exitEnrollment: (workspaceUid: string, uid: string, enrollmentUid: string) => Promise<Enrollment>;
+export type StageKind = "open" | "won" | "lost";
+export type DealStatus = "open" | "won" | "lost";
+export interface PipelineStage {
+    id: string;
+    name: string;
+    probability: number;
+    kind: StageKind;
+    rottingDays?: number | null;
+}
+export interface Pipeline extends Stored {
+    workspaceUid: string;
+    name: string;
+    stages: PipelineStage[];
+    isDefault: boolean;
+}
+export interface Deal extends Stored {
+    workspaceUid: string;
+    name: string;
+    amount: number;
+    currency: string;
+    pipelineUid: string;
+    stageId: string;
+    status: DealStatus;
+    ownerUserUid?: string | null;
+    contactUids: string[];
+    companyUid?: string | null;
+    expectedCloseDate?: string | null;
+    closedAt?: string | null;
+    lostReason?: string | null;
+    stageChangedAt: string;
+    stageHistory: {
+        stageId: string;
+        at: string;
+        userUid?: string;
+    }[];
+}
+export interface Forecast {
+    stages: {
+        stageId: string;
+        count: number;
+        amount: number;
+        weighted: number;
+    }[];
+    open: {
+        count: number;
+        amount: number;
+        weighted: number;
+    };
+    won: {
+        count: number;
+        amount: number;
+    };
+    lost: {
+        count: number;
+        amount: number;
+    };
+    winRate?: number;
+    averageDaysToWin?: number;
+}
+export type PipelineInput = Partial<Pick<Pipeline, "name" | "isDefault">> & {
+    stages?: Partial<PipelineStage>[];
+};
+export type DealInput = Partial<Pick<Deal, "name" | "amount" | "currency" | "pipelineUid" | "stageId" | "ownerUserUid" | "contactUids" | "companyUid" | "expectedCloseDate" | "lostReason" | "version">>;
+export declare const listPipelines: (workspaceUid: string) => Promise<Pipeline[]>;
+export declare const createPipeline: (workspaceUid: string, input: PipelineInput) => Promise<Pipeline>;
+export declare const updatePipeline: (workspaceUid: string, uid: string, input: PipelineInput) => Promise<Pipeline>;
+export declare const deletePipeline: (workspaceUid: string, uid: string) => Promise<void>;
+/** A pipeline's deals, or a contact's (`contactUid`). */
+export declare function listDeals(workspaceUid: string, query?: {
+    pipelineUid?: string;
+    status?: DealStatus;
+    ownerUserUid?: string;
+    contactUid?: string;
+}): Promise<Deal[]>;
+export declare const getDeal: (workspaceUid: string, uid: string) => Promise<Deal>;
+export declare const createDeal: (workspaceUid: string, input: DealInput) => Promise<Deal>;
+export declare const updateDeal: (workspaceUid: string, uid: string, input: DealInput) => Promise<Deal>;
+export declare const deleteDeal: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const dealForecast: (workspaceUid: string, pipelineUid: string, days?: number) => Promise<Forecast>;
+export interface EmailDay {
+    date: string;
+    sent: number;
+    opened: number;
+    clicked: number;
+    replied: number;
+    bounced: number;
+    unsubscribed: number;
+}
+export interface EmailReport {
+    days: EmailDay[];
+    totals: {
+        sent: number;
+        opened: number;
+        clicked: number;
+        replied: number;
+        bounced: number;
+        unsubscribed: number;
+        complained: number;
+    };
+    domains: {
+        domain: string;
+        sent: number;
+        opened: number;
+        clicked: number;
+    }[];
+}
+export interface GrowthReport {
+    days: {
+        date: string;
+        contacts: number;
+        subscribed: number;
+        unsubscribed: number;
+    }[];
+    contacts: number;
+    lists: {
+        uid: string;
+        name: string;
+        subscribed: number;
+    }[];
+}
+export interface SalesReport {
+    days: {
+        date: string;
+        created: number;
+        won: number;
+        wonAmount: number;
+        lost: number;
+    }[];
+    open: {
+        count: number;
+        amount: number;
+    };
+    won: {
+        count: number;
+        amount: number;
+    };
+    lost: number;
+}
+export declare const emailReport: (workspaceUid: string, days: number) => Promise<EmailReport>;
+export declare const growthReport: (workspaceUid: string, days: number) => Promise<GrowthReport>;
+export declare const salesReport: (workspaceUid: string, days: number, pipelineUid?: string) => Promise<SalesReport>;
+export interface WebhookEndpoint extends Stored {
+    workspaceUid: string;
+    url: string;
+    events: string[];
+    enabled: boolean;
+    description?: string | null;
+    failureCount: number;
+    lastDeliveryAt?: string;
+    lastError?: string | null;
+    secretHint: string;
+    /** Only when it was just made. */
+    secret?: string;
+}
+export type WebhookDeliveryStatus = "pending" | "delivered" | "failed";
+export interface WebhookDelivery extends Stored {
+    endpointUid: string;
+    eventType: string;
+    status: WebhookDeliveryStatus;
+    attempts: number;
+    responseStatus?: number;
+    lastError?: string | null;
+    deliveredAt?: string;
+}
+/** The event types an endpoint can take (besides `*`, all of them). */
+export declare const WEBHOOK_EVENTS: readonly string[];
+export type WebhookInput = {
+    url?: string;
+    events?: string[];
+    enabled?: boolean;
+    description?: string | null;
+};
+export declare const listWebhooks: (workspaceUid: string) => Promise<WebhookEndpoint[]>;
+export declare const createWebhook: (workspaceUid: string, input: WebhookInput) => Promise<WebhookEndpoint>;
+export declare const updateWebhook: (workspaceUid: string, uid: string, input: WebhookInput) => Promise<WebhookEndpoint>;
+export declare const deleteWebhook: (workspaceUid: string, uid: string) => Promise<void>;
+export declare const rotateWebhookSecret: (workspaceUid: string, uid: string) => Promise<{
+    secret: string;
+}>;
+export declare const testWebhook: (workspaceUid: string, uid: string) => Promise<{
+    status?: number;
+    error?: string;
+}>;
+export declare const webhookDeliveries: (workspaceUid: string, uid: string) => Promise<WebhookDelivery[]>;
+export type ApiKeyScope = "contacts" | "subscriptions" | "events";
+export declare const API_KEY_SCOPES: readonly ApiKeyScope[];
+export interface ApiKey extends Stored {
+    workspaceUid: string;
+    name: string;
+    prefix: string;
+    scopes: ApiKeyScope[];
+    lastUsedAt?: string;
+    createdByUserUid: string;
+    /** Only when it was just made. */
+    key?: string;
+}
+export declare const listApiKeys: (workspaceUid: string) => Promise<ApiKey[]>;
+export declare const createApiKey: (workspaceUid: string, input: {
+    name: string;
+    scopes: ApiKeyScope[];
+}) => Promise<ApiKey>;
+export declare const updateApiKey: (workspaceUid: string, uid: string, input: {
+    name?: string;
+    scopes?: ApiKeyScope[];
+}) => Promise<ApiKey>;
+export declare const deleteApiKey: (workspaceUid: string, uid: string) => Promise<void>;
+export interface AdminWorkspace {
+    uid: string;
+    name: string;
+    dateCreated: string;
+    members: number;
+    contacts: number;
+    campaignsSent: number;
+    sendingDisabled: boolean;
+}
+export interface AdminStats {
+    workspaces: number;
+    contacts: number;
+    sentLastDay: number;
+    queued: number;
+}
+export declare const adminStats: () => Promise<AdminStats>;
+export declare const adminWorkspaces: (page: number, limit?: number) => Promise<{
+    items: AdminWorkspace[];
+    total: number;
+}>;
+export declare const setWorkspaceSending: (uid: string, sendingDisabled: boolean) => Promise<{
+    uid: string;
+    sendingDisabled: boolean;
+}>;
+export {};