@rapidmx/crm-plugin 0.1.0

package/dist/types/routes/BaseWorkspaceRecordRoute.d.ts

@@ -0,0 +1,78 @@
+import { type JWTUser } from "@rapidrest/core";
+import { RepoUtils } from "@rapidrest/service-core";
+import { CrmModelName } from "../models/CrmModelClasses.js";
+import { CrmEntity, WorkspaceAction } from "../models/types.js";
+import { CrmRouteBase } from "./CrmRouteBase.js";
+/** A record of a workspace. */
+export interface WorkspaceRecord extends CrmEntity {
+    workspaceUid: string;
+}
+/** A page of a search: the records, and how many match in all. */
+export interface SearchResult<V> {
+    items: V[];
+    total: number;
+}
+/** What a write hook gets. */
+export interface WriteContext {
+    workspaceUid: string;
+    user: JWTUser;
+}
+/**
+ * The create, read, update, delete and search endpoints of one kind of workspace record, mounted by a subclass at
+ * `/api/mail/crm/<kind>`:
+ * - `GET /:workspaceUid` - a page (`limit`, `page`), newest first, optionally narrowed by `listQuery()`'s query parameters.
+ * - `POST /:workspaceUid/search` - `{ filter?, q?, sort?, limit?, page? }` to `{ items, total }` (see `searchQuery()`).
+ * - `GET /:workspaceUid/:uid`, `POST /:workspaceUid`, `PUT /:workspaceUid/:uid`, `DELETE /:workspaceUid/:uid`.
+ *
+ * Reading takes `READ` on the workspace, writing `WRITE` (`writeAction` - `MANAGE` for workspace configuration such as property
+ * definitions). A subclass supplies the model (`model`), the fields a request may set (`readCreate()`/`readUpdate()`), and optionally
+ * the response shape (`toViews()`) and what else a write changes (`afterWrite()`/`afterDelete()`).
+ *
+ * Every stored record is scoped by `workspaceUid`: a uid of another workspace's record is a 404, the same as one that doesn't exist.
+ * An update may carry the `version` it was based on; a stale one is a 409 (`RepoUtils.update()`'s optimistic lock).
+ */
+export declare abstract class BaseWorkspaceRecordRoute<T extends WorkspaceRecord, V = T> extends CrmRouteBase {
+    /** The model this route serves. */
+    protected abstract readonly model: CrmModelName;
+    /** The push message type of a change (e.g. `CrmContact`). */
+    protected abstract readonly pushType: string;
+    /** The action writes take. */
+    protected readonly writeAction: WorkspaceAction;
+    /** The fields a search may sort by. `dateCreated` and `dateModified` are always allowed. */
+    protected readonly sortFields: readonly string[];
+    /** How many records one workspace may have of this kind (`undefined`: no limit). */
+    protected readonly maxRecords?: number;
+    /** The stored fields of a new record, from a create request. */
+    protected abstract readCreate(body: Record<string, unknown>, context: WriteContext): Promise<Partial<T>>;
+    /** The changed fields of `existing`, from an update request. */
+    protected abstract readUpdate(body: Record<string, unknown>, existing: T, context: WriteContext): Promise<Partial<T>>;
+    /**
+     * Whatever a write changes besides the record itself (property values, the timeline...). `before` is unset on a create. Returns the
+     * record as saved again, when the hook changed it too.
+     */
+    protected afterWrite(_record: T, _before: T | undefined, _body: Record<string, unknown>, _context: WriteContext): Promise<T | void>;
+    /** Refuses a delete (throws) when `record` can't go yet. */
+    protected beforeDelete(_record: T): Promise<void>;
+    /** Whatever a delete removes besides the record itself. */
+    protected afterDelete(_record: T, _context: WriteContext): Promise<void>;
+    /** The response shape of `records` (all of one workspace). */
+    protected toViews(records: T[], _workspaceUid: string): Promise<V[]>;
+    /** Extra conditions `GET /:workspaceUid` takes from its query parameters (e.g. `subjectUid`). */
+    protected listQuery(_query: Record<string, unknown>): Record<string, unknown>;
+    /**
+     * The conditions of a `POST /:workspaceUid/search` request besides the workspace itself, from its `filter` and `q`. By default
+     * neither is supported; the contact and company routes compile filters (`filters/Filter.ts`).
+     */
+    protected searchQuery(body: Record<string, unknown>, _workspaceUid: string): Promise<Record<string, unknown> | undefined>;
+    protected records(): Promise<RepoUtils<T>>;
+    list(workspaceUid: string, query: Record<string, unknown> | undefined, user?: JWTUser): Promise<V[]>;
+    search(workspaceUid: string, body: unknown, user?: JWTUser): Promise<SearchResult<V>>;
+    get(workspaceUid: string, uid: string, user?: JWTUser): Promise<V>;
+    create(workspaceUid: string, body: unknown, user?: JWTUser): Promise<V>;
+    update(workspaceUid: string, uid: string, body: unknown, user?: JWTUser): Promise<V>;
+    remove(workspaceUid: string, uid: string, user?: JWTUser): Promise<void>;
+    /** The workspace's record `uid`, or a 404. */
+    protected requireRecord(workspaceUid: string, uid: string): Promise<T>;
+    /** `{ field: "ASC" | "DESC" }` from a search's `sort` (`{ field, direction }`), newest first by default. */
+    private readSort;
+}

