ab-ecosystem-cpass 0.1.0 → 1.0.0

package/dist/resources/channels/webhooks.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChannelWebhooks = void 0;
+const paths_1 = require("../paths");
+const base = (channelId) => `${paths_1.CHANNELS}/${(0, paths_1.seg)(channelId)}/webhooks`;
+/**
+ * Channel webhooks: where a channel's message traffic is delivered.
+ *
+ * These carry conversation events -- `incoming`, `sent`, `delivered`, `read`,
+ * `failed` -- plus the account-level notices Meta sends about templates, the
+ * phone number and the WABA. Distinct from `crm.webhooks`, which carries
+ * contact changes from the audience module.
+ *
+ * Each webhook subscribes to a set of events; several webhooks may watch the
+ * same channel, and each gets its own copy.
+ *
+ * `meta` on a stored webhook is an audit trail -- who created or last changed
+ * it and from where -- filled in by the service from the caller's identity and
+ * IP. It is never accepted on a write.
+ */
+class ChannelWebhooks {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/channels/:channelId/webhooks` -- offset paginated. `search`
+     * matches the title and the URL; `active` and `event` are quick filters,
+     * where `event` finds the webhooks subscribed to that one event.
+     *
+     * Scope: `channels:read`.
+     */
+    list(channelId, query = {}) {
+        return this.http.request('GET', base(channelId), { query });
+    }
+    /**
+     * `GET /v1/channels/:channelId/webhooks/:id`.
+     *
+     * Scope: `channels:read`.
+     */
+    get(channelId, id) {
+        return this.http.request('GET', `${base(channelId)}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/channels/:channelId/webhooks` -- 201 with the created webhook.
+     *
+     * Only `url` and `events` are required; the title defaults to
+     * `'CRM Channel Webhook'` and the webhook starts active. Webhooks created
+     * through the API are recorded with `meta.source: 'API'`.
+     *
+     * Scope: `channels:write`.
+     */
+    create(channelId, input) {
+        return this.http.request('POST', base(channelId), { body: input });
+    }
+    /**
+     * `PATCH /v1/channels/:channelId/webhooks/:id` -- a partial update; at least
+     * one field is required. `events` replaces the subscription list rather than
+     * adding to it. Pause delivery with `{ active: false }`.
+     *
+     * Scope: `channels:write`.
+     */
+    update(channelId, id, input) {
+        return this.http.request('PATCH', `${base(channelId)}/${(0, paths_1.seg)(id)}`, {
+            body: input,
+        });
+    }
+    /**
+     * `DELETE /v1/channels/:channelId/webhooks/:id` -- 204. Delivery stops
+     * immediately.
+     *
+     * Scope: `channels:write`.
+     */
+    delete(channelId, id) {
+        return this.http.request('DELETE', `${base(channelId)}/${(0, paths_1.seg)(id)}`);
+    }
+}
+exports.ChannelWebhooks = ChannelWebhooks;
+//# sourceMappingURL=webhooks.js.map

package/dist/resources/channels/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../../src/resources/channels/webhooks.ts"],"names":[],"mappings":";;;AAQA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,CAAC,SAAiB,EAAE,EAAE,CAAC,GAAG,gBAAQ,IAAI,IAAA,WAAG,EAAC,SAAS,CAAC,WAAW,CAAC;AAE7E;;;;;;;;;;;;;;GAcG;AACH,MAAa,eAAe;IACG;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;OAMG;IACH,IAAI,CAAC,SAAiB,EAAE,QAA2C,EAAE;QACnE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA4B,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,SAAiB,EAAE,EAAU;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiB,KAAK,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAiB,EAAE,KAAgC;QACxD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiB,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,EAAU,EAAE,KAAgC;QACpE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiB,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,EAAE;YACjF,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAiB,EAAE,EAAU;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF;AA1DD,0CA0DC"}

package/dist/resources/paths.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Where each service sits behind the gateway.
+ *
+ * The gateway mounts its router at `/v1` and proxies `/audience/*` to the
+ * audience service and `/channels/*` to the channels service, stripping the
+ * prefix on the way through. So `/v1/audience/contacts` reaches the audience
+ * service as `/contacts`.
+ */
+export declare const AUDIENCE = "/v1/audience";
+export declare const CHANNELS = "/v1/channels";
+/** Path segments are escaped: an id from a caller must not be able to add one. */
+export declare const seg: (value: string) => string;

package/dist/resources/paths.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.seg = exports.CHANNELS = exports.AUDIENCE = void 0;
+/**
+ * Where each service sits behind the gateway.
+ *
+ * The gateway mounts its router at `/v1` and proxies `/audience/*` to the
+ * audience service and `/channels/*` to the channels service, stripping the
+ * prefix on the way through. So `/v1/audience/contacts` reaches the audience
+ * service as `/contacts`.
+ */
+exports.AUDIENCE = '/v1/audience';
+exports.CHANNELS = '/v1/channels';
+/** Path segments are escaped: an id from a caller must not be able to add one. */
+const seg = (value) => encodeURIComponent(String(value));
+exports.seg = seg;
+//# sourceMappingURL=paths.js.map

package/dist/resources/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/resources/paths.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACU,QAAA,QAAQ,GAAG,cAAc,CAAC;AAC1B,QAAA,QAAQ,GAAG,cAAc,CAAC;AAEvC,kFAAkF;AAC3E,MAAM,GAAG,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE"}

package/dist/types/audience.d.ts

@@ -0,0 +1,512 @@
+/**
+ * Audience service types: contacts and everything hanging off them.
+ * Mirrors `packages/contracts/src/audience/*`.
+ */
+import type { ContactFilter, ContactFilterEntry } from './contact-filter';
+import type { IsoDate, JsonObject, ListQuery, ObjectId, PageQuery } from './common';
+/** A label a contact can carry. */
+export interface ContactTag {
+    id: string;
+    name: string;
+    icon: string;
+    color: string;
+}
+export interface CreateContactTagInput {
+    /** Trimmed, 1..120 characters. */
+    name: string;
+    /** Icon name or emoji, up to 120 characters. Default `''`. */
+    icon?: string;
+    /** Free-form so the palette can evolve; only length is checked (32). Default `''`. */
+    color?: string;
+}
+export type UpdateContactTagInput = Partial<CreateContactTagInput>;
+/** `search` matches the tag name. */
+export type ListContactTagsQuery = ListQuery;
+export type ContactStatus = 'live' | 'trashed';
+export type ContactPrivacyStatus = 'open' | 'locked';
+export type ContactChannel = 'whatsapp' | 'facebook' | 'instagram' | 'telegram' | 'email' | 'rcs' | 'webchat';
+/** One channel identity of a contact. Server-owned: never sent on a write. */
+export interface ContactProfile {
+    id: string;
+    channel: ContactChannel;
+    /** Phone number, handle or address, depending on the channel. */
+    identifier: string;
+    name: string;
+    profile_pic: string;
+    extra: JsonObject;
+}
+export interface ContactName {
+    /** Up to 20 characters. */
+    salutation: string;
+    /** Up to 120 characters. */
+    first_name: string;
+    /** Up to 120 characters. */
+    last_name: string;
+}
+/** Which directions of traffic are blocked for this contact. */
+export interface ContactBlocked {
+    incoming: boolean;
+    outgoing: boolean;
+    bot: boolean;
+    api: boolean;
+}
+export interface ContactChatMetadata {
+    new: boolean;
+    archived: boolean;
+    unread: number;
+    /** Seconds to pause automation for. */
+    pause_duration: number;
+    marked_as_unread: boolean;
+    closed: boolean;
+    marked_as_done: boolean;
+    blocked: ContactBlocked;
+}
+export interface ContactLeadSource {
+    type?: string;
+    module?: string;
+    id: string | null;
+}
+export interface Contact {
+    id: string;
+    name: ContactName;
+    /** Channel identities, keyed by channel. Server-owned. */
+    profile: Record<string, ContactProfile>;
+    /** Custom field values, keyed by field slug. */
+    custom_field_hash: JsonObject;
+    chat_metadata: ContactChatMetadata;
+    order?: string;
+    /** Unix seconds. Server-owned. */
+    last_seen: number;
+    /** Unix seconds of the last inbound customer message. Server-owned. */
+    last_icm_timestamp: number;
+    /** Server-owned. */
+    last_interaction_props: JsonObject;
+    agent: string | null;
+    team: string | null;
+    lead_source: ContactLeadSource;
+    status: ContactStatus;
+    privacy_status: ContactPrivacyStatus;
+    /** Resolved tag documents, not ids. */
+    tags: ContactTag[];
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+/**
+ * Everything a caller may set. The server-owned paths (`profile`, `last_seen`,
+ * `last_icm_timestamp`, `last_interaction_props`) are deliberately absent.
+ */
+export interface CreateContactInput {
+    name?: Partial<ContactName>;
+    order?: string;
+    /** Contact tag ids. Default `[]`. */
+    tags?: ObjectId[];
+    agent?: ObjectId | null;
+    team?: ObjectId | null;
+    lead_source?: {
+        type?: string;
+        module?: string;
+        id?: ObjectId | null;
+    };
+    status?: ContactStatus;
+    privacy_status?: ContactPrivacyStatus;
+    /** Values keyed by custom field slug. */
+    custom_field_hash?: JsonObject;
+    chat_metadata?: Partial<Omit<ContactChatMetadata, 'blocked'>> & {
+        blocked?: Partial<ContactBlocked>;
+    };
+}
+export type UpdateContactInput = Partial<CreateContactInput>;
+/**
+ * `search` matches the first and last name, plus the name and identifier of
+ * every channel identity. `segment` names a saved filter; `filter` carries
+ * ad-hoc conditions. Sending both narrows the segment by the conditions.
+ */
+export interface ListContactsQuery extends ListQuery {
+    /** A contact tag id. */
+    tag?: ObjectId;
+    agent?: ObjectId;
+    /** Default `'live'`; pass `'trashed'` to read the trash. */
+    status?: ContactStatus;
+    /** A segment's id or its name; ids are tried first when the value looks like one. */
+    segment?: string;
+    /** Serialised to JSON by the SDK before it goes on the query string. */
+    filter?: ContactFilter;
+}
+/**
+ * `delete` is two-stage: the first call trashes the contact, a second one on an
+ * already-trashed contact destroys it. The body says which happened, since the
+ * status code (200 either way) does not.
+ */
+export interface ContactDeleteResult {
+    id: string;
+    status: 'trashed' | 'deleted';
+}
+export interface ContactNoteAttachment {
+    type?: string;
+    size?: string;
+    url: string;
+    mime?: string;
+    file_name?: string;
+}
+export interface ContactNote {
+    id: string;
+    /** The contact the note hangs off. */
+    contact: string;
+    note: string;
+    attachments: ContactNoteAttachment[];
+    /** Ids of team members mentioned in the note. */
+    mentions: string[];
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+export interface CreateContactNoteInput {
+    /** 1..5000 characters. */
+    note: string;
+    /** Default `[]`. */
+    attachments?: ContactNoteAttachment[];
+    /** Team member ids. Default `[]`. */
+    mentions?: ObjectId[];
+}
+export type UpdateContactNoteInput = Partial<CreateContactNoteInput>;
+/** Cursor paginated -- notes are appended, so an offset would shift under you. */
+export type ListContactNotesQuery = PageQuery;
+export type CustomFieldType = 'text' | 'url' | 'email' | 'date' | 'phone' | 'number' | 'decimal' | 'amount' | 'address' | 'location' | 'country' | 'language' | 'attachment' | 'periodic_time' | 'percent' | 'timezone' | 'textarea' | 'checkbox' | 'dropdown' | 'timestamp' | 'dial_code' | 'multi_select';
+/** `system` fields are provisioned by the platform, `user` ones by tenants. */
+export type CustomFieldSource = 'system' | 'user';
+export type CustomFieldTeamAccess = 'restricted' | 'open_to_all';
+export interface CustomField {
+    id: string;
+    /** Machine name, unique per account. Usable in place of the id on every route. */
+    slug: string;
+    name?: string;
+    caption?: string;
+    /** Who owns the field, not its data type -- that is `dataType`. */
+    type: CustomFieldSource;
+    dataType?: CustomFieldType;
+    /** Default value, shaped by `dataType`. */
+    default: JsonObject;
+    /** Type-specific configuration: dropdown options, number precision, and so on. */
+    props: JsonObject;
+    required: boolean;
+    displayInPanel: boolean;
+    showInSidebar: boolean;
+    showAsLabel: boolean;
+    isBoard: boolean;
+    teamAccess: CustomFieldTeamAccess;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+export interface CreateCustomFieldInput {
+    /**
+     * snake_case, `^[a-z][a-z0-9_]{0,63}$`, and not one of the reserved names --
+     * contact document paths (`name`, `tags`, `status`, ...), channel keys
+     * (`whatsapp`, `email`, ...) or built-in filter fields (`system_last_seen`,
+     * `system_identifier`, ...). Immutable: `update` cannot change it.
+     */
+    slug: string;
+    /** 1..120 characters. */
+    name: string;
+    /** Up to 240 characters. */
+    caption?: string;
+    dataType: CustomFieldType;
+    /** Default `{}`. */
+    default?: JsonObject;
+    /** Type-specific configuration. Default `{}`. */
+    props?: JsonObject;
+    /** Default `false`. */
+    required?: boolean;
+    /** Default `false`. */
+    displayInPanel?: boolean;
+    /** Default `false`. */
+    showInSidebar?: boolean;
+    /** Default `false`. */
+    showAsLabel?: boolean;
+    /** Default `false`. */
+    isBoard?: boolean;
+    /** Default `'open_to_all'`. */
+    teamAccess?: CustomFieldTeamAccess;
+}
+/** Everything but the slug, which a field keeps for life. */
+export type UpdateCustomFieldInput = Partial<Omit<CreateCustomFieldInput, 'slug'>>;
+/** `search` matches the slug, the label and the caption. */
+export interface ListCustomFieldsQuery extends ListQuery {
+    /** Quick filter: the field's data type. */
+    dataType?: CustomFieldType;
+    /** Quick filter: platform-provisioned or tenant-created. */
+    type?: CustomFieldSource;
+    teamAccess?: CustomFieldTeamAccess;
+}
+/**
+ * A saved contact filter. Nothing is materialised: a segment holds no contact
+ * ids, and covers whatever its conditions match the next time it is run.
+ */
+export interface Segment {
+    id: string;
+    name: string;
+    description?: string;
+    filter: ContactFilter;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+export interface CreateSegmentInput {
+    /** Trimmed, 1..120 characters. */
+    name: string;
+    /** Trimmed, up to 500 characters. */
+    description?: string;
+    /** Rejected on write if the conditions do not parse, rather than when first run. */
+    filter: ContactFilter;
+}
+export type UpdateSegmentInput = Partial<CreateSegmentInput>;
+/** `search` matches the segment name and description. */
+export type ListSegmentsQuery = ListQuery;
+/** The only module triggers watch today. */
+export type CrmTriggerModule = 'contact';
+/**
+ * `event` triggers run off a contact change. `time` triggers are scheduled, and
+ * are stored and served but not yet dispatched -- nothing schedules them.
+ */
+export type CrmTriggerType = 'event' | 'time';
+/**
+ * What happened to the contact. `edited` and `modified` are both any-change; the
+ * rest are narrower readings of the same update, decided by which paths moved.
+ */
+export type CrmTriggerEvent = 'agent_assigned' | 'agent_deassigned' | 'created' | 'edited' | 'modified' | 'deleted' | 'marked_as_done' | 'marked_as_closed' | 'marked_as_archived' | 'blocked';
+/**
+ * Narrows an event to the fields it touched. `any` fires on every change,
+ * `any_of_selected` needs one of `fields` to have moved, `all` needs all of
+ * them. Events with no change set -- a creation, a deletion -- pass regardless.
+ */
+export interface CrmTriggerWhen {
+    /** Default `'any'`. */
+    condition?: 'any' | 'any_of_selected' | 'all';
+    /** Dotted contact paths: `name.first_name`, `chat_metadata.closed`. Default `[]`. */
+    fields?: string[];
+}
+export type CrmTriggerHttpMethod = 'POST' | 'PUT' | 'PATCH' | 'GET';
+/** Webhook is the only action the schema defines. */
+export interface CrmTriggerAction {
+    /** Default `'webhook'`. */
+    type?: 'webhook';
+    config: {
+        url: string;
+        /** Default `'POST'`. */
+        method?: CrmTriggerHttpMethod;
+        /** Sent alongside the contact payload. Default `{}`. */
+        headers?: Record<string, string>;
+    };
+}
+export interface CrmTrigger {
+    id: string;
+    name: string;
+    active: boolean;
+    module: CrmTriggerModule;
+    type: CrmTriggerType;
+    trigger: CrmTriggerEvent;
+    when: Required<CrmTriggerWhen>;
+    /**
+     * The same conditions `contacts.list({ filter })` speaks, flat rather than
+     * wrapped: the changed contact has to match them for the trigger to fire.
+     */
+    filters: ContactFilterEntry[];
+    action: CrmTriggerAction;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+export interface CreateCrmTriggerInput {
+    /** Trimmed, 1..120 characters. */
+    name: string;
+    /** Default `true`. */
+    active?: boolean;
+    /** Default `'contact'`. */
+    module?: CrmTriggerModule;
+    /** Default `'event'`. */
+    type?: CrmTriggerType;
+    /** Default `'edited'`. */
+    trigger?: CrmTriggerEvent;
+    /** Default `{ condition: 'any', fields: [] }`. */
+    when?: CrmTriggerWhen;
+    /** At most 50 conditions. Default `[]`, which fires on every matching event. */
+    filters?: ContactFilterEntry[];
+    action: CrmTriggerAction;
+}
+export type UpdateCrmTriggerInput = Partial<CreateCrmTriggerInput>;
+/** `search` matches the trigger name. */
+export interface ListCrmTriggersQuery extends ListQuery {
+    /** Quick filter: the contact event the trigger watches. */
+    trigger?: CrmTriggerEvent;
+    type?: CrmTriggerType;
+    active?: boolean;
+}
+export type CrmTriggerLogStatus = 'success' | 'fail';
+/**
+ * One dispatch attempt. Logs are written by the dispatcher, never by a caller,
+ * and the collection expires them after 30 days.
+ */
+export interface CrmTriggerLog {
+    id: string;
+    /** Id of the trigger that fired. */
+    trigger: string;
+    event: CrmTriggerEvent;
+    status: CrmTriggerLogStatus;
+    payload: {
+        url?: string;
+        body?: unknown;
+    };
+    /** Whatever came back: status and body, or the error that stopped the call. */
+    response?: unknown;
+    /** When the log row is removed. */
+    expiryDate: IsoDate;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+export interface ListCrmTriggerLogsQuery extends ListQuery {
+    /** Quick filter: one trigger's history. */
+    trigger?: ObjectId;
+    event?: CrmTriggerEvent;
+    status?: CrmTriggerLogStatus;
+}
+/** Import and export history share one lifecycle, and a row starts out `pending`. */
+export type HistoryStatus = 'pending' | 'processing' | 'completed' | 'failed';
+/** What a history row moved: contacts, or datastore records. */
+export type HistoryModule = 'contact' | 'datastore';
+/**
+ * `extra` is an untyped column on both schemas. The SDK carries it through
+ * verbatim, so anything an older writer left there survives a round trip.
+ * A failed import puts its reason in `extra.error`.
+ */
+export type HistoryExtra = JsonObject;
+/**
+ * Everything the worker needs to read the file. The stored column is untyped,
+ * so the keys the platform acts on are named and anything else is passed
+ * through rather than dropped.
+ */
+export interface ImportConfig {
+    /** Column header -> contact field. Default `{}`. */
+    mapping?: Record<string, string>;
+    /** What to do with a row matching an existing contact. Default `'skip'`. */
+    duplicateStrategy?: 'skip' | 'update';
+    /** Anything else a caller or an older writer put here. */
+    [key: string]: unknown;
+}
+/** Counted by the worker as it walks the file; `new` + `duplicate` = `success`. */
+export interface ImportStatistics {
+    total: number;
+    success: number;
+    failed: number;
+    /** Rows that created a contact. */
+    new: number;
+    /** Rows that matched one that already existed. */
+    duplicate: number;
+}
+export interface ImportHistory {
+    id: string;
+    /** The team member who started it; rows written before members existed carry none. */
+    member?: string;
+    module: HistoryModule;
+    /** Storage key of the uploaded file. */
+    file: string;
+    title: string;
+    status: HistoryStatus;
+    config: ImportConfig;
+    extra: HistoryExtra;
+    statistics: ImportStatistics;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+export interface CreateImportHistoryInput {
+    /** Default `'contact'`. */
+    module?: HistoryModule;
+    /** Storage key of the uploaded file, 1..1024 characters. The worker resolves it. */
+    file: string;
+    /** Trimmed, 1..200 characters. */
+    title: string;
+    /** Default `{}`, which means an empty mapping and `duplicateStrategy: 'skip'`. */
+    config?: ImportConfig;
+    /** Default `{}`. */
+    extra?: HistoryExtra;
+}
+/** `search` matches the title. */
+export interface ListImportHistoryQuery extends ListQuery {
+    module?: HistoryModule;
+    status?: HistoryStatus;
+}
+/**
+ * What to write out. Sending both a segment and a filter narrows the segment,
+ * the same way `contacts.list` reads the pair.
+ */
+export interface ExportConfig {
+    /** A saved segment's id or its name. */
+    segment?: string;
+    filter?: ContactFilter;
+    /** Columns to write; empty means the worker's default set. Default `[]`. */
+    fields?: string[];
+    /** Anything else a caller or an older writer put here. */
+    [key: string]: unknown;
+}
+export interface ExportHistory {
+    id: string;
+    /** The team member who started it; rows written before members existed carry none. */
+    member?: string;
+    module: HistoryModule;
+    /** Storage key of the finished file; absent until the worker has written one. */
+    file?: string;
+    title: string;
+    /** Rows written. `0` until the export completes. */
+    count: number;
+    status: HistoryStatus;
+    /** Why it failed, when it did. */
+    error?: string;
+    config: ExportConfig;
+    extra: HistoryExtra;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+export interface CreateExportHistoryInput {
+    /** Default `'contact'`. */
+    module?: HistoryModule;
+    /** Trimmed, 1..200 characters. */
+    title: string;
+    /** Default `{}`, which exports every contact with the worker's default columns. */
+    config?: ExportConfig;
+    /** Default `{}`. */
+    extra?: HistoryExtra;
+}
+/** `search` matches the title. */
+export interface ListExportHistoryQuery extends ListQuery {
+    module?: HistoryModule;
+    status?: HistoryStatus;
+}
+export type WebhookEventType = 'contact.created' | 'contact.updated' | 'contact.deleted';
+export interface Webhook {
+    id: string;
+    url: string;
+    events: WebhookEventType[];
+    enabled: boolean;
+    /** Consecutive delivery failures. */
+    failureCount: number;
+    lastDeliveredAt?: IsoDate;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+}
+export interface CreateWebhookInput {
+    /** Must be a valid absolute URL. */
+    url: string;
+    /** At least one event. */
+    events: WebhookEventType[];
+    /** Default `true`. */
+    enabled?: boolean;
+}
+export type UpdateWebhookInput = Partial<CreateWebhookInput>;
+/** Cursor paginated. */
+export interface ListWebhooksQuery extends PageQuery {
+    enabled?: boolean;
+}
+/** The body the platform POSTs to a registered webhook URL. */
+export interface WebhookEnvelope {
+    /** Delivery id, stable across retries of the same event. */
+    id: string;
+    type: string;
+    tenantId: string;
+    createdAt: IsoDate;
+    data: unknown;
+}

package/dist/types/audience.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=audience.js.map

package/dist/types/audience.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audience.js","sourceRoot":"","sources":["../../src/types/audience.ts"],"names":[],"mappings":""}