@pushwoosh/rpc-gateway-statistics-api 1.3.879 → 1.3.880

package/data.js

@@ -1481,6 +1481,47 @@ export const data = {
             },
             "unsubscribes": {
                 "type": "number"
+            },
+            "bounceReasons": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailProviderBounceReason",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.EmailProviderBounceReason": {
+        "type": "I",
+        "fields": {
+            "reason": {
+                "type": "string"
+            },
+            "type": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailBounceType"
+            },
+            "count": {
+                "type": "number"
+            },
+            "topCodes": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailProviderBounceCode",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.EmailBounceType": {
+        "type": "E",
+        "values": [
+            "EMAIL_BOUNCE_TYPE_UNSPECIFIED",
+            "EMAIL_BOUNCE_TYPE_HARD",
+            "EMAIL_BOUNCE_TYPE_SOFT"
+        ]
+    },
+    "pushwoosh.statistics.statistics.v1.EmailProviderBounceCode": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "count": {
+                "type": "number"
             }
         }
     },
@@ -4458,12 +4499,6 @@ export const data = {
             },
             "hardBounceRatePercent": {
                 "type": "number"
-            },
-            "softbounces": {
-                "type": "number"
-            },
-            "softBounceRatePercent": {
-                "type": "number"
             }
         }
     },
@@ -4501,24 +4536,6 @@ export const data = {
             },
             "rates": {
                 "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailRates"
-            },
-            "bounceReasons": {
-                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse.BounceReason",
-                "array": true
-            }
-        }
-    },
-    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse.BounceReason": {
-        "type": "I",
-        "fields": {
-            "reason": {
-                "type": "string"
-            },
-            "hard": {
-                "type": "number"
-            },
-            "soft": {
-                "type": "number"
             }
         }
     },
@@ -4534,10 +4551,6 @@ export const data = {
             },
             "pauseCheck": {
                 "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPauseCheck"
-            },
-            "bounceReasons": {
-                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse.BounceReason",
-                "array": true
             }
         }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-statistics-api",
-    "version": "1.3.879",
+    "version": "1.3.880",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -602,6 +602,25 @@ export type EmailProviderStatistics = {
     softBounces: number;
     complaints: number;
     unsubscribes: number;
+    /** Bounce events of this provider by reason, most first; rates divide by sends above. */
+    bounceReasons: EmailProviderBounceReason[];
+};
+/**
+ * The bounce events of one provider that email-feedback-api classified into one reason,
+ * hard or soft; events logged before it wrote bounceReason are left out.
+ */
+export type EmailProviderBounceReason = {
+    /** The bounceReason value, e.g. mailbox_full. */
+    reason: string;
+    type: EmailBounceType;
+    count: number;
+    /** Up to three SMTP codes of these events, most first: the enhanced status, else the basic one. */
+    topCodes: EmailProviderBounceCode[];
+};
+export type EmailBounceType = 'EMAIL_BOUNCE_TYPE_UNSPECIFIED' | 'EMAIL_BOUNCE_TYPE_HARD' | 'EMAIL_BOUNCE_TYPE_SOFT';
+export type EmailProviderBounceCode = {
+    code: string;
+    count: number;
 };
 export type GetEmailProviderStatisticsCPResponse = {
     /** Providers with at least one event in the window, most sends first. */

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -36,7 +36,7 @@ export interface OverviewKPIService {
     /** GetChannelUsersTrend returns the daily users-with-channel series of one platform. */
     GetChannelUsersTrend: OverviewKPIService_GetChannelUsersTrend;
     /**
-     * GetEmailRates returns the complaint and bounce rates, counted the way the
+     * GetEmailRates returns the complaint and hard bounce rates, counted the way the
      * sending pause counts them, plus the account-wide check that pause runs on.
      */
     GetEmailRates: OverviewKPIService_GetEmailRates;
@@ -236,7 +236,7 @@ export type GetEmailRatesRequest = {
 };
 /**
  * EmailRates is one tally in events, the unit channels/email-feedback-api pauses by:
- * every rate divides by sends, deliveries take no part.
+ * both rates divide by sends, deliveries take no part.
  */
 export type EmailRates = {
     sends: number;
@@ -244,9 +244,6 @@ export type EmailRates = {
     hardbounces: number;
     complaintRatePercent: number;
     hardBounceRatePercent: number;
-    /** the pause never reads soft bounces; they are here to be seen next to hard ones */
-    softbounces: number;
-    softBounceRatePercent: number;
 };
 /**
  * EmailPauseCheck is the very number the pause is decided on: the whole account over
@@ -267,14 +264,6 @@ export type EmailPauseCheck = {
 export type GetEmailRatesResponse_Point = {
     day: Date;
     rates: EmailRates;
-    /** this day's slice of the response bounce_reasons, in the same order and unit */
-    bounceReasons: GetEmailRatesResponse_BounceReason[];
-};
-export type GetEmailRatesResponse_BounceReason = {
-    /** the bounceReason value email-feedback-api wrote, e.g. mailbox_full */
-    reason: string;
-    hard: number;
-    soft: number;
 };
 export type GetEmailRatesResponse = {
     /** the requested application and period, one point per day */
@@ -286,11 +275,6 @@ export type GetEmailRatesResponse = {
      * differ from the two above, and that difference is the point of this field
      */
     pauseCheck: EmailPauseCheck;
-    /**
-     * bounce events of the same application and period as totals, by hard+soft desc;
-     * only bounces logged since email-feedback-api started writing bounceReason
-     */
-    bounceReasons: GetEmailRatesResponse_BounceReason[];
 };
 export type GetEmailActivityDistributionRequest = {
     applicationCode: string;