package/dist/types/routes/BaseWorkspaceRoute.d.ts

@@ -0,0 +1,78 @@
+import { type JWTUser } from "@rapidrest/core";
+import { Workspace, WorkspaceMember, WorkspaceRole, WorkspaceSender } from "../models/types.js";
+import { CrmRouteBase } from "./CrmRouteBase.js";
+/** How many members and senders one workspace may have, by default (`mail:crm:max_members`, `mail:crm:max_senders`). */
+export declare const MAX_MEMBERS = 500;
+export declare const MAX_SENDERS = 50;
+/** A workspace as its members see it: the record plus the caller's own role. */
+export interface WorkspaceView extends Workspace {
+    role: WorkspaceRole;
+}
+/**
+ * CRM workspaces (`/api/mail/crm/workspaces`): creating one (the creator becomes its owner), listing the caller's, changing and deleting
+ * them, and managing who is a member with which role, and which addresses the workspace sends as.
+ *
+ * A workspace's `AccessControlList` (uid = the workspace's uid, created with it) holds one record per member granting their role's
+ * actions (`ROLE_ACTIONS`); every other CRM route checks the caller against it. `WorkspaceMember` rows mirror those records so a
+ * member's workspaces can be listed and its members shown; this route changes both together.
+ */
+export declare abstract class BaseWorkspaceRoute extends CrmRouteBase {
+    /** Roles allowed to create a workspace, comma-separated; empty lets every signed-in user. */
+    protected creatorRoles: string;
+    protected maxWorkspacesPerUser: number;
+    protected maxMembers: number;
+    protected maxSenders: number;
+    list(user?: JWTUser): Promise<WorkspaceView[]>;
+    create(body: unknown, user?: JWTUser): Promise<WorkspaceView>;
+    get(workspaceUid: string, user?: JWTUser): Promise<WorkspaceView>;
+    update(workspaceUid: string, body: unknown, user?: JWTUser): Promise<WorkspaceView>;
+    /** Deletes the workspace and everything in it. Owners only. */
+    remove(workspaceUid: string, user?: JWTUser): Promise<void>;
+    listMembers(workspaceUid: string, user?: JWTUser): Promise<WorkspaceMember[]>;
+    /**
+     * Adds a member by `userUid`, or by `address` - resolved to the owner of the mailbox with that address, so a colleague can be
+     * added by their email address. Only an owner can add another owner.
+     */
+    addMember(workspaceUid: string, body: unknown, user?: JWTUser): Promise<WorkspaceMember>;
+    /** Changes a member's role. Making someone an owner, or changing an owner's role, takes an owner; the last owner stays one. */
+    updateMember(workspaceUid: string, memberUid: string, body: unknown, user?: JWTUser): Promise<WorkspaceMember>;
+    /** Removes a member. A member may always leave; removing someone else takes `MANAGE`, and removing an owner takes an owner. */
+    removeMember(workspaceUid: string, memberUid: string, user?: JWTUser): Promise<void>;
+    listSenders(workspaceUid: string, user?: JWTUser): Promise<WorkspaceSender[]>;
+    /**
+     * Adds an address the workspace sends as. The caller must be able to change the mailbox the address belongs to (update access:
+     * its owner or a delegate) - otherwise any workspace admin could send as anyone's mailbox - and the address must be the
+     * mailbox's primary address or one of its aliases.
+     */
+    addSender(workspaceUid: string, body: unknown, user?: JWTUser): Promise<WorkspaceSender>;
+    updateSender(workspaceUid: string, senderUid: string, body: unknown, user?: JWTUser): Promise<WorkspaceSender>;
+    removeSender(workspaceUid: string, senderUid: string, user?: JWTUser): Promise<void>;
+    /** The caller's uid, lowercased, or a 401 for an anonymous caller. */
+    private requireUser;
+    /** The workspace fields of a create (`required`: `name`) or update request. */
+    private readWorkspace;
+    /** The version an update was based on (the request's `version`, else the stored one - last writer wins). */
+    private requestVersion;
+    private readRole;
+    /** Who a member request names: `userUid` as given, or `address` as the owner of the mailbox with that address. */
+    private resolvePerson;
+    /**
+     * The mailbox whose primary address is `address` (lowercase). Only the primary address: a member or sender is named by the
+     * mailbox's own address, so an alias never silently picks some other mailbox.
+     */
+    private findMailboxByAddress;
+    /** The mailbox `address` belongs to, when the caller may send from it (update access to the mailbox), else a 400. */
+    private requireSendableMailbox;
+    private requireWorkspace;
+    private requireWorkspaceSender;
+    private members;
+    private senders;
+    /** Refuses (409) a change that would leave the workspace without an owner: `member` becoming `role` (`undefined`: leaving). */
+    private keepAnOwner;
+    /** Grants `userUid` the actions of `role` on the workspace's ACL, or removes their record (`role` undefined). Retries lost races. */
+    private setAclRecord;
+    /** A plain copy of a stored record, for a response. */
+    protected plain<T>(record: T): T;
+}
+/** Whether `zone` is an IANA time zone this runtime knows. */
+export declare function isTimeZone(zone: string): boolean;

