clarion-shared-types 1.0.114 → 1.0.116

package/dist/types/modules/dispatch/enums/response-unit-dispatch-enums.d.ts

@@ -0,0 +1,109 @@
+/** Where one unit is in answering one incident. ACTIVE = DISPATCHED..ON_SCENE. */
+export declare enum ResponseUnitDispatchStatus {
+    DISPATCHED = "DISPATCHED",
+    ACKNOWLEDGED = "ACKNOWLEDGED",
+    EN_ROUTE = "EN_ROUTE",
+    ON_SCENE = "ON_SCENE",
+    COMPLETED = "COMPLETED",
+    CANCELLED = "CANCELLED"
+}
+export declare enum ResponseUnitDispatchTransitionSource {
+    DISPATCHER = "DISPATCHER",
+    INCIDENT_LIFECYCLE = "INCIDENT_LIFECYCLE",
+    RESPONDER = "RESPONDER",
+    WORKFLOW = "WORKFLOW"
+}
+export declare enum ResponseUnitCapabilityMatch {
+    MATCH = "MATCH",
+    NOT_REQUIRED = "NOT_REQUIRED",
+    UNKNOWN = "UNKNOWN",
+    NOT_SUITED = "NOT_SUITED"
+}
+export declare enum ResponseCapabilityRequirementSource {
+    INCIDENT_TYPE = "INCIDENT_TYPE",
+    INCIDENT_CATEGORY = "INCIDENT_CATEGORY",
+    NONE = "NONE"
+}
+export declare enum ResponseUnitLocationSource {
+    LIVE = "LIVE",
+    BASE = "BASE",
+    NONE = "NONE"
+}
+export declare enum ResponseUnitLocationFreshness {
+    CURRENT = "CURRENT",
+    STALE = "STALE",
+    UNKNOWN = "UNKNOWN"
+}
+export declare enum ResponseUnitDistanceBasis {
+    STRAIGHT_LINE = "STRAIGHT_LINE",
+    ROAD_ROUTE = "ROAD_ROUTE"
+}
+/** Why a unit cannot be dispatched (blockers) or is not recommended (cautions). */
+export declare enum ResponseUnitDispatchConstraint {
+    INACTIVE = "INACTIVE",
+    OPERATIONALLY_UNAVAILABLE = "OPERATIONALLY_UNAVAILABLE",
+    ENGAGED = "ENGAGED",
+    ALREADY_DISPATCHED = "ALREADY_DISPATCHED",
+    OTHER_CONTROL_CENTRE = "OTHER_CONTROL_CENTRE",
+    CAPABILITY_REQUIRED = "CAPABILITY_REQUIRED",
+    NOT_SUITED = "NOT_SUITED",
+    NO_LOCATION = "NO_LOCATION",
+    LOCATION_STALE = "LOCATION_STALE",
+    OUTSIDE_SEARCH_AREA = "OUTSIDE_SEARCH_AREA"
+}
+export declare enum ResponseUnitRecommendationReason {
+    AVAILABLE = "AVAILABLE",
+    CAPABILITY_MATCH = "CAPABILITY_MATCH",
+    NO_CAPABILITY_REQUIREMENT = "NO_CAPABILITY_REQUIREMENT",
+    CAPABILITY_UNKNOWN = "CAPABILITY_UNKNOWN",
+    SAME_CONTROL_CENTRE = "SAME_CONTROL_CENTRE",
+    OTHER_CONTROL_CENTRE = "OTHER_CONTROL_CENTRE",
+    LIVE_LOCATION_CURRENT = "LIVE_LOCATION_CURRENT",
+    LIVE_LOCATION_STALE = "LIVE_LOCATION_STALE",
+    BASE_LOCATION = "BASE_LOCATION",
+    NEAREST = "NEAREST",
+    QUICKEST = "QUICKEST"
+}
+/**
+ * NO_UNITS_CONFIGURED hides the dispatch panel (this control room has no units);
+ * NO_ELIGIBLE_UNITS is an alarm (it has units and none can go).
+ */
+export declare enum ResponseUnitRecommendationStatus {
+    RECOMMENDED = "RECOMMENDED",
+    NO_RECOMMENDATION = "NO_RECOMMENDATION",
+    NO_ELIGIBLE_UNITS = "NO_ELIGIBLE_UNITS",
+    NO_UNITS_CONFIGURED = "NO_UNITS_CONFIGURED",
+    NOT_DISPATCHABLE = "NOT_DISPATCHABLE"
+}
+export declare enum IncidentDispatchBlocker {
+    INCIDENT_ENDED = "INCIDENT_ENDED",
+    NOT_AN_EMERGENCY_INCIDENT = "NOT_AN_EMERGENCY_INCIDENT",
+    PROVIDER_RESPONSE_NOT_REQUESTED = "PROVIDER_RESPONSE_NOT_REQUESTED",
+    DISPATCH_DISABLED = "DISPATCH_DISABLED"
+}
+export declare enum ResponseUnitDispatchNotificationStatus {
+    PENDING = "PENDING",
+    SENT = "SENT",
+    FAILED = "FAILED",
+    NOT_POSSIBLE = "NOT_POSSIBLE"
+}
+export declare enum ResponseUnitDispatchNotificationFailure {
+    NO_PHONE_NUMBER = "NO_PHONE_NUMBER",
+    INVALID_PHONE_NUMBER = "INVALID_PHONE_NUMBER",
+    PROVIDER_FAILURE = "PROVIDER_FAILURE",
+    NOT_CONFIGURED = "NOT_CONFIGURED",
+    NO_RESPONSE = "NO_RESPONSE"
+}
+/** The `code` on a refused request (the gateway returns it under `details`). */
+export declare enum ResponseUnitDispatchErrorCode {
+    INCIDENT_NOT_DISPATCHABLE = "INCIDENT_NOT_DISPATCHABLE",
+    RESPONSE_UNIT_NOT_FOUND = "RESPONSE_UNIT_NOT_FOUND",
+    RESPONSE_UNIT_NOT_DISPATCHABLE = "RESPONSE_UNIT_NOT_DISPATCHABLE",
+    RESPONSE_UNIT_ENGAGED = "RESPONSE_UNIT_ENGAGED",
+    RESPONSE_UNIT_ALREADY_DISPATCHED = "RESPONSE_UNIT_ALREADY_DISPATCHED",
+    IDEMPOTENCY_KEY_REUSED = "IDEMPOTENCY_KEY_REUSED",
+    DISPATCH_NOT_FOUND = "DISPATCH_NOT_FOUND",
+    INVALID_STATUS_TRANSITION = "INVALID_STATUS_TRANSITION",
+    NOTIFICATION_NOT_RESENDABLE = "NOTIFICATION_NOT_RESENDABLE",
+    ORGANIZATION_UNAVAILABLE = "ORGANIZATION_UNAVAILABLE"
+}

