@evercam/api 1.0.0-ae97ae0a0 → 1.0.0-api-fixes-7de7fc3dd

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

@@ -21,11 +21,12 @@ export type BimModelRequestPayload = {
     apiId?: string;
 };
 export type BimModelResponsePayload = {
-    dates?: [string];
+    id?: number;
+    dates?: string[] | null;
     height?: number;
     imageUrl?: string;
     model?: string;
-    models?: [string];
+    models?: string[];
     rotation?: number;
     scaleX?: number;
     scaleY?: number;
@@ -40,13 +41,13 @@ export type BimCompareExportRequestPayload = {
     cameraExid: string;
     snapshotDate: string;
     bimDate: string;
-    embed: string;
+    embed?: string;
     compareExid: string;
-    createAnimation: boolean;
-    bimTransparency?: number;
-    model?: string;
-    layerId?: number;
-    maskId?: number;
+    createAnimation?: boolean;
+    bimTransparency: number;
+    model: string;
+    layerId: number;
+    maskId: number;
     evercamWatermark?: boolean;
     logo?: CompareLogoPosition;
 };
@@ -66,16 +67,16 @@ export declare enum BimUploadStatus {
 }
 export type BimCreationPayload = {
     title: string;
-    software: "synchro" | "navisworks" | "revit" | "tekla" | "archicad" | "solibri" | "bim360" | "other";
-    model: string;
-    apiKey: string;
-    apiId: string;
-    displayName: string;
     fileUrl: string;
-    requestor: string;
-    finalView: boolean;
-    enableDistortion: boolean;
-    startAt: string;
+    software?: "navisworks" | "synchro";
+    model?: string;
+    apiKey?: string;
+    apiId?: string;
+    displayName?: string;
+    requestor?: string;
+    finalView?: boolean;
+    enableDistortion?: boolean;
+    startAt?: string;
 };
 export declare enum BIMLayerTypes {
     Mask = "mask",
@@ -93,49 +94,51 @@ export declare enum BIMLayerTypes {
     ForgeBimMep = "forge_bim_mep"
 }
 export type BimLayersQueryParams = {
-    layerType: BIMLayerTypes;
-    timestamp: DateType;
+    layerType?: BIMLayerTypes;
+    timestamp?: DateType;
 };
 export type BIMLayerPostPayload = {
-    name: string;
-    layerType: BIMLayerTypes;
-    startAt: DateType;
     shapes: string;
-    zIndex: number;
+    startAt: DateType;
+    name?: string;
+    displayName?: string;
+    layerType?: BIMLayerTypes;
+    zIndex?: number;
 };
 export type BIMLayer = {
     id: number;
     name: string;
     layerType: BIMLayerTypes;
+    displayName?: string | null;
     startAt: DateType;
     insertedAt: DateType;
     updatedAt: DateType;
     shapes: string;
 };
 export type BimPendingImage = {
-    url: string;
-    s3Url: string;
+    url?: string;
+    key?: string;
 };
 export type BimUploadCameraParameters = {
-    distortionFov: [number];
-    horizontalFov: number;
-    verticalFov: number;
-    focalLength1: number;
-    focalLength2: number;
-    centerX: number;
-    centerY: number;
+    distortionCoeffs?: number[][];
+    horizontalFov?: number;
+    verticalFov?: number;
+    focalLength1?: number;
+    focalLength2?: number;
+    centerX?: number;
+    centerY?: number;
 };
 export type PendingBimImagesParams = {
     model: string;
-    apiKey: string;
-    apiId: string;
+    apiKey?: string;
+    apiId?: string;
 };
 export type ProcessPendingImagesBimParams = {
     model: string;
     names: string[];
-    enableDistortion: boolean;
-    apiId: string;
-    apiKey: string;
+    enableDistortion?: boolean;
+    apiId?: string;
+    apiKey?: string;
 };
 export type BimUploadsQueryParams = {
     page: number;
@@ -168,3 +171,11 @@ export declare enum ForgeBimDialogTrigger {
     AddModel = "add_model",
     InitialSetup = "initial_setup"
 }
+export type BimUpdatedWebhookPayload = {
+    eventName: "bim.updated";
+    projectId: string;
+    data: {
+        updatedAt: string;
+        bimIdentifier: string;
+    };
+};

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

@@ -1,4 +1,4 @@
-import { AuditLogActionType, DateType, EntityByExid, KitAlarm, NvrDeviceType, PaginationParams, PowerSchedule, PowerType, ProjectExid, ProjectFeatureFlag, Schedule, ScheduleLowercase, TimestampPositionCoordinates } from "@evercam/api/types";
+import { AuditLogActionType, DateType, EntityByExid, KitAlarm, NvrDeviceType, NvrHddStatus, PaginationParams, PowerSchedule, PowerType, ProjectExid, ProjectFeatureFlag, Schedule, ScheduleLowercase, StorageProvider, TimestampPositionCoordinates } from "@evercam/api/types";
 import { DateRangeFilter } from "@evercam/api/types/time";
 import { GeoPoint, TuplePoint2D } from "@evercam/api/types/shared";
 export type CameraExid = string;
@@ -148,13 +148,20 @@ export type AdminCamera = {
     cloudRecordingStorageDuration?: number | null;
     liveViewFrequency?: number | null;
     anprSources?: string[];
-    storageProviders?: string[];
+    storageProviders?: StorageProvider[];
     featureFlags?: CameraFeatureFlag[];
     zohoId?: string | null;
     offlineReason?: string | null;
     macAddress?: string | null;
     type?: string[];
     thumbnailUrl?: string;
+    channel?: string | null;
+    nvrSnapshotUrl?: string | null;
+    ptz?: boolean;
+    hddInfo?: Record<string, unknown>[];
+    cameraFirmwareVersion?: string | null;
+    cameraTimezone?: string | null;
+    resolution?: string | null;
 };
 export type CameraMapMarker = {
     isOnline: boolean;
@@ -215,7 +222,7 @@ export type CameraLogsRequestPayload = {
 export type CameraUpdateRequestPayload = {
     status?: string;
     timezone?: string;
-    isPuclic?: boolean;
+    isPublic?: boolean;
     discoverable?: boolean;
     fullname?: string;
     lastOnline?: string;
@@ -264,6 +271,7 @@ export type CameraStatusLog = {
     start: string;
     end: string;
     state: CameraStatus;
+    status?: string;
 };
 export type Log = {
     details: {
@@ -343,6 +351,10 @@ export type CameraPath = {
 export type CheckCameraPortPayload = {
     address: string;
     port: number;
+};
+export type CheckCameraPortResponse = {
+    address: string;
+    port: number;
     open: boolean;
 };
 export type CameraCreateRequestPayload = {
@@ -401,10 +413,8 @@ export type CameraNote = {
     insertedAt: DateType;
 };
 export type CreateCameraNotePayload = {
-    id?: number;
-    cameraExid: CameraExid;
-    customMessage: string;
-    action: string;
+    noteType: string;
+    content: string;
 };
 export declare enum HddStatus {
     Error = "error",
@@ -414,11 +424,11 @@ export declare enum HddStatus {
     Ok = "ok"
 }
 export type NvrQueryParams = PaginationParams & {
-    ownerId: number;
-    cameraName: string;
-    cameraExid: CameraExid;
-    cameraIp: string;
-    hddStatus: HddStatus;
+    ownerId?: number;
+    cameraName?: string;
+    cameraExid?: CameraExid;
+    cameraIp?: string;
+    hddStatus?: NvrHddStatus[];
 };
 export type OfflineCamera = {
     id: number;
@@ -447,14 +457,14 @@ export type OfflineCamera = {
     }[];
 };
 export type OfflineCameraQueryParams = PaginationParams & {
-    status: CameraStatus;
-    cameraExid: CameraExid;
-    cameraName: string;
-    timezone: string;
-    cameraOwner: string;
-    powerType: PowerType;
-    powerSchedule: PowerSchedule;
-    batteryReadingsLastVoltage: number;
+    status?: CameraStatus;
+    cameraExid?: CameraExid;
+    cameraName?: string;
+    timezone?: string;
+    cameraOwner?: string;
+    powerType?: PowerType;
+    powerSchedule?: PowerSchedule;
+    batteryReadingsLastVoltage?: number;
 };
 export type OfflineCameraNote = {
     action: AuditLogActionType;
@@ -504,29 +514,32 @@ export type MergeDuplicatedCameraPayload = {
     shareeCameras: Record<string, unknown>;
 };
 export type FetchCameraQueryParams = PaginationParams & {
-    status: CameraStatus;
-    isPublic: boolean;
-    featureFlags: CameraFeatureFlag[];
-    ptz: boolean;
-    frequency: number;
-    channel: number;
-    cameraExid: CameraExid;
-    cameraExids: CameraExid[];
-    cameraName: string;
-    projectName: string;
-    timezone: string;
-    region: string;
-    cameraModel: CameraModel;
-    nvrModel: NvrModel;
-    cameraOwner: string;
-    ownerEmail: string;
-    isRecording: boolean;
-    cloudRecordingStorageDuration: number;
-    cameraIds: string;
-    hasLocation: boolean;
-    externalHttpPort: string;
-    externalRsptPort: string;
-    nvrHttpPort: string;
+    status?: CameraStatus;
+    statuses?: string[];
+    isPublic?: boolean;
+    featureFlags?: CameraFeatureFlag[];
+    ptz?: boolean;
+    frequency?: number;
+    channel?: number;
+    cameraExid?: CameraExid;
+    cameraExids?: CameraExid[];
+    cameraName?: string;
+    projectName?: string;
+    timezone?: string;
+    region?: string;
+    cameraModel?: CameraModel;
+    nvrModel?: NvrModel;
+    cameraOwner?: string;
+    ownerEmail?: string;
+    isRecording?: boolean;
+    cloudRecordingStorageDuration?: number;
+    cameraIds?: string;
+    hasLocation?: boolean;
+    externalHttpPort?: string;
+    externalRtspPort?: string;
+    nvrHttpPort?: string;
+    createdAtFrom?: string;
+    createdAtTo?: string;
 };
 export declare enum BimType {
     TwoD = "2D",

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

@@ -1,18 +1,22 @@
 import { CameraExid, DateType, ProjectExid, PaginationParams, TuplePoint3D, TuplePoint2D } from "@evercam/api/types";
 export declare enum CommentsScope {
     Recordings = "recordings",
+    Project = "project",
     ThreeSixty = "360",
     Drone = "drone",
+    Bim = "bim",
     Timeline = "timeline"
 }
 export declare enum CommentsLabel {
     Info = "Info",
     Danger = "Danger",
-    Restricted = "Restricted"
+    Restricted = "Restricted",
+    Hyperlink = "Hyperlink"
 }
 export type CommentsRequestPayload = {
-    scope: CommentsScope;
+    scope?: CommentsScope;
     cameraExid?: CameraExid;
+    archived?: "true" | "false";
 };
 export type CommentsListRequestPayload = PaginationParams & {
     projectExid?: ProjectExid;
@@ -25,30 +29,34 @@ export type CommentsListRequestPayload = PaginationParams & {
     includeArchived?: boolean;
 };
 export type Comment = {
-    fromDate?: string;
-    toDate?: string;
-    timestamp: string;
-    projectExid: ProjectExid;
-    updatedAt?: string;
     id?: number;
-    cameraExid: CameraExid;
-    content: string;
+    cameraExid?: CameraExid;
+    content?: string;
+    scope?: CommentsScope;
+    visibility?: string[];
+    timestamp?: string;
+    fromTimestamp?: string;
+    toTimestamp?: string;
+    label?: CommentsLabel;
+    position2d?: TuplePoint2D;
+    position3d?: TuplePoint3D;
     createdAt?: string;
+    archivedAt?: string;
     creatorEmail?: string;
     creatorName?: string;
-    position2d?: TuplePoint2D;
-    position3d?: TuplePoint3D;
     context?: Record<string, unknown>;
+    projectExid?: ProjectExid;
+    updatedAt?: string;
     canDelete?: boolean;
-    archivedAt?: string;
-    label?: CommentsLabel;
 };
 export type CommentCreationRequestPayload = {
-    fromDate?: DateType;
-    toDate?: DateType;
+    fromTimestamp?: DateType;
+    toTimestamp?: DateType;
     timestamp?: DateType;
     scope?: CommentsScope;
-    projectExid: ProjectExid;
+    visibility?: string[];
+    label?: CommentsLabel;
+    projectExid?: ProjectExid;
     cameraExid?: CameraExid;
     content: string;
     position2d?: TuplePoint2D;

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

@@ -4,8 +4,7 @@ export type CompanyUser = {
     fullname: string;
     email: string;
     eventsCount: number;
-    lastSeenAt: string;
-    active: boolean;
+    lastLoginAt: string | null;
 };
 export type AdminCompanyUser = {
     id: number;
@@ -14,10 +13,14 @@ export type AdminCompanyUser = {
     lastLoginAt: string;
 };
 export type CompanyProject = {
+    id: number;
     exid: string;
     name: string;
-    status: string;
-    startedAt: DateType;
+    status: string | null;
+    archiveTier: string | null;
+    insertedAt: DateType;
+    startDate: DateType | null;
+    endDate: DateType | null;
 };
 export type AdminCompanyProject = {
     id: number;
@@ -95,16 +98,18 @@ export type CompanyCameraSummary = {
     ownerEmail: string;
     ownerFullname: string;
     usersCount: number;
+    apiId?: string;
+    apiKey?: string;
 };
 export type CompanyQueryParams = PaginationParams & {
-    name: string;
-    exid: string;
-    domains: string;
-    projects: string;
-    cameras: string;
-    users: string;
-    activeUsers: string;
-    sessions: string;
+    name?: string;
+    exid?: string;
+    domains?: string;
+    projects?: string;
+    cameras?: string;
+    users?: string;
+    sessions?: string;
+    activeUsers?: string;
 };
 export type CompanyUpdatePayload = {
     name: string;
@@ -113,3 +118,9 @@ export type CompanyUpdatePayload = {
     domains?: string;
     zohoId?: string;
 };
+export type CompanyUpdateResponse = {
+    name?: string;
+    exid?: string;
+    domains?: string;
+    zohoId?: string;
+};

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

@@ -1,26 +1,29 @@
 import { DateType, PaginationParams } from "@evercam/api/types";
 export type Compare = {
+    id: number;
+    exid: string;
     cameraExid: string;
+    title: string;
+    fromDate: string;
+    toDate: string;
     createdAt: string;
+    status: string;
+    requesterEmail: string;
+    requesterName: string;
     embedCode: string;
-    embedTime: boolean;
-    fileName: string;
-    frames: number;
-    fromDate: string;
-    id: number;
-    exid: string;
-    mediaUrls: {
+    public: boolean;
+    notes?: string | null;
+    category?: string | null;
+    isUrgent?: boolean;
+    embedTime?: boolean;
+    fileName?: string;
+    frames?: number;
+    mediaUrls?: {
         gif: string;
         mp4: string;
     };
-    public: boolean;
-    requesterEmail: string;
-    requesterName: string;
-    status: string;
-    thumbnailUrl: string;
-    title: string;
-    toDate: string;
-    type: string;
+    thumbnailUrl?: string;
+    type?: string;
 };
 export declare enum CompareStatus {
     Processing = 0,
@@ -32,17 +35,17 @@ export type CompareRequestPayload = {
     name: string;
     beforeDate: string;
     afterDate: string;
-    cameraExid: string;
     embed: string;
+    cameraExid?: string;
     bim?: boolean;
     custom?: boolean;
     options?: {
-        type: string;
-        beforeSnap: string;
-        afterSnap: string;
+        type?: string;
+        beforeSnap?: string;
+        afterSnap?: string;
     };
-    createAnimation: boolean;
-    evercamWatermark: boolean;
+    createAnimation?: boolean;
+    evercamWatermark?: boolean;
     logo?: CompareLogoPosition;
 };
 export type CompareLogoPosition = {
@@ -67,6 +70,7 @@ export type AdminCompare = {
     insertedAt: DateType;
 };
 export type AdminCompareQueryParams = PaginationParams & {
-    name: string;
-    camera: string;
+    name?: string;
+    camera?: string;
+    sort?: string;
 };

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

@@ -38,28 +38,37 @@ export declare enum HddSize {
     TenTB = "10 TB"
 }
 export type FootageCreateUpdatePayload = {
-    cameraId: string;
+    cameraId?: number;
+    hddId?: number;
     startDate: string;
-    endDate: string;
+    endDate?: string;
 };
 export type HDDCreateUpdatePayload = {
-    size: string;
-    type: string;
-    format: string;
-    locationId: string;
-    serialNumber: string;
-    hddStatus: string;
-    shelfBlock: string;
+    locationId: number;
+    kitId?: number | null;
+    serialNumber?: string;
+    size?: string;
+    hddStatus?: string;
+    type?: string;
+    shelfBlock?: string;
+    format?: string;
+    errorStatus?: string;
+    reportedCapacity?: string;
+    reportedFreeSpace?: string;
+    reportedProperty?: string;
+    reportedPath?: string;
+    reportedHddType?: string;
 };
 export type HDDsQueryParams = PaginationParams & {
-    id: number;
-    location: string;
-    serialNumber: string;
-    shelfBlock: string;
-    format: string;
-    size: string;
-    type: string;
-    hddStatus: string;
+    id?: number;
+    location?: string;
+    serialNumber?: string;
+    shelfBlock?: string;
+    format?: string;
+    size?: string;
+    type?: string;
+    hddStatus?: string;
+    sort?: string;
 };
 export type AdminHddFootage = {
     id: number;
@@ -70,19 +79,44 @@ export type AdminHddFootage = {
 };
 export type AdminHdd = {
     id: number;
-    size: string;
-    type: string;
-    format: string;
-    location: string;
+    size: string | null;
+    type: string | null;
+    format: string | null;
+    location: string | null;
     errorStatus: string | null;
     createdAt: string;
-    serialNumber: string;
-    hddStatus: string;
+    serialNumber: string | null;
+    hddStatus: string | null;
     reportedCapacity: string | null;
     reportedFreeSpace: string | null;
     reportedHddType: string | null;
     reportedPath: string | null;
     reportedProperty: string | null;
-    shelfBlock: string;
+    shelfBlock: string | null;
     footages: AdminHddFootage[];
 };
+export type HddDetail = {
+    id: number;
+    locationId: number | null;
+    kitId: number | null;
+    serialNumber: string | null;
+    size: string | null;
+    hddStatus: string | null;
+    type: string | null;
+    shelfBlock: string | null;
+    format: string | null;
+    errorStatus: string | null;
+    reportedCapacity: string | null;
+    reportedFreeSpace: string | null;
+    reportedProperty: string | null;
+    reportedPath: string | null;
+    reportedHddType: string | null;
+    createdAt: string;
+};
+export type HddFootageItem = {
+    id: number;
+    cameraId: number | null;
+    hddId: number | null;
+    startDate: string;
+    endDate: string | null;
+};