ab-ecosystem-cpass 1.0.0 → 1.0.6

package/dist/resources/audience/scheduled-messages.js

@@ -0,0 +1,259 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduledMessages = void 0;
+const paths_1 = require("../paths");
+const BASE = `${paths_1.AUDIENCE}/scheduled-messages`;
+/**
+ * Scheduled messages: a send with a time, and optionally a condition checked
+ * immediately before it goes out.
+ *
+ * ### What the condition is for
+ *
+ * A drip is easy to start and awkward to stop. Schedule five messages over two
+ * weeks, your lead converts after the third, and the last two still go out --
+ * now addressed to a customer, as a pitch. Cancelling them means somebody
+ * noticing in time.
+ *
+ * So each occurrence re-reads the contact a moment before sending and stands
+ * down if they no longer match. Keep a `stage` custom field on your contacts,
+ * condition the series on `stage equal to Lead`, and set `stage` to `Customer`
+ * when they convert: the rest of the sequence cancels itself. No cancellation
+ * call, no scheduled-message ids to track.
+ *
+ * ```ts
+ * const nurture = await crm.scheduledMessages.createSeries({
+ *   title: 'Lead nurture',
+ *   channel: channelId,
+ *   contact: { id: contactId },
+ *   timezone: 'Asia/Kolkata',
+ *   starts_at: '2026-10-13T10:00:00',
+ *   conditions: {
+ *     conditions: [
+ *       { field_id: 'stage', field_type: 'dropdown', condition: 'equal to', value: 'Lead' },
+ *     ],
+ *   },
+ *   on_condition_fail: 'cancel_series',
+ *   steps: [
+ *     { after: { value: 0, unit: 'days' }, content: intro },
+ *     { after: { value: 3, unit: 'days' }, content: caseStudy },
+ *     { after: { value: 6, unit: 'days' }, content: pricing },
+ *   ],
+ * });
+ *
+ * // Later, when the lead converts -- this is the whole of "stop the drip":
+ * await crm.contacts.update(contactId, { custom_field_hash: { stage: 'Customer' } });
+ * ```
+ *
+ * ### Two things that will catch you out
+ *
+ * **Templates, not free text.** WhatsApp only allows free-form messages within
+ * 24 hours of the contact's last inbound message, and a drip is by construction
+ * outside that window from the second message onward. Every step but the first
+ * has to be an approved template or the provider refuses it; `create` rejects
+ * free text past the window rather than letting you discover it on day four.
+ *
+ * **A series is expanded, not recurring.** `createSeries` writes one row per
+ * message straight away, so you can list them, move one, or cancel one without
+ * touching the others. There is no rule being evaluated later and nothing to
+ * recompute -- which is also why `until` has to be a real end rather than
+ * "forever".
+ *
+ * Scoping: scheduled messages belong to an account the same way contacts do --
+ * reads match the caller or the account they act for, writes land on the
+ * caller's own.
+ */
+class ScheduledMessages {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * `GET /v1/audience/scheduled-messages` -- offset paginated, soonest first
+     * among `pending`, newest first among the rest. `search` matches the title.
+     *
+     * Narrow it with `contact` for one person's queue, `series` for one drip's
+     * occurrences, or `status` to answer "what is still waiting" (`pending`)
+     * versus "what stood down and why" (`skipped`).
+     *
+     * Scope: `messages:read`.
+     */
+    list(query = {}) {
+        return this.http.request('GET', BASE, { query });
+    }
+    /**
+     * `GET /v1/audience/scheduled-messages/:id` -- one occurrence, with its
+     * `result` if it has reached a terminal status.
+     *
+     * Scope: `messages:read`.
+     */
+    get(id) {
+        return this.http.request('GET', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `POST /v1/audience/scheduled-messages` -- 201 with the created occurrence.
+     *
+     * One message, one time. `series` on the response is `null` and `occurrence`
+     * is `1`.
+     *
+     * ```ts
+     * await crm.scheduledMessages.create({
+     *   title: 'Pricing follow-up',
+     *   channel: channelId,
+     *   contact: { id: contactId },
+     *   timezone: 'Asia/Kolkata',
+     *   scheduled_at: '2026-10-15T10:00:00',   // 10:00 IST
+     *   content: { type: 'text', text: { body: 'Following up on the pricing.' } },
+     *   conditions: {
+     *     conditions: [
+     *       { field_id: 'stage', field_type: 'dropdown', condition: 'equal to', value: 'Lead' },
+     *     ],
+     *   },
+     * });
+     * ```
+     *
+     * `on_condition_fail` defaults to `skip` here, which for a single message is
+     * the only reading that means anything -- there is no series to cancel.
+     *
+     * 422 if `scheduled_at` is in the past, if `timezone` is not an IANA zone, if
+     * the condition names a field type the comparison cannot apply to, or if the
+     * message is free text and the send falls outside the channel's reply window.
+     *
+     * Scope: `messages:write`.
+     */
+    create(input) {
+        return this.http.request('POST', BASE, { body: input });
+    }
+    /**
+     * `POST /v1/audience/scheduled-messages/series` -- 201 with the series and
+     * every occurrence it expanded into.
+     *
+     * For a sequence whose steps carry different copy. `after` is measured from
+     * `starts_at`, not from the previous step, so changing one delay leaves the
+     * others where they were.
+     *
+     * ```ts
+     * const series = await crm.scheduledMessages.createSeries({
+     *   title: 'Lead nurture -- 2 weeks',
+     *   channel: channelId,
+     *   contact: { id: contactId },
+     *   timezone: 'Asia/Kolkata',
+     *   starts_at: '2026-10-13T10:00:00',
+     *   conditions: { conditions: [stillALead] },
+     *   steps: [
+     *     { after: { value: 0,  unit: 'days' }, content: intro },
+     *     { after: { value: 3,  unit: 'days' }, content: caseStudy },
+     *     { after: { value: 6,  unit: 'days' }, content: pricing },
+     *     { after: { value: 9,  unit: 'days' }, content: demo },
+     *     { after: { value: 12, unit: 'days' }, content: lastCall },
+     *   ],
+     * });
+     *
+     * series.occurrences.length; // 5
+     * ```
+     *
+     * A step may carry its own `conditions`, which are checked **in addition to**
+     * the series' -- both have to pass. Leave them out to inherit.
+     *
+     * `on_condition_fail` defaults to `cancel_series`.
+     *
+     * Scope: `messages:write`.
+     */
+    createSeries(input) {
+        return this.http.request('POST', `${BASE}/series`, { body: input });
+    }
+    /**
+     * `POST /v1/audience/scheduled-messages/series` -- the same route, for the
+     * case where every occurrence sends the same message.
+     *
+     * ```ts
+     * await crm.scheduledMessages.createRepeating({
+     *   title: 'Weekly check-in',
+     *   channel: channelId,
+     *   contact: { id: contactId },
+     *   timezone: 'Asia/Kolkata',
+     *   starts_at: '2026-10-13T10:00:00',
+     *   repeat: { every: 3, unit: 'days', until: '2026-10-27T10:00:00' },
+     *   content: nudgeTemplate,
+     *   conditions: { conditions: [stillALead] },
+     * });
+     * ```
+     *
+     * `until` is inclusive and has to be a real end: the expansion is written as
+     * rows, so an open-ended cadence has nothing to expand into. The result is the
+     * same `ScheduledMessageSeries` as `createSeries` -- once created, a repeating
+     * schedule and a stepped one are indistinguishable.
+     *
+     * 422 if the expansion would exceed 365 occurrences.
+     *
+     * Scope: `messages:write`.
+     */
+    createRepeating(input) {
+        return this.http.request('POST', `${BASE}/series`, { body: input });
+    }
+    /**
+     * `PATCH /v1/audience/scheduled-messages/:id` -- moves one occurrence.
+     *
+     * Only a `pending` one. Rescheduling something already `sent`, `skipped` or
+     * `cancelled` is a 409 rather than a silent no-op -- legacy answered
+     * `{ success: true }` either way, which made a failed reschedule look like a
+     * successful one.
+     *
+     * Moving one occurrence does not move the rest of its series.
+     *
+     * ```ts
+     * await crm.scheduledMessages.reschedule(id, { scheduled_at: '2026-10-16T14:00:00' });
+     * ```
+     *
+     * Scope: `messages:write`.
+     */
+    reschedule(id, input) {
+        return this.http.request('PATCH', `${BASE}/${(0, paths_1.seg)(id)}`, { body: input });
+    }
+    /**
+     * `DELETE /v1/audience/scheduled-messages/:id` -- 200 with the cancelled row.
+     *
+     * The row is kept rather than deleted, at `status: 'cancelled'`, so a schedule
+     * that did not send still shows why. Use `cancelSeries` to stop a whole drip;
+     * this stops one message and leaves the others queued.
+     *
+     * Scope: `messages:write`.
+     */
+    cancel(id) {
+        return this.http.request('DELETE', `${BASE}/${(0, paths_1.seg)(id)}`);
+    }
+    /**
+     * `DELETE /v1/audience/scheduled-messages/series/:series` -- 200 with the
+     * number of occurrences stood down.
+     *
+     * Cancels every `pending` occurrence; anything already sent is untouched and
+     * not counted. Idempotent -- a second call cancels nothing and answers `0`.
+     *
+     * Usually you do not need this. If the series carries a condition, changing
+     * the contact so it no longer matches is the better way to stop a drip: it
+     * leaves the reason on the record, and it works for every contact in the same
+     * sequence rather than one series at a time.
+     *
+     * Scope: `messages:write`.
+     */
+    cancelSeries(series) {
+        return this.http.request('DELETE', `${BASE}/series/${(0, paths_1.seg)(series)}`);
+    }
+    /**
+     * `POST /v1/audience/scheduled-messages/:id/send-now` -- 200 with the row.
+     *
+     * Brings a `pending` occurrence forward to immediately. The condition is still
+     * checked, because the condition is the point -- a send-now on a contact who
+     * no longer matches comes back `skipped`, not `sent`.
+     *
+     * It does not duplicate: the occurrence is moved, not copied, so the original
+     * time no longer fires. Legacy's equivalent scheduled a second job without
+     * cancelling the first and delivered the message twice.
+     *
+     * Scope: `messages:write`.
+     */
+    sendNow(id) {
+        return this.http.request('POST', `${BASE}/${(0, paths_1.seg)(id)}/send-now`);
+    }
+}
+exports.ScheduledMessages = ScheduledMessages;
+//# sourceMappingURL=scheduled-messages.js.map

package/dist/resources/audience/scheduled-messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduled-messages.js","sourceRoot":"","sources":["../../../src/resources/audience/scheduled-messages.ts"],"names":[],"mappings":";;;AAYA,oCAAyC;AAEzC,MAAM,IAAI,GAAG,GAAG,gBAAQ,qBAAqB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,MAAa,iBAAiB;IACC;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;;;;;;;OASG;IACH,IAAI,CAAC,QAA6C,EAAE;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA8B,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAmB,KAAK,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,KAAkC;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAmB,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,YAAY,CAAC,KAAiC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB,MAAM,EAAE,GAAG,IAAI,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,eAAe,CAAC,KAAmC;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB,MAAM,EAAE,GAAG,IAAI,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,EAAU,EAAE,KAA6B;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAmB,OAAO,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAmB,QAAQ,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE,GAAG,IAAI,WAAW,IAAA,WAAG,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAmB,MAAM,EAAE,GAAG,IAAI,IAAI,IAAA,WAAG,EAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACpF,CAAC;CACF;AAtMD,8CAsMC"}

package/dist/resources/campaign-audience.d.ts

@@ -0,0 +1,132 @@
+import type { CampaignReceiver } from '../internal/receiver-file';
+/**
+ * Most recipients one bulk campaign may carry.
+ *
+ * The same ceiling the panel has always enforced. It is not arbitrary: the list
+ * is encrypted into a single file and read back into memory by the campaign
+ * manager, so this is the point at which "one campaign" stops being a sensible
+ * unit of work.
+ */
+export declare const MAX_BULK_RECEIVERS = 1000000;
+/**
+ * How a bulk audience is described.
+ *
+ * Four shapes, because there are four ways a person actually has this data to
+ * hand. All of them end as the same encrypted file; the difference is only how
+ * much parsing the SDK does on the way.
+ */
+export type BulkAudienceInput = 
+/**
+ * Just numbers, with no per-recipient variables.
+ *
+ * Accepts an array, or one string holding many -- a textarea's contents,
+ * separated by commas, newlines, semicolons or spaces, in any combination.
+ */
+{
+    numbers: string | readonly string[];
+    dedupe?: boolean;
+}
+/**
+ * Raw CSV or TSV text whose first row is the header.
+ *
+ * `recipientColumn` names the header holding the number; every column,
+ * including that one, also becomes a template variable. The delimiter is
+ * detected from the header row unless you pass one.
+ */
+ | {
+    csv: string;
+    recipientColumn: string;
+    delimiter?: string;
+    dedupe?: boolean;
+}
+/**
+ * Rows you have already parsed -- from your own CSV reader, a spreadsheet API,
+ * or a database query.
+ */
+ | {
+    rows: readonly Record<string, unknown>[];
+    recipientColumn: string;
+    dedupe?: boolean;
+}
+/** Receivers you have already built. The escape hatch; nothing is inferred. */
+ | {
+    receivers: readonly CampaignReceiver[];
+};
+/** What resolving an audience produced, including what it discarded. */
+export interface ResolvedAudience {
+    receivers: CampaignReceiver[];
+    /** Entries that carried no usable digits and were skipped. */
+    skipped: number;
+    /** Entries dropped because an earlier entry had the same number. */
+    duplicates: number;
+}
+/**
+ * Normalises a column name into a template variable id.
+ *
+ * Lower-cased with every non-alphanumeric character replaced by `_`, which is
+ * what the panel's CSV reader and its paste-a-table path both did -- so a header
+ * of `First Name` is the variable `first_name` here exactly as it was there, and
+ * templates built against the old behaviour keep working.
+ *
+ * A blank header becomes `empty_<index>` rather than `_`, so two unnamed columns
+ * do not collapse into one variable.
+ */
+export declare const normaliseColumn: (header: unknown, index: number) => string;
+/**
+ * Pulls the numbers out of one string, or tidies an array of them.
+ *
+ * Splits on commas, newlines, carriage returns, tabs, semicolons and spaces --
+ * all of them, in any mixture. The panel chose a single separator per paste
+ * (commas if the text contained any, otherwise newlines), which quietly mangled
+ * the common case of pasting a column from a spreadsheet into a field that
+ * already had comma-separated numbers: the newlines were never split on, so two
+ * numbers merged into one 24-digit number and the send went nowhere. Splitting on
+ * every separator cannot produce that, and for input with one separator it
+ * behaves identically.
+ */
+export declare const normaliseNumbers: (input: string | readonly string[]) => string[];
+/**
+ * Splits delimited text into a header and rows, RFC 4180 style.
+ *
+ * A proper parser rather than `split(',')`, because a quoted field may contain
+ * the delimiter, a newline, or an escaped quote -- and a currency-formatted
+ * variable (`"1,299"`) is exactly the sort of value that appears in these files.
+ * Splitting naively turns one such row into two bad ones.
+ *
+ * Values stay strings. The panel parsed with `dynamicTyping`, which coerced
+ * numeric-looking cells to JavaScript numbers -- and that silently corrupted the
+ * one column that matters: a 16-digit number exceeds `Number.MAX_SAFE_INTEGER`
+ * and comes back with its last digits changed, while a number written with a
+ * leading zero loses it. Keeping text as text avoids both.
+ */
+export declare const parseDelimited: (text: string, delimiter?: string) => {
+    headers: string[];
+    rows: Record<string, string>[];
+};
+/**
+ * Turns parsed rows into receivers.
+ *
+ * Every column becomes a variable, including the recipient column itself -- which
+ * is intentional and matches the panel: a template that greets someone by the
+ * number they were messaged on still works.
+ *
+ * A row whose recipient column holds no digits is skipped rather than failing the
+ * whole batch. In a file of ten thousand rows, a handful of blanks and a trailing
+ * footer line are normal, and refusing the campaign over them would mean the
+ * caller has to clean a file they may not control. The count comes back in
+ * {@link ResolvedAudience.skipped} so the omission is visible rather than silent.
+ */
+export declare const buildReceivers: (rows: readonly Record<string, unknown>[], recipientColumn: string, options?: {
+    dedupe?: boolean;
+}) => ResolvedAudience;
+/**
+ * Resolves any of the four audience shapes into one receiver list.
+ *
+ * De-duplicates by number unless `dedupe: false`. On by default because the cost
+ * of a duplicate here is not a wasted row in a table -- it is the same person
+ * receiving the same marketing message twice, billed twice, and more likely to
+ * report the sender. A caller who genuinely wants two sends to one number can
+ * say so.
+ */
+export declare const resolveAudience: (input: BulkAudienceInput) => ResolvedAudience;
+export type { CampaignReceiver };

package/dist/resources/campaign-audience.js

@@ -0,0 +1,224 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveAudience = exports.buildReceivers = exports.parseDelimited = exports.normaliseNumbers = exports.normaliseColumn = exports.MAX_BULK_RECEIVERS = void 0;
+/**
+ * Most recipients one bulk campaign may carry.
+ *
+ * The same ceiling the panel has always enforced. It is not arbitrary: the list
+ * is encrypted into a single file and read back into memory by the campaign
+ * manager, so this is the point at which "one campaign" stops being a sensible
+ * unit of work.
+ */
+exports.MAX_BULK_RECEIVERS = 1_000_000;
+/** Digits only: no `+`, no spaces, no dashes, no parentheses. */
+const digitsOf = (value) => (value === null || value === undefined ? '' : String(value).replace(/\D/g, ''));
+/**
+ * Normalises a column name into a template variable id.
+ *
+ * Lower-cased with every non-alphanumeric character replaced by `_`, which is
+ * what the panel's CSV reader and its paste-a-table path both did -- so a header
+ * of `First Name` is the variable `first_name` here exactly as it was there, and
+ * templates built against the old behaviour keep working.
+ *
+ * A blank header becomes `empty_<index>` rather than `_`, so two unnamed columns
+ * do not collapse into one variable.
+ */
+const normaliseColumn = (header, index) => {
+    const name = String(header ?? '').trim();
+    if (!name)
+        return `empty_${index}`;
+    return name.toLowerCase().replace(/[^a-z0-9]/g, '_');
+};
+exports.normaliseColumn = normaliseColumn;
+/**
+ * Pulls the numbers out of one string, or tidies an array of them.
+ *
+ * Splits on commas, newlines, carriage returns, tabs, semicolons and spaces --
+ * all of them, in any mixture. The panel chose a single separator per paste
+ * (commas if the text contained any, otherwise newlines), which quietly mangled
+ * the common case of pasting a column from a spreadsheet into a field that
+ * already had comma-separated numbers: the newlines were never split on, so two
+ * numbers merged into one 24-digit number and the send went nowhere. Splitting on
+ * every separator cannot produce that, and for input with one separator it
+ * behaves identically.
+ */
+const normaliseNumbers = (input) => {
+    const parts = typeof input === 'string' ? input.split(/[\s,;]+/) : input;
+    return parts.map(digitsOf).filter((value) => value.length > 0);
+};
+exports.normaliseNumbers = normaliseNumbers;
+/**
+ * Splits delimited text into a header and rows, RFC 4180 style.
+ *
+ * A proper parser rather than `split(',')`, because a quoted field may contain
+ * the delimiter, a newline, or an escaped quote -- and a currency-formatted
+ * variable (`"1,299"`) is exactly the sort of value that appears in these files.
+ * Splitting naively turns one such row into two bad ones.
+ *
+ * Values stay strings. The panel parsed with `dynamicTyping`, which coerced
+ * numeric-looking cells to JavaScript numbers -- and that silently corrupted the
+ * one column that matters: a 16-digit number exceeds `Number.MAX_SAFE_INTEGER`
+ * and comes back with its last digits changed, while a number written with a
+ * leading zero loses it. Keeping text as text avoids both.
+ */
+const parseDelimited = (text, delimiter) => {
+    const rows = splitRows(text, delimiter ?? detectDelimiter(text));
+    const headerRow = rows.shift();
+    if (!headerRow)
+        return { headers: [], rows: [] };
+    const headers = headerRow.map(exports.normaliseColumn);
+    const parsed = rows
+        // A trailing newline, or a blank line in the middle, is not a record.
+        .filter((cells) => cells.some((cell) => cell.trim() !== ''))
+        .map((cells) => {
+        const row = {};
+        headers.forEach((header, index) => {
+            row[header] = cells[index] ?? '';
+        });
+        return row;
+    });
+    return { headers, rows: parsed };
+};
+exports.parseDelimited = parseDelimited;
+/** Tab if the header row has one, else semicolon, else comma. */
+const detectDelimiter = (text) => {
+    const firstLine = text.slice(0, text.search(/\r?\n/) === -1 ? undefined : text.search(/\r?\n/));
+    if (firstLine.includes('\t'))
+        return '\t';
+    if (firstLine.includes(';') && !firstLine.includes(','))
+        return ';';
+    return ',';
+};
+/** The parser proper: quotes, doubled quotes inside them, and newlines within a field. */
+const splitRows = (text, delimiter) => {
+    const rows = [];
+    let row = [];
+    let field = '';
+    let quoted = false;
+    for (let i = 0; i < text.length; i += 1) {
+        const char = text[i];
+        if (quoted) {
+            if (char !== '"') {
+                field += char;
+            }
+            else if (text[i + 1] === '"') {
+                // A doubled quote inside a quoted field is one literal quote.
+                field += '"';
+                i += 1;
+            }
+            else {
+                quoted = false;
+            }
+            continue;
+        }
+        if (char === '"' && field === '') {
+            quoted = true;
+        }
+        else if (char === delimiter) {
+            row.push(field);
+            field = '';
+        }
+        else if (char === '\n' || char === '\r') {
+            // Either line ending, and CRLF counts once.
+            if (char === '\r' && text[i + 1] === '\n')
+                i += 1;
+            row.push(field);
+            rows.push(row);
+            row = [];
+            field = '';
+        }
+        else {
+            field += char;
+        }
+    }
+    if (field !== '' || row.length) {
+        row.push(field);
+        rows.push(row);
+    }
+    return rows;
+};
+/**
+ * Turns parsed rows into receivers.
+ *
+ * Every column becomes a variable, including the recipient column itself -- which
+ * is intentional and matches the panel: a template that greets someone by the
+ * number they were messaged on still works.
+ *
+ * A row whose recipient column holds no digits is skipped rather than failing the
+ * whole batch. In a file of ten thousand rows, a handful of blanks and a trailing
+ * footer line are normal, and refusing the campaign over them would mean the
+ * caller has to clean a file they may not control. The count comes back in
+ * {@link ResolvedAudience.skipped} so the omission is visible rather than silent.
+ */
+const buildReceivers = (rows, recipientColumn, options = {}) => {
+    const column = (0, exports.normaliseColumn)(recipientColumn, 0);
+    const receivers = [];
+    const seen = new Set();
+    let skipped = 0;
+    let duplicates = 0;
+    for (const row of rows) {
+        // Accept the column as written or as normalised, so a caller passing
+        // `'First Name'` against already-normalised rows still resolves.
+        const raw = row[recipientColumn] ?? row[column];
+        const waba = digitsOf(raw);
+        if (!waba) {
+            skipped += 1;
+            continue;
+        }
+        if (options.dedupe !== false) {
+            if (seen.has(waba)) {
+                duplicates += 1;
+                continue;
+            }
+            seen.add(waba);
+        }
+        receivers.push({
+            waba,
+            custom_fields: Object.keys(row).map((key, index) => ({
+                id: (0, exports.normaliseColumn)(key, index),
+                value: row[key] === null || row[key] === undefined ? '' : String(row[key]),
+            })),
+        });
+    }
+    return { receivers, skipped, duplicates };
+};
+exports.buildReceivers = buildReceivers;
+/**
+ * Resolves any of the four audience shapes into one receiver list.
+ *
+ * De-duplicates by number unless `dedupe: false`. On by default because the cost
+ * of a duplicate here is not a wasted row in a table -- it is the same person
+ * receiving the same marketing message twice, billed twice, and more likely to
+ * report the sender. A caller who genuinely wants two sends to one number can
+ * say so.
+ */
+const resolveAudience = (input) => {
+    if ('receivers' in input) {
+        // Taken as given: a caller who built these chose the shape deliberately.
+        return { receivers: [...input.receivers], skipped: 0, duplicates: 0 };
+    }
+    if ('numbers' in input) {
+        const numbers = (0, exports.normaliseNumbers)(input.numbers);
+        const receivers = [];
+        const seen = new Set();
+        let duplicates = 0;
+        for (const waba of numbers) {
+            if (input.dedupe !== false) {
+                if (seen.has(waba)) {
+                    duplicates += 1;
+                    continue;
+                }
+                seen.add(waba);
+            }
+            receivers.push({ waba, custom_fields: [] });
+        }
+        const supplied = typeof input.numbers === 'string' ? numbers.length + countBlank(input.numbers) : input.numbers.length;
+        return { receivers, skipped: Math.max(0, supplied - numbers.length - duplicates), duplicates };
+    }
+    const rows = 'csv' in input ? (0, exports.parseDelimited)(input.csv, input.delimiter).rows : input.rows;
+    return (0, exports.buildReceivers)(rows, input.recipientColumn, { dedupe: input.dedupe });
+};
+exports.resolveAudience = resolveAudience;
+/** Entries in a pasted string that held no digits at all, for the skipped count. */
+const countBlank = (text) => text.split(/[\s,;]+/).filter((part) => part !== '' && digitsOf(part) === '').length;
+//# sourceMappingURL=campaign-audience.js.map

package/dist/resources/campaign-audience.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-audience.js","sourceRoot":"","sources":["../../src/resources/campaign-audience.ts"],"names":[],"mappings":";;;AAEA;;;;;;;GAOG;AACU,QAAA,kBAAkB,GAAG,SAAS,CAAC;AA0C5C,iEAAiE;AACjE,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAU,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;AAE7H;;;;;;;;;;GAUG;AACI,MAAM,eAAe,GAAG,CAAC,MAAe,EAAE,KAAa,EAAU,EAAE;IACxE,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACzC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,KAAK,EAAE,CAAC;IAEnC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;AACvD,CAAC,CAAC;AALW,QAAA,eAAe,mBAK1B;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,gBAAgB,GAAG,CAAC,KAAiC,EAAY,EAAE;IAC9E,MAAM,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAEzE,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAJW,QAAA,gBAAgB,oBAI3B;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,cAAc,GAAG,CAC5B,IAAY,EACZ,SAAkB,EACqC,EAAE;IACzD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,SAAS,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC/B,IAAI,CAAC,SAAS;QAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAEjD,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,uBAAe,CAAC,CAAC;IAE/C,MAAM,MAAM,GAAG,IAAI;QACjB,sEAAsE;SACrE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SAC3D,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,GAAG,GAA2B,EAAE,CAAC;QACvC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAChC,GAAG,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;IAEL,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACnC,CAAC,CAAC;AAtBW,QAAA,cAAc,kBAsBzB;AAEF,iEAAiE;AACjE,MAAM,eAAe,GAAG,CAAC,IAAY,EAAU,EAAE;IAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAEhG,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC1C,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IACpE,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,0FAA0F;AAC1F,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAc,EAAE;IAChE,MAAM,IAAI,GAAe,EAAE,CAAC;IAC5B,IAAI,GAAG,GAAa,EAAE,CAAC;IACvB,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;QAEtB,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACjB,KAAK,IAAI,IAAI,CAAC;YAChB,CAAC;iBAAM,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gBAC/B,8DAA8D;gBAC9D,KAAK,IAAI,GAAG,CAAC;gBACb,CAAC,IAAI,CAAC,CAAC;YACT,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,KAAK,CAAC;YACjB,CAAC;YACD,SAAS;QACX,CAAC;QAED,IAAI,IAAI,KAAK,GAAG,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACjC,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;aAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAChB,KAAK,GAAG,EAAE,CAAC;QACb,CAAC;aAAM,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAC1C,4CAA4C;YAC5C,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI;gBAAE,CAAC,IAAI,CAAC,CAAC;YAClD,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,GAAG,GAAG,EAAE,CAAC;YACT,KAAK,GAAG,EAAE,CAAC;QACb,CAAC;aAAM,CAAC;YACN,KAAK,IAAI,IAAI,CAAC;QAChB,CAAC;IACH,CAAC;IAED,IAAI,KAAK,KAAK,EAAE,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAC/B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,cAAc,GAAG,CAC5B,IAAwC,EACxC,eAAuB,EACvB,UAAgC,EAAE,EAChB,EAAE;IACpB,MAAM,MAAM,GAAG,IAAA,uBAAe,EAAC,eAAe,EAAE,CAAC,CAAC,CAAC;IACnD,MAAM,SAAS,GAAuB,EAAE,CAAC;IACzC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,qEAAqE;QACrE,iEAAiE;QACjE,MAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAE3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,IAAI,CAAC,CAAC;YACb,SAAS;QACX,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAC7B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnB,UAAU,IAAI,CAAC,CAAC;gBAChB,SAAS;YACX,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;QAED,SAAS,CAAC,IAAI,CAAC;YACb,IAAI;YACJ,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;gBACnD,EAAE,EAAE,IAAA,uBAAe,EAAC,GAAG,EAAE,KAAK,CAAC;gBAC/B,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3E,CAAC,CAAC;SACJ,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAC5C,CAAC,CAAC;AAxCW,QAAA,cAAc,kBAwCzB;AAEF;;;;;;;;GAQG;AACI,MAAM,eAAe,GAAG,CAAC,KAAwB,EAAoB,EAAE;IAC5E,IAAI,WAAW,IAAI,KAAK,EAAE,CAAC;QACzB,yEAAyE;QACzE,OAAO,EAAE,SAAS,EAAE,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IACxE,CAAC;IAED,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,IAAA,wBAAgB,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,SAAS,GAAuB,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,IAAI,UAAU,GAAG,CAAC,CAAC;QAEnB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;gBAC3B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBACnB,UAAU,IAAI,CAAC,CAAC;oBAChB,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;YACD,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAEvH,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;IACjG,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,IAAA,sBAAc,EAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;IAC3F,OAAO,IAAA,sBAAc,EAAC,IAAI,EAAE,KAAK,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;AAC/E,CAAC,CAAC;AA9BW,QAAA,eAAe,mBA8B1B;AAEF,oFAAoF;AACpF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE,CAC1C,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC"}

package/dist/resources/campaign-report-exports.d.ts

@@ -0,0 +1,14 @@
+import type { CampaignReportExport, CreateCampaignReportExportInput } from '../types/campaign';
+import type { Page, PageQuery } from '../types/common';
+import type { HttpClient } from '../http';
+export declare class CampaignReportExports {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(query?: Partial<PageQuery>): Promise<Page<CampaignReportExport>>;
+    /**
+     * One export. Poll this until `status` is `completed`, then read `fileUrl` --
+     * which expires, so download rather than storing the link.
+     */
+    get(id: string): Promise<CampaignReportExport>;
+    create(input: CreateCampaignReportExportInput): Promise<CampaignReportExport>;
+}

package/dist/resources/campaign-report-exports.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignReportExports = void 0;
+class CampaignReportExports {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    list(query = {}) {
+        return this.http.request('GET', '/v1/campaign-report-exports', {
+            query,
+        });
+    }
+    /**
+     * One export. Poll this until `status` is `completed`, then read `fileUrl` --
+     * which expires, so download rather than storing the link.
+     */
+    get(id) {
+        return this.http.request('GET', `/v1/campaign-report-exports/${encodeURIComponent(id)}`);
+    }
+    create(input) {
+        return this.http.request('POST', '/v1/campaign-report-exports', {
+            body: input,
+        });
+    }
+}
+exports.CampaignReportExports = CampaignReportExports;
+//# sourceMappingURL=campaign-report-exports.js.map