@pushwoosh/rpc-gateway-journey-data 0.26.318 → 0.26.320

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
@@ -172,6 +172,18 @@ export const data = {
172
172
  "method": "post",
173
173
  "path": "/api/v2/journeygateway/{uuid}/users"
174
174
  },
175
+ "GetJourneyMetrics": {
176
+ "request": "pushwoosh.cj.journey.GetJourneyMetricsRequest",
177
+ "response": "pushwoosh.cj.journey.GetJourneyMetricsResponse",
178
+ "method": "post",
179
+ "path": "/api/v2/journeygateway/{uuid}/statistics/metrics"
180
+ },
181
+ "GetJourneyDeliveryReport": {
182
+ "request": "pushwoosh.cj.journey.GetJourneyDeliveryReportRequest",
183
+ "response": "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse",
184
+ "method": "post",
185
+ "path": "/api/v2/journeygateway/{uuid}/statistics/delivery-report"
186
+ },
175
187
  "GetVoucherPools": {
176
188
  "request": "pushwoosh.cj.journey.GetVoucherPoolsRequest",
177
189
  "response": "pushwoosh.cj.journey.GetVoucherPoolsResponse",
@@ -582,6 +594,9 @@ export const data = {
582
594
  },
583
595
  "unshowableSends": {
584
596
  "type": "number"
597
+ },
598
+ "recipients": {
599
+ "type": "number"
585
600
  }
586
601
  }
587
602
  },
@@ -619,6 +634,9 @@ export const data = {
619
634
  },
620
635
  "errors": {
621
636
  "type": "number"
637
+ },
638
+ "recipients": {
639
+ "type": "number"
622
640
  }
623
641
  }
624
642
  },
@@ -633,6 +651,9 @@ export const data = {
633
651
  },
634
652
  "errors": {
635
653
  "type": "number"
654
+ },
655
+ "recipients": {
656
+ "type": "number"
636
657
  }
637
658
  }
638
659
  },
@@ -650,6 +671,9 @@ export const data = {
650
671
  },
651
672
  "errors": {
652
673
  "type": "number"
674
+ },
675
+ "recipients": {
676
+ "type": "number"
653
677
  }
654
678
  }
655
679
  },
@@ -696,6 +720,9 @@ export const data = {
696
720
  },
697
721
  "errors": {
698
722
  "type": "number"
723
+ },
724
+ "recipients": {
725
+ "type": "number"
699
726
  }
700
727
  }
701
728
  },
@@ -3869,6 +3896,352 @@ export const data = {
3869
3896
  }
3870
3897
  }
3871
3898
  },
