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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/data.js CHANGED
@@ -33,7 +33,9 @@ export const data = {
33
33
  "TARGETED",
34
34
  "LIVE_ACTIVITY_API",
35
35
  "WHATSAPP_API",
36
- "SMS_API"
36
+ "SMS_API",
37
+ "INBOX_CP",
38
+ "INBOX_API"
37
39
  ]
38
40
  },
39
41
  "pushwoosh.statistics.types.MessageType": {
@@ -3273,6 +3275,60 @@ export const data = {
3273
3275
  }
3274
3276
  }
3275
3277
  },
3278
+ "pushwoosh.statistics.statistics.v2.InboxMetrics": {
3279
+ "type": "I",
3280
+ "fields": {
3281
+ "sends": {
3282
+ "type": "number"
3283
+ },
3284
+ "reached": {
3285
+ "type": "number"
3286
+ },
3287
+ "read": {
3288
+ "type": "number"
3289
+ },
3290
+ "clicks": {
3291
+ "type": "number"
3292
+ },
3293
+ "dismissed": {
3294
+ "type": "number"
3295
+ },
3296
+ "errors": {
3297
+ "type": "number"
3298
+ }
3299
+ }
3300
+ },
3301
+ "pushwoosh.statistics.statistics.v2.InboxDetails": {
3302
+ "type": "I",
3303
+ "fields": {
3304
+ "title": {
3305
+ "type": "string"
3306
+ },
3307
+ "content": {
3308
+ "type": "string"
3309
+ },
3310
+ "iconUrl": {
3311
+ "type": "string"
3312
+ },
3313
+ "bannerUrl": {
3314
+ "type": "string"
3315
+ },
3316
+ "expirationDate": {
3317
+ "type": "string"
3318
+ }
3319
+ }
3320
+ },
3321
+ "pushwoosh.statistics.statistics.v2.InboxInfo": {
3322
+ "type": "I",
3323
+ "fields": {
3324
+ "details": {
3325
+ "type": "pushwoosh.statistics.statistics.v2.InboxDetails"
3326
+ },
3327
+ "metrics": {
3328
+ "type": "pushwoosh.statistics.statistics.v2.InboxMetrics"
3329
+ }
3330
+ }
3331
+ },
3276
3332
  "pushwoosh.statistics.statistics.v2.EmailInfo": {
3277
3333
  "type": "I",
3278
3334
  "fields": {
@@ -3315,13 +3371,17 @@ export const data = {
3315
3371
  },
3316
3372
  "emailInfo": {
3317
3373
  "type": "pushwoosh.statistics.statistics.v2.EmailInfo"
3374
+ },
3375
+ "inboxInfo": {
3376
+ "type": "pushwoosh.statistics.statistics.v2.InboxInfo"
3318
3377
  }
3319
3378
  },
3320
3379
  "oneofs": {
3321
3380
  "info": {
3322
3381
  "oneof": [
3323
3382
  "pushInfo",
3324
- "emailInfo"
3383
+ "emailInfo",
3384
+ "inboxInfo"
3325
3385
  ]
3326
3386
  }
3327
3387
  }
@@ -5018,7 +5078,9 @@ export const data = {
5018
5078
  "STAGE_ERRORS",
5019
5079
  "STAGE_DELIVERIES",
5020
5080
  "STAGE_OPENED",
5021
- "STAGE_INTERACTIONS"
5081
+ "STAGE_INTERACTIONS",
5082
+ "STAGE_REACHED",
5083
+ "STAGE_READ"
5022
5084
  ]
5023
5085
  },
5024
5086
  "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Kind": {
@@ -5064,7 +5126,8 @@ export const data = {
5064
5126
  "CHANNEL_MOBILE_PUSH",
5065
5127
  "CHANNEL_WEB_PUSH",
5066
5128
  "CHANNEL_EMAIL",
5067
- "CHANNEL_OTHER"
5129
+ "CHANNEL_OTHER",
5130
+ "CHANNEL_APP_INBOX"
5068
5131
  ]
5069
5132
  },
5070
5133
  "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.ChannelFunnel": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-gateway-statistics-api",
3
- "version": "1.3.825",
3
+ "version": "1.3.826",
4
4
  "description": "Statistics API gateway HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -88,6 +88,25 @@ export type PushInfo = {