package/dist/types/modules/dispatch/index.d.ts

@@ -0,0 +1,3 @@
+export * from './enums/response-unit-dispatch-enums';
+export * from './interfaces/response-unit-dispatch.dto';
+export * from './utils/response-unit-dispatch-display.util';

package/dist/types/modules/dispatch/interfaces/response-unit-dispatch.dto.d.ts

@@ -0,0 +1,166 @@
+import { ResponseCapability, ResponseUnitAvailability } from '../../response-unit/enums/response-unit/response-capability.enum';
+import { IncidentDispatchBlocker, ResponseCapabilityRequirementSource, ResponseUnitCapabilityMatch, ResponseUnitDispatchConstraint, ResponseUnitDispatchNotificationFailure, ResponseUnitDispatchNotificationStatus, ResponseUnitDispatchStatus, ResponseUnitDispatchTransitionSource, ResponseUnitDistanceBasis, ResponseUnitLocationFreshness, ResponseUnitLocationSource, ResponseUnitRecommendationReason, ResponseUnitRecommendationStatus } from '../enums/response-unit-dispatch-enums';
+export interface ResponseCapabilityRequirementDto {
+    capabilities: ResponseCapability[];
+    source: ResponseCapabilityRequirementSource;
+}
+export interface ResponseUnitCandidateLocationDto {
+    source: ResponseUnitLocationSource;
+    freshness: ResponseUnitLocationFreshness;
+    latitude: number | null;
+    longitude: number | null;
+    recordedAt: string | null;
+    ageSeconds: number | null;
+    accuracyMetres: number | null;
+}
+export interface ResponseUnitTravelEstimateDto {
+    distanceMetres: number;
+    durationSeconds: number | null;
+    basis: ResponseUnitDistanceBasis;
+    trafficAware: boolean;
+}
+export interface ResponseUnitCandidateDto {
+    responseUnitId: number;
+    name: string;
+    responseUnitType: string;
+    vehicleType: string | null;
+    registrationNumber: string | null;
+    controlCentreId: number | null;
+    sameControlCentre: boolean;
+    operationalStatus: string | null;
+    availability: ResponseUnitAvailability;
+    engagedIncidentId: number | null;
+    capabilities: ResponseCapability[];
+    capabilityMatch: ResponseUnitCapabilityMatch;
+    matchedCapabilities: ResponseCapability[];
+    location: ResponseUnitCandidateLocationDto;
+    distanceMetres: number | null;
+    travel: ResponseUnitTravelEstimateDto | null;
+    hasPhoneNumber: boolean;
+    dispatchable: boolean;
+    recommendable: boolean;
+    constraints: ResponseUnitDispatchConstraint[];
+    reasons: ResponseUnitRecommendationReason[];
+    rank: number | null;
+}
+export interface ResponseUnitRecommendationSummaryDto {
+    configuredUnits: number;
+    dispatchableUnits: number;
+    recommendableUnits: number;
+    engagedUnits: number;
+    unavailableUnits: number;
+    unitsWithoutLocation: number;
+    truncated: boolean;
+}
+export interface ResponseUnitDispatchUnitSnapshotDto {
+    availability: ResponseUnitAvailability;
+    operationalStatus: string | null;
+    capabilities: ResponseCapability[];
+    capabilityMatch: ResponseUnitCapabilityMatch;
+    sameControlCentre: boolean;
+    locationSource: ResponseUnitLocationSource;
+    locationFreshness: ResponseUnitLocationFreshness;
+    locationRecordedAt: string | null;
+    locationAgeSeconds: number | null;
+    distanceMetres: number | null;
+    hasPhoneNumber: boolean;
+}
+export interface ResponseUnitDispatchRecommendationSnapshotDto {
+    generatedAt: string;
+    status: ResponseUnitRecommendationStatus;
+    recommendedResponseUnitId: number | null;
+    ranked: Array<{
+        responseUnitId: number;
+        rank: number;
+        distanceMetres: number | null;
+        capabilityMatch: ResponseUnitCapabilityMatch;
+        locationFreshness: ResponseUnitLocationFreshness;
+    }>;
+    requiredCapabilities: ResponseCapability[];
+    requirementSource: ResponseCapabilityRequirementSource;
+    liveTrackingAvailable: boolean;
+}
+export interface ResponseUnitDispatchNotificationStateDto {
+    channel: 'SMS';
+    status: ResponseUnitDispatchNotificationStatus;
+    failureReason: ResponseUnitDispatchNotificationFailure | null;
+    /** Masked (+2547******78). */
+    recipient: string | null;
+    attempts: number;
+    requestedAt: string | null;
+    resultAt: string | null;
+    providerCode: string | null;
+}
+/** One response unit sent to one incident. */
+export interface IncidentResponseUnitDispatchDto {
+    id: number;
+    reference: string;
+    incidentId: number;
+    organizationId: number;
+    controlCentreId: number | null;
+    responseUnitId: number;
+    responseUnitName: string;
+    responseUnitType: string | null;
+    responseUnitControlCentreId: number | null;
+    status: ResponseUnitDispatchStatus;
+    dispatchedByUserId: number;
+    dispatchedAt: string;
+    wasRecommended: boolean;
+    recommendedResponseUnitId: number | null;
+    shownRecommendedResponseUnitId: number | null;
+    overrideReason: string | null;
+    notes: string | null;
+    distanceMetres: number | null;
+    unitSnapshot: ResponseUnitDispatchUnitSnapshotDto;
+    recommendationSnapshot: ResponseUnitDispatchRecommendationSnapshotDto | null;
+    statusChangedAt: string;
+    statusChangedByUserId: number | null;
+    statusSource: ResponseUnitDispatchTransitionSource;
+    statusReason: string | null;
+    acknowledgedAt: string | null;
+    enRouteAt: string | null;
+    onSceneAt: string | null;
+    completedAt: string | null;
+    cancelledAt: string | null;
+    notification: ResponseUnitDispatchNotificationStateDto;
+    createdAt: string;
+    updatedAt: string;
+}
+/** `GET /api/incidents/:id/response-unit-recommendation`. */
+export interface ResponseUnitRecommendationDto {
+    incidentId: number;
+    organizationId: number;
+    controlCentreId: number | null;
+    generatedAt: string;
+    status: ResponseUnitRecommendationStatus;
+    incidentBlockers: IncidentDispatchBlocker[];
+    requirement: ResponseCapabilityRequirementDto;
+    recommended: ResponseUnitCandidateDto | null;
+    alternatives: ResponseUnitCandidateDto[];
+    otherUnits: ResponseUnitCandidateDto[];
+    activeDispatches: IncidentResponseUnitDispatchDto[];
+    summary: ResponseUnitRecommendationSummaryDto;
+    incidentLocationAvailable: boolean;
+    liveTrackingAvailable: boolean;
+    travelTimeEnabled: boolean;
+}
+/** `POST /api/incidents/:id/response-unit-dispatches` body. Send an Idempotency-Key header with it. */
+export interface DispatchResponseUnitRequest {
+    responseUnitId: number;
+    /** The unit the screen showed as recommended. */
+    recommendedResponseUnitId?: number | null;
+    /** Optional: why another unit than the recommended one. */
+    overrideReason?: string;
+    notes?: string;
+}
+/** `POST /api/incidents/:id/response-unit-dispatches` response. */
+export interface DispatchResponseUnitResultDto {
+    dispatch: IncidentResponseUnitDispatchDto;
+    /** A repeat of an earlier request (same Idempotency-Key): nothing was sent again. */
+    replayed: boolean;
+}
+/** `POST /api/incidents/:id/response-unit-dispatches/:dispatchId/status` body. */
+export interface UpdateResponseUnitDispatchStatusRequest {
+    status: ResponseUnitDispatchStatus;
+    reason?: string;
+}

