resqueserve-core 4.8.130-dev.14 → 4.9.0-rc.10

package/main.d.ts

@@ -298,6 +298,11 @@ export interface Area {
     district: IAddressDistrict;
 }
 export interface ChatMessage {
+    /**
+     * Gets the unique identifier of the message.
+     *
+     */
+    id: string;
     /**
      * Gets or sets the user who sent the message. Is null if system message.
      *
@@ -309,10 +314,20 @@ export interface ChatMessage {
      */
     createdOn: string;
     /**
-     * Gets or sets the text content of the message.
+     * Gets or sets the text content of the message (system messages: in English, see ).
      *
      */
     text: string;
+    /**
+     * Gets the localization key of a system message; clients show it in their own language with and fall back to . Null for user messages.
+     *
+     */
+    textKey: string;
+    /**
+     * Gets the arguments of ; an argument that is a localization key itself is translated too.
+     *
+     */
+    textArguments: string[] | null;
     /**
      * Gets or sets a value indicating whether the sender is a supervisor.
      *
@@ -729,6 +744,11 @@ export interface ResourceLookupDto {
     callsign: string;
     callsignShort: string;
     station: string;
+    /**
+     * The callsign the search matched best (callsign, short, GPS or verbal); null without search.
+     *
+     */
+    matchedCallsign: string;
     /**
      * Gets or sets the cache version associated with the lookup entity.
      *
@@ -927,7 +947,6 @@ export interface ResourceInformation {
     station: string;
     currentOperation: string;
     destination: string;
-    duty: string;
 }
 export interface Keyword {
     id: number;
@@ -1048,6 +1067,23 @@ export interface KeywordInfo {
      */
     name: string;
 }
+export interface KeywordLookupItem {
+    /**
+     * The ID of the keyword.
+     *
+     */
+    id: number;
+    /**
+     * The name of the keyword.
+     *
+     */
+    name: string;
+    /**
+     * Whether the keyword is urgent (emergency).
+     *
+     */
+    isUrgent: boolean;
+}
 export interface MissionLoad {
     id: number;
     /**
@@ -1071,6 +1107,55 @@ export interface OAuthTokenResponse {
     tokenType: string;
     expiresIn: number;
 }
+export interface OperationAuditEntry {
+    /**
+     * The ID of the audit entry.
+     *
+     */
+    id: string;
+    /**
+     * When it happened.
+     *
+     */
+    timestamp: string;
+    /**
+     * The user who caused it; null for the system.
+     *
+     */
+    user: IUserInfo;
+    /**
+     * The kind of change.
+     *
+     */
+    action: AuditAction;
+    /**
+     * The operation specific kind of change, if any.
+     *
+     */
+    actionSub: AuditActionSub | null;
+    /**
+     * The localized message (markdown) without timestamp and user.
+     *
+     */
+    message: string;
+}
+export interface OperationChangeInfo {
+    /**
+     * Increases with every change; a client keeps the highest revision per entity and drops events with a lower one (they arrived out of order).
+     *
+     */
+    revision: number;
+    /**
+     * The editor (one desk window) that made the change; null for changes by the system. A client may keep the value the user is typing in a field instead of overwriting it with its own echo.
+     *
+     */
+    editorId: string | null;
+    /**
+     * The changed properties, camel case as in the JSON of the entity.
+     *
+     */
+    changedProperties: string[] | null;
+}
 export interface OperationInfo {
     id: string;
     /**
@@ -1104,6 +1189,33 @@ export interface OperationInfo {
      */
     status: OperationStatus;
 }
