@pushwoosh/rpc-gateway-statistics-api 1.3.912 → 1.3.914

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/commonTypes.d.ts CHANGED
@@ -7,12 +7,16 @@ export type JsonValue = string | number | boolean | null | JsonValue[] | {
7
7
  export type JsonObject = {
8
8
  [key: string]: JsonValue;
9
9
  };
10
- export type RpcMethod<Req, Res> = ((request: Req) => Promise<Res>) & {
11
- safe(request: Req): Promise<[{
10
+ /** Per-call options accepted by every method. */
11
+ export type RpcCallOptions = {
12
+ signal?: AbortSignal;
13
+ };
14
+ export type RpcMethod<Req, Res> = ((request: Req, options?: RpcCallOptions) => Promise<Res>) & {
15
+ safe(request: Req, options?: RpcCallOptions): Promise<[{
12
16
  error: unknown;
13
17
  }, null] | [null, Res]>;
14
18
  };
15
- export type RpcMethodV3<Req, Res, Err> = ((request: Req) => Promise<Res>) & {
16
- safe(request: Req): Promise<[Err, null] | [null, Res]>;
19
+ export type RpcMethodV3<Req, Res, Err> = ((request: Req, options?: RpcCallOptions) => Promise<Res>) & {
20
+ safe(request: Req, options?: RpcCallOptions): Promise<[Err, null] | [null, Res]>;
17
21
  parseError(e: unknown): Err;
18
22
  };
package/data.js CHANGED
@@ -982,31 +982,6 @@ export const data = {
982
982
  }
983
983
  }
984
984
  },
985
- "pushwoosh.statistics.statistics.v1.GetInappTotalStatisticsCPRequest": {
986
- "type": "I",
987
- "fields": {
988
- "applicationCode": {
989
- "type": "string"
990
- },
991
- "timestampFrom": {
992
- "type": "string"
993
- },
994
- "timestampTo": {
995
- "type": "string"
996
- },
997
- "interval": {
998
- "type": "pushwoosh.statistics.types.TimeInterval"
999
- },
1000
- "inappCodes": {
1001
- "type": "string",
1002
- "array": true
1003
- },
1004
- "richMediaCodes": {
1005
- "type": "string",
1006
- "array": true
1007
- }
1008
- }
1009
- },
1010
985
  "pushwoosh.statistics.statistics.v1.CountPercent": {
1011
986
  "type": "I",
1012
987
  "fields": {
@@ -1018,20 +993,6 @@ export const data = {
1018
993
  }
1019
994
  }
1020
995
  },
1021
- "pushwoosh.statistics.statistics.v1.MetricCountPercentWithTimestampPlatformID": {
1022
- "type": "I",
1023
- "fields": {
1024
- "timestamp": {
1025
- "type": "string"
1026
- },
1027
- "platformId": {
1028
- "type": "number"
1029
- },
1030
- "metrics": {
1031
- "type": "pushwoosh.statistics.statistics.v1.CountPercent"
1032
- }
1033
- }
1034
- },
1035
996
  "pushwoosh.statistics.statistics.v1.PlatformMetricCount": {
1036
997
  "type": "I",
1037
998
  "fields": {
@@ -1046,121 +1007,6 @@ export const data = {
1046
1007
  }
1047
1008
  }
1048
1009
  },
1049
- "pushwoosh.statistics.statistics.v1.GetInappTotalStatisticsCPResponse": {
1050
- "type": "I",
1051
- "fields": {
1052
- "rows": {
1053
- "type": "pushwoosh.statistics.statistics.v1.MetricCountPercentWithTimestampPlatformID",
1054
- "array": true
1055
- },
1056
- "totals": {
1057
- "type": "pushwoosh.statistics.statistics.v1.PlatformMetricCount",
1058
- "array": true
1059
- },
1060
- "frequencyCappingSuppressions": {
1061
- "type": "number"
1062
- },
1063
- "frequencyCappingUniqueUsers": {
1064
- "type": "number"
1065
- }
1066
- }
1067
- },
1068
- "pushwoosh.statistics.statistics.v1.GetEmailClicksTotalStatisticsCPRequest": {
1069
- "type": "I",
1070
- "fields": {
1071
- "applicationCode": {
1072
- "type": "string"
1073
- },
1074
- "timestampFrom": {
1075
- "type": "string"
1076
- },
1077
- "timestampTo": {
1078
- "type": "string"
1079
- },
1080
- "interval": {
1081
- "type": "pushwoosh.statistics.types.TimeInterval"
1082
- }
1083
- }
1084
- },
1085
- "pushwoosh.statistics.statistics.v1.GetEmailClicksTotalStatisticsCPResponse": {
1086
- "type": "I",
1087
- "fields": {
1088
- "rows": {
1089
- "type": "pushwoosh.statistics.statistics.v1.MetricCountPercentWithTimestampPlatformID",
1090
- "array": true
1091
- },
1092
- "totals": {
1093
- "type": "pushwoosh.statistics.statistics.v1.PlatformMetricCount",
1094
- "array": true
1095
- }
1096
- }
1097
- },
1098
- "pushwoosh.statistics.statistics.v1.DevicePushCount": {
1099
- "type": "I",
1100
- "fields": {
1101
- "pushEnable": {
1102
- "type": "number"
1103
- },
1104
- "pushDisable": {
1105
- "type": "number"
1106
- }
1107
- }
1108
- },
1109
- "pushwoosh.statistics.statistics.v1.MetricDevicePushCountWithTimestampPlatformID": {
1110
- "type": "I",
1111
- "fields": {
1112
- "timestamp": {
1113
- "type": "string"
1114
- },
1115
- "platformId": {
1116
- "type": "number"
1117
- },
1118
- "metrics": {
1119
- "type": "pushwoosh.statistics.statistics.v1.DevicePushCount"
1120
- }
1121
- }
1122
- },
1123
- "pushwoosh.statistics.statistics.v1.PlatformDevicePushCount": {
1124
- "type": "I",
1125
- "fields": {
1126
- "platformId": {
1127
- "type": "number"
1128
- },
1129
- "currentMetric": {
1130
- "type": "pushwoosh.statistics.statistics.v1.DevicePushCount"
1131
- },
1132
- "previousMetric": {
1133
- "type": "pushwoosh.statistics.statistics.v1.DevicePushCount"
1134
- }
1135
- }
1136
- },
1137
- "pushwoosh.statistics.statistics.v1.GetSubscribersTotalStatisticsCPRequest": {
1138
- "type": "I",
1139
- "fields": {
1140
- "applicationCode": {
1141
- "type": "string"
1142
- },
1143
- "timestampFrom": {
1144
- "type": "string"
1145
- },
1146
- "timestampTo": {
1147
- "type": "string"
1148
- }
1149
- }
1150
- },
1151
- "pushwoosh.statistics.statistics.v1.GetSubscribersTotalStatisticsCPResponse": {
1152
- "type": "I",
1153
- "fields": {
1154
- "rows": {
1155
- "type": "pushwoosh.statistics.statistics.v1.MetricDevicePushCountWithTimestampPlatformID",
1156
- "array": true
1157
- },
1158
- "totals": {
1159
- "type": "pushwoosh.statistics.statistics.v1.PlatformDevicePushCount",
1160
- "array": true
1161
- }
1162
- }
1163
- },
1164
1010
  "pushwoosh.statistics.statistics.v1.GetSubscribersDailyStatisticsCPRequest": {
1165
1011
  "type": "I",
1166
1012
  "fields": {
@@ -1518,124 +1364,6 @@ export const data = {
1518
1364
  }
1519
1365
  }
1520
1366
  },
1521
- "pushwoosh.statistics.statistics.v1.GetEngagementTotalStatisticsCPRequest": {
1522
- "type": "I",
1523
- "fields": {
1524
- "applicationCode": {
1525
- "type": "string"
1526
- },
1527
- "timestampFrom": {
1528
- "type": "string"
1529
- },
1530
- "timestampTo": {
1531
- "type": "string"
1532
- },
1533
- "interval": {
1534
- "type": "pushwoosh.statistics.types.TimeInterval"
1535
- }
1536
- }
1537
- },
1538
- "pushwoosh.statistics.statistics.v1.GetEngagementTotalStatisticsCPResponse": {
1539
- "type": "I",
1540
- "fields": {
1541
- "rows": {
1542
- "type": "pushwoosh.statistics.statistics.v1.MetricCountPercentWithTimestampPlatformID",
1543
- "array": true
1544
- },
1545
- "totals": {
1546
- "type": "pushwoosh.statistics.statistics.v1.PlatformMetricCount",
1547
- "array": true
1548
- }
1549
- }
1550
- },
1551
- "pushwoosh.statistics.statistics.v1.GetAverageCTRTotalStatisticsCPRequest": {
1552
- "type": "I",
1553
- "fields": {
1554
- "applicationCode": {
1555
- "type": "string"
1556
- },
1557
- "timestampFrom": {
1558
- "type": "string"
1559
- },
1560
- "timestampTo": {
1561
- "type": "string"
1562
- },
1563
- "interval": {
1564
- "type": "pushwoosh.statistics.types.TimeInterval"
1565
- }
1566
- }
1567
- },
1568
- "pushwoosh.statistics.statistics.v1.GetAverageCTRTotalStatisticsCPResponse": {
1569
- "type": "I",
1570
- "fields": {
1571
- "rows": {
1572
- "type": "pushwoosh.statistics.statistics.v1.MetricCountPercentWithTimestampPlatformID",
1573
- "array": true
1574
- },
1575
- "totals": {
1576
- "type": "pushwoosh.statistics.statistics.v1.PlatformMetricCount",
1577
- "array": true
1578
- }
1579
- }
1580
- },
1581
- "pushwoosh.statistics.statistics.v1.GetActiveUsersTotalStatisticsCPRequest": {
1582
- "type": "I",
1583
- "fields": {
1584
- "applicationCode": {
1585
- "type": "string"
1586
- },
1587
- "timestampFrom": {
1588
- "type": "string"
1589
- },
1590
- "timestampTo": {
1591
- "type": "string"
1592
- }
1593
- }
1594
- },
1595
- "pushwoosh.statistics.statistics.v1.GetActiveUsersTotalStatisticsCPResponse": {
1596
- "type": "I",
1597
- "fields": {
1598
- "dau": {
1599
- "type": "pushwoosh.statistics.statistics.v1.MetricCountPercentWithTimestampPlatformID",
1600
- "array": true
1601
- },
1602
- "mau": {
1603
- "type": "pushwoosh.statistics.statistics.v1.MetricCountPercentWithTimestampPlatformID",
1604
- "array": true
1605
- },
1606
- "dauTotals": {
1607
- "type": "pushwoosh.statistics.statistics.v1.PlatformMetricCount",
1608
- "array": true
1609
- },
1610
- "mauTotals": {
1611
- "type": "pushwoosh.statistics.statistics.v1.PlatformMetricCount",
1612
- "array": true
1613
- }
1614
- }
1615
- },
1616
- "pushwoosh.statistics.statistics.v1.GetMessagesFunnelStatisticsCPRequest": {
1617
- "type": "I",
1618
- "fields": {
1619
- "applicationCode": {
1620
- "type": "string"
1621
- },
1622
- "timestampFrom": {
1623
- "type": "string"
1624
- },
1625
- "timestampTo": {
1626
- "type": "string"
1627
- }
1628
- }
1629
- },
1630
- "pushwoosh.statistics.statistics.v1.GetMessagesFunnelStatisticsCPResponse": {
1631
- "type": "I",
1632
- "fields": {
1633
- "totals": {
1634
- "type": "pushwoosh.statistics.statistics.v1.PlatformShortMetric",
1635
- "array": true
1636
- }
1637
- }
1638
- },
1639
1367
  "pushwoosh.statistics.statistics.v1.GetFrequencyCappingTotalStatisticsCPRequest": {
1640
1368
  "type": "I",
1641
1369
  "fields": {
@@ -1685,33 +1413,6 @@ export const data = {
1685
1413
  }
1686
1414
  }
1687
1415
  },
1688
- "pushwoosh.statistics.statistics.v1.GetUsersPAEStatisticsCPRequest": {
1689
- "type": "I",
1690
- "fields": {
1691
- "applicationCode": {
1692
- "type": "string"
1693
- },
1694
- "timestampFrom": {
1695
- "type": "string"
1696
- },
1697
- "timestampTo": {
1698
- "type": "string"
1699
- }
1700
- }
1701
- },
1702
- "pushwoosh.statistics.statistics.v1.GetUsersPAEStatisticsCPResponse": {
1703
- "type": "I",
1704
- "fields": {
1705
- "rows": {
1706
- "type": "pushwoosh.statistics.statistics.v1.MetricCountPercentWithTimestampPlatformID",
1707
- "array": true
1708
- },
1709
- "totals": {
1710
- "type": "pushwoosh.statistics.statistics.v1.PlatformMetricCount",
1711
- "array": true
1712
- }
1713
- }
1714
- },
1715
1416
  "pushwoosh.statistics.statistics.v1.ActiveUsersType": {
1716
1417
  "type": "E",
1717
1418
  "values": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-gateway-statistics-api",
3
- "version": "1.3.912",
3
+ "version": "1.3.914",
4
4
  "description": "Statistics API gateway HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -389,67 +389,15 @@ export type GetMessagesTotalStatisticsCPResponse = {
389
389
  rows: ShortMessageMetricWithTimestampPlatformID[];
390
390
  totals: PlatformShortMetric[];
391
391
  };
392
- export type GetInappTotalStatisticsCPRequest = {
393
- applicationCode: string;
394
- timestampFrom: string;
395
- timestampTo: string;
396
- interval: pushwoosh_statistics_types_TimeInterval;
397
- inappCodes: string[];
398
- richMediaCodes: string[];
399
- };
400
392
  export type CountPercent = {
401
393
  count: number;
402
394
  percent: number;
403
395
  };
404
- export type MetricCountPercentWithTimestampPlatformID = {
405
- timestamp: string;
406
- platformId: number;
407
- metrics: CountPercent;
408
- };
409
396
  export type PlatformMetricCount = {
410
397
  platformId: number;
411
398
  currentMetric: CountPercent;
412
399
  previousMetric: CountPercent;
413
400
  };
414
- export type GetInappTotalStatisticsCPResponse = {
415
- rows: MetricCountPercentWithTimestampPlatformID[];
416
- totals: PlatformMetricCount[];
417
- frequencyCappingSuppressions: number;
418
- frequencyCappingUniqueUsers: number;
419
- };
420
- export type GetEmailClicksTotalStatisticsCPRequest = {
421
- applicationCode: string;
422
- timestampFrom: string;
423
- timestampTo: string;
424
- interval: pushwoosh_statistics_types_TimeInterval;
425
- };
426
- export type GetEmailClicksTotalStatisticsCPResponse = {
427
- rows: MetricCountPercentWithTimestampPlatformID[];
428
- totals: PlatformMetricCount[];
429
- };
430
- export type DevicePushCount = {
431
- pushEnable: number;
432
- pushDisable: number;
433
- };
434
- export type MetricDevicePushCountWithTimestampPlatformID = {
435
- timestamp: string;
436
- platformId: number;
437
- metrics: DevicePushCount;
438
- };
439
- export type PlatformDevicePushCount = {
440
- platformId: number;
441
- currentMetric: DevicePushCount;
442
- previousMetric: DevicePushCount;
443
- };
444
- export type GetSubscribersTotalStatisticsCPRequest = {
445
- applicationCode: string;
446
- timestampFrom: string;
447
- timestampTo: string;
448
- };
449
- export type GetSubscribersTotalStatisticsCPResponse = {
450
- rows: MetricDevicePushCountWithTimestampPlatformID[];
451
- totals: PlatformDevicePushCount[];
452
- };
453
401
  export type GetSubscribersDailyStatisticsCPRequest = {
454
402
  applicationCode: string;
455
403
  timestampFrom: string;
@@ -615,45 +563,6 @@ export type GetRetentionTotalStatisticsCPRequest = {
615
563
  export type GetRetentionTotalStatisticsCPResponse = {
616
564
  totals: PlatformMetricCount[];
617
565
  };
618
- export type GetEngagementTotalStatisticsCPRequest = {
619
- applicationCode: string;
620
- timestampFrom: string;
621
- timestampTo: string;
622
- interval: pushwoosh_statistics_types_TimeInterval;
623
- };
624
- export type GetEngagementTotalStatisticsCPResponse = {
625
- rows: MetricCountPercentWithTimestampPlatformID[];
626
- totals: PlatformMetricCount[];
627
- };
628
- export type GetAverageCTRTotalStatisticsCPRequest = {
629
- applicationCode: string;
630
- timestampFrom: string;
631
- timestampTo: string;
632
- interval: pushwoosh_statistics_types_TimeInterval;
633
- };
634
- export type GetAverageCTRTotalStatisticsCPResponse = {
635
- rows: MetricCountPercentWithTimestampPlatformID[];
636
- totals: PlatformMetricCount[];
637
- };
638
- export type GetActiveUsersTotalStatisticsCPRequest = {
639
- applicationCode: string;
640
- timestampFrom: string;
641
- timestampTo: string;
642
- };
643
- export type GetActiveUsersTotalStatisticsCPResponse = {
644
- dau: MetricCountPercentWithTimestampPlatformID[];
645
- mau: MetricCountPercentWithTimestampPlatformID[];
646
- dauTotals: PlatformMetricCount[];
647
- mauTotals: PlatformMetricCount[];
648
- };
649
- export type GetMessagesFunnelStatisticsCPRequest = {
650
- applicationCode: string;
651
- timestampFrom: string;
652
- timestampTo: string;
653
- };
654
- export type GetMessagesFunnelStatisticsCPResponse = {
655
- totals: PlatformShortMetric[];
656
- };
657
566
  export type GetFrequencyCappingTotalStatisticsCPRequest = {
658
567
  applicationCode: string;
659
568
  timestampFrom: string;
@@ -672,15 +581,6 @@ export type GetFrequencyCappingTotalStatisticsCPResponse = {
672
581
  frequencyCappingUniqueUsers: number;
673
582
  rows: FrequencyCappingMetricWithTimestamp[];
674
583
  };
675
- export type GetUsersPAEStatisticsCPRequest = {
676
- applicationCode: string;
677
- timestampFrom: string;
678
- timestampTo: string;
679
- };
680
- export type GetUsersPAEStatisticsCPResponse = {
681
- rows: MetricCountPercentWithTimestampPlatformID[];
682
- totals: PlatformMetricCount[];
683
- };
684
584
  /** ActiveUsersType specifies the type of active users calculation */
685
585
  export type ActiveUsersType =
686
586
  /** Unspecified type */