@pushwoosh/rpc-gateway-journey-data 0.26.317 → 0.26.319

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",
@@ -3869,6 +3881,352 @@ export const data = {
3869
3881
  }
3870
3882
  }
3871
3883
  },
3884
+ "pushwoosh.cj.journey.Channel": {
3885
+ "type": "E",
3886
+ "values": [
3887
+ "CHANNEL_UNSPECIFIED",
3888
+ "PUSH",
3889
+ "EMAIL",
3890
+ "WHATSAPP",
3891
+ "SMS",
3892
+ "IN_APP"
3893
+ ]
3894
+ },
3895
+ "pushwoosh.cj.journey.GetJourneyMetricsRequest": {
3896
+ "type": "I",
3897
+ "fields": {
3898
+ "uuid": {
3899
+ "type": "string"
3900
+ },
3901
+ "application": {
3902
+ "type": "string"
3903
+ },
3904
+ "timestampFrom": {
3905
+ "type": "Date"
3906
+ },
3907
+ "timestampTo": {
3908
+ "type": "Date"
3909
+ },
3910
+ "timezone": {
3911
+ "type": "string"
3912
+ },
3913
+ "channels": {
3914
+ "type": "pushwoosh.cj.journey.Channel",
3915
+ "array": true
3916
+ }
3917
+ }
3918
+ },
3919
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.PushMetrics": {
3920
+ "type": "I",
3921
+ "fields": {
3922
+ "sends": {
3923
+ "type": "number",
3924
+ "array": true
3925
+ },
3926
+ "opens": {
3927
+ "type": "number",
3928
+ "array": true
3929
+ },
3930
+ "deliveryIssues": {
3931
+ "type": "number",
3932
+ "array": true
3933
+ }
3934
+ }
3935
+ },
3936
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.EmailMetrics": {
3937
+ "type": "I",
3938
+ "fields": {
3939
+ "sends": {
3940
+ "type": "number",
3941
+ "array": true
3942
+ },
3943
+ "opens": {
3944
+ "type": "number",
3945
+ "array": true
3946
+ },
3947
+ "deliveryIssues": {
3948
+ "type": "number",
3949
+ "array": true
3950
+ },
3951
+ "clicks": {
3952
+ "type": "number",
3953
+ "array": true
3954
+ }
3955
+ }
3956
+ },
3957
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.WhatsAppMetrics": {
3958
+ "type": "I",
3959
+ "fields": {
3960
+ "sends": {
3961
+ "type": "number",
3962
+ "array": true
3963
+ },
3964
+ "read": {
3965
+ "type": "number",
3966
+ "array": true
3967
+ },
3968
+ "deliveryIssues": {
3969
+ "type": "number",
3970
+ "array": true
3971
+ }
3972
+ }
3973
+ },
3974
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.SMSMetrics": {
3975
+ "type": "I",
3976
+ "fields": {
3977
+ "sends": {
3978
+ "type": "number",
3979
+ "array": true
3980
+ },
3981
+ "opens": {
3982
+ "type": "number",
3983
+ "array": true
3984
+ },
3985
+ "deliveries": {
3986
+ "type": "number",
3987
+ "array": true
3988
+ },
3989
+ "deliveryIssues": {
3990
+ "type": "number",
3991
+ "array": true
3992
+ }
3993
+ }
3994
+ },
3995
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.InAppMetrics": {
3996
+ "type": "I",
3997
+ "fields": {
3998
+ "sends": {
3999
+ "type": "number",
4000
+ "array": true
4001
+ },
4002
+ "impressions": {
4003
+ "type": "number",
4004
+ "array": true
4005
+ },
4006
+ "interactions": {
4007
+ "type": "number",
4008
+ "array": true
4009
+ },
4010
+ "deliveryIssues": {
4011
+ "type": "number",
4012
+ "array": true
4013
+ }
4014
+ }
4015
+ },
4016
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.ChannelMetrics": {
4017
+ "type": "I",
4018
+ "fields": {
4019
+ "push": {
4020
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.PushMetrics"
4021
+ },
4022
+ "email": {
4023
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.EmailMetrics"
4024
+ },
4025
+ "whatsapp": {
4026
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.WhatsAppMetrics"
4027
+ },
4028
+ "sms": {
4029
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.SMSMetrics"
4030
+ },
4031
+ "inApp": {
4032
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.InAppMetrics"
4033
+ }
4034
+ }
4035
+ },
4036
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.PushTotals": {
4037
+ "type": "I",
4038
+ "fields": {
4039
+ "sent": {
4040
+ "type": "number"
4041
+ },
4042
+ "recipients": {
4043
+ "type": "number"
4044
+ },
4045
+ "opened": {
4046
+ "type": "number"
4047
+ },
4048
+ "deliveryIssues": {
4049
+ "type": "number"
4050
+ }
4051
+ }
4052
+ },
4053
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.EmailTotals": {
4054
+ "type": "I",
4055
+ "fields": {
4056
+ "sent": {
4057
+ "type": "number"
4058
+ },
4059
+ "recipients": {
4060
+ "type": "number"
4061
+ },
4062
+ "opened": {
4063
+ "type": "number"
4064
+ },
4065
+ "deliveryIssues": {
4066
+ "type": "number"
4067
+ },
4068
+ "hardBounces": {
4069
+ "type": "number"
4070
+ },
4071
+ "softBounces": {
4072
+ "type": "number"
4073
+ },
4074
+ "complaints": {
4075
+ "type": "number"
4076
+ },
4077
+ "clicks": {
4078
+ "type": "number"
4079
+ },
4080
+ "unsubscribes": {
4081
+ "type": "number"
4082
+ }
4083
+ }
4084
+ },
4085
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.WhatsAppTotals": {
4086
+ "type": "I",
4087
+ "fields": {
4088
+ "sent": {
4089
+ "type": "number"
4090
+ },
4091
+ "recipients": {
4092
+ "type": "number"
4093
+ },
4094
+ "read": {
4095
+ "type": "number"
4096
+ },
4097
+ "errors": {
4098
+ "type": "number"
4099
+ }
4100
+ }
4101
+ },
4102
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.SMSTotals": {
4103
+ "type": "I",
4104
+ "fields": {
4105
+ "sent": {
4106
+ "type": "number"
4107
+ },
4108
+ "recipients": {
4109
+ "type": "number"
4110
+ },
4111
+ "opened": {
4112
+ "type": "number"
4113
+ },
4114
+ "errors": {
4115
+ "type": "number"
4116
+ }
4117
+ }
4118
+ },
4119
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.InAppTotals": {
4120
+ "type": "I",
4121
+ "fields": {
4122
+ "sent": {
4123
+ "type": "number"
4124
+ },
4125
+ "impressions": {
4126
+ "type": "number"
4127
+ },
4128
+ "interactions": {
4129
+ "type": "number"
4130
+ },
4131
+ "errors": {
4132
+ "type": "number"
4133
+ }
4134
+ }
4135
+ },
4136
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse.ChannelTotals": {
4137
+ "type": "I",
4138
+ "fields": {
4139
+ "push": {
4140
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.PushTotals"
4141
+ },
4142
+ "email": {
4143
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.EmailTotals"
4144
+ },
4145
+ "whatsapp": {
4146
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.WhatsAppTotals"
4147
+ },
4148
+ "sms": {
4149
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.SMSTotals"
4150
+ },
4151
+ "inApp": {
4152
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.InAppTotals"
4153
+ }
4154
+ }
4155
+ },
4156
+ "pushwoosh.cj.journey.GetJourneyMetricsResponse": {
4157
+ "type": "I",
4158
+ "fields": {
4159
+ "timestamps": {
4160
+ "type": "Date",
4161
+ "array": true
4162
+ },
4163
+ "channelMetrics": {
4164
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.ChannelMetrics"
4165
+ },
4166
+ "totals": {
4167
+ "type": "pushwoosh.cj.journey.GetJourneyMetricsResponse.ChannelTotals"
4168
+ }
4169
+ }
4170
+ },
4171
+ "pushwoosh.cj.journey.GetJourneyDeliveryReportRequest": {
4172
+ "type": "I",
4173
+ "fields": {
4174
+ "application": {
4175
+ "type": "string"
4176
+ },
4177
+ "uuid": {
4178
+ "type": "string"
4179
+ },
4180
+ "timestampFrom": {
4181
+ "type": "Date"
4182
+ },
4183
+ "timestampTo": {
4184
+ "type": "Date"
4185
+ },
4186
+ "timezone": {
4187
+ "type": "string"
4188
+ },
4189
+ "channels": {
4190
+ "type": "pushwoosh.cj.journey.Channel",
4191
+ "array": true
4192
+ }
4193
+ }
4194
+ },
4195
+ "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse.DeliveryError": {
4196
+ "type": "I",
4197
+ "fields": {
4198
+ "name": {
4199
+ "type": "string"
4200
+ },
4201
+ "description": {
4202
+ "type": "string"
4203
+ },
4204
+ "count": {
4205
+ "type": "number"
4206
+ }
4207
+ }
4208
+ },
4209
+ "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse.ChannelDeliveryReport": {
4210
+ "type": "I",
4211
+ "fields": {
4212
+ "channel": {
4213
+ "type": "string"
4214
+ },
4215
+ "errors": {
4216
+ "type": "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse.DeliveryError",
4217
+ "array": true
4218
+ }
4219
+ }
4220
+ },
4221
+ "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse": {
4222
+ "type": "I",
4223
+ "fields": {
4224
+ "channels": {
4225
+ "type": "pushwoosh.cj.journey.GetJourneyDeliveryReportResponse.ChannelDeliveryReport",
4226
+ "array": true
4227
+ }
4228
+ }
4229
+ },
3872
4230
  "pushwoosh.cj.journey.MultiEntry": {
3873
4231
  "type": "I",
3874
4232
  "fields": {
@@ -6364,6 +6722,10 @@ export const data = {
6364
6722
  "platforms": {
6365
6723
  "type": "string",
6366
6724
  "array": true
6725
+ },
6726
+ "hwids": {
6727
+ "type": "string",
6728
+ "array": true
6367
6729
  }
6368
6730
  }
6369
6731
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-gateway-journey-data",
3
- "version": "0.26.317",
3
+ "version": "0.26.319",
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>;
@@ -1432,6 +1434,117 @@ export type GetJourneyUsersResponse = {
1432
1434
  users: GetJourneyUsersResponse_UserPoint[];
1433
1435
  totals: number;
1434
1436
  };
1437
+ export type Channel = 'CHANNEL_UNSPECIFIED' | 'PUSH' | 'EMAIL' | 'WHATSAPP' | 'SMS' | 'IN_APP';
1438
+ export type GetJourneyMetricsRequest = {
1439
+ uuid?: string;
1440
+ application?: string;
1441
+ timestampFrom?: Date;
1442
+ timestampTo?: Date;
1443
+ timezone?: string;
1444
+ channels?: Channel[];
1445
+ };
1446
+ export type GetJourneyMetricsResponse_PushMetrics = {
1447
+ sends: number[];
1448
+ opens: number[];
1449
+ deliveryIssues: number[];
1450
+ };
1451
+ export type GetJourneyMetricsResponse_EmailMetrics = {
1452
+ sends: number[];
1453
+ opens: number[];
1454
+ deliveryIssues: number[];
1455
+ clicks: number[];
1456
+ };
1457
+ export type GetJourneyMetricsResponse_WhatsAppMetrics = {
1458
+ sends: number[];
1459
+ read: number[];
1460
+ deliveryIssues: number[];
1461
+ };
1462
+ export type GetJourneyMetricsResponse_SMSMetrics = {
1463
+ sends: number[];
1464
+ opens: number[];
1465
+ deliveries: number[];
1466
+ deliveryIssues: number[];
1467
+ };
1468
+ export type GetJourneyMetricsResponse_InAppMetrics = {
1469
+ sends: number[];
1470
+ impressions: number[];
1471
+ interactions: number[];
1472
+ deliveryIssues: number[];
1473
+ };
1474
+ export type GetJourneyMetricsResponse_ChannelMetrics = {
1475
+ push: GetJourneyMetricsResponse_PushMetrics;
1476
+ email: GetJourneyMetricsResponse_EmailMetrics;
1477
+ whatsapp: GetJourneyMetricsResponse_WhatsAppMetrics;
1478
+ sms: GetJourneyMetricsResponse_SMSMetrics;
1479
+ inApp: GetJourneyMetricsResponse_InAppMetrics;
1480
+ };
1481
+ export type GetJourneyMetricsResponse_PushTotals = {
1482
+ sent: number;
1483
+ recipients: number;
1484
+ opened: number;
1485
+ deliveryIssues: number;
1486
+ };
1487
+ export type GetJourneyMetricsResponse_EmailTotals = {
1488
+ sent: number;
1489
+ recipients: number;
1490
+ opened: number;
1491
+ deliveryIssues: number;
1492
+ hardBounces: number;
1493
+ softBounces: number;
1494
+ complaints: number;
1495
+ clicks: number;
1496
+ unsubscribes: number;
1497
+ };
1498
+ export type GetJourneyMetricsResponse_WhatsAppTotals = {
1499
+ sent: number;
1500
+ recipients: number;
1501
+ read: number;
1502
+ errors: number;
1503
+ };
1504
+ export type GetJourneyMetricsResponse_SMSTotals = {
1505
+ sent: number;
1506
+ recipients: number;
1507
+ opened: number;
1508
+ errors: number;
1509
+ };
1510
+ export type GetJourneyMetricsResponse_InAppTotals = {
1511
+ sent: number;
1512
+ impressions: number;
1513
+ interactions: number;
1514
+ errors: number;
1515
+ };
1516
+ export type GetJourneyMetricsResponse_ChannelTotals = {
1517
+ push: GetJourneyMetricsResponse_PushTotals;
1518
+ email: GetJourneyMetricsResponse_EmailTotals;
1519
+ whatsapp: GetJourneyMetricsResponse_WhatsAppTotals;
1520
+ sms: GetJourneyMetricsResponse_SMSTotals;
1521
+ inApp: GetJourneyMetricsResponse_InAppTotals;
1522
+ };
1523
+ export type GetJourneyMetricsResponse = {
1524
+ timestamps: Date[];
1525
+ channelMetrics: GetJourneyMetricsResponse_ChannelMetrics;
1526
+ totals: GetJourneyMetricsResponse_ChannelTotals;
1527
+ };
1528
+ export type GetJourneyDeliveryReportRequest = {
1529
+ application?: string;
1530
+ uuid?: string;
1531
+ timestampFrom?: Date;
1532
+ timestampTo?: Date;
1533
+ timezone?: string;
1534
+ channels?: Channel[];
1535
+ };
1536
+ export type GetJourneyDeliveryReportResponse_DeliveryError = {
1537
+ name: string;
1538
+ description: string;
1539
+ count: number;
1540
+ };
1541
+ export type GetJourneyDeliveryReportResponse_ChannelDeliveryReport = {
1542
+ channel: string;
1543
+ errors: GetJourneyDeliveryReportResponse_DeliveryError[];
1544
+ };
1545
+ export type GetJourneyDeliveryReportResponse = {
1546
+ channels: GetJourneyDeliveryReportResponse_ChannelDeliveryReport[];
1547
+ };
1435
1548
  export type MultiEntry = {
1436
1549
  enabled: boolean;
1437
1550
  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;