package/dist/types/routes/CrmRouteBase.d.ts

@@ -0,0 +1,95 @@
+import { type JWTUser } from "@rapidrest/core";
+import { ACLUtils, NotificationUtils, ObjectFactory, RepoUtils } from "@rapidrest/service-core";
+import { CrmModelClasses, CrmModelName, CrmRepos } from "../models/CrmModelClasses.js";
+import { CrmObjectType, Workspace, MailingList, Subscription, SubscriptionStatus, WorkspaceAction, WorkspaceMember, WorkspaceSender } from "../models/types.js";
+import { MergeContext } from "../templates/Render.js";
+import { TokenPayload } from "../util/Tokens.js";
+/** The `PropertyValue.key` a contact's subscribed lists are mirrored under, so filters can match list membership. */
+export declare const LISTS_KEY = "lists";
+/** The `CrmSetting` key of the generated token signing key. */
+/** Who or what changed a subscription, and from where. */
+export interface SubscriptionChange {
+    /** `form`, `import`, `manual`, `preferences`, `unsubscribe-link`, `api`... */
+    source: string;
+    /** The subscriber's address, for consent given by the subscriber themselves. */
+    ip?: string;
+    /** The member who made the change, if a member did. */
+    actorUserUid?: string;
+}
+/**
+ * What every CRM route shares: the model classes of its backend (`classes`, from `MONGO_MODELS`/`SQL_MODELS`), their repositories,
+ * workspace access checks, the workspace's push channel, the activity timeline, subscriptions, and the signed links in emails.
+ *
+ * Every model keeps a deny-all class ACL; routes check the caller against the *workspace's* ACL (`requireAccess()`) and then read
+ * and write with `ignoreACL: true`, always scoped by `workspaceUid`.
+ */
+export declare abstract class CrmRouteBase {
+    protected abstract classes: CrmModelClasses;
+    protected _objectFactory?: ObjectFactory;
+    protected aclUtils?: ACLUtils;
+    protected notificationUtils?: NotificationUtils;
+    /** Roles `ACLUtils.hasPermission()` would let through anything - stripped before every workspace check (`assertWorkspaceAccess()`). */
+    protected trustedRoles: string[];
+    /** The site the public pages (preference center, forms) are served from, e.g. `https://mail.example.com`. */
+    protected publicUrl: string;
+    /** The key tokens are signed with. Empty: one is generated and kept (`CrmSetting` `token-secret`). */
+    protected configuredTokenSecret: string;
+    protected logger?: any;
+    private crmRepos?;
+    private cachedTokenSecret?;
+    /** The repositories of every model. */
+    protected repos(): CrmRepos;
+    /** The repository of `name`'s model. */
+    protected repo<T = any>(name: CrmModelName): Promise<RepoUtils<any>>;
+    /** Refuses a caller without `action` on `workspaceUid` - see `assertWorkspaceAccess()`. */
+    protected requireAccess(user: JWTUser | undefined, workspaceUid: string, action: WorkspaceAction): Promise<void>;
+    /** The membership of `userUid` in `workspaceUid`, if they are a member. */
+    protected findMember(workspaceUid: string, userUid: string): Promise<WorkspaceMember | undefined>;
+    /** `userUid` when it is a member of `workspaceUid` (a record's owner, a task's assignee), `null` to clear, or a 400. */
+    protected requireMemberUid(workspaceUid: string, userUid: string | null | undefined, field: string): Promise<string | null | undefined>;
+    /** Whether the caller may change the workspace's settings (holds `MANAGE`), trusted roles aside. */
+    protected canManage(user: JWTUser | undefined, workspaceUid: string): Promise<boolean>;
+    /** The workspace `workspaceUid`, or a 404. */
+    protected requireWorkspaceRecord(workspaceUid: string): Promise<Workspace>;
+    /**
+     * The merge context of `contactUid` (a contact of the workspace, else a 400), or of a made-up reader when it is undefined - with the
+     * sender and links given (links default to placeholders, for previews).
+     */
+    protected mergeContextFor(workspace: Workspace, contactUid: unknown, sender?: WorkspaceSender, links?: MergeContext["links"]): Promise<MergeContext>;
+    /** Refuses (400) a `subjectType`/`subjectUid` pair that isn't a contact or company of `workspaceUid`. */
+    protected requireSubject(workspaceUid: string, subjectType: unknown, subjectUid: unknown): Promise<{
+        subjectType: CrmObjectType;
+        subjectUid: string;
+    }>;
+    /** `senderUid` when it is a sender of the workspace, or a 400. */
+    protected requireSender(workspaceUid: string, senderUid: unknown): Promise<string>;
+    /** The workspace's list `listUid`, or `undefined`. */
+    protected findList(workspaceUid: string, listUid: unknown): Promise<MailingList | undefined>;
+    /** Tells the workspace's open pages (everyone subscribed to its channel on `/push`) that `type` records changed. */
+    protected notify(workspaceUid: string, type: string, action: "create" | "update" | "delete", data: unknown): void;
+    /** Adds one entry to a record's activity timeline. Never throws: a timeline entry must not fail the change it records. */
+    protected addTimeline(entry: {
+        workspaceUid: string;
+        subjectType: CrmObjectType;
+        subjectUid: string;
+        kind: string;
+        summary: string;
+        actorUserUid?: string;
+        data?: Record<string, unknown>;
+        refUid?: string;
+    }): Promise<void>;
+    /**
+     * The key tokens are signed with: `mail:crm:token_secret`, or else the generated one (`readOrCreateTokenSecret()`).
+     */
+    protected tokenSecret(): Promise<string>;
+    /** An absolute link to a public page under `mail:crm:public_url`, e.g. `publicLink("/subscriptions/<token>")`. */
+    protected publicLink(path: string): string;
+    /** A signed token for a public link - see `util/Tokens.ts`. */
+    protected token(payload: TokenPayload): Promise<string>;
+    /**
+     * Sets a contact's subscription to a list: creates it, or moves it to `status`. A subscription already `subscribed` stays so when
+     * asked to become `pending` (a form filled in again doesn't make a subscriber confirm twice). Keeps the contact's `lists` values
+     * (what filters match on) in step, and records subscribing and unsubscribing on the contact's timeline. Returns the subscription.
+     */
+    setSubscription(workspaceUid: string, listUid: string, contactUid: string, status: SubscriptionStatus, change: SubscriptionChange): Promise<Subscription>;
+}