3899
+ "pushwoosh.cj.journey.Channel": {
3900
+ "type": "E",
3901
+ "values": [
3902
+ "CHANNEL_UNSPECIFIED",
3903
+ "PUSH",
3904
+ "EMAIL",
3905
+ "WHATSAPP",
3906
+ "SMS",
3907
+ "IN_APP"
3908
+ ]
3909
+ },
3910
+ "pushwoosh.cj.journey.GetJourneyMetricsRequest": {
3911
+ "type": "I",
3912
+ "fields": {
3913
+ "uuid": {
3914
+ "type": "string"
3915
+ },
3916
+ "application": {
3917
+ "type": "string"
3918
+ },
3919
+ "timestampFrom": {
3920
+ "type": "Date"
3921
+ },
3922
+ "timestampTo": {
3923
+ "type": "Date"
3924
+ },
3925
+ "timezone": {
3926
+ "type": "string"
3927
+ },
3928
+ "channels": {
3929
+ "type": "pushwoosh.cj.journey.Channel",
3930
+ "array": true
3931
+ }
3932
+ }
3933
+ },
3934
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.PushMetrics": {
3935
+ "type": "I",
3936
+ "fields": {
3937
+ "sends": {
3938
+ "type": "number",
3939
+ "array": true
3940
+ },
3941
+ "opens": {
3942
+ "type": "number",
3943
+ "array": true
3944
+ },
3945
+ "deliveryIssues": {
3946
+ "type": "number",
3947
+ "array": true
3948
+ }
3949
+ }
3950
+ },
3951
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.EmailMetrics": {
3952
+ "type": "I",
3953
+ "fields": {
3954
+ "sends": {
3955
+ "type": "number",
3956
+ "array": true
3957
+ },
3958
+ "opens": {
3959
+ "type": "number",
3960
+ "array": true
3961
+ },
3962
+ "deliveryIssues": {
3963
+ "type": "number",
3964
+ "array": true
3965
+ },
3966
+ "clicks": {
3967
+ "type": "number",
3968
+ "array": true
3969
+ }
3970
+ }
3971
+ },
3972
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.WhatsAppMetrics": {
3973
+ "type": "I",
3974
+ "fields": {
3975
+ "sends": {
3976
+ "type": "number",
3977
+ "array": true
3978
+ },
3979
+ "read": {
3980
+ "type": "number",
3981
+ "array": true
3982
+ },
3983
+ "deliveryIssues": {
3984
+ "type": "number",
3985
+ "array": true
3986
+ }
3987
+ }
3988
+ },
3989
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.SMSMetrics": {
3990
+ "type": "I",
3991
+ "fields": {
3992
+ "sends": {
3993
+ "type": "number",
3994
+ "array": true
3995
+ },
3996
+ "opens": {
3997
+ "type": "number",
3998
+ "array": true
3999
+ },
4000
+ "deliveries": {
4001
+ "type": "number",
4002
+ "array": true
4003
+ },
4004
+ "deliveryIssues": {
4005
+ "type": "number",
4006
+ "array": true
4007
+ }
4008
+ }
4009
+ },
4010
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.InAppMetrics": {
4011
+ "type": "I",
4012
+ "fields": {
4013
+ "sends": {
4014
+ "type": "number",
4015
+ "array": true
4016
+ },
4017
+ "impressions": {
4018
+ "type": "number",
4019
+ "array": true
4020
+ },
4021
+ "interactions": {
4022
+ "type": "number",
4023
+ "array": true
4024
+ },
4025
+ "deliveryIssues": {
4026
+ "type": "number",
4027
+ "array": true
4028
+ }
4029
+ }
4030
+ },
4031
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.ChannelMetrics": {
4032
+ "type": "I",
4033
+ "fields": {
4034
+ "push": {
4035
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.PushMetrics"
4036
+ },
4037
+ "email": {
4038
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.EmailMetrics"
4039
+ },
4040
+ "whatsapp": {
4041
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.WhatsAppMetrics"
4042
+ },
4043
+ "sms": {
4044
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.SMSMetrics"
4045
+ },
4046
+ "inApp": {
4047
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.InAppMetrics"
4048
+ }
4049
+ }
4050
+ },
4051
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.PushTotals": {
4052
+ "type": "I",
4053
+ "fields": {
4054
+ "sent": {
4055
+ "type": "number"
4056
+ },
4057
+ "recipients": {
4058
+ "type": "number"
4059
+ },
4060
+ "opened": {
4061
+ "type": "number"
4062
+ },
4063
+ "deliveryIssues": {
4064
+ "type": "number"
4065
+ }
4066
+ }
4067
+ },
4068
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.EmailTotals": {
4069
+ "type": "I",
4070
+ "fields": {
4071
+ "sent": {
4072
+ "type": "number"
4073
+ },
4074
+ "recipients": {
4075
+ "type": "number"
4076
+ },
4077
+ "opened": {
4078
+ "type": "number"
4079
+ },
4080
+ "deliveryIssues": {
4081
+ "type": "number"
4082
+ },
4083
+ "hardBounces": {
4084
+ "type": "number"
4085
+ },
4086
+ "softBounces": {
4087
+ "type": "number"
4088
+ },
4089
+ "complaints": {
4090
+ "type": "number"
4091
+ },
4092
+ "clicks": {
4093
+ "type": "number"
4094
+ },
4095
+ "unsubscribes": {
4096
+ "type": "number"
4097
+ }
4098
+ }
4099
+ },
4100
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.WhatsAppTotals": {
4101
+ "type": "I",
4102
+ "fields": {
4103
+ "sent": {
4104
+ "type": "number"
4105
+ },
4106
+ "recipients": {
4107
+ "type": "number"
4108
+ },
4109
+ "read": {
4110
+ "type": "number"
4111
+ },
4112
+ "errors": {
4113
+ "type": "number"
4114
+ }
4115
+ }
4116
+ },
4117
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.SMSTotals": {
4118
+ "type": "I",
4119
+ "fields": {
4120
+ "sent": {
4121
+ "type": "number"
4122
+ },
4123
+ "recipients": {
4124
+ "type": "number"
4125
+ },
4126
+ "opened": {
4127
+ "type": "number"
4128
+ },
4129
+ "errors": {
4130
+ "type": "number"
4131
+ }
4132
+ }
4133
+ },
4134
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.InAppTotals": {
4135
+ "type": "I",
4136
+ "fields": {
4137
+ "sent": {
4138
+ "type": "number"
4139
+ },
4140
+ "impressions": {
4141
+ "type": "number"
4142
+ },
4143
+ "interactions": {
4144
+ "type": "number"
4145
+ },
4146
+ "errors": {
4147
+ "type": "number"
4148
+ }
4149
+ }
4150
+ },
4151
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.ChannelTotals": {
4152
+ "type": "I",
4153
+ "fields": {
4154
+ "push": {
4155
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.PushTotals"
4156
+ },
4157
+ "email": {
4158
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.EmailTotals"
4159
+ },
4160
+ "whatsapp": {
4161
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.WhatsAppTotals"
4162
+ },
4163
+ "sms": {
4164
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.SMSTotals"
4165
+ },
4166
+ "inApp": {
4167
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.InAppTotals"
4168
+ }
4169
+ }
4170
+ },
4171
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse": {
4172
+ "type": "I",
4173
+ "fields": {
4174
+ "timestamps": {
4175
+ "type": "Date",
4176
+ "array": true
4177
+ },
4178
+ "channelMetrics": {
4179
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.ChannelMetrics"
4180
+ },
4181
+ "totals": {
4182
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.ChannelTotals"
4183
+ }
4184
+ }
4185
+ },
4186
+ "pushwoosh.cj.journey.GetJourneyDeliveryReportRequest": {
4187
+ "type": "I",
4188
+ "fields": {
4189
+ "application": {
4190
+ "type": "string"
4191
+ },
4192
+ "uuid": {
4193
+ "type": "string"
4194
+ },
4195
+ "timestampFrom": {
4196
+ "type": "Date"
4197
+ },
4198
+ "timestampTo": {
4199
+ "type": "Date"
4200
+ },
4201
+ "timezone": {
4202
+ "type": "string"
4203
+ },
4204
+ "channels": {
4205
+ "type": "pushwoosh.cj.journey.Channel",
4206
+ "array": true
4207
+ }
4208
+ }
4209
+ },
4210
+ "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse.DeliveryError": {
4211
+ "type": "I",
4212
+ "fields": {
4213
+ "name": {
4214
+ "type": "string"
4215
+ },
4216
+ "description": {
4217
+ "type": "string"
4218
+ },
4219
+ "count": {
4220
+ "type": "number"
4221
+ }
4222
+ }
4223
+ },
4224
+ "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse.ChannelDeliveryReport": {
4225
+ "type": "I",
4226
+ "fields": {
4227
+ "channel": {
4228
+ "type": "string"
4229
+ },
4230
+ "errors": {
4231
+ "type": "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse.DeliveryError",
4232
+ "array": true
4233
+ }
4234
+ }
4235
+ },
4236
+ "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse": {
4237
+ "type": "I",
4238
+ "fields": {
4239
+ "channels": {
4240
+ "type": "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse.ChannelDeliveryReport",
4241
+ "array": true
4242
+ }
4243
+ }
4244
+ },
3872
4245
  "pushwoosh.cj.journey.MultiEntry": {
3873
4246
  "type": "I",
3874
4247
  "fields": {
@@ -6364,6 +6737,10 @@ export const data = {
6364
6737
  "platforms": {
6365
6738
  "type": "string",
6366
6739
  "array": true
6740
+ },
6741
+ "hwids": {
6742
+ "type": "string",
6743
+ "array": true
6367
6744
  }
6368
6745
  }
6369
6746
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-gateway-journey-data",
3
- "version": "0.26.318",
3
+ "version": "0.26.320",
4
4
  "description": "CJ api gateway HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -29,6 +29,8 @@ export interface Journey {
29
29
  GetAccountRestrictionValues(request: GetAccountRestrictionValuesRequest): Promise<GetAccountRestrictionValuesResponse>;
30
30
  GetJourneyGeneralTimeStatistics(request: GetJourneyGeneralTimeStatisticsRequest): Promise<GetJourneyGeneralTimeStatisticsResponse>;
31
31
  GetJourneyUsers(request: GetJourneyUsersRequest): Promise<GetJourneyUsersResponse>;
32
+ GetJourneyMetrics(request: GetJourneyMetricsRequest): Promise<GetJourneyMetricsResponse>;
33
+ GetJourneyDeliveryReport(request: GetJourneyDeliveryReportRequest): Promise<GetJourneyDeliveryReportResponse>;
32
34
  GetVoucherPools(request: GetVoucherPoolsRequest): Promise<GetVoucherPoolsResponse>;
33
35
  StartJourneyV2(request: StartJourneyV2Request): Promise<StartJourneyResponse>;
34
36
  PauseJourneyV2(request: PauseJourneyV2Request): Promise<PauseJourneyResponse>;
@@ -200,6 +202,7 @@ export type PointStatSendPush = {
200
202
  skippedDueCappingSettings: number;
201
203
  errors: number;
202
204
  unshowableSends: number;
205
+ recipients: number;
203
206
  };
204
207
  export type PointStatInApp = {
205
208
  shows: number;
@@ -213,17 +216,20 @@ export type PointStatSendSms = {
213
216
  delivered: number;
214
217
  skipped: number;
215
218
  errors: number;
219
+ recipients: number;
216
220
  };
217
221
  export type PointStatSendLine = {
218
222
  sent: number;
219
223
  delivered: number;
220
224
  errors: number;
225
+ recipients: number;
221
226
  };
222
227
  export type PointStatSendWhatsApp = {
223
228
  sent: number;
224
229
  totalOpened: number;
225
230
  skipped: number;
226
231
  errors: number;
232
+ recipients: number;
227
233
  };
228
234
  export type PointStatSendData = {
229
235
  sent: number;
@@ -240,6 +246,7 @@ export type PointStatSendEmail = {
240
246
  complaints: number;
241
247
  skipped: number;
242
248
  errors: number;
249
+ recipients: number;
243
250
  };
244
251
  export type PointStatMessageBus = {};
245
252
  export type PointStatGoalEvent = {};
@@ -1432,6 +1439,117 @@ export type GetJourneyUsersResponse = {
1432
1439
  users: GetJourneyUsersResponse_UserPoint[];
1433
1440
  totals: number;
1434
1441
  };
1442
+ export type Channel = 'CHANNEL_UNSPECIFIED' | 'PUSH' | 'EMAIL' | 'WHATSAPP' | 'SMS' | 'IN_APP';
1443
+ export type GetJourneyMetricsRequest = {
1444
+ uuid?: string;
1445
+ application?: string;
1446
+ timestampFrom?: Date;
1447
+ timestampTo?: Date;
1448
+ timezone?: string;
1449
+ channels?: Channel[];
1450
+ };
1451
+ export type GetJourneyMetricsResponse_PushMetrics = {
1452
+ sends: number[];
1453
+ opens: number[];
1454
+ deliveryIssues: number[];
1455
+ };
1456
+ export type GetJourneyMetricsResponse_EmailMetrics = {
1457
+ sends: number[];
1458
+ opens: number[];
1459
+ deliveryIssues: number[];
1460
+ clicks: number[];
1461
+ };
1462
+ export type GetJourneyMetricsResponse_WhatsAppMetrics = {
1463
+ sends: number[];
1464
+ read: number[];
1465
+ deliveryIssues: number[];
1466
+ };
1467
+ export type GetJourneyMetricsResponse_SMSMetrics = {
1468
+ sends: number[];
1469
+ opens: number[];
1470
+ deliveries: number[];
1471
+ deliveryIssues: number[];
1472
+ };
1473
+ export type GetJourneyMetricsResponse_InAppMetrics = {
1474
+ sends: number[];
1475
+ impressions: number[];
1476
+ interactions: number[];
1477
+ deliveryIssues: number[];
1478
+ };
1479
+ export type GetJourneyMetricsResponse_ChannelMetrics = {
1480
+ push: GetJourneyMetricsResponse_PushMetrics;
1481
+ email: GetJourneyMetricsResponse_EmailMetrics;
1482
+ whatsapp: GetJourneyMetricsResponse_WhatsAppMetrics;
1483
+ sms: GetJourneyMetricsResponse_SMSMetrics;
1484
+ inApp: GetJourneyMetricsResponse_InAppMetrics;
1485
+ };
1486
+ export type GetJourneyMetricsResponse_PushTotals = {
1487
+ sent: number;
1488
+ recipients: number;
1489
+ opened: number;
1490
+ deliveryIssues: number;
1491
+ };
1492
+ export type GetJourneyMetricsResponse_EmailTotals = {
1493
+ sent: number;
1494
+ recipients: number;
1495
+ opened: number;
1496
+ deliveryIssues: number;
1497
+ hardBounces: number;
1498
+ softBounces: number;
1499
+ complaints: number;
1500
+ clicks: number;
1501
+ unsubscribes: number;
1502
+ };
1503
+ export type GetJourneyMetricsResponse_WhatsAppTotals = {
1504
+ sent: number;
1505
+ recipients: number;
1506
+ read: number;
1507
+ errors: number;
1508
+ };
1509
+ export type GetJourneyMetricsResponse_SMSTotals = {
1510
+ sent: number;
1511
+ recipients: number;
1512
+ opened: number;
1513
+ errors: number;
1514
+ };
1515
+ export type GetJourneyMetricsResponse_InAppTotals = {
1516
+ sent: number;
1517
+ impressions: number;
1518
+ interactions: number;
1519
+ errors: number;
1520
+ };
1521
+ export type GetJourneyMetricsResponse_ChannelTotals = {
1522
+ push: GetJourneyMetricsResponse_PushTotals;
1523
+ email: GetJourneyMetricsResponse_EmailTotals;
1524
+ whatsapp: GetJourneyMetricsResponse_WhatsAppTotals;
1525
+ sms: GetJourneyMetricsResponse_SMSTotals;
1526
+ inApp: GetJourneyMetricsResponse_InAppTotals;
1527
+ };
1528
+ export type GetJourneyMetricsResponse = {
1529
+ timestamps: Date[];
1530
+ channelMetrics: GetJourneyMetricsResponse_ChannelMetrics;
1531
+ totals: GetJourneyMetricsResponse_ChannelTotals;
1532
+ };
1533
+ export type GetJourneyDeliveryReportRequest = {
1534
+ application?: string;
1535
+ uuid?: string;
1536
+ timestampFrom?: Date;
1537
+ timestampTo?: Date;
1538
+ timezone?: string;
1539
+ channels?: Channel[];
1540
+ };
1541
+ export type GetJourneyDeliveryReportResponse_DeliveryError = {
1542
+ name: string;
1543
+ description: string;
1544
+ count: number;
1545
+ };
1546
+ export type GetJourneyDeliveryReportResponse_ChannelDeliveryReport = {
1547
+ channel: string;
1548
+ errors: GetJourneyDeliveryReportResponse_DeliveryError[];
1549
+ };
1550
+ export type GetJourneyDeliveryReportResponse = {
1551
+ channels: GetJourneyDeliveryReportResponse_ChannelDeliveryReport[];
1552
+ };
1435
1553
  export type MultiEntry = {
1436
1554
  enabled: boolean;
1437
1555
  attributeName: string;
@@ -932,6 +932,7 @@ export type FilterExpression_Event = {
932
932
  date: FilterExpression_Event_Date;
933
933
  attributes: FilterExpression_Event_Attribute[];
934
934
  platforms: string[];
935
+ hwids: string[];
935
936
  };
936
937
  export type FilterExpression_Updated_Condition_Lte = {
937
938
  value: Date;