package/dist/types/modules/dispatch/utils/response-unit-dispatch-display.util.d.ts

@@ -0,0 +1,30 @@
+import { ResponseCapability, ResponseUnitAvailability } from '../../response-unit/enums/response-unit/response-capability.enum';
+import { IncidentDispatchBlocker, ResponseUnitDispatchConstraint, ResponseUnitDispatchNotificationFailure, ResponseUnitDispatchNotificationStatus, ResponseUnitDispatchStatus } from '../enums/response-unit-dispatch-enums';
+import { ResponseUnitCandidateDto } from '../interfaces/response-unit-dispatch.dto';
+export declare const RESPONSE_CAPABILITY_LABELS: Readonly<Record<ResponseCapability, string>>;
+export declare const RESPONSE_UNIT_AVAILABILITY_LABELS: Readonly<Record<ResponseUnitAvailability, string>>;
+export declare const RESPONSE_UNIT_DISPATCH_STATUS_LABELS: Readonly<Record<ResponseUnitDispatchStatus, string>>;
+/** Why a unit cannot go, or is not suggested - as the dispatcher reads it. */
+export declare const RESPONSE_UNIT_DISPATCH_CONSTRAINT_LABELS: Readonly<Record<ResponseUnitDispatchConstraint, string>>;
+export declare const INCIDENT_DISPATCH_BLOCKER_LABELS: Readonly<Record<IncidentDispatchBlocker, string>>;
+export declare const RESPONSE_UNIT_DISPATCH_NOTIFICATION_STATUS_LABELS: Readonly<Record<ResponseUnitDispatchNotificationStatus, string>>;
+export declare const RESPONSE_UNIT_DISPATCH_NOTIFICATION_FAILURE_LABELS: Readonly<Record<ResponseUnitDispatchNotificationFailure, string>>;
+/** Where each dispatch may be moved next (forward only; steps may be skipped). */
+export declare const RESPONSE_UNIT_DISPATCH_NEXT_STATUSES: Readonly<Record<ResponseUnitDispatchStatus, readonly ResponseUnitDispatchStatus[]>>;
+export declare const ACTIVE_RESPONSE_UNIT_DISPATCH_STATUSES: readonly ResponseUnitDispatchStatus[];
+export declare function isActiveResponseUnitDispatch(status: ResponseUnitDispatchStatus | string | null | undefined): boolean;
+/** "850 m", "2.4 km", "38 km". */
+export declare function formatDispatchDistance(metres: number | null | undefined): string;
+/** "18 sec ago", "4 min ago", "2 h ago". */
+export declare function formatDispatchAge(seconds: number | null | undefined): string;
+/** "7 min", "1 h 05 min". */
+export declare function formatDispatchDuration(seconds: number | null | undefined): string;
+/** A candidate's position, as one short phrase: "Live 18 sec ago", "Live, out of date (6 min ago)", "Base location". */
+export declare function describeCandidateLocation(candidate: ResponseUnitCandidateDto, ageSeconds?: number | null): string;
+/**
+ * The "Recommended because" lines, from the reasons and the numbers behind
+ * them. Never the scoring - the facts it rests on, in the order it weighs them.
+ */
+export declare function explainRecommendation(candidate: ResponseUnitCandidateDto, ageSeconds?: number | null): string[];
+/** The reasons a unit cannot go or is not suggested, as labels. */
+export declare function describeCandidateConstraints(candidate: ResponseUnitCandidateDto): string[];