package/dist/types/routes/mongo/AnalyticsRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseAnalyticsRoute } from "../BaseAnalyticsRoute.js";
+/** A workspace's reports (`/api/mail/crm/analytics`). */
+export declare class AnalyticsRouteMongo extends BaseAnalyticsRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/ApiKeyRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseApiKeyRoute } from "../BaseApiKeyRoute.js";
+/** A workspace's integration API keys (`/api/mail/crm/api-keys`). */
+export declare class ApiKeyRouteMongo extends BaseApiKeyRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/AutomationRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseAutomationRoute } from "../BaseAutomationRoute.js";
+/** A workspace's automations (`/api/mail/crm/automations`). */
+export declare class AutomationRouteMongo extends BaseAutomationRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/CampaignRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseCampaignRoute } from "../BaseCampaignRoute.js";
+/** A workspace's email campaigns (`/api/mail/crm/campaigns`). */
+export declare class CampaignRouteMongo extends BaseCampaignRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/CompanyRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseCompanyRoute } from "../BaseCompanyRoute.js";
+/** A workspace's companies (`/api/mail/crm/companies`). */
+export declare class CompanyRouteMongo extends BaseCompanyRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/ContactRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseContactRoute } from "../BaseContactRoute.js";
+/** A workspace's contacts (`/api/mail/crm/contacts`). */
+export declare class ContactRouteMongo extends BaseContactRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/CrmAdminRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseCrmAdminRoute } from "../BaseCrmAdminRoute.js";
+/** Deployment administration of the CRM (`/api/mail/crm/admin`). */
+export declare class CrmAdminRouteMongo extends BaseCrmAdminRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/DealRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseDealRoute } from "../BaseDealRoute.js";
+/** A workspace's deals (`/api/mail/crm/deals`). */
+export declare class DealRouteMongo extends BaseDealRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/FormRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseFormRoute } from "../BaseFormRoute.js";
+/** A workspace's signup forms (`/api/mail/crm/forms`). */
+export declare class FormRouteMongo extends BaseFormRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/ImportRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseImportRoute } from "../BaseImportRoute.js";
+/** CSV imports of contacts and companies (`/api/mail/crm/imports`). */
+export declare class ImportRouteMongo extends BaseImportRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/IntegrationRouteMongo.d.ts

