@masters-union/outbound-sdk 0.4.8 → 0.4.10

package/dist/index.d.mts

@@ -798,6 +798,12 @@ interface CampaignTotals {
     clicked: number;
     bounced: number;
     complained: number;
+    /**
+     * Accepted from the caller but never handed to the provider, because the address was
+     * suppressed (prior bounce/complaint/unsubscribe) or failed validation. Not counted in
+     * `sent`, and the reason `sent` can read lower than `recipients`.
+     */
+    dropped: number;
     failed: number;
     queued: number;
     processing: number;
@@ -807,8 +813,12 @@ interface CampaignRates {
     deliveryRate: string;
     openRate: string;
     clickRate: string;
+    /** Against `sent`. */
     bounceRate: string;
+    /** Against `sent`. */
     complaintRate: string;
+    /** Against `recipients`, not `sent`: dropped rows never reached the provider. */
+    dropRate: string;
 }
 interface CampaignTimeseriesPoint {
     /** ISO bucket start (UTC instant of the local bucket). */
@@ -1027,8 +1037,16 @@ interface ContactListFieldsResponse {
         name: string;
         sample: string | null;
     }>;
-    /** Mappable alongside `fields`, but not attributes. */
-    reservedFields: string[];
+    /**
+     * Mappable alongside `fields`, but stored on the contact rather than in its
+     * attributes. Carries a sample for the same reason `fields` does: a mapping UI
+     * that shows a column name with no example value gives the user nothing to
+     * judge it by.
+     */
+    reservedFields: Array<{
+        name: string;
+        sample: string | null;
+    }>;
 }
 interface RecountContactListResponse {
     contactCount: number;

package/dist/index.d.ts

@@ -798,6 +798,12 @@ interface CampaignTotals {
     clicked: number;
     bounced: number;
     complained: number;
+    /**
+     * Accepted from the caller but never handed to the provider, because the address was
+     * suppressed (prior bounce/complaint/unsubscribe) or failed validation. Not counted in
+     * `sent`, and the reason `sent` can read lower than `recipients`.
+     */
+    dropped: number;
     failed: number;
     queued: number;
     processing: number;
@@ -807,8 +813,12 @@ interface CampaignRates {
     deliveryRate: string;
     openRate: string;
     clickRate: string;
+    /** Against `sent`. */
     bounceRate: string;
+    /** Against `sent`. */
     complaintRate: string;
+    /** Against `recipients`, not `sent`: dropped rows never reached the provider. */
+    dropRate: string;
 }
 interface CampaignTimeseriesPoint {
     /** ISO bucket start (UTC instant of the local bucket). */
@@ -1027,8 +1037,16 @@ interface ContactListFieldsResponse {
         name: string;
         sample: string | null;
     }>;
-    /** Mappable alongside `fields`, but not attributes. */
-    reservedFields: string[];
+    /**
+     * Mappable alongside `fields`, but stored on the contact rather than in its
+     * attributes. Carries a sample for the same reason `fields` does: a mapping UI
+     * that shows a column name with no example value gives the user nothing to
+     * judge it by.
+     */
+    reservedFields: Array<{
+        name: string;
+        sample: string | null;
+    }>;
 }
 interface RecountContactListResponse {
     contactCount: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@masters-union/outbound-sdk",
-  "version": "0.4.8",
+  "version": "0.4.10",
   "description": "Official Node.js SDK for the Outbound Email SaaS platform",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",