+export interface Pagination<T> {
+    /**
+     * Gets the number of the current page in the pagination sequence.
+     *
+     */
+    currentPage: number;
+    /**
+     * Gets the total number of pages available.
+     *
+     */
+    totalPages: number;
+    /**
+     * Gets the number of items per page.
+     *
+     */
+    pageSize: number;
+    /**
+     * Gets the total number of items across all pages.
+     *
+     */
+    totalItems: number;
+    /**
+     * Gets the collection of items on the current page.
+     *
+     */
+    items: T[] | null;
+}
 export interface Poi {
     id: number;
     /**
@@ -1225,6 +1337,11 @@ export interface Preselection {
      *
      */
     departureTime: string | null;
+    /**
+     * Gets when the unit's duty ends (session time), only when it ends soon (Core DispatchDefaults.DutyEndWarningMinutes); otherwise null.
+     *
+     */
+    dutyEndsOn: string | null;
     /**
      * Gets the total estimated time to reach the target, combining and . Returns null when is unknown.
      *
@@ -1268,6 +1385,16 @@ export interface ResourceFilter {
      *
      */
     unitCategories: UnitCategory[] | null;
+    /**
+     * Gets or sets a collection of to filter resources by the kind of unit (any of the groups matches).
+     *
+     */
+    unitCategoryGroups: UnitCategoryGroup[] | null;
+    /**
+     * Gets or sets a collection of to filter resources by how soon they are available (any of them matches).
+     *
+     */
+    unitAvailabilities: UnitAvailability[] | null;
     /**
      * Gets or sets a collection of to filter resources by unit display categories see .
      *
@@ -1776,6 +1903,33 @@ export interface Unit {
      */
     displayCategory: string;
 }
+export interface UnitDutyInformation {
+    /**
+     * The unit.
+     *
+     */
+    unitId: number;
+    /**
+     * How the unit's duty is defined (always, by day, by night, by duty periods).
+     *
+     */
+    dutyOptions: UnitDutyOptions;
+    /**
+     * Duty periods: when the current duty ends (following shifts included); null when not on duty or around the clock.
+     *
+     */
+    dutyEndsOn: string | null;
+    /**
+     * Duty periods, not on duty: when the next shift starts.
+     *
+     */
+    nextDutyStartsOn: string | null;
+    /**
+     * Minutes from the session time until or .
+     *
+     */
+    minutesUntilChange: number | null;
+}
 export interface UnitDutyPeriod {
     id: number;
     /**
@@ -1853,6 +2007,43 @@ export interface UnitInfo {
      */
     origin: ShelfOriginBase;
 }