@@ -0,0 +1,7 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseIntegrationRoute } from "../BaseIntegrationRoute.js";
+/** The API a workspace's own systems call with an API key (`/api/mail/crm/integrations`). */
+export declare class IntegrationRouteMongo extends BaseIntegrationRoute {
+    protected classes: CrmModelClasses;
+    protected contactRouteClass: any;
+}

package/dist/types/routes/mongo/ListRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseListRoute } from "../BaseListRoute.js";
+/** A workspace's mailing lists (`/api/mail/crm/lists`). */
+export declare class ListRouteMongo extends BaseListRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/NoteRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseNoteRoute } from "../BaseNoteRoute.js";
+/** Notes on contacts and companies (`/api/mail/crm/notes`). */
+export declare class NoteRouteMongo extends BaseNoteRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/PipelineRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BasePipelineRoute } from "../BasePipelineRoute.js";
+/** A workspace's sales pipelines (`/api/mail/crm/pipelines`). */
+export declare class PipelineRouteMongo extends BasePipelineRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/PropertyDefinitionRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BasePropertyDefinitionRoute } from "../BasePropertyDefinitionRoute.js";
+/** A workspace's custom properties (`/api/mail/crm/properties`). */
+export declare class PropertyDefinitionRouteMongo extends BasePropertyDefinitionRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/PublicRouteMongo.d.ts

