@pushwoosh/rpc-gateway-statistics-api 1.3.824 → 1.3.826

package/data.js

@@ -33,7 +33,9 @@ export const data = {
             "TARGETED",
             "LIVE_ACTIVITY_API",
             "WHATSAPP_API",
-            "SMS_API"
+            "SMS_API",
+            "INBOX_CP",
+            "INBOX_API"
         ]
     },
     "pushwoosh.statistics.types.MessageType": {
@@ -2304,6 +2306,9 @@ export const data = {
             },
             "totalPushTaps": {
                 "type": "number"
+            },
+            "pushSends": {
+                "type": "number"
             }
         }
     },
@@ -3270,6 +3275,60 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.InboxMetrics": {
+        "type": "I",
+        "fields": {
+            "sends": {
+                "type": "number"
+            },
+            "reached": {
+                "type": "number"
+            },
+            "read": {
+                "type": "number"
+            },
+            "clicks": {
+                "type": "number"
+            },
+            "dismissed": {
+                "type": "number"
+            },
+            "errors": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.InboxDetails": {
+        "type": "I",
+        "fields": {
+            "title": {
+                "type": "string"
+            },
+            "content": {
+                "type": "string"
+            },
+            "iconUrl": {
+                "type": "string"
+            },
+            "bannerUrl": {
+                "type": "string"
+            },
+            "expirationDate": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.InboxInfo": {
+        "type": "I",
+        "fields": {
+            "details": {
+                "type": "pushwoosh.statistics.statistics.v2.InboxDetails"
+            },
+            "metrics": {
+                "type": "pushwoosh.statistics.statistics.v2.InboxMetrics"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.EmailInfo": {
         "type": "I",
         "fields": {
@@ -3312,13 +3371,17 @@ export const data = {
             },
             "emailInfo": {
                 "type": "pushwoosh.statistics.statistics.v2.EmailInfo"
+            },
+            "inboxInfo": {
+                "type": "pushwoosh.statistics.statistics.v2.InboxInfo"
             }
         },
         "oneofs": {
             "info": {
                 "oneof": [
                     "pushInfo",
-                    "emailInfo"
+                    "emailInfo",
+                    "inboxInfo"
                 ]
             }
         }
@@ -5015,7 +5078,9 @@ export const data = {
             "STAGE_ERRORS",
             "STAGE_DELIVERIES",
             "STAGE_OPENED",
-            "STAGE_INTERACTIONS"
+            "STAGE_INTERACTIONS",
+            "STAGE_REACHED",
+            "STAGE_READ"
         ]
     },
     "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Kind": {
@@ -5061,7 +5126,8 @@ export const data = {
             "CHANNEL_MOBILE_PUSH",
             "CHANNEL_WEB_PUSH",
             "CHANNEL_EMAIL",
-            "CHANNEL_OTHER"
+            "CHANNEL_OTHER",
+            "CHANNEL_APP_INBOX"
         ]
     },
     "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.ChannelFunnel": {

package/package.json

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

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -952,18 +952,20 @@ export type GetAdCampaignStatisticsRequest = {
 /**
  * One row per creative of the campaign. Opens are opens of the letters that
  * carried it: the creative is chosen once per send, so the send is the unit.
+ * Every counter here belongs to ONE channel: a campaign sold in letters and in
+ * pushes at once would otherwise report an open rate over two different things.
  */
 export type AdCampaignStatisticsItem = {
     creativeId: number;
     /** letters of those sends */
     sends: number;
-    /** unique devices that opened them */
+    /** unique devices that opened a letter */
     opens: number;
     /** unique devices that clicked the banner */
     clicks: number;
     /** every click on the banner */
     totalClicks: number;
-    /** sends the creative was attached to */
+    /** sends the creative was attached to, both channels */
     messages: number;
     /**
      * A push has no link click of its own: what a recipient does with it is a tap,
@@ -972,6 +974,8 @@ export type AdCampaignStatisticsItem = {
     pushTaps: number;
     /** every tap on it */
     totalPushTaps: number;
+    /** pushes of those sends */
+    pushSends: number;
 };
 export type GetAdCampaignStatisticsResponse = {
     items: AdCampaignStatisticsItem[];

package/pushwoosh_statistics_statistics_v2.d.ts

@@ -88,6 +88,25 @@ export type PushInfo = {
     details: PushDetails;
     metrics: PushMetrics[];
 };
+export type InboxMetrics = {
+    sends: number;
+    reached: number;
+    read: number;
+    clicks: number;
+    dismissed: number;
+    errors: number;
+};
+export type InboxDetails = {
+    title: string;
+    content: string;
+    iconUrl: string;
+    bannerUrl: string;
+    expirationDate: string;
+};
+export type InboxInfo = {
+    details: InboxDetails;
+    metrics: InboxMetrics;
+};
 export type EmailInfo = {
     details: EmailDetails;
     metrics: EmailMetrics[];
@@ -100,7 +119,11 @@ export type ListResponseItem_info_emailInfo = {
     type: 'emailInfo';
     data: EmailInfo;
 };
-export type ListResponseItem_info = ListResponseItem_info_pushInfo | ListResponseItem_info_emailInfo;
+export type ListResponseItem_info_inboxInfo = {
+    type: 'inboxInfo';
+    data: InboxInfo;
+};
+export type ListResponseItem_info = ListResponseItem_info_pushInfo | ListResponseItem_info_emailInfo | ListResponseItem_info_inboxInfo;
 export type ListResponseItem = {
     id: number;
     code: string;

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -613,7 +613,14 @@ export type GetDeliveryFunnelResponse_Stage = 'STAGE_UNSPECIFIED'
  * STAGE_INTERACTIONS: what the recipient did with the letter — clicked, unsubscribed,
  * complained. Email broadcasts only, see the funnel formulas doc for why.
  */
- | 'STAGE_INTERACTIONS';
+ | 'STAGE_INTERACTIONS'
+/**
+ * STAGE_REACHED and STAGE_READ belong to the App Inbox channel alone, where they take
+ * the place of STAGE_DELIVERIES.
+ */
+ | 'STAGE_REACHED'
+/** reached, split by read / dismissed unread / still unread or expired */
+ | 'STAGE_READ';
 /**
  * Kind tells how a piece relates to its stage total. PASSED and REASON pieces are the
  * stage's own distribution: disjoint, and they add up to its count.
@@ -674,7 +681,7 @@ export type GetDeliveryFunnelResponse_Channel = 'CHANNEL_UNSPECIFIED'
 /** Safari, Chrome, Firefox */
  | 'CHANNEL_WEB_PUSH' | 'CHANNEL_EMAIL'
 /** SMS, messengers, Wallet, Windows, Baidu, Xiaomi */
- | 'CHANNEL_OTHER';
+ | 'CHANNEL_OTHER' | 'CHANNEL_APP_INBOX';
 /**
  * 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.

package/pushwoosh_statistics_types.d.ts

@@ -3,7 +3,7 @@ export type Source = 'SOURCE_UNSPECIFIED'
 /** deprecated */
  | 'AB_EXPERIMENT' | 'AB_TEST' | 'API' | 'AUTO_PUSH' | 'CP' | 'CSV' | 'CUSTOMER_JOURNEY' | 'EMAIL_API' | 'EMAIL_CP' | 'GEO_ZONE' | 'PUSH_ON_EVENT' | 'RSS' | 'SYSTEM'
 /** deprecated */
- | 'TWITTER' | 'TARGETED' | 'LIVE_ACTIVITY_API' | 'WHATSAPP_API' | 'SMS_API';
+ | 'TWITTER' | 'TARGETED' | 'LIVE_ACTIVITY_API' | 'WHATSAPP_API' | 'SMS_API' | 'INBOX_CP' | 'INBOX_API';
 export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'TRANSACTIONAL' | 'BROADCAST' | 'ALL';
 export type Platform = 'PLATFORM_UNSPECIFIED' | 'IOS'
 /** deprecated */