+export interface UnitLookupItem {
+    /**
+     * The ID of the unit.
+     *
+     */
+    id: number;
+    /**
+     * The callsign.
+     *
+     */
+    callsign: string;
+    /**
+     * The short callsign.
+     *
+     */
+    callsignShort: string;
+    /**
+     * The GPS callsign, if any.
+     *
+     */
+    callsignGps: string;
+    /**
+     * The verbal callsign (as spoken on the radio), if any.
+     *
+     */
+    callsignVerbal: string;
+    /**
+     * The unit category, e.g. "RTW".
+     *
+     */
+    category: string;
+    /**
+     * The callsign (callsign, short, GPS or verbal) that matched the search best.
+     *
+     */
+    matchedCallsign: string;
+}
 export interface UserInfo {
     suspendedUntilUtc: string | null;
     id: number;
@@ -1888,23 +2079,6 @@ export interface UserInfo {
      */
     lastActivityOn: string | null;
 }
-export interface SimulationUnitDebug {
-    id: number;
-    unitInformation: IUnitInfo;
-    patient: string;
-    session: string;
-    state: string;
-    mission: string;
-    request: string;
-    isDriving: boolean;
-    isOnDuty: boolean;
-    isFrozen: boolean;
-    isFrozenUntil: string | null;
-    knowledge: string;
-    equipmentOnScene: string;
-    requiredEquipments: string;
-    onServerTime: string;
-}
 export interface Information {
 }
 export interface LookupDto {
@@ -3091,6 +3265,11 @@ export interface IOperation {
      *
      */
     callerName: string;
+    /**
+     * Gets the properties the operation still needs before units can be dispatched to it (computed); empty when it is ready for dispatch.
+     *
+     */
+    missingDispatchRequirements: DispatchRequirement[] | null;
     /**
      * Gets or sets the phone number of the caller.
      *
@@ -3141,6 +3320,21 @@ export interface IOperation {
      *
      */
     informationExternal: string;
+    /**
+     * Gets or sets the floor at the location, e.g. "3rd floor" (detail for the units; not used for geocoding).
+     *
+     */
+    locationFloor: string;
+    /**
+     * Gets or sets the junction, interchange or exit at the location, e.g. on a motorway (detail for the units; not used for geocoding).
+     *
+     */
+    locationJunction: string;
+    /**
+     * Gets or sets the position on a route at the location in any unit, e.g. "km 123.4" or "mile 76" (detail for the units; not used for geocoding).
+     *
+     */
+    locationRouteMarker: string;
     id: string;
     /**
      * Gets or sets the internal operation number.
@@ -3300,6 +3494,11 @@ export interface IOperationResource {
      *
      */
     suggestionOn: string | null;
+    /**
+     * Gets or sets when the reservation for the current operation is released automatically (real time, UTC, not the session time); null without reservation.
+     *
+     */
+    reservationExpiresOn: string | null;
     /**
      * Gets or sets the count of times the unit has been dispatched, used for load balancing between units.
      *
@@ -3361,6 +3560,16 @@ export interface IOperationTask {
      */
     createdOn: string;
     matchUnitId: number | null;
+    /**
+     * Gets whether a dispatcher may execute the task now (computed): manual tasks that may run several times, and manual-once tasks that have not run yet.
+     *
+     */
+    canExecuteManually: boolean;
+    /**
+     * Gets whether the task is still to do (computed): it has not completed and is not queued or running.
+     *
+     */
+    isOpen: boolean;
 }
 export interface IPatient {
     id: string;
@@ -3379,6 +3588,16 @@ export interface IPatient {
      *
      */
     pickupDeadline: string | null;
+    /**
+     * Gets or sets the PZC (patient condition code) as its 6-digit value: incident code, age, urgency level (e.g. 232183); null if not set.
+     *
+     */
+    pzc: number | null;
+    /**
+     * Gets or sets the units of the operation that take care of the patient (several possible, e.g. the emergency doctor and the ambulance).
+     *
+     */
+    assignedUnitIds: number[] | null;
     /**
      * Gets or sets the first name of the person.
      *
@@ -3575,6 +3794,11 @@ export interface IPreselection {
      *
      */
     totalTimeToTarget: string | null;
+    /**
+     * Gets when the unit's duty ends (session time), only when it ends soon (Core DispatchDefaults.DutyEndWarningMinutes); otherwise null.
+     *
+     */
+    dutyEndsOn: string | null;
 }
 export interface IPrioritizedService {
     /**
@@ -3620,6 +3844,16 @@ export interface IResourceFilter {
      *
      */
     unitCategories: UnitCategory[] | null;
+    /**
+     * Gets or sets a collection of to filter resources by the kind of unit (any of the groups matches).
+     *
+     */
+    unitCategoryGroups: UnitCategoryGroup[] | null;
+    /**
+     * Gets or sets a collection of to filter resources by how soon they are available (any of them matches).
+     *
+     */
+    unitAvailabilities: UnitAvailability[] | null;
     /**
      * Gets or sets a collection of to filter resources by unit display categories see .
      *
@@ -4214,6 +4448,11 @@ export interface IUnitResource {
      *
      */
     suggestionOn: string | null;
+    /**
+     * Gets or sets when the reservation for the current operation is released automatically (real time, UTC, not the session time); null without reservation.
+     *
+     */
+    reservationExpiresOn: string | null;
     /**
      * Gets or sets the count of times the unit has been dispatched, used for load balancing between units.
      *
@@ -4567,7 +4806,12 @@ export declare enum DispatchCenterOption {
      * Specifies whether the equipment suggester accounts for equipment already provided by units from previous suggesters (e.g., TagsSuggester). Note: This calculation is only relevant if is enabled; otherwise, the equipment suggester is skipped when tag-based units are present.
      *
      */
-    EquipmentSuggesterIncludesPreviousSuggesterResults = 22
+    EquipmentSuggesterIncludesPreviousSuggesterResults = 22,
+    /**
+     * Patients are transported to the nearest hospital that accepts their PZC, as assigned per hospital. Without such a hospital, or when disabled, to the nearest hospital with the departments the PZC requires at least.
+     *
+     */
+    HospitalDestinationByPzcAssignment = 23
 }
 export declare enum DispatchGroupAvailabilityState {
     /**
@@ -4586,6 +4830,18 @@ export declare enum DispatchGroupAvailabilityState {
      */
     FullyAvailable = 2
 }
+export declare enum DispatchRequirement {
+    /**
+     * The location must be set (any accuracy other than ).
+     *
+     */
+    Location = 0,
+    /**
+     * At least one keyword must be set.
+     *
+     */
+    Keyword = 1
+}
 export declare enum Gender {
     /**
      * Represents the male gender.
@@ -4751,7 +5007,12 @@ export declare enum NotificationCategory {
      * Notification for a patient transport request from a hospital / external source.
      *
      */
-    TransportRequested = 13
+    TransportRequested = 13,
+    /**
+     * Notification for a PZC (Patientenzustandscode) transmitted by a unit before the patient transport.
+     *
+     */
+    PzcReported = 14
 }
 export declare enum OpeningDays {
     Monday = 1,
@@ -5088,7 +5349,10 @@ export declare enum ProblemInformation {
     PzcHospitalDepartmentNotFound = 172,
     SessionRestoreInProgress = 173,
     SessionBulkOperationInProgress = 174,
-    DispatchCenterAreaIsNotSet = 175
+    DispatchCenterAreaIsNotSet = 175,
+    OperationNotReadyForDispatch = 176,
+    OperationTaskNotExecutable = 177,
+    OperationLocationRequired = 178
 }
 export declare enum SessionAccess {
     Private = 0,
@@ -5209,66 +5473,66 @@ export declare enum ShelfBatchCreateMode {
      * Validates the batch without making any changes to the database.
      *
      */
-    DryRun = 0,
+    DryRun = "DryRun",
     /**
      * Only updates existing entities. Does not create new entities.
      *
      */
-    UpdateOnly = 1,
+    UpdateOnly = "UpdateOnly",
     /**
      * Only creates new entities. Does not update existing entities.
      *
      */
-    CreateOnly = 2,
+    CreateOnly = "CreateOnly",
     /**
      * Updates existing entities and creates new entities as needed.
      *
      */
-    CreateOrUpdate = 3
+    CreateOrUpdate = "CreateOrUpdate"
 }
 export declare enum ShelfBatchFailureMode {
     /**
      * Stop the entire batch operation immediately when the first entity fails. All successful operations are rolled back.
      *
      */
-    StopOnFirstFailure = 0,
+    StopOnFirstFailure = "StopOnFirstFailure",
     /**
      * Skip failed entities and continue processing the remaining entities. Successful operations are committed, failed entities are reported.
      *
      */
-    SkipAndContinue = 1,
+    SkipAndContinue = "SkipAndContinue",
     /**
      * Complete the entire batch but collect all failures. Roll back all operations if any entity fails.
      *
      */
-    AllOrNothing = 2
+    AllOrNothing = "AllOrNothing"
 }
 export declare enum ShelfIdentificationStrategy {
     /**
      * Always use the origin ID for entity identification. Fails if origin ID is not provided or entity is not found.
      *
      */
-    OriginIdOnly = 0,
+    OriginIdOnly = "OriginIdOnly",
     /**
      * Use the origin ID if provided, otherwise fall back to internal ID.
      *
      */
-    OriginIdOrInternalId = 1,
+    OriginIdOrInternalId = "OriginIdOrInternalId",
     /**
      * Use the origin ID for lookup, but fall back to internal ID if entity is not found.
      *
      */
-    OriginIdWithInternalIdFallback = 2,
+    OriginIdWithInternalIdFallback = "OriginIdWithInternalIdFallback",
     /**
      * Use the origin ID if provided and entity exists, otherwise fall back to internal ID. Combines both null check and existence check fallback behavior.
      *
      */
-    OriginIdWithFullFallback = 3,
+    OriginIdWithFullFallback = "OriginIdWithFullFallback",
     /**
      * Will not compare any provided ids with existing ids. All entities will be handled as "new".
      *
      */
-    Disable = 4
+    Disable = "Disable"
 }
 export declare enum Sound {
     /**
@@ -5484,6 +5748,23 @@ export declare enum TaskStatus {
      */
     NotSupported = 5
 }
+export declare enum UnitAvailability {
+    /**
+     * On duty (at the station or on the way) and not bound to an operation.
+     *
+     */
+    Available = 0,
+    /**
+     * Arrived at the destination (e.g. hospital), available soon.
+     *
+     */
+    SoonAvailable = 1,
+    /**
+     * On the way, on scene, driving to the destination, not on duty or individual status.
+     *
+     */
+    NotAvailable = 2
+}
 export declare enum UnitCategory {
     DLK = 0,
     ELW1 = 1,
@@ -5517,6 +5798,28 @@ export declare enum UnitCategory {
     NAW = 29,
     KEF = 30
 }
+export declare enum UnitCategoryGroup {
+    /**
+     * Ambulances for emergencies (e.g. RTW, NAW).
+     *
+     */
+    AmbulanceUrgent = 0,
+    /**
+     * Ambulances for patient transports (e.g. KTW).
+     *
+     */
+    AmbulanceNonUrgent = 1,
+    /**
+     * Units with an emergency doctor (e.g. NEF, RTH).
+     *
+     */
+    Doctor = 2,
+    /**
+     * Fire brigade units (e.g. HLF, DLK).
+     *
+     */
+    Firefighter = 3
+}
 export declare enum UnitDispatchOption {
     /**
      * Indicates a normal dispatch option.
@@ -5720,6 +6023,30 @@ export declare function setLocale(locale: string): void;
 export declare function getCurrentLocale(): string;
 export declare function getLocalizedEnumValue<T extends keyof typeof EnumLocalizations>(enumName: T, enumValue: keyof typeof EnumLocalizations[T], locale?: string): string;
 export declare function localizeEnum<T extends Record<string, string | number>>(enumObject: T, enumName: keyof typeof EnumLocalizations, locale?: string): Record<keyof T, string>;
+export declare namespace DispatchDefaults {
+    /**
+     * How long units stay reserved for an operation (real time, IUnitResource.ReservationExpiresOn) before the reservation is released automatically. Extending a reservation starts it again.
+     *
+     */
+    const ReservationTimeoutSeconds: number;
+    /**
+     * Units whose duty ends within this many minutes (session time) are marked in the resource browser.
+     *
+     */
+    const DutyEndWarningMinutes: number;
+}
+export declare namespace OperationDefaults {
+    /**
+     * The maximum length of the internal and the external information (notes) of an operation.
+     *
+     */
+    const InformationMaxLength: number;
+    /**
+     * The maximum length of a location detail (floor, junction, route marker) of an operation.
+     *
+     */
+    const LocationDetailMaxLength: number;
+}
 export declare namespace SignalRDefaults {
     /**
      * The interval, in seconds, at which the SignalR client sends keep-alive messages to the server.
@@ -5782,4 +6109,3 @@ export declare namespace UserInterfaceDefaults {
         const CommandcenterHeaderImageHeight: number;
     }
 }
-//# sourceMappingURL=main.d.ts.map