@@ -0,0 +1,7 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BasePublicRoute } from "../BasePublicRoute.js";
+/** The anonymous endpoints of forms, the preference center and unsubscribe links (`/api/mail/crm/public`). */
+export declare class PublicRouteMongo extends BasePublicRoute {
+    protected classes: CrmModelClasses;
+    protected contactRouteClass: any;
+}

package/dist/types/routes/mongo/SavedBlockRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseSavedBlockRoute } from "../BaseSavedBlockRoute.js";
+/** Blocks saved for reuse in a workspace's templates (`/api/mail/crm/saved-blocks`). */
+export declare class SavedBlockRouteMongo extends BaseSavedBlockRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/ScoringRuleRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseScoringRuleRoute } from "../BaseScoringRuleRoute.js";
+/** A workspace's lead scoring rules (`/api/mail/crm/scoring-rules`). */
+export declare class ScoringRuleRouteMongo extends BaseScoringRuleRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/SegmentRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseSegmentRoute } from "../BaseSegmentRoute.js";
+/** A workspace's contact segments (`/api/mail/crm/segments`). */
+export declare class SegmentRouteMongo extends BaseSegmentRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/SubscriptionRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseSubscriptionRoute } from "../BaseSubscriptionRoute.js";
+/** Contacts' subscriptions to mailing lists (`/api/mail/crm/subscriptions`). */
+export declare class SubscriptionRouteMongo extends BaseSubscriptionRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/SuppressionRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseSuppressionRoute } from "../BaseSuppressionRoute.js";
+/** Addresses a workspace never sends marketing mail to (`/api/mail/crm/suppressions`). */
+export declare class SuppressionRouteMongo extends BaseSuppressionRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/TaskRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseTaskRoute } from "../BaseTaskRoute.js";
+/** A workspace's tasks (`/api/mail/crm/tasks`). */
+export declare class TaskRouteMongo extends BaseTaskRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/TemplateRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseTemplateRoute } from "../BaseTemplateRoute.js";
+/** A workspace's email templates (`/api/mail/crm/templates`). */
+export declare class TemplateRouteMongo extends BaseTemplateRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/TimelineRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseTimelineRoute } from "../BaseTimelineRoute.js";
+/** Contact and company activity timelines (`/api/mail/crm/timeline`). */
+export declare class TimelineRouteMongo extends BaseTimelineRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/TrackingRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseTrackingRoute } from "../BaseTrackingRoute.js";
+/** The anonymous open and click tracking endpoints of CRM email (`/api/mail/crm/t`). */
+export declare class TrackingRouteMongo extends BaseTrackingRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/WebhookRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseWebhookRoute } from "../BaseWebhookRoute.js";
+/** A workspace's webhook endpoints (`/api/mail/crm/webhooks`). */
+export declare class WebhookRouteMongo extends BaseWebhookRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/mongo/WorkspaceRouteMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseWorkspaceRoute } from "../BaseWorkspaceRoute.js";
+/** CRM workspaces, their members and senders (`/api/mail/crm/workspaces`). */
+export declare class WorkspaceRouteMongo extends BaseWorkspaceRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/AnalyticsRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseAnalyticsRoute } from "../BaseAnalyticsRoute.js";
+/** A workspace's reports (`/api/mail/crm/analytics`). */
+export declare class AnalyticsRouteSQL extends BaseAnalyticsRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/ApiKeyRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseApiKeyRoute } from "../BaseApiKeyRoute.js";
+/** A workspace's integration API keys (`/api/mail/crm/api-keys`). */
+export declare class ApiKeyRouteSQL extends BaseApiKeyRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/AutomationRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseAutomationRoute } from "../BaseAutomationRoute.js";
+/** A workspace's automations (`/api/mail/crm/automations`). */
+export declare class AutomationRouteSQL extends BaseAutomationRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/CampaignRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseCampaignRoute } from "../BaseCampaignRoute.js";
+/** A workspace's email campaigns (`/api/mail/crm/campaigns`). */
+export declare class CampaignRouteSQL extends BaseCampaignRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/CompanyRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseCompanyRoute } from "../BaseCompanyRoute.js";
+/** A workspace's companies (`/api/mail/crm/companies`). */
+export declare class CompanyRouteSQL extends BaseCompanyRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/ContactRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseContactRoute } from "../BaseContactRoute.js";
+/** A workspace's contacts (`/api/mail/crm/contacts`). */
+export declare class ContactRouteSQL extends BaseContactRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/CrmAdminRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseCrmAdminRoute } from "../BaseCrmAdminRoute.js";
+/** Deployment administration of the CRM (`/api/mail/crm/admin`). */
+export declare class CrmAdminRouteSQL extends BaseCrmAdminRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/DealRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseDealRoute } from "../BaseDealRoute.js";
+/** A workspace's deals (`/api/mail/crm/deals`). */
+export declare class DealRouteSQL extends BaseDealRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/FormRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseFormRoute } from "../BaseFormRoute.js";
+/** A workspace's signup forms (`/api/mail/crm/forms`). */
+export declare class FormRouteSQL extends BaseFormRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/ImportRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseImportRoute } from "../BaseImportRoute.js";
+/** CSV imports of contacts and companies (`/api/mail/crm/imports`). */
+export declare class ImportRouteSQL extends BaseImportRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/IntegrationRouteSQL.d.ts

