@pushwoosh/rpc-gateway-statistics-api 1.3.729 → 1.3.730

package/data.js

@@ -4105,9 +4105,41 @@ export const data = {
             "BASIC_FORM_REASON_UNSPECIFIED",
             "BASIC_FORM_REASON_RETENTION",
             "BASIC_FORM_REASON_UNAVAILABLE",
-            "BASIC_FORM_REASON_NO_DELIVERIES"
+            "BASIC_FORM_REASON_NO_DELIVERIES",
+            "BASIC_FORM_REASON_NOT_APPLICABLE"
         ]
     },
+    "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Channel": {
+        "type": "E",
+        "values": [
+            "CHANNEL_UNSPECIFIED",
+            "CHANNEL_MOBILE_PUSH",
+            "CHANNEL_WEB_PUSH",
+            "CHANNEL_EMAIL",
+            "CHANNEL_OTHER"
+        ]
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ChannelFunnel": {
+        "type": "I",
+        "fields": {
+            "channel": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Channel"
+            },
+            "funnel": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.StageItem",
+                "array": true
+            },
+            "deliveriesForm": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.DeliveriesForm"
+            },
+            "basicFormReason": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.BasicFormReason"
+            },
+            "confirmedDeliveries": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ConfirmedDeliveries"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.PlatformCount": {
         "type": "I",
         "fields": {
@@ -4190,8 +4222,8 @@ export const data = {
     "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse": {
         "type": "I",
         "fields": {
-            "funnel": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.StageItem",
+            "channels": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ChannelFunnel",
                 "array": true
             },
             "windowFrom": {
@@ -4202,15 +4234,6 @@ export const data = {
             },
             "funnelState": {
                 "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.FunnelState"
-            },
-            "deliveriesForm": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.DeliveriesForm"
-            },
-            "basicFormReason": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.BasicFormReason"
-            },
-            "confirmedDeliveries": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ConfirmedDeliveries"
             }
         }
     },

package/package.json

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

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -582,7 +582,34 @@ export type GetMessageDeliveryFunnelResponse_BasicFormReason = 'BASIC_FORM_REASO
 /** system message, account not covered */
  | 'BASIC_FORM_REASON_UNAVAILABLE'
 /** nothing accepted yet — say nothing in the UI */
- | 'BASIC_FORM_REASON_NO_DELIVERIES';
+ | 'BASIC_FORM_REASON_NO_DELIVERIES'
+/**
+ * NOT_APPLICABLE: the channel has no alert state at all, so the basic form is what
+ * it always carries — not a degradation the client should explain away.
+ */
+ | 'BASIC_FORM_REASON_NOT_APPLICABLE';
+/**
+ * Channel groups platforms by how their funnel reads. Web push is apart from mobile
+ * push because its alert state is always on: an ALERTS_DISABLED row could not fill.
+ */
+export type GetMessageDeliveryFunnelResponse_Channel = 'CHANNEL_UNSPECIFIED'
+/** iOS, OSX, Android, Amazon, Huawei */
+ | 'CHANNEL_MOBILE_PUSH'
+/** Safari, Chrome, Firefox */
+ | 'CHANNEL_WEB_PUSH' | 'CHANNEL_EMAIL'
+/** SMS, messengers, Wallet, Windows, Baidu, Xiaomi */
+ | 'CHANNEL_OTHER';
+/**
+ * ChannelFunnel is one channel's whole funnel. The form belongs here rather than to
+ * the response: a message on iOS and Email carries two different ones at once.
+ */
+export type GetMessageDeliveryFunnelResponse_ChannelFunnel = {
+    channel: GetMessageDeliveryFunnelResponse_Channel;
+    funnel: GetMessageDeliveryFunnelResponse_StageItem[];
+    deliveriesForm: GetMessageDeliveryFunnelResponse_DeliveriesForm;
+    basicFormReason: GetMessageDeliveryFunnelResponse_BasicFormReason;
+    confirmedDeliveries: GetMessageDeliveryFunnelResponse_ConfirmedDeliveries;
+};
 /**
  * PlatformCount is one platform's share of the number above it; the parent is always
  * their sum. A platform with nothing to report is absent, which is not a zero.
@@ -631,7 +658,11 @@ export type GetMessageDeliveryFunnelResponse_ConfirmedDeliveries = {
     platforms: GetMessageDeliveryFunnelResponse_PlatformCount[];
 };
 export type GetMessageDeliveryFunnelResponse = {
-    funnel: GetMessageDeliveryFunnelResponse_StageItem[];
+    /**
+     * Channels are not ordered; a client looks one up by its channel field, not by
+     * position.
+     */
+    channels: GetMessageDeliveryFunnelResponse_ChannelFunnel[];
     /**
      * The window the funnel was computed over, derived from the data: the numbers are
      * meaningless without it, and the pre-aggregate TTL can cut it short.
@@ -639,9 +670,6 @@ export type GetMessageDeliveryFunnelResponse = {
     windowFrom: Date;
     windowTo: Date;
     funnelState: GetMessageDeliveryFunnelResponse_FunnelState;
-    deliveriesForm: GetMessageDeliveryFunnelResponse_DeliveriesForm;
-    basicFormReason: GetMessageDeliveryFunnelResponse_BasicFormReason;
-    confirmedDeliveries: GetMessageDeliveryFunnelResponse_ConfirmedDeliveries;
 };
 /**
  * GetMessageDeliveryTimelineRequest asks for one message's metrics over time. Unlike