88
88
  details: PushDetails;
89
89
  metrics: PushMetrics[];
90
90
  };
91
+ export type InboxMetrics = {
92
+ sends: number;
93
+ reached: number;
94
+ read: number;
95
+ clicks: number;
96
+ dismissed: number;
97
+ errors: number;
98
+ };
99
+ export type InboxDetails = {
100
+ title: string;
101
+ content: string;
102
+ iconUrl: string;
103
+ bannerUrl: string;
104
+ expirationDate: string;
105
+ };
106
+ export type InboxInfo = {
107
+ details: InboxDetails;
108
+ metrics: InboxMetrics;
109
+ };
91
110
  export type EmailInfo = {
92
111
  details: EmailDetails;
93
112
  metrics: EmailMetrics[];
@@ -100,7 +119,11 @@ export type ListResponseItem_info_emailInfo = {
100
119
  type: 'emailInfo';
101
120
  data: EmailInfo;
102
121
  };
103
- export type ListResponseItem_info = ListResponseItem_info_pushInfo | ListResponseItem_info_emailInfo;
122
+ export type ListResponseItem_info_inboxInfo = {
123
+ type: 'inboxInfo';
124
+ data: InboxInfo;
125
+ };
126
+ export type ListResponseItem_info = ListResponseItem_info_pushInfo | ListResponseItem_info_emailInfo | ListResponseItem_info_inboxInfo;
104
127
  export type ListResponseItem = {
105
128
  id: number;
106
129
  code: string;
@@ -613,7 +613,14 @@ export type GetDeliveryFunnelResponse_Stage = 'STAGE_UNSPECIFIED'
613
613
  * STAGE_INTERACTIONS: what the recipient did with the letter — clicked, unsubscribed,
614
614
  * complained. Email broadcasts only, see the funnel formulas doc for why.
615
615
  */
616
- | 'STAGE_INTERACTIONS';
616
+ | 'STAGE_INTERACTIONS'
617
+ /**
618
+ * STAGE_REACHED and STAGE_READ belong to the App Inbox channel alone, where they take
619
+ * the place of STAGE_DELIVERIES.
620
+ */
621
+ | 'STAGE_REACHED'
622
+ /** reached, split by read / dismissed unread / still unread or expired */
623
+ | 'STAGE_READ';
617
624
  /**
618
625
  * Kind tells how a piece relates to its stage total. PASSED and REASON pieces are the
619
626
  * stage's own distribution: disjoint, and they add up to its count.
@@ -674,7 +681,7 @@ export type GetDeliveryFunnelResponse_Channel = 'CHANNEL_UNSPECIFIED'
674
681
  /** Safari, Chrome, Firefox */
675
682
  | 'CHANNEL_WEB_PUSH' | 'CHANNEL_EMAIL'
676
683
  /** SMS, messengers, Wallet, Windows, Baidu, Xiaomi */
677
- | 'CHANNEL_OTHER';
684
+ | 'CHANNEL_OTHER' | 'CHANNEL_APP_INBOX';
678
685
  /**
679
686
  * ChannelFunnel is one channel's whole funnel. The form belongs here rather than to
680
687
  * the response: a message on iOS and Email carries two different ones at once.
@@ -3,7 +3,7 @@ export type Source = 'SOURCE_UNSPECIFIED'
3
3
  /** deprecated */
4
4
  | 'AB_EXPERIMENT' | 'AB_TEST' | 'API' | 'AUTO_PUSH' | 'CP' | 'CSV' | 'CUSTOMER_JOURNEY' | 'EMAIL_API' | 'EMAIL_CP' | 'GEO_ZONE' | 'PUSH_ON_EVENT' | 'RSS' | 'SYSTEM'
5
5
  /** deprecated */
6
- | 'TWITTER' | 'TARGETED' | 'LIVE_ACTIVITY_API' | 'WHATSAPP_API' | 'SMS_API';
6
+ | 'TWITTER' | 'TARGETED' | 'LIVE_ACTIVITY_API' | 'WHATSAPP_API' | 'SMS_API' | 'INBOX_CP' | 'INBOX_API';
7
7
  export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'TRANSACTIONAL' | 'BROADCAST' | 'ALL';
8
8
  export type Platform = 'PLATFORM_UNSPECIFIED' | 'IOS'
9
9
  /** deprecated */