@@ -0,0 +1,7 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseIntegrationRoute } from "../BaseIntegrationRoute.js";
+/** The API a workspace's own systems call with an API key (`/api/mail/crm/integrations`). */
+export declare class IntegrationRouteSQL extends BaseIntegrationRoute {
+    protected classes: CrmModelClasses;
+    protected contactRouteClass: any;
+}

package/dist/types/routes/sql/ListRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseListRoute } from "../BaseListRoute.js";
+/** A workspace's mailing lists (`/api/mail/crm/lists`). */
+export declare class ListRouteSQL extends BaseListRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/NoteRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseNoteRoute } from "../BaseNoteRoute.js";
+/** Notes on contacts and companies (`/api/mail/crm/notes`). */
+export declare class NoteRouteSQL extends BaseNoteRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/PipelineRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BasePipelineRoute } from "../BasePipelineRoute.js";
+/** A workspace's sales pipelines (`/api/mail/crm/pipelines`). */
+export declare class PipelineRouteSQL extends BasePipelineRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/PropertyDefinitionRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BasePropertyDefinitionRoute } from "../BasePropertyDefinitionRoute.js";
+/** A workspace's custom properties (`/api/mail/crm/properties`). */
+export declare class PropertyDefinitionRouteSQL extends BasePropertyDefinitionRoute {
+    protected classes: CrmModelClasses;
+}

package/dist/types/routes/sql/PublicRouteSQL.d.ts

@@ -0,0 +1,7 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BasePublicRoute } from "../BasePublicRoute.js";
+/** The anonymous endpoints of forms, the preference center and unsubscribe links (`/api/mail/crm/public`). */
+export declare class PublicRouteSQL extends BasePublicRoute {
+    protected classes: CrmModelClasses;
+    protected contactRouteClass: any;
+}

package/dist/types/routes/sql/SavedBlockRouteSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { BaseSavedBlockRoute } from "../BaseSavedBlockRoute.js";
+/** Blocks saved for reuse in a workspace's templates (`/api/mail/crm/saved-blocks`). */
+export declare class SavedBlockRouteSQL extends BaseSavedBlockRoute {
+    protected classes: CrmModelClasses;
+}