package/dist/types/modules/incident/enums/incident-actions.enum.d.ts

@@ -7,6 +7,8 @@ export declare enum IncidentActions {
     ON_HOLD = "On Hold",
     ASSIGNED = "Assigned",
     RESPONSE_UNIT_ASSIGNED = "Response Unit Assigned",
+    RESPONSE_UNIT_DISPATCHED = "Response Unit Dispatched",
+    RESPONSE_UNIT_DISPATCH_UPDATED = "Response Unit Dispatch Updated",
     REOPENED = "Reopened",
     REPORT_CREATED = "Report Created",
     COMMENTED = "Commented",

package/dist/types/modules/incident/intefaces/incident-category.d.ts

@@ -1,3 +1,4 @@
+import { ResponseCapability } from "../../response-unit/enums/response-unit/response-capability.enum";
 import { IncidentType } from "./incident-type";
 export interface IncidentCategory {
     id?: number;
@@ -13,5 +14,10 @@ export interface IncidentCategory {
      * `includeSystem=true`.
      */
     isSystem?: boolean;
+    /**
+     * Response capabilities this kind of incident needs; a unit with ANY of them
+     * is suitable. A type's list overrides its category's; empty = no requirement.
+     */
+    responseCapabilities?: ResponseCapability[];
     types?: IncidentType[];
 }

package/dist/types/modules/incident/intefaces/incident-type.d.ts

@@ -1,3 +1,4 @@
+import { ResponseCapability } from "../../response-unit/enums/response-unit/response-capability.enum";
 import { IncidentCategory } from "./incident-category";
 export interface IncidentType {
     id?: number;
@@ -14,5 +15,10 @@ export interface IncidentType {
      * `includeSystem=true`.
      */
     isSystem?: boolean;
+    /**
+     * Response capabilities this kind of incident needs; a unit with ANY of them
+     * is suitable. A type's list overrides its category's; empty = no requirement.
+     */
+    responseCapabilities?: ResponseCapability[];
     category?: IncidentCategory;
 }

package/dist/types/modules/notification/index.d.ts

@@ -11,3 +11,4 @@ export * from './interfaces/email-send-result';
 export * from './interfaces/notification-dispatch-result';
 export * from './interfaces/organization-notification-settings.dto';
 export * from './utils/notification-sender.util';
+export * from './interfaces/notification-analytics';

package/dist/types/modules/notification/interfaces/notification-analytics.d.ts

@@ -0,0 +1,273 @@
+/**
+ * Notification analytics (the admin's Notification Analytics): what Clarion sent people
+ * over a period, on every channel - push to the app, the console's in-app notifications,
+ * SMS and email - whether it got through, whether it was opened, and how many people a
+ * push can reach at all.
+ *
+ * One read, computed by clarion-notification from one consistent snapshot, with who each
+ * recipient is from clarion-authentication. Counts, rates and durations only: never a
+ * title, a message, a phone number or an address.
+ *
+ * DURATIONS ARE IN SECONDS, like every analytics contract.
+ *
+ * How it is counted:
+ *  - Everything by when it was CREATED - the moment Clarion decided to tell somebody.
+ *  - Whose it is: the organization recorded on it; for a push, the organization of the
+ *    post it announces, then the recipient's; for an SMS, the recipient's. Older SMS and
+ *    email (before 21 September 2026) recorded no organization and often no recipient:
+ *    those are counted only in the platform view (`unattributed`).
+ *  - Got through: accepted by the provider - Firebase for a push, the SMS gateway, the
+ *    mail service - or, in the console, delivered. Nothing reports whether an SMS or an
+ *    email was read, so only push (tapped) and in-app (read) have an open rate.
+ *  - A country narrows push, in-app and devices by the recipient's country and SMS by
+ *    the number's; email has no country and is never narrowed.
+ */
+/** How the period is cut into points for the charts. Chosen by the service from the length of the period. */
+export type NotificationAnalyticsBucket = 'hour' | 'day' | 'week' | 'month';
+/** The four ways Clarion tells somebody something. */
+export type NotificationAnalyticsChannel = 'PUSH' | 'IN_APP' | 'SMS' | 'EMAIL';
+export interface NotificationAnalyticsRange {
+    /** Inclusive, ISO 8601. The first notification when the period asked for was "forever". */
+    from: string;
+    /** Exclusive, ISO 8601. */
+    to: string;
+    bucket: NotificationAnalyticsBucket;
+    /** IANA time zone the buckets and the hour-of-week grid are cut in. */
+    timeZone: string;
+}
+/** A count by a key (a kind, a provider, a reason), largest first unless the section says otherwise. */
+export interface NotificationAnalyticsCount<K extends string = string> {
+    key: K;
+    count: number;
+}
+/** Median and 90th percentile of one duration, in seconds; null when nothing was measured. */
+export interface NotificationAnalyticsDuration {
+    median: number | null;
+    p90: number | null;
+    /** How many were measured. */
+    count: number;
+}
+/** One channel over the period. */
+export interface NotificationAnalyticsChannelRow {
+    channel: NotificationAnalyticsChannel;
+    /** Created in the period. */
+    total: number;
+    /** Got through: accepted by the provider, or delivered to the console. */
+    succeeded: number;
+    failed: number;
+    /** No outcome yet: waiting, or cancelled before it was sent. */
+    pending: number;
+    /** succeeded / (succeeded + failed), as a percentage. */
+    successRate: number | null;
+    /** Push tapped, in-app read; null for SMS and email - nothing reports it. */
+    opened: number | null;
+    /** opened / succeeded, as a percentage. */
+    openRate: number | null;
+}
+/** One kind of push - what it announced - and how it went. */
+export interface NotificationAnalyticsPushKindRow {
+    /** The event it announced (NEWSFEED_POST_PUBLISHED, GUARDIAN_INCIDENT_ALERT...), else its category (INCIDENT, ALERT...). */
+    kind: string;
+    total: number;
+    failed: number;
+    opened: number;
+    /** opened / those that got through, as a percentage. */
+    openRate: number | null;
+    medianSecondsToOpen: number | null;
+}
+/** Push notifications to the app. */
+export interface NotificationAnalyticsPush {
+    /** One per device: a notification to somebody with two phones is two. */
+    total: number;
+    succeeded: number;
+    failed: number;
+    pending: number;
+    opened: number;
+    successRate: number | null;
+    openRate: number | null;
+    /** Different people pushed to. */
+    recipients: number;
+    /** Notifications as Clarion decided them, each fanned out to its recipients' devices. */
+    sends: number;
+    /** Created to accepted by Firebase - seconds, with decimals. */
+    toSend: NotificationAnalyticsDuration;
+    /** Created to tapped. */
+    toOpen: NotificationAnalyticsDuration;
+    byKind: NotificationAnalyticsPushKindRow[];
+    /** Critical, High, Normal, Low - in that order, zeros included. */
+    byPriority: NotificationAnalyticsCount[];
+    /** The Android channel it rang on (urgent, incidents...); DEFAULT when none. */
+    byChannel: NotificationAnalyticsCount[];
+    /** Why pushes failed, as the provider said it - ids, numbers and addresses masked. The eight commonest. */
+    failureReasons: NotificationAnalyticsCount[];
+}
+/** The phones and browsers a push can reach - NOW, whatever the period, apart from `registered`. */
+export interface NotificationAnalyticsDevices {
+    activeNow: number;
+    /** Switched off: signed out, replaced by a newer registration, or refused by the provider. */
+    inactiveNow: number;
+    /** People with at least one active device: who a push can reach. */
+    reachableNow: number;
+    /** Registered in the period. */
+    registered: number;
+    /** Active devices by kind (android, ios, web). */
+    byType: NotificationAnalyticsCount[];
+    /** Active devices by app version; NONE when not recorded. */
+    byAppVersion: NotificationAnalyticsCount[];
+    byLanguage: NotificationAnalyticsCount[];
+}
+/** The console's own notifications, to the staff using it. */
+export interface NotificationAnalyticsInApp {
+    total: number;
+    succeeded: number;
+    failed: number;
+    pending: number;
+    read: number;
+    /** read / total, as a percentage. */
+    readRate: number | null;
+    /** Different people notified. */
+    recipients: number;
+    /** INCIDENT, ALERT, MESSAGE... */
+    byType: NotificationAnalyticsCount[];
+    /** What happened (Created, Auto-Stopped, CHAT_MESSAGE...). */
+    byAction: NotificationAnalyticsCount[];
+    /** NOW: notifications nobody has read yet, whenever created. */
+    unreadNow: number;
+}
+/** Cost recorded on SMS, per currency. */
+export interface NotificationAnalyticsSmsCost {
+    currency: string;
+    amount: number;
+    /** Messages with a cost recorded. */
+    messages: number;
+}
+/** SMS. */
+export interface NotificationAnalyticsSms {
+    total: number;
+    succeeded: number;
+    failed: number;
+    pending: number;
+    successRate: number | null;
+    /** Created to accepted by the gateway. */
+    toSend: NotificationAnalyticsDuration;
+    /** What it was for: otp:verify_phone, otp:reset_password, guardian_incident_notification...; NOT_RECORDED for the oldest. */
+    byPurpose: NotificationAnalyticsCount[];
+    /** The gateway that took it (uwazii, twilio, africastalking); NOT_RECORDED for the oldest. */
+    byProvider: NotificationAnalyticsCount[];
+    /** Whose sender ID it went out under (PLATFORM_DEFAULT, ORGANIZATION); NOT_RECORDED for the oldest. */
+    bySenderSource: NotificationAnalyticsCount[];
+    /** The number's country; UNKNOWN when not recorded. */
+    byCountry: NotificationAnalyticsCount[];
+    /** Why messages failed - ids, numbers and addresses masked. The eight commonest. */
+    failureReasons: NotificationAnalyticsCount[];
+    cost: NotificationAnalyticsSmsCost[];
+}
+/** Email. */
+export interface NotificationAnalyticsEmail {
+    total: number;
+    succeeded: number;
+    failed: number;
+    successRate: number | null;
+    /** Verification, Password Reset, Notification, Acknowledgement... */
+    byType: NotificationAnalyticsCount[];
+    /** The mail service that took it; NOT_RECORDED for the oldest. */
+    byProvider: NotificationAnalyticsCount[];
+    bySenderSource: NotificationAnalyticsCount[];
+}
+/** One point on the charts: a bucket of the period. */
+export interface NotificationAnalyticsPoint {
+    /** Local wall-clock start of the bucket, in `range.timeZone` (no offset). */
+    bucket: string;
+    push: number;
+    pushFailed: number;
+    /** Of the pushes created in the bucket, those tapped (whenever). */
+    pushOpened: number;
+    inApp: number;
+    inAppRead: number;
+    sms: number;
+    smsFailed: number;
+    email: number;
+    emailFailed: number;
+}
+/** One hour of the week. Weekday 1 is Monday. */
+export interface NotificationAnalyticsHeatCell {
+    weekday: number;
+    hour: number;
+    /** Notifications created in it, every channel. */
+    sent: number;
+    /** Pushes tapped in it - when people look. */
+    opened: number;
+}
+/** The previous period of the same length, for the change on each headline figure. */
+export interface NotificationAnalyticsPrevious {
+    from: string;
+    to: string;
+    total: number;
+    push: number;
+    pushFailed: number;
+    pushOpened: number;
+    pushOpenRate: number | null;
+    pushSuccessRate: number | null;
+    inApp: number;
+    inAppRead: number;
+    sms: number;
+    smsFailed: number;
+    smsSuccessRate: number | null;
+    email: number;
+    emailFailed: number;
+    devicesRegistered: number;
+}
+/** A Super-Admin's view of every organization: one row each, busiest first. */
+export interface NotificationAnalyticsOrganizationRow {
+    organizationId: number;
+    total: number;
+    push: number;
+    pushFailed: number;
+    pushOpenRate: number | null;
+    inApp: number;
+    inAppReadRate: number | null;
+    sms: number;
+    smsFailed: number;
+    email: number;
+    /** NOW. */
+    activeDevices: number;
+}
+/** Notifications of the period no organization could be found for - the platform view only. */
+export interface NotificationAnalyticsUnattributed {
+    push: number;
+    sms: number;
+    email: number;
+}
+export interface NotificationAnalytics {
+    /** Whose figures: one organization, or null for every organization. */
+    organizationId: number | null;
+    /** The one country the figures are narrowed to, or null for every country. */
+    countryCode: string | null;
+    range: NotificationAnalyticsRange;
+    generatedAt: string;
+    previous: NotificationAnalyticsPrevious | null;
+    /** Countries with notifications or devices in scope, whatever country is chosen - for narrowing to one. */
+    countryOptions: NotificationAnalyticsCount[];
+    /** PUSH, IN_APP, SMS, EMAIL - in that order. */
+    channels: NotificationAnalyticsChannelRow[];
+    push: NotificationAnalyticsPush;
+    devices: NotificationAnalyticsDevices;
+    inApp: NotificationAnalyticsInApp;
+    sms: NotificationAnalyticsSms;
+    email: NotificationAnalyticsEmail;
+    timeline: NotificationAnalyticsPoint[];
+    /** All 168 hours of the week, Monday first, zeros included. */
+    heatmap: NotificationAnalyticsHeatCell[];
+    /** A Super-Admin looking at every organization only. */
+    byOrganization?: NotificationAnalyticsOrganizationRow[];
+    /** A Super-Admin looking at every organization only. */
+    unattributed?: NotificationAnalyticsUnattributed;
+}
+/** What a dashboard asks: the period, one country - and, for a Super-Admin, whose figures. */
+export interface NotificationAnalyticsQuery {
+    from?: string;
+    to?: string;
+    timeZone?: string;
+    organizationId?: number;
+    countryCode?: string;
+}

package/dist/types/modules/permission/enums/permission-actions.enum.d.ts

@@ -53,6 +53,9 @@ export declare enum PermissionActions {
     READ_TRACKING_HISTORY = "read:tracking-history",
     READ_TRACKING_OPERATIONS = "read:tracking-operations",
     MANAGE_TRACKING_OPERATIONS = "manage:tracking-operations",
+    READ_RESPONSE_UNIT_DISPATCH = "read:response-unit-dispatch",
+    CREATE_RESPONSE_UNIT_DISPATCH = "create:response-unit-dispatch",
+    UPDATE_RESPONSE_UNIT_DISPATCH = "update:response-unit-dispatch",
     CREATE_SUPPORT_TICKET = "create:support-ticket",
     READ_SUPPORT_TICKET = "read:support-ticket",
     UPDATE_SUPPORT_TICKET = "update:support-ticket",
@@ -87,6 +90,7 @@ export declare enum PermissionActions {
     READ_SUPPORT_SYNC = "read:support-sync",
     MANAGE_SUPPORT_SYNC = "manage:support-sync",
     READ_NOTIFICATION_BRANDING = "read:notification-branding",
+    READ_NOTIFICATION_ANALYTICS = "read:notification-analytics",
     UPDATE_NOTIFICATION_BRANDING = "update:notification-branding",
     CREATE_NOTIFICATION_EMAIL_SENDER = "create:notification-email-sender",
     READ_NOTIFICATION_EMAIL_SENDER = "read:notification-email-sender",

package/dist/types/modules/permission/enums/permissions-moudule.enum.d.ts

@@ -8,6 +8,7 @@ export declare enum PermissionsModule {
     INCIDENT = "Grievance",
     RESPONSE_UNIT = "Response Unit",
     TRACKING = "Tracking",
+    RESPONSE_UNIT_DISPATCH = "Response Unit Dispatch",
     BILLING = "Billing",
     NEWSFEED = "Newsfeed",
     SUPPORT = "Support",