@linqapp/sdk 0.35.0 → 0.36.1

package/resources/phone-numbers.d.ts

@@ -37,6 +37,228 @@ export declare class PhoneNumbers extends APIResource {
      * ```
      */
     list(options?: RequestOptions): APIPromise<PhoneNumberListResponse>;
+    /**
+     * Returns the audit's status and, once complete, the report. Audits are scoped to
+     * the line in the URL — an `auditId` started on a different line returns `404`.
+     *
+     * @example
+     * ```ts
+     * const reputationAudit =
+     *   await client.phoneNumbers.getReputationAudit('auditId', {
+     *     phoneNumber: 'phoneNumber',
+     *   });
+     * ```
+     */
+    getReputationAudit(auditID: string, params: PhoneNumberGetReputationAuditParams, options?: RequestOptions): APIPromise<ReputationAudit>;
+    /**
+     * Starts an asynchronous reputation audit for a line and returns an `audit_id`.
+     * Poll the GET endpoint for the result.
+     *
+     * Rate limited per line: only one audit may run at a time (a second request
+     * returns `409` while the first is still in progress), and a new audit can't be
+     * started for the same line until a cooldown elapses (`429`, with `Retry-After`
+     * carrying the wait).
+     *
+     * @example
+     * ```ts
+     * const reputationAuditStarted =
+     *   await client.phoneNumbers.startReputationAudit(
+     *     'phoneNumber',
+     *   );
+     * ```
+     */
+    startReputationAudit(phoneNumber: string, options?: RequestOptions): APIPromise<ReputationAuditStarted>;
+}
+export interface ReputationActionItem {
+    detail?: string;
+    expected_impact?: 'high' | 'medium' | 'low';
+    /**
+     * 1 = do first
+     */
+    priority?: number;
+    title?: string;
+}
+export interface ReputationAudit {
+    audit_id: string;
+    /**
+     * `pending` until the report is ready — poll until `complete` or `error`.
+     */
+    status: 'pending' | 'complete' | 'error';
+    /**
+     * Present only when `status` is `error`. Short, generic reason safe to display.
+     */
+    error?: string;
+    /**
+     * When the report was generated; signals reflect the line at this moment.
+     */
+    generated_at?: string;
+    /**
+     * The line audited, E.164.
+     */
+    phone?: string;
+    /**
+     * Present only when `status` is `complete`.
+     */
+    report?: ReputationReport;
+}
+export interface ReputationAuditStarted {
+    /**
+     * Identifier for this audit. Poll
+     * `GET /v3/phone_numbers/{phoneNumber}/reputation_audit/{auditId}` until `status`
+     * is `complete` or `error`.
+     */
+    audit_id: string;
+    /**
+     * A newly started audit is `pending`.
+     */
+    status: 'pending' | 'complete' | 'error';
+}
+export interface ReputationDriver {
+    /**
+     * Stable driver-category identifier — what is dragging the line, or one of its
+     * conversations, down.
+     *
+     * - `low_engagement` — The conversation is one-sided: several messages sent, few
+     *   or no replies back. Pause or rework outreach where recipients are not
+     *   replying, and lead with messages that invite a response. Conversation-level:
+     *   it appears on `evidence.unhealthy_chats[].driver_keys`, never in `drivers`.
+     * - `overall_conversation_health` — A large share of the line's active
+     *   conversations are trending unhealthy. Fix those conversations first — review
+     *   their content and timing, and whether recipients are engaging.
+     * - `volume_spike` — The line's daily sending volume jumped far above its own
+     *   normal level. Ramp gradually instead of spiking, spread large sends across
+     *   days, and prioritize people who have already engaged.
+     * - `new_conversation_rate` — The line is starting too many brand-new
+     *   conversations in a single day. Spread new conversations out over time instead
+     *   of starting many at once.
+     * - `opt_out_handling` — Recipients asked this line to stop. Honor every stop
+     *   request immediately: send nothing further to that recipient unless they opt
+     *   back in. Every send to them is rejected with `403` (error code `2024`),
+     *   including a final courtesy message — to send one telling them they can reply
+     *   to resume, set `override_optout: true` on that single request.
+     * - `flagged` — The line is currently restricted and its messages may not be
+     *   reaching recipients. Move active traffic to a healthy line now, and let this
+     *   one recover before sending more.
+     * - `other` — Fallback for a signal without dedicated partner copy.
+     */
+    key?: ReputationDriverKey;
+    /**
+     * A specific observed figure when available; otherwise a short qualitative note.
+     */
+    metric?: string;
+    /**
+     * One plain-English sentence.
+     */
+    summary?: string;
+}
+/**
+ * Stable driver-category identifier — what is dragging the line, or one of its
+ * conversations, down.
+ *
+ * - `low_engagement` — The conversation is one-sided: several messages sent, few
+ *   or no replies back. Pause or rework outreach where recipients are not
+ *   replying, and lead with messages that invite a response. Conversation-level:
+ *   it appears on `evidence.unhealthy_chats[].driver_keys`, never in `drivers`.
+ * - `overall_conversation_health` — A large share of the line's active
+ *   conversations are trending unhealthy. Fix those conversations first — review
+ *   their content and timing, and whether recipients are engaging.
+ * - `volume_spike` — The line's daily sending volume jumped far above its own
+ *   normal level. Ramp gradually instead of spiking, spread large sends across
+ *   days, and prioritize people who have already engaged.
+ * - `new_conversation_rate` — The line is starting too many brand-new
+ *   conversations in a single day. Spread new conversations out over time instead
+ *   of starting many at once.
+ * - `opt_out_handling` — Recipients asked this line to stop. Honor every stop
+ *   request immediately: send nothing further to that recipient unless they opt
+ *   back in. Every send to them is rejected with `403` (error code `2024`),
+ *   including a final courtesy message — to send one telling them they can reply
+ *   to resume, set `override_optout: true` on that single request.
+ * - `flagged` — The line is currently restricted and its messages may not be
+ *   reaching recipients. Move active traffic to a healthy line now, and let this
+ *   one recover before sending more.
+ * - `other` — Fallback for a signal without dedicated partner copy.
+ */
+export type ReputationDriverKey = 'low_engagement' | 'overall_conversation_health' | 'volume_spike' | 'new_conversation_rate' | 'opt_out_handling' | 'flagged' | 'other';
+/**
+ * The specific conversations behind the drivers, so partners can verify every
+ * claim against their own send logs. Each `chat_id` can be fetched via
+ * `GET /v3/chats/{chatId}` — its current health appears there.
+ */
+export interface ReputationEvidence {
+    /**
+     * Worst first — most messages sent after the stop request; honor these
+     * immediately.
+     */
+    opt_out_chats?: Array<ReputationOptOutChat>;
+    /**
+     * Up to 15, worst first.
+     */
+    unhealthy_chats?: Array<ReputationUnhealthyChat>;
+}
+export interface ReputationOptOutChat {
+    chat_id?: string;
+    /**
+     * Outbound messages sent after the recipient asked to stop.
+     */
+    messages_after_stop?: number;
+}
+export interface ReputationReport {
+    /**
+     * Ordered by `priority`; 1 = do first.
+     */
+    action_items?: Array<ReputationActionItem>;
+    /**
+     * Ranked, highest impact first.
+     */
+    drivers?: Array<ReputationDriver>;
+    /**
+     * The specific conversations behind the drivers, so partners can verify every
+     * claim against their own send logs. Each `chat_id` can be fetched via
+     * `GET /v3/chats/{chatId}` — its current health appears there.
+     */
+    evidence?: ReputationEvidence;
+    /**
+     * The `key` of the most important driver. Empty string when the line has nothing
+     * to act on — the report then carries a single reassurance action item. Its values
+     * are the `ReputationDriverKey` vocabulary — see that schema for what each means
+     * and what to do about it.
+     */
+    primary_driver?: string;
+    /**
+     * Current reputation of this phone line.
+     *
+     * - `HEALTHY` — The line is in good standing. Send normally.
+     * - `AT_RISK` — Warning signs on the line: engagement is low across many of its
+     *   conversations, or it's starting too many brand-new conversations in a single
+     *   day — and a spike in send volume can add to either. Slow the line's send pace,
+     *   avoid opening many new conversations at once, and review your messaging
+     *   patterns.
+     * - `CRITICAL` — Strong signals that messages from this line aren't landing well.
+     *   Pause outbound on the line until it recovers.
+     *
+     * Defaults to `HEALTHY` for lines that have not yet been scored.
+     */
+    severity?: 'HEALTHY' | 'AT_RISK' | 'CRITICAL';
+    /**
+     * Deterministic markdown rendering of this report, suitable for feeding directly
+     * to automated systems and AI agents as investigation context. Rendered from the
+     * structured fields above, which remain the source of truth.
+     */
+    summary_markdown?: string;
+}
+export interface ReputationUnhealthyChat {
+    chat_id?: string;
+    /**
+     * What is dragging this conversation down, in the same vocabulary as the report's
+     * drivers. Each key's meaning and the fix for it are documented on
+     * `ReputationDriverKey`.
+     */
+    driver_keys?: Array<ReputationDriverKey>;
+    /**
+     * The conversation's current health — the same value `GET /v3/chats/{chatId}`
+     * reports for it.
+     */
+    status?: 'AT_RISK' | 'CRITICAL' | 'OPTED_OUT';
 }
 export interface PhoneNumberUpdateResponse {
     /**
@@ -127,7 +349,13 @@ export interface PhoneNumberUpdateParams {
      */
     forwarding_number: string | null;
 }
+export interface PhoneNumberGetReputationAuditParams {
+    /**
+     * The line in E.164 format.
+     */
+    phoneNumber: string;
+}
 export declare namespace PhoneNumbers {
-    export { type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberListResponse as PhoneNumberListResponse, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, };
+    export { type ReputationActionItem as ReputationActionItem, type ReputationAudit as ReputationAudit, type ReputationAuditStarted as ReputationAuditStarted, type ReputationDriver as ReputationDriver, type ReputationDriverKey as ReputationDriverKey, type ReputationEvidence as ReputationEvidence, type ReputationOptOutChat as ReputationOptOutChat, type ReputationReport as ReputationReport, type ReputationUnhealthyChat as ReputationUnhealthyChat, type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberListResponse as PhoneNumberListResponse, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, type PhoneNumberGetReputationAuditParams as PhoneNumberGetReputationAuditParams, };
 }
 //# sourceMappingURL=phone-numbers.d.ts.map

package/resources/phone-numbers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;GAQG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGpE;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC3D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;;;;;;;;WAUG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC;QAEnC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,WAAW,CAAC;QAC3B;;;;;;;;;;WAUG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;;;;eAaG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;GAQG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInE;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAK9B;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGxG;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,eAAe,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;CAC1C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,mBAAmB,GAC3B,gBAAgB,GAChB,6BAA6B,GAC7B,cAAc,GACd,uBAAuB,GACvB,kBAAkB,GAClB,SAAS,GACT,OAAO,CAAC;AAEZ;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAElC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAE9B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;IAE9C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEzC;;;OAGG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,WAAW,CAAC;CAC/C;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC3D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;;;;;;;;WAUG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC;QAEnC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,WAAW,CAAC;QAC3B;;;;;;;;;;WAUG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;;;;eAaG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/phone-numbers.js

@@ -44,6 +44,42 @@ class PhoneNumbers extends resource_1.APIResource {
     list(options) {
         return this._client.get('/v3/phone_numbers', options);
     }
+    /**
+     * Returns the audit's status and, once complete, the report. Audits are scoped to
+     * the line in the URL — an `auditId` started on a different line returns `404`.
+     *
+     * @example
+     * ```ts
+     * const reputationAudit =
+     *   await client.phoneNumbers.getReputationAudit('auditId', {
+     *     phoneNumber: 'phoneNumber',
+     *   });
+     * ```
+     */
+    getReputationAudit(auditID, params, options) {
+        const { phoneNumber } = params;
+        return this._client.get((0, path_1.path) `/v3/phone_numbers/${phoneNumber}/reputation_audit/${auditID}`, options);
+    }
+    /**
+     * Starts an asynchronous reputation audit for a line and returns an `audit_id`.
+     * Poll the GET endpoint for the result.
+     *
+     * Rate limited per line: only one audit may run at a time (a second request
+     * returns `409` while the first is still in progress), and a new audit can't be
+     * started for the same line until a cooldown elapses (`429`, with `Retry-After`
+     * carrying the wait).
+     *
+     * @example
+     * ```ts
+     * const reputationAuditStarted =
+     *   await client.phoneNumbers.startReputationAudit(
+     *     'phoneNumber',
+     *   );
+     * ```
+     */
+    startReputationAudit(phoneNumber, options) {
+        return this._client.post((0, path_1.path) `/v3/phone_numbers/${phoneNumber}/reputation_audit`, options);
+    }
 }
 exports.PhoneNumbers = PhoneNumbers;
 //# sourceMappingURL=phone-numbers.js.map

package/resources/phone-numbers.js.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C;;;;;;;;GAQG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AApCD,oCAoCC"}
+{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C;;;;;;;;GAQG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,OAAe,EACf,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,WAAW,qBAAqB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,WAAmB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,WAAW,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAC7F,CAAC;CACF;AA9ED,oCA8EC"}

package/resources/phone-numbers.mjs

@@ -41,5 +41,41 @@ export class PhoneNumbers extends APIResource {
     list(options) {
         return this._client.get('/v3/phone_numbers', options);
     }
+    /**
+     * Returns the audit's status and, once complete, the report. Audits are scoped to
+     * the line in the URL — an `auditId` started on a different line returns `404`.
+     *
+     * @example
+     * ```ts
+     * const reputationAudit =
+     *   await client.phoneNumbers.getReputationAudit('auditId', {
+     *     phoneNumber: 'phoneNumber',
+     *   });
+     * ```
+     */
+    getReputationAudit(auditID, params, options) {
+        const { phoneNumber } = params;
+        return this._client.get(path `/v3/phone_numbers/${phoneNumber}/reputation_audit/${auditID}`, options);
+    }
+    /**
+     * Starts an asynchronous reputation audit for a line and returns an `audit_id`.
+     * Poll the GET endpoint for the result.
+     *
+     * Rate limited per line: only one audit may run at a time (a second request
+     * returns `409` while the first is still in progress), and a new audit can't be
+     * started for the same line until a cooldown elapses (`429`, with `Retry-After`
+     * carrying the wait).
+     *
+     * @example
+     * ```ts
+     * const reputationAuditStarted =
+     *   await client.phoneNumbers.startReputationAudit(
+     *     'phoneNumber',
+     *   );
+     * ```
+     */
+    startReputationAudit(phoneNumber, options) {
+        return this._client.post(path `/v3/phone_numbers/${phoneNumber}/reputation_audit`, options);
+    }
 }
 //# sourceMappingURL=phone-numbers.mjs.map

package/resources/phone-numbers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.mjs","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF"}
+{"version":3,"file":"phone-numbers.mjs","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,OAAe,EACf,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,WAAW,qBAAqB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,WAAmB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,WAAW,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAC7F,CAAC;CACF"}

package/src/client.ts

@@ -81,10 +81,20 @@ import {
 } from './resources/payment-requests';
 import { Payment, PaymentCreateParams, PaymentCredentialsResponse, Payments } from './resources/payments';
 import {
+  PhoneNumberGetReputationAuditParams,
   PhoneNumberListResponse,
   PhoneNumberUpdateParams,
   PhoneNumberUpdateResponse,
   PhoneNumbers,
+  ReputationActionItem,
+  ReputationAudit,
+  ReputationAuditStarted,
+  ReputationDriver,
+  ReputationDriverKey,
+  ReputationEvidence,
+  ReputationOptOutChat,
+  ReputationReport,
+  ReputationUnhealthyChat,
 } from './resources/phone-numbers';
 import { PhonenumberListResponse, Phonenumbers } from './resources/phonenumbers';
 import { WebhookEventListResponse, WebhookEventType, WebhookEvents } from './resources/webhook-events';
@@ -1300,6 +1310,41 @@ export class LinqAPIV3 {
    * branding; a newly registered experience can take up to ~24 hours to
    * activate on Apple's side, during which links open the web checkout.
    *
+   * ## Sending it as a card instead
+   *
+   * A `link` part is one way to deliver a request. The other is the
+   * **`agentpay` experience**, which sends the same request as a native card
+   * in Linq's iMessage app — the amount and reason are drawn in the bubble,
+   * and it turns itself into "Paid" in place once the payment succeeds,
+   * without a second message.
+   *
+   * Send it to `POST /v3/chats/{chatId}/messages`:
+   *
+   * ```json
+   * {
+   *   "message": {
+   *     "experience": {
+   *       "name": "agentpay",
+   *       "action": "request_payment",
+   *       "params": { "checkout_url": "https://zero.linqapp.com/pay/acme?session=tok_..." }
+   *     }
+   *   }
+   * }
+   * ```
+   *
+   * `checkout_url` is the only required field — pass back exactly what
+   * `POST /v3/payment_requests` returned. **The amount and reason are read
+   * from that request, never from you**, so the card can never claim a
+   * different figure than the checkout will charge. Optional `title` and
+   * `note` override the copy only. The link must be one of your own payment
+   * requests; another partner's is rejected.
+   *
+   * The trade-off against a `link` part: a card is an app card, so it is
+   * iMessage-only, and recipients without the app see a static version of it.
+   * A link works everywhere and is what opens the Apple Pay App Clip. Send
+   * whichever suits the conversation — both settle the same payment request
+   * and fire the same webhooks.
+   *
    * ## Webhooks
    *
    * Subscribe to payment lifecycle events to reconcile server-side rather than
@@ -1340,9 +1385,55 @@ export class LinqAPIV3 {
    */
   blockedHandles: API.BlockedHandles = new API.BlockedHandles(this);
   /**
-   * Let an agent pay on a customer's behalf with a single-use virtual card.
-   * Connect a customer once, then create a payment — a virtual card is minted
-   * scoped to that purchase and the card details are handed back for checkout.
+   * An **experience** renders inside Linq's iMessage app as a native card,
+   * instead of as text or a link. You invoke one by name; Linq resolves the
+   * recipient, mints any session it needs, composes the card and sends it.
+   *
+   * Send it to `POST /v3/chats/{chatId}/messages`:
+   *
+   * ```json
+   * {
+   *   "message": {
+   *     "experience": {
+   *       "name": "agentpay",
+   *       "action": "request_payment",
+   *       "params": { "checkout_url": "https://zero.linqapp.com/pay/acme?session=tok_..." }
+   *     }
+   *   }
+   * }
+   * ```
+   *
+   * The key is `experience` — what you're invoking. Nested under it is its
+   * `name`, the action you're invoking on it, and that action's params. A card
+   * **is** the whole message on Apple's side, so a message carries either
+   * `experience` or `parts`, never both, and an action goes to exactly one
+   * recipient.
+   *
+   * ## What you can invoke
+   *
+   * | Experience | Action | What the customer sees |
+   * |---|---|---|
+   * | `agentpay` | `request_payment` | A payment request they can pay in the app. Turns itself into "Paid" in place once it settles. |
+   * | `agentcard` | `attach_card` | A prompt to add a card to their wallet. |
+   * | `agentcard` | `approve_card` | A passkey approval for a virtual card. |
+   * | `link` | `open` | A card that opens a URL you supply. |
+   *
+   * `GET /v3/experiences` is the authoritative list for your account, with
+   * every action and the fields each accepts — an action missing there cannot
+   * be sent. Fields are display copy unless documented otherwise.
+   *
+   * ## Params are checked before the card is sent
+   *
+   * Unknown fields are **rejected rather than ignored**, so copy that would
+   * never have rendered fails for you now instead of arriving wrong on
+   * somebody's phone. Some fields are read rather than sent: `agentpay`'s
+   * `request_payment` takes only a `checkout_url` and resolves the amount and
+   * reason from that payment request, so a card can never claim a figure the
+   * checkout will not charge.
+   *
+   * Cards are **iMessage-only**. Recipients without the app see a static
+   * version built from the same copy; SMS and RCS recipients cannot receive
+   * one at all (error codes 2018 and 4005).
    *
    */
   experiences: API.Experiences = new API.Experiences(this);
@@ -1704,9 +1795,19 @@ export declare namespace LinqAPIV3 {
 
   export {
     PhoneNumbers as PhoneNumbers,
+    type ReputationActionItem as ReputationActionItem,
+    type ReputationAudit as ReputationAudit,
+    type ReputationAuditStarted as ReputationAuditStarted,
+    type ReputationDriver as ReputationDriver,
+    type ReputationDriverKey as ReputationDriverKey,
+    type ReputationEvidence as ReputationEvidence,
+    type ReputationOptOutChat as ReputationOptOutChat,
+    type ReputationReport as ReputationReport,
+    type ReputationUnhealthyChat as ReputationUnhealthyChat,
     type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse,
     type PhoneNumberListResponse as PhoneNumberListResponse,
     type PhoneNumberUpdateParams as PhoneNumberUpdateParams,
+    type PhoneNumberGetReputationAuditParams as PhoneNumberGetReputationAuditParams,
   };
 
   export {

package/src/resources/attachments.ts

@@ -197,10 +197,9 @@ export class Attachments extends APIResource {
    *
    * ## Step 1: Request an upload URL
    *
-   * Call this endpoint with file metadata:
+   * Call `POST /v3/attachments` with file metadata:
    *
    * ```json
-   * POST /v3/attachments
    * {
    *   "filename": "photo.jpg",
    *   "content_type": "image/jpeg",
@@ -231,11 +230,10 @@ export class Attachments extends APIResource {
    *
    * ## Step 3: Send a message with the attachment
    *
-   * Reference the `attachment_id` in a media part. The ID never expires — use it in
-   * as many messages as you want.
+   * Reference the `attachment_id` in a media part with `POST /v3/chats`. The ID
+   * never expires — use it in as many messages as you want.
    *
    * ```json
-   * POST /v3/chats
    * {
    *   "from": "+15559876543",
    *   "to": ["+15551234567"],

package/src/resources/chats/chats.ts

@@ -481,11 +481,17 @@ export interface MediaPart {
  * from/to).
  *
  * A message carries EITHER `parts` — text and attachments, which compose into one
- * bubble — or a single `action`, which invokes an experience inside Linq's
- * iMessage app. Never both: an app card is the whole message (Apple's `MSMessage`
- * cannot coexist with text), so copy and a card are two sends, not one.
+ * bubble — or a single `experience` invocation, which renders an experience inside
+ * Linq's iMessage app. Never both: an app card is the whole message (Apple's
+ * `MSMessage` cannot coexist with text), so copy and a card are two sends, not
+ * one.
  */
 export interface MessageContent {
+  /**
+   * iMessage effect to apply to this message (screen or bubble effect)
+   */
+  effect?: ResourcesMessagesAPI.MessageEffect;
+
   /**
    * Invokes an action on an experience — a third party that renders inside Linq's
    * iMessage app. Linq resolves the recipient's connection, mints any session the
@@ -494,12 +500,7 @@ export interface MessageContent {
    * Call `GET /v3/experiences/{experience}` for the actions you may invoke and the
    * fields each accepts.
    */
-  action?: MessageContent.Action;
-
-  /**
-   * iMessage effect to apply to this message (screen or bubble effect)
-   */
-  effect?: ResourcesMessagesAPI.MessageEffect;
+  experience?: MessageContent.Experience;
 
   /**
    * Optional idempotency key for this message. Use this to prevent duplicate sends
@@ -570,16 +571,16 @@ export namespace MessageContent {
    * Call `GET /v3/experiences/{experience}` for the actions you may invoke and the
    * fields each accepts.
    */
-  export interface Action {
+  export interface Experience {
     /**
      * Which of its actions, e.g. `attach_card`.
      */
     action: string;
 
     /**
-     * The experience to invoke, e.g. `agentcard`.
+     * The experience to invoke, e.g. `agentcard` or `agentpay`.
      */
-    experience: string;
+    name: string;
 
     /**
      * Values for the fields this action exposes. Keys are exactly the field names
@@ -587,6 +588,10 @@ export namespace MessageContent {
      *
      * Display copy only, except a `url`-type field — that value sets the destination,
      * and must be an absolute `https` URL.
+     *
+     * Some fields are read rather than sent: `agentpay`'s `request_payment` takes only
+     * a `checkout_url` and resolves the amount and reason from that payment request
+     * itself, so the card cannot state a figure the checkout will not charge.
      */
     params?: { [key: string]: unknown };
   }
@@ -1033,9 +1038,10 @@ export interface ChatCreateParams {
    * from/to).
    *
    * A message carries EITHER `parts` — text and attachments, which compose into one
-   * bubble — or a single `action`, which invokes an experience inside Linq's
-   * iMessage app. Never both: an app card is the whole message (Apple's `MSMessage`
-   * cannot coexist with text), so copy and a card are two sends, not one.
+   * bubble — or a single `experience` invocation, which renders an experience inside
+   * Linq's iMessage app. Never both: an app card is the whole message (Apple's
+   * `MSMessage` cannot coexist with text), so copy and a card are two sends, not
+   * one.
    */
   message: MessageContent;
 

package/src/resources/chats/messages.ts

@@ -393,9 +393,10 @@ export interface MessageSendParams {
    * from/to).
    *
    * A message carries EITHER `parts` — text and attachments, which compose into one
-   * bubble — or a single `action`, which invokes an experience inside Linq's
-   * iMessage app. Never both: an app card is the whole message (Apple's `MSMessage`
-   * cannot coexist with text), so copy and a card are two sends, not one.
+   * bubble — or a single `experience` invocation, which renders an experience inside
+   * Linq's iMessage app. Never both: an app card is the whole message (Apple's
+   * `MSMessage` cannot coexist with text), so copy and a card are two sends, not
+   * one.
    */
   message: ChatsAPI.MessageContent;