@evercam/api 1.0.0-51a0c8745 → 1.0.0-545d28907

package/dist/api/types/ingest.d.ts

@@ -9,6 +9,10 @@ export declare enum IngestProcessingStatus {
     InProgress = "inprogress",
     Pending = "pending"
 }
+export declare enum MobileAssetsType {
+    Audio = "mobile_audios",
+    Photo = "mobile_photos"
+}
 export declare enum IngestVersions {
     V1 = "v1",
     V2 = "v2"

package/dist/api/types/kit.d.ts

@@ -1,4 +1,4 @@
-import { CountryCode, CountryId, DateTime, DateType, Nvr, PaginationParams, PowerType, Project, Router, Schedule, Tag } from "@/types";
+import { CameraExid, CountryCode, CountryId, DateTime, DateType, Nvr, PaginationParams, PowerType, Project, Router, Schedule, Tag } from "@/types";
 export type Kit = {
     alarms: KitAlarm[];
     countryCode: CountryCode;
@@ -16,7 +16,11 @@ export type Kit = {
     serial: string;
     status: KitStatus;
     powerSchedule: Schedule;
+    ups: boolean;
+    boxId: string;
     tags: Tag[];
+    storages: KitStorage[];
+    createdAt: string;
 };
 export declare enum KitStatus {
     New = "new",
@@ -32,16 +36,16 @@ export declare enum KitRegion {
 }
 export declare enum KitAlarm {
     NvrOffline = "nvr_offline",
+    OfflineScheduled = "offline_scheduled",
     UnknownCamera = "unknown_camera",
     NotRecordingCamera = "not_recording_camera",
-    OfflineScheduled = "offline_scheduled",
     FullSD = "full_sd",
     FullStorage = "full_storage",
     HddUnmounted = "hdd_unmounted",
     NoHdd = "no_hdd",
     MissingRouterInfo = "missing_router_info",
-    PowerLost = "ac_failure",
-    UpsLowBattery = "low_battery"
+    AcFailure = "ac_failure",
+    LowBattery = "low_battery"
 }
 export declare enum KitMetricId {
     SolarCharger = "solar_charger",
@@ -316,7 +320,7 @@ export declare enum KitStorageTransport {
 export type KitStorageRequestPayload = {
     kitId: number;
 };
-export type KitStorageResponsePayload = {
+export type KitStorage = {
     id: number;
     serial: string;
     status: string;
@@ -330,5 +334,24 @@ export type KitStorageResponsePayload = {
     vendor: string;
     kitId: number;
     capacity: number;
+    freeSpace: number;
     tran: KitStorageTransport;
 };
+export type KitFootageRequestPayload = {
+    cameraId: CameraExid;
+    storageId: number;
+};
+export type KitFootage = {
+    id: number;
+    startDate: string;
+    endDate: string;
+    cameraId: number;
+    storageId: number;
+};
+export type KitAlarmItem = {
+    id: number;
+    kitId: number;
+    alarm: KitAlarm;
+    startDate: DateTime;
+    endDate: DateTime | null;
+};

package/dist/api/types/planner.d.ts

@@ -1,6 +1,9 @@
 export declare enum EDistortImageModes {
     FreeRotate = "freeRotate",
-    Lock = "lock"
+    Lock = "lock",
+    Rotate = "rotate",
+    Scale = "scale",
+    Pan = "drag"
 }
 export declare enum EMapTypes {
     Blank = "Blank",

package/dist/api/types/progressPhoto.d.ts

@@ -1,31 +1,13 @@
-import { DateTime, DateType, PaginationParams } from "@/types";
-export type ProgressPhoto = {
-    cameraIds: string;
-    cameraNames: number;
-    createdAt: string;
-    id: number;
-    provider: string;
-    type: string;
-    config: Partial<{
-        recipients: string;
-        projectId: number;
-        companyId: number;
-    }>;
-    isPaused: boolean;
-    notifyDays: string;
-    notifyTime: string;
-    requesterEmail: string;
-    requesterName: string;
-    timezone: string;
-    title: string;
-};
+import { Automation, AutomationType, DateTime, DateType, PaginationParams } from "@/types";
 export type ProgressPhotosCreateUpdateRequestPayload = {
     cameraExids?: string;
     notifyDays?: string;
+    compareDelay?: AutomationType;
     notifyTime?: string;
     provider?: string;
     type?: string;
     config?: {
+        compareDelay?: AutomationType;
         recipients?: string;
         projectId?: number;
         companyId?: number;
@@ -40,9 +22,9 @@ export type ProgressPhotosUnSubscribeParams = {
     token?: string;
 };
 export type ProgressPhotosResponsePayload = {
-    progressPhotos: ProgressPhoto[];
+    progressPhotos: Automation[];
 };
-export declare enum ProgressPhotoDialogType {
+export declare enum AutomationDialogType {
     Create = "create",
     Edit = "edit",
     Pause = "pause"

package/dist/api/types/project.d.ts

@@ -1,4 +1,4 @@
-import { AdminCamera, Camera, CameraExid, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
+import { AdminCamera, Camera, CameraExid, DateRangeFilter, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
 export type ProjectExid = Exid;
 export type ProjectsByExid = EntityByExid<Project>;
 export type Project = {
@@ -12,6 +12,7 @@ export type Project = {
     zohoId?: string;
     userId?: number;
     cameras?: Array<Camera | AdminCamera>;
+    unrestrictedCameras?: Array<Camera | AdminCamera>;
     featureFlags: Array<ProjectFeatureFlag>;
     owner?: {
         email?: string;
@@ -60,7 +61,8 @@ export declare enum ProjectFeatureFlag {
     NoLicensePlate = "no_license_plate",
     DefaultToProjectApp = "default_to_project_app",
     SmartSearch = "smart_search",
-    PpeMonitoring = "ppe_monitoring"
+    PpeMonitoring = "ppe_monitoring",
+    NoGdpr = "no_gdpr"
 }
 export type ProjectBatteryReading = {
     exid: number;
@@ -126,3 +128,41 @@ export type ProjectUsers = {
     }[];
     users: Record<string, ProjectUserProperty[]>;
 };
+export type ProjectDateRangeFilter = DateRangeFilter & {
+    projectExid: ProjectExid;
+};
+export type ProjectRole = {
+    id: string;
+    name: string;
+};
+export type ProjectMember = {
+    id: string;
+    email: string;
+    fullname: string;
+    role: ProjectRole;
+};
+export type ProjectInvite = {
+    id?: string;
+    email: string;
+    role?: ProjectRole;
+    invitedAt?: string;
+};
+export type ProjectMembersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+};
+export type ProjectMembersRequestPayload = {
+    roleId: number;
+    emails: string[];
+    overrideRole?: Partial<{
+        permissions?: string[];
+        subRoles?: Array<{
+            resourceId: string;
+            roleId: number;
+        }>;
+    }>;
+};
+export type ProjectInviteMembersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+};

package/dist/api/types/recording.d.ts

@@ -10,6 +10,7 @@ export type NearestSnapshotRequestPayload = {
     apiId?: string;
     token?: string;
     cancelToken?: object;
+    includeImage?: boolean;
 };
 export type AvailableDaysRequestPayload = {
     cameraId: string;

package/dist/api/types/recycleBin.d.ts

@@ -0,0 +1,14 @@
+import type { DateType, PaginationParams } from "@/types";
+export type RecycleBin = {
+    id?: number;
+    exid: string;
+    name: string;
+    type: string;
+    deletedBy: string;
+    deletedAt: DateType;
+};
+export type RecycleBinQueryParams = PaginationParams & {
+    name: string;
+    type: string;
+    deletedBy: string;
+};

package/dist/api/types/routeParams.d.ts

@@ -46,6 +46,7 @@ export declare enum TimelineMobileCaptureUrlParams {
     ShowMobileCapture = "showMobileCapture"
 }
 export declare enum TimelineCommentsUrlParams {
-    ShowComments = "showComments"
+    ShowComments = "showComments",
+    SelectedCommentId = "selectedCommentId"
 }
 export type TimelineUrlParams = Record<TimelineUrlParam | TimelineMediaUrlParams | TimelineBimUrlParams | TimelineExNvrRecordingsUrlParams | TimelineAnprUrlParams | TimelineMobileCaptureUrlParams | TimelineCommentsUrlParams, string | null>;

package/dist/api/types/shared.d.ts

@@ -90,11 +90,6 @@ export declare enum _3dViewer {
     Itwin = "itwin",
     Cesium = "cesium"
 }
-export declare enum SsoProvider {
-    Microsoft = "microsoft",
-    Google = "google",
-    Evercam = "evercam"
-}
 export declare enum InfoPage {
     ThreeSixtyView = "360",
     BIMView = "bim",
@@ -105,7 +100,7 @@ export declare enum InfoPage {
     Timeline = "timeline",
     WeatherReport = "weather-report"
 }
-export declare enum DownloadTypes {
+export declare enum DownloadFileType {
     Jpeg = "jpeg",
     Pdf = "pdf",
     Csv = "csv"

package/dist/api/types/siteAnalytics.d.ts

@@ -1,15 +1,15 @@
-import type { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid } from "@evercam/api/types";
-import { DetectionLabel, DownloadTypes } from "@evercam/api/types";
+import type { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter } from "@evercam/api/types";
+import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
 export declare enum SiteAnalyticsMode {
     Detections = "detections",
     Segments = "segments"
 }
-export type SmartSearchOptionData = {
+export type SmartSearchQueryPartData = {
     id?: string;
-    type: SmartSearchQueryComponentType;
+    type: SmartSearchQueryPartType;
     value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | SmartSearchCondition | SmartSearchDateRange | string;
 };
-export type SmartSearchQueryPart = SmartSearchOptionData | [SmartSearchQueryPart] | SmartSearchQueryPart[];
+export type SmartSearchQueryPart = SmartSearchQueryPartData | SmartSearchQueryPartData[];
 export declare enum SmartSearchQueryComponentType {
     Condition = "condition",
     Object = "object",
@@ -17,8 +17,10 @@ export declare enum SmartSearchQueryComponentType {
     Time = "time",
     Operator = "operator",
     Camera = "camera",
-    DateRange = "date_range"
+    DateRange = "date_range",
+    Heatmap = "heatmap"
 }
+export type SmartSearchQueryPartType = SmartSearchQueryComponentType | SmartSearchCondition;
 export type SmartSearchDateRange = {
     start: DateType;
     end: DateType;
@@ -26,7 +28,7 @@ export type SmartSearchDateRange = {
 export type SmartSearchQueryComponentData = {
     id: string;
     type: SmartSearchQueryComponentType;
-    parts: [SmartSearchQueryPart];
+    parts: SmartSearchQueryPart;
 };
 export declare enum SmartSearchCondition {
     InArea = "in_area",
@@ -114,7 +116,7 @@ export type SavedQuery = {
         timeSchedule?: Schedule | undefined;
     };
     params: Record<string, string>;
-    components?: Omit<SmartSearchOptionData, "id">[];
+    components?: Omit<SmartSearchQueryPartData, "id">[];
     toDate?: DateType;
     createdAt?: DateType;
     cameraExid: string;
@@ -132,10 +134,30 @@ export type DetectionsRequestParams = {
     trackId?: number;
     thresholds?: string[];
     excludeLabels?: Array<DetectionLabel | PpeLabel>;
+    mergedClasses?: Array<string>;
     confidenceThreshold?: number;
 } & PaginationParams;
 export type DetectionsExportRequestParams = DetectionsRequestParams & {
-    fileType: DownloadTypes;
+    fileType: DownloadFileType;
     columns?: string[];
     directDownload?: boolean;
 };
+export type SmartSearchHeatmapPoint = {
+    coordinates: [number, number];
+    detectionsCount: number;
+};
+export type SmartSearchHeatmapData = {
+    label: string;
+    points: SmartSearchHeatmapPoint[];
+};
+export type SmartSearchNearConfig = {
+    sourceLabels: DetectionLabel[];
+    targetLabel?: DetectionLabel;
+};
+export type HeatmapIntersectionsRequestParams = CameraDateRangeFilter & SmartSearchNearConfig;
+export type SmartSearchSidebarItem = {
+    key: string;
+    displayLabel: string;
+    data: SmartSearchHeatmapData;
+    imagePath?: string;
+};

package/dist/api/types/snapshots.d.ts

@@ -48,3 +48,12 @@ export type DeleteSnapshotQueryParams = {
     adminEmail: string;
     adminFullname: string;
 };
+export type TransferCloudRecordingsQueryParams = {
+    targetCameraExid: CameraExid;
+    fromDate: DateType;
+    toDate: DateType;
+    overwriteExistingSnapshots?: boolean;
+    keepSourceSnapshots?: boolean;
+    adminEmail?: string;
+    adminFullname?: string;
+};

package/dist/api/types/sso.d.ts

@@ -0,0 +1,55 @@
+export type SsoProvider = {
+    id: number;
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoUpdatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoCreatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};

package/dist/api/types/streaming.d.ts

@@ -39,8 +39,7 @@ export type ExNvrDeviceConfig = {
     timezone: string;
 };
 export declare enum ExNvrFootageAvailableStatus {
-    Active = "Active",
-    NotActive = "Not Active",
+    Available = "Available",
     NotAvailable = "Not Available"
 }
 export declare enum ExNvrDeviceState {

package/dist/api/types/time.d.ts

@@ -18,4 +18,8 @@ export type DateTime_tz = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}${"+" | "-"}${HH}:
 export type DateTime_Z = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}Z` | string;
 export type DateTime_Z_micros = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}.${microS}Z` | string;
 export type DateTimeSpaceSeparated = `${Date_YYYY_MM_DD} ${Time_HH_mm_ss}` | string;
+export type DateRangeFilter = {
+    fromDate: DateType;
+    toDate: DateType;
+};
 export {};

package/dist/api/types/user.d.ts

@@ -59,6 +59,10 @@ export type ProjectUser = User & {
     cameraExid: string;
     cameraRights: string;
 };
+export declare enum ContactRole {
+    SalesExecutive = "Sales Executive",
+    CustomerSuccessManager = "Customer Success Manager"
+}
 export declare enum Persona {
     HQ = "HQ",
     PM = "PM",

package/dist/api/types/videoWall.d.ts

@@ -1,4 +1,4 @@
-import { Camera, Media } from "@/types";
+import { Camera, Media, PaginationParams } from "@/types";
 export declare enum VideoWallItemType {
     LiveView = "live",
     Video = "video",
@@ -31,3 +31,36 @@ export type VideoWallPresetItem = {
     weather?: Record<string, unknown>;
     media?: Media;
 };
+export type VideoWallSource = "default" | "widget";
+export interface VideoWall {
+    id: number;
+    exid: string;
+    name: string;
+    source: VideoWallSource;
+    config: Record<string, any>;
+    inserted_at: string;
+    updated_at: string;
+    user: {
+        id: number;
+        firstname: string;
+        lastname: string;
+        email: string;
+    };
+}
+export interface ListParams extends PaginationParams {
+    project_exid?: string;
+    id?: number;
+    exid?: string;
+    project_id?: number;
+    user_id?: number;
+    name?: string;
+    project?: string;
+    user?: string;
+    source?: VideoWallSource;
+}
+export type VideoWallCreateUpdatePayload = {
+    project_exid: string;
+    name: string;
+    source?: VideoWallSource;
+    config: Record<string, unknown>;
+};

package/dist/api/types/weather.d.ts

@@ -5,6 +5,8 @@ export type HistoryWeatherRequestPayload = {
 };
 export type CurrentWeatherRequestPayload = {
     provider: WeatherProvider;
+    includeForecast?: boolean;
+    forecastDays?: number;
 };
 export type WeatherResponsePayload = Array<{
     hour?: number;

package/dist/api/types/widget.d.ts

@@ -53,6 +53,19 @@ export declare enum VideoWallWidgetSettingsKeys {
     Height = "height",
     HeightResolution = "heightResolution"
 }
+export declare enum ThreeSixtyKeys {
+    DateId = "dateId",
+    DateLocked = "dateLocked",
+    FloorId = "floorId",
+    FloorLocked = "floorLocked",
+    Marker = "markerId",
+    MarkerLocked = "markerLocked",
+    MediaLocked = "mediaLocked",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
 export type CommonWidgetSettings = {
     width: number;
     resolution: string;
@@ -65,6 +78,8 @@ export type RecordingsWidgetSettings = CommonWidgetSettings & {
     hasDelay: boolean;
     delay: number;
     delayUnit: DelayUnit;
+    hasRange: boolean;
+    dateRange: [DateTime, DateTime] | null;
 };
 export type LiveViewWidgetSettings = CommonWidgetSettings & {
     fullscreen: boolean;
@@ -81,12 +96,18 @@ export type VideoWallWidgetSettings = CommonWidgetSettings & {
     preset: VideoWallPresetItemConfig;
     refreshRate: number;
 };
-export type WidgetSettings = RecordingsWidgetSettings | LiveViewWidgetSettings | BimCompareWidgetSettings | VideoWallWidgetSettings;
+export type ThreeSixtyWidgetSettings = CommonWidgetSettings & {
+    dateId: string;
+    floorId: string;
+    markerId: string;
+};
+export type WidgetSettings = RecordingsWidgetSettings | LiveViewWidgetSettings | BimCompareWidgetSettings | VideoWallWidgetSettings | ThreeSixtyWidgetSettings;
 export declare enum WidgetType {
     LiveWidget = "Live View",
     Recording = "Recordings",
     BimCompare = "BIM Compare",
-    VideoWall = "Video Wall"
+    VideoWall = "Video Wall",
+    ThreeSixty = "360"
 }
 export declare const WidgetTypesByResource: {
     camera: WidgetType[];
@@ -99,7 +120,7 @@ export type WidgetsListRequestPayload = PaginationParams & {
     active: boolean;
     settings: WidgetSettings;
     widgetType: WidgetType;
-    isPublic: boolean;
+    domainRestricted: boolean;
     allowedOrigin: string;
 };
 export type Widget = {
@@ -119,7 +140,7 @@ export type Widget = {
     widgetType: WidgetType;
     settings: WidgetSettings;
     allowedOrigin: string;
-    isPublic: boolean;
+    domainRestricted: boolean;
     active: boolean;
     user: {
         id: number;
@@ -155,7 +176,7 @@ export type WidgetFull = {
     settings: WidgetSettings;
     sessionSettings: any;
     allowedOrigin: string;
-    isPublic: boolean;
+    domainRestricted: boolean;
     insertedAt: DateTime;
     updatedAt: DateTime;
 };
@@ -167,6 +188,6 @@ export type WidgetPayload = {
     widgetType: WidgetType;
     active: boolean;
     settings: WidgetSettings;
-    isPublic: boolean;
+    domainRestricted: boolean;
     allowedOrigin: string;
 };

package/dist/api/utils.d.ts

@@ -7,3 +7,4 @@ export declare const toQueryString: <T extends Record<string, unknown>>(paramsOb
     forceArrayBrackets?: boolean | undefined;
 }) => string | undefined;
 export declare function queryStringToObject(queryString?: string): QueryParams;
+export declare function capitalizeFirstLetter(inputString: string): string;