evo360-types 1.3.713 → 1.3.715

package/dist/types/evo-campaigns/index.d.ts

@@ -227,7 +227,18 @@ export interface ICampaignChannelCounters {
     failed?: number;
     clicked?: number;
     replied?: number;
+    /**
+     * Ticket outcome of sends whose policy asked to close the ticket (F6). Recorded by
+     * the hub-omni at the moment it decides. `kept_open` is the RULE (patient already had
+     * an open ticket — the campaign never ends a live attendance); `close_failed` is a
+     * defect (close attempted, did not happen).
+     */
+    ticket_closed?: number;
+    ticket_kept_open?: number;
+    ticket_close_failed?: number;
 }
+/** What happened to the ticket of a campaign send that asked to close it (F6). */
+export type CampaignTicketOutcome = "closed" | "kept_open" | "close_failed";
 export interface ICampaignCounters {
     raw?: number;
     unique?: number;
@@ -330,6 +341,26 @@ export interface ICampaign extends IFireDoc {
     finished_at?: Date | null;
     cancel_reason?: string | null;
     error_reason?: string | null;
+    /**
+     * Why the campaign is paused, when the SYSTEM paused it (F6 circuit breaker).
+     * `null`/absent on an operator pause and cleared on resume — its presence is what
+     * tells the screen "the platform stopped this, here is the cause".
+     */
+    pause_reason?: ICampaignPauseReason | null;
+}
+/**
+ * System pause (F6). A provider error that fails EVERY recipient the same way
+ * (account payment, account restricted, template paused/disabled, broken media)
+ * stops the dispatch instead of burning the rest of the list.
+ */
+export interface ICampaignPauseReason {
+    kind: "provider_systemic_error";
+    channel: CampaignChannel;
+    error_code: string;
+    error_message?: string | null;
+    /** Recipient whose failure tripped the breaker — the operator can open it. */
+    recipient_id?: string | null;
+    at: Date;
 }
 export type CampaignBucketSourceType = "leads" | "patients" | "appointments" | "csv";
 export interface ICampaignBucketCsvFile {
@@ -417,6 +448,16 @@ export interface ICampaignRecipientChannelState {
     failed_at?: Date | null;
     /** Provider error text that accompanies `failed_at`. */
     error?: string | null;
+    /**
+     * Provider error CODE that accompanies `failed_at` (F6). Kept apart from `error`
+     * because the code is what the operator-facing breakdown groups by and what the
+     * circuit breaker decides on; parsing it back out of the text would be guessing.
+     * String, not number: providers other than Meta do not promise numeric codes.
+     */
+    error_code?: string | null;
+    /** Ticket outcome when the policy asked to close it (F6) — see ICampaignChannelCounters. */
+    ticket_outcome?: CampaignTicketOutcome | null;
+    ticket_id?: string | null;
 }
 /**
  * Why a recipient was kept out. Closed union: every value here HAS a writer in

package/dist/types/evo-campaigns/index.ts

@@ -304,8 +304,20 @@ export interface ICampaignChannelCounters {
   failed?: number;
   clicked?: number;
   replied?: number;
+  /**
+   * Ticket outcome of sends whose policy asked to close the ticket (F6). Recorded by
+   * the hub-omni at the moment it decides. `kept_open` is the RULE (patient already had
+   * an open ticket — the campaign never ends a live attendance); `close_failed` is a
+   * defect (close attempted, did not happen).
+   */
+  ticket_closed?: number;
+  ticket_kept_open?: number;
+  ticket_close_failed?: number;
 }
 
+/** What happened to the ticket of a campaign send that asked to close it (F6). */
+export type CampaignTicketOutcome = "closed" | "kept_open" | "close_failed";
+
 export interface ICampaignCounters {
   raw?: number;
   unique?: number;
@@ -422,6 +434,27 @@ export interface ICampaign extends IFireDoc {
   finished_at?: Date | null;
   cancel_reason?: string | null;
   error_reason?: string | null;
+  /**
+   * Why the campaign is paused, when the SYSTEM paused it (F6 circuit breaker).
+   * `null`/absent on an operator pause and cleared on resume — its presence is what
+   * tells the screen "the platform stopped this, here is the cause".
+   */
+  pause_reason?: ICampaignPauseReason | null;
+}
+
+/**
+ * System pause (F6). A provider error that fails EVERY recipient the same way
+ * (account payment, account restricted, template paused/disabled, broken media)
+ * stops the dispatch instead of burning the rest of the list.
+ */
+export interface ICampaignPauseReason {
+  kind: "provider_systemic_error";
+  channel: CampaignChannel;
+  error_code: string;
+  error_message?: string | null;
+  /** Recipient whose failure tripped the breaker — the operator can open it. */
+  recipient_id?: string | null;
+  at: Date;
 }
 
 // ----- Bucket ---------------------------------------------------------------
@@ -550,6 +583,16 @@ export interface ICampaignRecipientChannelState {
   failed_at?: Date | null;
   /** Provider error text that accompanies `failed_at`. */
   error?: string | null;
+  /**
+   * Provider error CODE that accompanies `failed_at` (F6). Kept apart from `error`
+   * because the code is what the operator-facing breakdown groups by and what the
+   * circuit breaker decides on; parsing it back out of the text would be guessing.
+   * String, not number: providers other than Meta do not promise numeric codes.
+   */
+  error_code?: string | null;
+  /** Ticket outcome when the policy asked to close it (F6) — see ICampaignChannelCounters. */
+  ticket_outcome?: CampaignTicketOutcome | null;
+  ticket_id?: string | null;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "evo360-types",
-  "version": "1.3.713",
+  "version": "1.3.715",
   "description": "HREVO360 Shared Types",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",